> ## 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.

# List shipments for the store

> List shipments for the store. Requires the READ_SHIPPING scope.

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.


## 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:
          $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
      required:
        - fullName
        - addressLine1
        - city
        - state
        - zipCode
        - country
        - phoneNumber
      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
  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.

````