Skip to main content
GET
List shipments for the store
Returns a paginated list of the store’s shipments, each enriched with its associated orders. Optionally filter to a single order. Requires the READ_SHIPPING scope.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Query Parameters

orderId
string

Restrict results to shipments containing this order ObjectId.

page
integer
default:1

Page number (1-based).

limit
integer
default:10

Items per page. Defaults to 10.

Response

List shipments for the store.

Standard Salesive response envelope. The operation-specific payload is carried in data.

status
integer
required

HTTP status code, echoed in the body.

success
boolean
required

Whether the request succeeded.

message
string
required

Human-readable result message.

data
object