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

# Retrieve order shipments

> Lists an order's shipments. Staff can retrieve orders across all store locations.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}/shipments
openapi: 3.2.0
info:
  title: CE POS APIs
  description: >-
    The consolidated Point of Sale surface. Every operation is served under the
    storefront base URL; the POS backend proxies some of them to the admin
    service.
  version: '1.0'
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/storefront
    description: Staging Server
    variables:
      store_id:
        description: Store ID
        default: store_id
    x-speakeasy-server-id: staging
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/storefront
    description: Prod Server
    variables:
      store_id:
        description: Store ID
        default: store_id
    x-speakeasy-server-id: prod
security:
  - Authorization: []
tags:
  - name: section-identity
    summary: Identity
    kind: nav
  - name: Devices
    description: >-
      Set up the till: pair a device with the store using its pairing code, list
      the store's `PosLocation`s and `PosDevice`s, and claim a device for the
      signed-in user or release it.
    summary: Devices
    kind: nav
    parent: section-identity
  - name: Authentication
    description: >-
      Sign a staff member in on a paired device with a one-time password over
      SMS, WhatsApp or email, then refresh the access token or log out.
    summary: Authentication
    kind: nav
    parent: section-identity
  - name: Users
    description: >-
      The staff member signed in on the till, as a `PosUser` with their
      location, device and roles.
    summary: Users
    kind: nav
    parent: section-identity
  - name: section-customers
    summary: Customers
    kind: nav
  - name: Customers
    description: >-
      Look up the shopper at the till: list customers (`CustomerListItem`) and
      read one's full `CustomerDetail`.
    summary: Customers
    kind: nav
    parent: section-customers
  - name: Addresses
    description: >-
      A customer's saved addresses, as `Address` objects: list, add, update and
      remove them.
    summary: Addresses
    kind: nav
    parent: section-customers
  - name: section-catalog
    summary: Catalog
    kind: nav
  - name: Products
    description: >-
      Browse and search the catalog at the till: list `Product`s and SKUs, read
      a product and its variants, and show similar, up-sell and cross-sell
      items.
    summary: Products
    kind: nav
    parent: section-catalog
  - name: Reviews
    description: Read product reviews at the till.
    summary: Reviews
    kind: nav
    parent: section-catalog
  - name: Categories
    description: >-
      The store's categories, as `ProductCategory` objects with their child
      categories.
    summary: Categories
    kind: nav
    parent: section-catalog
  - name: Inventory
    description: >-
      Stock at the store's locations: list it by item, read an item's
      `InventoryDetail`, and follow the `InventoryActivity` that moved it.
    summary: Inventory
    kind: nav
    parent: section-catalog
  - name: section-shopping
    summary: Shopping
    kind: nav
  - name: Carts
    description: >-
      The till's `Cart`: create it, add, update or remove items, link the
      customer, set the address, and apply loyalty points or credit balance.
      Each update returns the full, updated `Cart`.
    summary: Carts
    kind: nav
    parent: section-shopping
  - name: Coupons & promotions
    description: >-
      The coupons and promotions a cart can use: list what the store offers, see
      which apply to a cart and why the rest don't, and apply or remove a
      coupon.
    summary: Coupons & promotions
    kind: nav
    parent: section-shopping
  - name: Fulfillment
    description: >-
      List the delivery and collect-in-store options for a cart, and save the
      cart's choice.
    summary: Fulfillment
    kind: nav
    parent: section-shopping
  - name: section-orders
    summary: Orders
    kind: nav
  - name: Orders
    description: >-
      Place an order from the till's cart and follow it: list orders, read an
      `OrderDetail` and its activity, check stock before it ships, and get its
      invoice, receipt and shipments.
    summary: Orders
    kind: nav
    parent: section-orders
  - name: Order payments
    description: >-
      Collect payment for an order: add payments toward what is left to pay,
      across one or more methods, poll the payment status, and retry a failed or
      expired payment.
    summary: Order payments
    kind: nav
    parent: section-orders
  - name: Shipments
    description: >-
      The shipments that fulfill orders: list them, read a `ShipmentDetail` with
      its activity and invoice, approve, reject or update one, send a
      replacement, and refund a shortfall.
    summary: Shipments
    kind: nav
    parent: section-orders
  - name: section-payments
    summary: Payments
    kind: nav
  - name: Payments
    description: >-
      The payment methods the till accepts and the checks around paying with
      them: card BIN details, VPA verification, and authenticating a payment
      with a direct OTP.
    summary: Payments
    kind: nav
    parent: section-payments
  - name: section-store
    summary: Store
    kind: nav
  - name: Locations
    description: States and pincodes for address forms.
    summary: Locations
    kind: nav
    parent: section-store
