Skip to main content

Quickstart

This walkthrough covers the standard integration path for a merchant or logistics partner.

1. Validate the destination​

Use POST /addresses/validate to normalize address fields and confirm deliverability before the order moves into fulfillment.

2. Request a quote​

Use POST /rates/quote with origin, destination, and parcel dimensions to retrieve service options, pricing, and estimated delivery windows.

3. Create the shipment​

Use POST /shipments with the selected service level and an Idempotency-Key header to create the shipment safely even if the client retries the request.

4. Track operational status​

Use GET /tracking/{trackingNumber} to retrieve the current shipment state and event timeline.

5. Subscribe to webhooks​

Use POST /webhooks/subscriptions to receive shipment lifecycle events such as:

  • shipment.created
  • shipment.out_for_delivery
  • shipment.delivered
  • shipment.exception
  • Validate addresses before quoting
  • Quote before shipment creation
  • Store both shipmentId and trackingNumber
  • Process webhooks as the primary real-time feed
  • Use polling as a fallback for reconciliation and support tooling