> ## Documentation Index
> Fetch the complete documentation index at: https://docs.salesive.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get shipments by order

> Retrieve all shipments associated with a specific order.

## Request

```http theme={null}
GET /shipping/shipments?orderId=6a27d632289b87893fcbde35
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}
```

## Headers

| Header          | Type   | Description                                              |
| --------------- | ------ | -------------------------------------------------------- |
| `Authorization` | string | Provide the customer token in the format `Bearer <jwt>`. |
| `x-shop-id`     | string | Identify the shop that owns the order.                   |

## Query parameters

| Parameter | Type   | Required | Description                             |
| --------- | ------ | -------- | --------------------------------------- |
| `orderId` | string | Yes      | The order ID to retrieve shipments for. |

## Successful response

```json theme={null}
{
    "status": 200,
    "success": true,
    "message": "Shipments retrieved",
    "data": [
        {
            "_id": "6a27d67f289b87893fcbde40",
            "orders": [],
            "courier": {
                "id": null,
                "name": "Standard Delivery",
                "image": null
            },
            "shippingAddress": {
                "_id": "6938e4f0019a97bc42775b59",
                "user": "69360693a7a8f7dc8ae32d6d",
                "name": "Jane Smith",
                "email": "jane@example.com",
                "phone": "+2348099887766",
                "address": "12 Computation Way, Lagos",
                "city": "Lagos",
                "state": "Lagos",
                "zipCode": "100001",
                "country": "NG",
                "latitude": 6.4541,
                "longitude": 3.3947,
                "validated": {
                    "address_code": 572627280,
                    "address": "12 Computation Way, Lagos Island, Lagos, Nigeria",
                    "name": "Jane Smith",
                    "email": "jane@example.com",
                    "street_no": "12",
                    "street": "Computation Way",
                    "phone": "+2348099887766",
                    "formatted_address": "12 Computation Way, Lagos Island, Lagos, Nigeria",
                    "country": "Nigeria",
                    "country_code": "NG",
                    "city": "Lagos Island",
                    "city_code": "Lagos Island",
                    "state": "Lagos",
                    "state_code": "LA",
                    "postal_code": "100001",
                    "latitude": 6.4541,
                    "longitude": 3.3947
                },
                "isDefault": false,
                "deleted": false,
                "createdAt": "2025-12-10T03:11:44.136Z",
                "updatedAt": "2025-12-10T03:11:44.136Z",
                "__v": 0
            },
            "shippingOption": {
                "_id": "69f8f047f5d9d8178331ec8a",
                "name": "Standard Delivery",
                "description": "Delivered within 3-5 business days.",
                "type": "manual",
                "price": 5000,
                "match": "all",
                "couriers": [],
                "triggers": [],
                "enabled": true,
                "deleted": false,
                "deletedAt": null,
                "shop": "68b8f52575da81b332af29f1",
                "pickupAddress": null,
                "validatedAddress": null,
                "createdAt": "2026-05-04T19:15:19.313Z",
                "updatedAt": "2026-05-04T19:15:19.313Z",
                "__v": 0
            },
            "trackingCode": "",
            "trackingUrl": "",
            "status": "pending",
            "trackingHistory": [],
            "estimatedDelivery": null,
            "shippingCost": 5000,
            "packageDimensions": {
                "unit": "in"
            },
            "deleted": false,
            "deletedAt": null,
            "createdAt": "2026-06-09T09:01:51.440Z",
            "updatedAt": "2026-06-09T09:01:51.440Z",
            "__v": 0
        }
    ]
}
```

## Error response

```json theme={null}
{
    "status": 400,
    "success": false,
    "message": "\"orderId\" is required",
    "data": {}
}
```


## OpenAPI

````yaml GET /shipping/shipments
openapi: 3.1.0
info:
  title: Salesive Store API
  description: >-
    REST interface for querying products, categories, and merchandising banners
    exposed by Salesive storefronts.
  version: 1.0.0
servers:
  - description: Production
    url: https://store.salesive.com/api/v1
security:
  - BearerAuth: []
    ShopIdHeader: []
paths:
  /shipping/shipments:
    get:
      summary: Get shipments by order
      description: Retrieve all shipments associated with a specific order.
      parameters:
        - $ref: '#/components/parameters/XShopIdHeader'
        - name: orderId
          in: query
          required: true
          description: The order ID to retrieve shipments for.
          schema:
            type: string
      responses:
        '200':
          description: Shipments retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShipmentsResponse'
        '401':
          description: Unauthorized.
        '404':
          description: Order not found.
components:
  parameters:
    XShopIdHeader:
      name: x-shop-id
      in: header
      description: >-
        Optional identifier that scopes responses to a specific storefront when
        the referer cannot be inferred.
      required: false
      schema:
        type: string
  schemas:
    ShipmentsResponse:
      type: object
      required:
        - status
        - success
        - message
        - data
      properties:
        status:
          type: integer
        success:
          type: boolean
        message:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/Shipment'
    Shipment:
      type: object
      required:
        - _id
        - order
        - carrier
        - status
      properties:
        _id:
          type: string
          description: Shipment identifier.
        order:
          type: string
          description: Order identifier.
        trackingNumber:
          type: string
          description: Tracking number for the shipment.
        carrier:
          type: string
          description: Carrier name.
        status:
          type: string
          description: Shipment status (e.g., in_transit, delivered).
        shippingAddress:
          nullable: true
          deprecated: true
          description: >-
            Legacy embedded address; absent on current orders — use the
            shipment's shippingAddress instead.
          allOf:
            - $ref: '#/components/schemas/OrderAddress'
        estimatedDelivery:
          type: string
          format: date-time
          description: Estimated delivery date.
        shippedAt:
          type: string
          format: date-time
          description: Date when shipment was dispatched.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    OrderAddress:
      type: object
      properties:
        fullName:
          type: string
        addressLine1:
          type: string
        addressLine2:
          type: string
        city:
          type: string
        state:
          type: string
        zipCode:
          type: string
        country:
          type: string
        phoneNumber:
          type: string
      nullable: true
      deprecated: true
      description: >-
        Legacy embedded order address — not populated on current orders (no live
        order carries it). The delivery address lives on the order's shipment:
        see the shipment's shippingAddress, or GET /shipping/shipments.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT issued by the Salesive Store API for authenticated shoppers.
    ShopIdHeader:
      type: apiKey
      in: header
      name: x-shop-id
      description: >-
        Optional storefront identifier sent as a header to scope responses to a
        specific shop. Try It requests remember this value once provided.

````