Skip to main content
POST
Get shipping documents
Part of the Generating Shipping Documents integration guide — see it for when and how to use this endpoint.

Body

application/json
OrderId
string
required

"eCommerce order number" as passed down in the order payload. For Shopify, should be either the Shopify Order Name (default), e.g. #12345; or the Shopify Order Number, e.g. 12345. The Global-e order ID is also accepted.

Parcels
Parcel · object[]
required

List of parcels being shipped. May be an empty array: a request with no parcels and no exceptions returns the order's existing shipping documents.

DeliveryReferenceNumber
string

Additional informative dispatch reference.

HubCode
string

When dispatching from multiple hubs, indicates for a given call which hub the related shipment will be dispatched from.

IsCompleted
boolean

When true, all items not already declared as part of a parcel will be cancelled and refunded. Until true, consolidation of parcels is expected if no backorders are present. If backorder exceptions are specified, not required — allows dispatch of existing parcels without delay.

Exceptions
DispatchException · object[] | null

List of item exceptions (out-of-stock, backorder, or cancellation). May be an empty array or null.

TrackingDetails
TrackingDetails · object | null

Order-level tracking information. Add tracking on each parcel or for the entire order, not both.

Response

Successful response, or a 200 carrying object-level processing errors (IsSuccess=false with the Errors array populated).

IsSuccess
boolean

Indicates whether the API call was successful.

ErrorText
string | null

Description of the error for getting documents.

ShippingMethodCode
string | null

The merchant-configured shipping method code for the order's selected shipping method — the same value carried in InternationalDetails.ShippingMethodCode on Global-e's outbound order flows. This is the configured code, NOT the service level. Returned as null when no code can be resolved for the order's shipping method.

Example:

"GE_DIRECT-Standard"

Documents
OrderDocument · object[] | null

List of OrderDocument objects that hold the shipping documents.

ParcelsTracking
Merchant.ParcelTracking · object[] | null

The list of Merchant.ParcelTracking objects. Each object holds the parcel tracking number and the full tracking URL of the relevant shipper (with the parcel tracking number).

TrackingDetails
Merchant.TrackingDetails · object | null

Order tracking information.

DeliveryAdviceInformation
DeliveryAdviceInformation · object[] | null

List of DeliveryAdviceInformation objects that hold the information required for the "Delivery Advice" document.

AdditionalRequiredDocuments
AdditionalRequiredDocument · object[] | null

Additional shipping documents the order requires, such as an Export Accompanying Document (EAD). This array flags what is needed; the documents themselves arrive via SendAdditionalRequiredDocumentsToMerchant. See the Export documents guide.

Errors
OrderProcessingError · object[] | null

Object-level processing errors (returned with HTTP 200).