Sync order tracking information

If you are building an integration with Zonos and are generating order tracking information outside of Zonos, such as with your own shipping carrier integrations or with a third-party label provider, you can use the Zonos API to add tracking information to orders in Zonos. Adding tracking information to orders in Zonos will mark the order as shipped and will send tracking information to the customer.

You can also listen for tracking updates on Zonos orders to keep your system in sync with Zonos. This is useful if you are generating all of your labels in Dashboard and want to sync the tracking/status information back to your own system. This guide will cover both of these scenarios in detail.

Add order numbers to Zonos orders 

To add tracking numbers to an order, you can use the orderAddTrackingNumber mutation. This mutation requires the id of the order you want to add tracking numbers to, as well as the trackingNumbers you want to add to the order. This will mark the order as shipped and link the tracking information to the order.

mutation OrderAddTrackingNumber {
  orderAddTrackingNumber(
    input: { id: "order_XXXXXXXXXXXXXX", trackingNumbers: "123123123" }
  ) {
    status
    trackingNumbers
  }
}

Listen for tracking updates on Zonos orders 

You can use the SHIPMENT_CREATED webhook to listen to orders when new shipments are created. This webhook will be triggered when a label is created in Dashboard, or when an order is marked as shipped using the orderAddTrackingNumber mutation.

Read our webhooks guide for more information on how to set up webhooks, and see our webhook reference for more information on the SHIPMENT_CREATED webhook payload.