Skip to main content

Process Flow Charts

This page provides visual guides for common API workflows.

Shipment Creation Process​

The following chart illustrates the complete process of creating a shipment, handling asynchronous processing, and retrieving the final tracking label.

Key Steps:​

  1. Create: Initiate the request using the Create Shipment API.
  2. Poll: If the Carrier.Status returns Processing, you must poll the Get Shipment API periodically.
  3. Final Status: Continue polling until the status changes to Created or Failed.
  4. Label: Once Created, use the Get Label API to download your shipping labels.

Refund Process​

The refund process can return a terminal status immediately or require asynchronous monitoring.

Key Steps:​

  1. Initiate: Call the Create Refund API at any time for a created shipment.
  2. Terminal Check: If the response returns Refunded or Rejected, the process is finished.
  3. Monitor: If the status is not terminal, use the Get Refund API to check the progress periodically.
  4. Conclusion: The process is finished once the status reaches Refunded or Rejected.

Note: You are safe to call the Create Refund API to do the polling as well.