Skip to main content
POST
This API is enabled per merchant account by Global-e. If it is not enabled for your account, the request returns 403 Forbidden with no response body.
Typical integration sequence. These APIs may be used together when an export declaration or bonded reporting is required, but they are independent endpoints — none is a prerequisite for another.
  1. Get shipping documents — obtain the label and tracking number
  2. Submit bonded information — report bonded vs free-circulation status per product (when bonded reporting is required)
  3. Get shipment information — retrieve product, pricing and declaration header data (when you need the data Global-e holds)
  4. Create the export document — your side, not a Global-e API
  5. Upload shipment documents — upload the document and its reference to Global-e (when a document must be attached)
  6. Dispatch orders — End of Day
Only steps 1 and 6 are universal. Steps 2 to 5 depend on the shipment type, the destination and your configuration. Where they apply, complete steps 2 and 5 before End of Day / Dispatch orders.
If bonded information is not submitted before End of Day, Global-e applies a default bonded status per item based on the parcel’s fulfilment origin and destination. Values submitted through this API always override the default.

Body

application/json
​
TrackingNumber
string
required

Tracking number of the parcel, as returned by GetShippingDocuments. A tracking number may cover more than one parcel, but all of those parcels must belong to the same order.

Example:

"JD014600004882753258"

​
Products
BondedProduct · object[]
required

The product lines for this tracking number. At least one product line must be provided. A SKU whose units are split between the two customs statuses is sent as two lines for the same SKU — one bonded, one free circulation — and their quantities are added together. See the "One SKU split between bonded and free circulation" request example.

Minimum array length: 1

Response

The bonded information was validated and stored. Storage only — finance reporting and the carrier pre-alert are produced asynchronously afterwards.

​
Success
boolean

Indicates that the bonded information was stored. Returned only with HTTP 200, and always true. Failures are returned as an error response instead.

Example:

true