Skip to main content

List Shipments

GET 

/api/shipbob/:instance/shipments

Paginated, filterable, sortable list of ShipBob shipments for the instance (one ship event each).

Required scope: integrations:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Free-text search covers tracking_number and carrier. Default page size is 10.

Each row's sof_link.link_reference is the fulfillment number (e.g. SO-SB-1003.1). sales_order resolves through the linked fulfillment or, for a parcel not matched to a fulfillment yet, through the ShipBob order's fulfillment order.

Request​

Responses​

OK

Response Headers
    Content-Type