This documentation is in beta, and might contain errors. Contact us at integration@instabee.com with any questions.

Instabee API

Fetch Tracking Links

Locker to Locker (Consumer to Consumer) is the only product that has two separate tracking links: one for the sender and one for the recipient. All other products return a single tracking link.

These links are not returned by the create-order call. Use Fetch Order to retrieve them.

  1. Create the order with parcelPackingConfirmed: true — a Locker to Locker order is created and confirmed in a single call. Save the orderId from the response.
  2. The create-order response contains only a preliminary tracking link. It is generated before the parcel exists in our tracking system, so it does not resolve yet — opening it gives a broken link. Do not send this link to the sender or the recipient.
  3. Once the full order with packing confirmed has been sent, senderTracking and recipientTracking are generated. When they are ready they replace the preliminary tracking link, so call Fetch Order with the saved orderId to read them.

Tracking links are returned per parcel under parcels[].links when the parcel is in a trackable state.

Endpoint

Production

GET api.integration.instabee.com/orders/{orderId}

Sandbox

GET sandbox-api.integration.instabee.com/orders/{orderId}

Use sandbox credentials against the sandbox host.

Headers:

1Authorization: Bearer {token}

Path Parameters

ParameterTypeRequiredDescription
orderIdstringrequiredInstabee order ID returned from create order

What to Read in the Response

Look at each parcel in parcels[] and inspect the links object.

FieldTypeDescription
links.recipientTrackingstringRecipient tracking URL (when available)
links.senderTrackingstringSender tracking URL (when available)

recipientTracking and senderTracking may be absent for non-trackable parcels (for example cancelled parcels), in which case links is an empty object.

See the code examples panel for a full masked response sample.

Integration Notes

  1. Save orderId from the create-order response.
  2. Wait until the order has been sent with parcelPackingConfirmed: true — the links do not exist before that.
  3. Call Fetch Order using that orderId.
  4. For each parcel, read parcels[].links.recipientTracking and parcels[].links.senderTracking when present.
  5. Do not assume both tracking links exist for every parcel state, and do not fall back to the preliminary tracking link from the create-order response.
  6. If the links are not there yet, retry Fetch Order rather than caching an empty result.

Command Palette

Search for a command to run...