paths:
  /pos/orders/{order_number}/shipments:
    get:
      tags:
        - Orders
      summary: Retrieve order shipments
      description: >-
        Lists an order's shipments. Staff can retrieve orders across all store
        locations.
      operationId: pos-list-order-shipments
      parameters:
        - name: order_number
          in: path
          description: order number
          required: true
          schema:
            type: string
            maxLength: 128
            minLength: 1
            pattern: ^[A-Za-z0-9_-]{1,128}$
        - name: refresh
          in: query
          description: >-
            Supply a nonempty value to refresh tracking before retrieving
            shipments. Any nonempty value, including `false`, requests a
            refresh.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - success
                  - content
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                  content:
                    properties:
                      shipment:
                        $ref: '#/components/schemas/OrderShipmentDetail'
                    required:
                      - shipment
                    type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/AdminUnauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/AdminNotFound'
        '500':
          $ref: '#/components/responses/AdminInternalServerError'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      security:
        - Authorization: []
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/operations/pos-list-order-shipments
components:
  schemas:
    OrderShipmentDetail:
      title: OrderShipmentDetail
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/OrderShipmentDetail
      required:
        - order_number
        - order_date
        - order_status
        - sales_channel
        - payment_status
        - customer_name
        - shipments
        - allowed_actions
        - customer_id
        - sales_channel_type
        - sub_total
        - shipping_amount
        - total_tax
        - coupon_code
        - coupon_discount_percent
        - coupon_discount_amount
        - grand_total
      properties:
        order_number:
          type: string
        order_date:
          type: string
          format: date-time
        order_status:
          $ref: '#/components/schemas/AdminOrderStatus'
        sales_channel:
          type: object
          properties:
            id:
              type:
                - string
                - 'null'
            name:
              type:
                - string
                - 'null'
            type:
              type:
                - string
                - 'null'
          required:
            - id
            - name
            - type
        payment_status:
          $ref: '#/components/schemas/PaymentStatus'
        customer_name:
          type: string
        customer_id:
          type: string
        sales_channel_type:
          description: Type of the sales channel, repeated flat alongside `sales_channel`.
          type: string
        sub_total:
          type: number
          format: double
        total_tax:
          type: number
          format: double
        shipping_amount:
          type: number
          format: double
        grand_total:
          type: number
          format: double
        coupon_code:
          type:
            - string
            - 'null'
        coupon_discount_amount:
          type: number
          format: double
        coupon_discount_percent:
          type:
            - number
            - 'null'
          format: double
        shipments:
          type: array
          items:
            $ref: '#/components/schemas/OrderShipmentSummary'
        allowed_actions:
          type: array
          items:
            $ref: '#/components/schemas/InventoryAction'
    AdminOrderStatus:
      title: OrderStatus
      type: string
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/AdminOrderStatus
      enum:
        - draft
        - awaiting_approval
        - confirmed
        - schedule_requested
        - partially_scheduled
        - awaiting_shipment
        - shipped
        - partially_shipped
        - undelivered
        - partially_undelivered
        - return_to_origin
        - partially_return_to_origin
        - complete
        - partially_delivered
        - cancelled
        - pending
        - payment_failed
        - sent_to_store
        - ready_to_collect
        - processing
        - lost
    PaymentStatus:
      title: PaymentStatus
      type: string
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/PaymentStatus
      enum:
        - pending
        - success
        - failed
        - partially_paid
        - refund_initiated
        - refunded
        - unsettled
        - settled
        - partially_settled
        - manual_review
        - debit_scheduled
        - collection_due
    OrderShipmentSummary:
      title: OrderShipmentSummary
      description: Shipment details returned with an order.
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/OrderShipmentSummary
      required:
        - order_number
        - order_status
        - shipment_number
        - warehouse_id
        - warehouse_name
        - status
        - total_weight
        - total_boxes
        - shipment_items_count
        - shipping_estimated_cost
        - shipping_discount_amount
        - shipping_amount
        - shipping_tax_rate
        - shipping_tax_amount
        - shipping_amount_including_tax
        - shipping_provider_id
        - shipping_provider_name
        - courier_company_id
        - courier_company_name
        - courier_company_image_url
        - awb_no
        - shipping_label_url
        - eta_delivery
        - estimated_delivery_date
        - promised_delivery_date
        - shipped_date
        - delivered_date
        - returned_date
        - fulfillment_type
        - slo
        - cancellation_reason
        - customer_id
        - customer_name
        - shipping_address_line1
        - shipping_address_line2
        - shipping_landmark
        - shipping_pincode
        - shipping_city
        - shipping_state
        - created_at
        - modified_at
      properties:
        order_number:
          type: string
        order_status:
          $ref: '#/components/schemas/AdminOrderStatus'
        shipment_number:
          type: string
        warehouse_id:
          type:
            - string
            - 'null'
        warehouse_name:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/AdminShipmentStatus'
        total_weight:
          type: number
        total_boxes:
          type:
            - integer
            - 'null'
        shipment_items_count:
          type: integer
        shipping_estimated_cost:
          type: number
          format: double
        shipping_discount_amount:
          type: number
          format: double
        shipping_amount:
          type:
            - number
            - 'null'
          format: double
        shipping_tax_rate:
          type:
            - number
            - 'null'
          format: double
        shipping_tax_amount:
          type:
            - number
            - 'null'
          format: double
        shipping_amount_including_tax:
          type:
            - number
            - 'null'
          format: double
        shipping_provider_id:
          type:
            - string
            - 'null'
        shipping_provider_name:
          type:
            - string
            - 'null'
        courier_company_id:
          type:
            - string
            - 'null'
        courier_company_name:
          type:
            - string
            - 'null'
        courier_company_image_url:
          type:
            - string
            - 'null'
        awb_no:
          type:
            - string
            - 'null'
        shipping_label_url:
          type:
            - string
            - 'null'
        eta_delivery:
          type:
            - string
            - 'null'
        estimated_delivery_date:
          type:
            - string
            - 'null'
        promised_delivery_date:
          type:
            - string
            - 'null'
        out_for_delivery_date:
          type:
            - string
            - 'null'
        shipped_date:
          type:
            - string
            - 'null'
        delivered_date:
          type:
            - string
            - 'null'
        returned_date:
          type:
            - string
            - 'null'
        fulfillment_type:
          enum:
            - delivery
            - collect-in-store
        slo:
          type:
            - object
            - 'null'
          properties:
            expected_date:
              type: string
              format: date-time
            actual_date:
              type: string
              format: date-time
            difference:
              type: number
            slo_status:
              enum:
                - on-time
                - delay
                - early
        cancellation_reason:
          type:
            - string
            - 'null'
        customer_id:
          type: string
        customer_name:
          type:
            - string
            - 'null'
        shipping_address_line1:
          type:
            - string
            - 'null'
        shipping_address_line2:
          type:
            - string
            - 'null'
        shipping_landmark:
          type:
            - string
            - 'null'
        shipping_pincode:
          type:
            - string
            - 'null'
        shipping_city:
          type:
            - string
            - 'null'
        shipping_state:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        modified_at:
          type: string
          format: date-time
        shipment_items:
          type: array
          items:
            $ref: '#/components/schemas/OrderShipmentLine'
      allOf:
        - $ref: '#/components/schemas/ShipmentPackingAndProgression'
      x-tags:
        - Orders
    InventoryAction:
      title: InventoryAction
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/InventoryAction
      enum:
        - create-shipment
        - download-invoice
        - download-shipping-label
        - inventory-check
        - return-replace
        - update-manual
        - update-shipment
        - cancel-shipment
        - cancel-and-refund-shipment
        - replace-shipment
        - approve-shipment
        - reject-shipment
        - refund-shortfall
        - wait-for-inventory
        - reject-order
    AdminShipmentStatus:
      description: >-
        `refund_shortfall`: items the store could not fulfil and refunded
        instead, split off the order's unscheduled shipment.
      type: string
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/AdminShipmentStatus
      enum:
        - unscheduled
        - schedule_requested
        - scheduled
        - packed
        - shipped
        - in_transit
        - out_for_delivery
        - delivery_attempted
        - undelivered
        - return_to_origin
        - delivered
        - cancelled
        - ready_to_collect
        - sent_to_store
        - processing
        - lost
        - store_rejected
        - refund_shortfall
    OrderShipmentLine:
      title: OrderShipmentLine
      description: A line included in an order shipment.
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/OrderShipmentLine
      required:
        - product_id
        - variant_id
        - quantity
      properties:
        product_id:
          type: string
        product_name:
          type: string
          readOnly: true
        variant_id:
          description: '`null` for products without variants.'
          type:
            - string
            - 'null'
        variant_name:
          type:
            - string
            - 'null'
          readOnly: true
        product_image_url:
          type:
            - string
            - 'null'
          readOnly: true
        sku:
          type: string
          readOnly: true
        quantity:
          type: integer
        is_free_item:
          type: boolean
        free_quantity:
          type: integer
        selling_price:
          type: number
          format: double
      x-tags:
        - Orders
    ShipmentPackingAndProgression:
      title: ShipmentPackingAndProgression
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/ShipmentPackingAndProgression
      properties:
        packing:
          description: Per-box packing summary. Empty until packing is assigned.
          type: array
          items:
            $ref: '#/components/schemas/ShipmentBox'
        progression:
          type: array
          items:
            $ref: '#/components/schemas/ShipmentProgression'
      x-tags:
        - Shipping
    ShipmentBox:
      title: ShipmentBox
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/ShipmentBox
      required:
        - box_name
        - box_length
        - box_width
        - box_height
        - box_weight
        - items_count
        - box_count
      properties:
        box_id:
          type:
            - string
            - 'null'
        max_weight:
          type:
            - number
            - 'null'
          exclusiveMaximum: 100000000
          exclusiveMinimum: -100000000
        used_space:
          type:
            - number
            - 'null'
          exclusiveMaximum: 100000000
          exclusiveMinimum: -100000000
        box_name:
          type: string
          minLength: 1
        box_length:
          type: number
          exclusiveMaximum: 100000000
          exclusiveMinimum: -100000000
        box_width:
          type: number
          exclusiveMaximum: 100000000
          exclusiveMinimum: -100000000
        box_height:
          type: number
          exclusiveMaximum: 100000000
          exclusiveMinimum: -100000000
        box_weight:
          type: number
          exclusiveMaximum: 100000000
          exclusiveMinimum: -100000000
        items_count:
          type:
            - integer
            - 'null'
        box_count:
          type:
            - integer
            - 'null'
      x-tags:
        - Shipping
    ShipmentProgression:
      title: ShipmentProgression
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/ShipmentProgression
      properties:
        status:
          $ref: '#/components/schemas/ShipmentProgressionStatus'
        is_current:
          type: boolean
          readOnly: true
        is_completed:
          type: boolean
          readOnly: true
        completion_date:
          type:
            - string
            - 'null'
          format: date-time
      x-tags:
        - Shipping
    ShipmentProgressionStatus:
      title: ShipmentProgressionStatus
      description: >-
        Milestone on a shipment's fixed four-step progression ladder. Display
        labels, not `ShipmentStatus` values: every shipment carries all four in
        this order, and `is_completed` / `is_current` say where it has reached.
      type: string
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/schemas/ShipmentProgressionStatus
      enum:
        - Created
        - Packed
        - Shipped
        - Delivered
      x-tags:
        - Shipping
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
              - code
            properties:
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              code:
                type: string
              errors:
                type: object
              details:
                type: string
    AdminUnauthorized:
      description: >-
        The token is missing, invalid or expired, or does not grant access to
        this store and operation.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              details:
                type: string
    Forbidden:
      description: >-
        Access denied. `token-required` requires an authenticated session;
        `permission-denied` means the caller cannot access this resource. On
        POS, `session-expired` requires signing in again.
      content:
        application/json:
          schema:
            type: object
            required:
              - code
              - message
              - success
            properties:
              code:
                type: string
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              details:
                type: string
    AdminNotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              details:
                type: string
    AdminInternalServerError:
      description: >-
        The request could not be completed. Quote error_id, when present, when
        contacting support.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              details:
                type: string
              error_id:
                type: string
    GatewayTimeout:
      description: The request timed out.
      content:
        application/json:
          schema:
            type: object
            required:
              - code
              - message
              - success
            properties:
              code:
                type: string
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              details:
                type: string
  securitySchemes:
    Authorization:
      type: http
      description: Access token
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.