Skip to main content
GET
/
shipping
/
shipments
Get shipments by order
curl --request GET \
  --url https://store.salesive.com/api/v1/shipping/shipments \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'
{
  "status": 123,
  "success": true,
  "message": "<string>",
  "data": [
    {
      "_id": "<string>",
      "order": "<string>",
      "carrier": "<string>",
      "status": "<string>",
      "trackingNumber": "<string>",
      "shippingAddress": {
        "fullName": "<string>",
        "addressLine1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>",
        "phoneNumber": "<string>",
        "addressLine2": "<string>"
      },
      "estimatedDelivery": "2023-11-07T05:31:56Z",
      "shippedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}
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

JWT issued by the Salesive Store API for authenticated shoppers.

​
x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

​
x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Query Parameters

​
orderId
string
required

The order ID to retrieve shipments for.

Response

Shipments retrieved successfully.

​
status
integer
required
​
success
boolean
required
​
message
string
required
​
data
object[]
required