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"
    }
  ]
}

​
Request

GET /shipping/shipments?orderId=690ff00acf4de460fd1f6114
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}

​
Headers

HeaderTypeDescription
AuthorizationstringProvide the customer token in the format Bearer <jwt>.
x-shop-idstringIdentify the shop that owns the order.

​
Query parameters

ParameterTypeRequiredDescription
orderIdstringYesThe order ID to retrieve shipments for.

​
Successful response

{
  "status": 200,
  "success": true,
  "message": "Shipments retrieved successfully",
  "data": [
    {
      "_id": "68fd6e1027e0b21f55b403cf",
      "order": "690ff00acf4de460fd1f6114",
      "trackingNumber": "1Z999AA10123456784",
      "carrier": "FedEx",
      "status": "in_transit",
      "shippingAddress": {
        "fullName": "John Doe",
        "addressLine1": "123 Main St",
        "city": "New York",
        "state": "NY",
        "zipCode": "10001",
        "country": "USA",
        "phoneNumber": "+1234567890"
      },
      "estimatedDelivery": "2025-11-20T00:00:00.000Z",
      "shippedAt": "2025-11-15T10:00:00.000Z",
      "createdAt": "2025-11-14T15:35:00.000Z",
      "updatedAt": "2025-11-15T10:00:00.000Z"
    }
  ]
}

​
Error response

{
  "status": 404,
  "success": false,
  "message": "Order not found",
  "data": {}
}

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