Skip to main content
GET
List or reconcile Merchant shipments

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials flow for external machine-to-machine integrations.

Headers

Accept-Language
string

Preferred response language when a localized representation is available.

Maximum string length: 64
Example:

"en"

Query Parameters

limit
integer
default:25

Maximum items to return. Default 25, maximum 100. Values outside 1..100 are rejected with 400; they are never clamped.

Required range: 1 <= x <= 100
cursor
string

Opaque continuation token from a previous page's page.nextCursor. Bound to the tenant, parent resource, filter and sort of the originating query; a cursor presented to a different query is rejected with 400 INVALID_CURSOR.

Maximum string length: 256
Pattern: ^[A-Za-z0-9_-]{1,256}$
state
enum<string>
Available options:
PENDING_APPROVAL,
READY_FOR_DISPATCH,
OFFERED,
ACCEPTED,
DISPATCH_UNRESOLVED,
PICKED_UP,
OUT_FOR_DELIVERY,
DELIVERED,
DELIVERY_FAILED,
CANCELLED
externalReference
string
Required string length: 1 - 128

Response

Merchant shipment page

data
object[]
required
page
object
required
Example: