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

# List all shipments



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json get /shipping/shipments
openapi: 3.2.0
info:
  title: CE Admin APIs
  version: '1.0'
  summary: Comprehensive admin interface for managing your e-commerce platform
  description: >-
    Complete administrative API suite for Commerce Engine, providing powerful
    tools to manage products, orders, customers, inventory, analytics, and
    system configuration. Designed for administrators and backend integrations
    requiring full platform control.
  license:
    name: All Rights Reserved
    url: https://www.commercengine.io/contact-us
  contact:
    email: support@commercengine.io
    url: https://www.commercengine.io/contact-us
    name: Support
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/admin
    description: Staging Server
    variables:
      store_id:
        default: store_id
        description: Store ID
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/admin
    description: Prod Server
    variables:
      store_id:
        default: store_id
        description: Store ID
security:
  - Authorization: []
tags:
  - name: section-catalog
    summary: Catalog
    kind: nav
  - name: Products
    description: >-
      Create and update products; manage their channels and category
      assignments, and list SKUs.
    summary: Products
    kind: nav
    parent: section-catalog
  - name: Variants
    description: Create, read and update product variants individually or in bulk.
    summary: Variants
    kind: nav
    parent: section-catalog
  - name: Categories
    description: Manage catalog categories and the attributes assigned to them.
    summary: Categories
    kind: nav
    parent: section-catalog
  - name: Product attributes
    description: Define product attributes and the attribute sets that organize them.
    summary: Product attributes
    kind: nav
    parent: section-catalog
  - name: Inventory
    description: >-
      Read stock and inventory activity, update inventory, and record stock-in
      and stock-out movements.
    summary: Inventory
    kind: nav
    parent: section-catalog
  - name: Reviews
    description: Read, moderate and remove product reviews.
    summary: Reviews
    kind: nav
    parent: section-catalog
  - name: Media
    description: >-
      Request file uploads, manage uploaded files, and organize them into
      folders.
    summary: Media
    kind: nav
    parent: section-catalog
  - name: Catalog jobs
    description: Create catalog processing jobs and follow their status.
    summary: Catalog jobs
    kind: nav
    parent: section-catalog
  - name: section-customers
    summary: Customers
    kind: nav
  - name: Customers
    description: >-
      Create and update customers, view their details and activity, and manage
      profile images.
    summary: Customers
    kind: nav
    parent: section-customers
  - name: Users
    description: List the users attached to a customer and activate or deactivate them.
    summary: Users
    kind: nav
    parent: section-customers
  - name: Customer attributes
    description: Define customer attributes and manage the values assigned to customers.
    summary: Customer attributes
    kind: nav
    parent: section-customers
  - name: Customer groups
    description: Configure the customer groups available in the store.
    summary: Customer groups
    kind: nav
    parent: section-customers
  - name: Addresses
    description: Read and manage a customer’s saved addresses.
    summary: Addresses
    kind: nav
    parent: section-customers
  - name: Bank accounts
    description: Read and manage a customer’s bank accounts.
    summary: Bank accounts
    kind: nav
    parent: section-customers
  - name: KYC documents
    description: Configure the store’s KYC requirements and manage customer documents.
    summary: KYC documents
    kind: nav
    parent: section-customers
  - name: Visitors
    description: >-
      Read anonymous visitor profiles, their activity and their attribute
      values.
    summary: Visitors
    kind: nav
    parent: section-customers
  - name: Loyalty
    description: >-
      Configure loyalty programs, manage membership tiers, and inspect or record
      point activity.
    summary: Loyalty
    kind: nav
    parent: section-customers
  - name: Credit
    description: Set credit-line eligibility and read customer credit balances.
    summary: Credit
    kind: nav
    parent: section-customers
  - name: Mandates
    description: >-
      Inspect customer payment mandates and debit schedules, and pause, resume
      or revoke a mandate.
    summary: Mandates
    kind: nav
    parent: section-customers
  - name: Segments
    description: >-
      Manage customer segments, their members and associated advertising
      audiences.
    summary: Segments
    kind: nav
    parent: section-customers
  - name: section-shopping
    summary: Shopping
    kind: nav
  - name: Carts
    description: List abandoned carts for follow-up.
    summary: Carts
    kind: nav
    parent: section-shopping
  - name: Coupons & promotions
    description: Manage coupons, coupon codes and promotions, and inspect their usage.
    summary: Coupons & promotions
    kind: nav
    parent: section-shopping
  - name: section-orders
    summary: Orders
    kind: nav
  - name: Orders
    description: >-
      Read and update orders, accept or cancel them, check stock, and follow
      order activity.
    summary: Orders
    kind: nav
    parent: section-orders
  - name: Invoices
    description: List order invoices and retrieve an order’s invoice or receipt.
    summary: Invoices
    kind: nav
    parent: section-orders
  - name: Returns
    description: Read customer return requests and approve or reject them.
    summary: Returns
    kind: nav
    parent: section-orders
  - name: Shipments
    description: >-
      Create and manage shipments, follow delivery activity, and handle
      replacements and shortfalls.
    summary: Shipments
    kind: nav
    parent: section-orders
  - name: section-payments
    summary: Payments
    kind: nav
  - name: Order payments
    description: >-
      Create and inspect payment requests, verify order payments, and cancel or
      mark a payment paid.
    summary: Order payments
    kind: nav
    parent: section-payments
  - name: Refunds
    description: Estimate and issue refunds, or mark an order refund paid or forfeited.
    summary: Refunds
    kind: nav
    parent: section-payments
  - name: Payment exceptions
    description: Inspect payment exceptions and resolve them.
    summary: Payment exceptions
    kind: nav
    parent: section-payments
  - name: Payment methods
    description: Configure manual payment methods and list available payment options.
    summary: Payment methods
    kind: nav
    parent: section-payments
  - name: Seller payouts
    description: >-
      Configure seller payouts and manage invoices, adjustments, charges and
      payout batches.
    summary: Seller payouts
    kind: nav
    parent: section-payments
  - name: section-marketplace
    summary: Marketplace
    kind: nav
  - name: Marketplace catalog
    description: Inspect and publish marketplace products, variants, reviews and inventory.
    summary: Marketplace catalog
    kind: nav
    parent: section-marketplace
  - name: Marketplace listings
    description: List, synchronize and remove the store’s product listings on marketplaces.
    summary: Marketplace listings
    kind: nav
    parent: section-marketplace
  - name: Marketplace settings
    description: >-
      Read marketplace configuration and configure category schemas and
      attributes.
    summary: Marketplace settings
    kind: nav
    parent: section-marketplace
  - name: Sellers
    description: Manage the sellers a customer is authorized to buy from.
    summary: Sellers
    kind: nav
    parent: section-marketplace
  - name: section-fulfillment
    summary: Fulfillment
    kind: nav
  - name: Shipping methods
    description: Configure shipping methods and costs, and check courier serviceability.
    summary: Shipping methods
    kind: nav
    parent: section-fulfillment
  - name: Shipping boxes
    description: Manage shipping boxes and read the boxes available for a product.
    summary: Shipping boxes
    kind: nav
    parent: section-fulfillment
  - name: Shipping zones
    description: Create, read and maintain shipping zones.
    summary: Shipping zones
    kind: nav
    parent: section-fulfillment
  - name: Warehouses
    description: Create, read and maintain the store’s warehouses.
    summary: Warehouses
    kind: nav
    parent: section-fulfillment
  - name: section-point-of-sale
    summary: Point of sale
    kind: nav
  - name: Devices
    description: Manage POS devices, generate pairing codes and revoke devices.
    summary: Devices
    kind: nav
    parent: section-point-of-sale
  - name: POS users
    description: Manage staff accounts used at the point of sale.
    summary: Staff
    kind: nav
    parent: section-point-of-sale
  - name: POS roles
    description: Manage POS roles and inspect available permissions.
    summary: Roles & permissions
    kind: nav
    parent: section-point-of-sale
  - name: section-store
    summary: Store
    kind: nav
  - name: Store
    description: Read and update the store configuration.
    summary: Store
    kind: nav
    parent: section-store
  - name: Locations
    description: List countries, states and pincodes.
    summary: Locations
    kind: nav
    parent: section-store
  - name: Notifications
    description: >-
      Manage notification templates and store or customer notification
      preferences.
    summary: Notifications
    kind: nav
    parent: section-store
  - name: Downloads
    description: Request data downloads and follow download jobs.
    summary: Downloads
    kind: nav
    parent: section-store
  - name: Search
    description: Search customers, orders and products across the store.
    summary: Search
    kind: nav
    parent: section-store
  - name: Filter options
    description: >-
      Retrieve the available filters for resource lists in the administration
      interface.
    summary: Filter options
    kind: nav
    parent: section-store
  - name: section-integrations
    summary: Integrations
    kind: nav
  - name: Catalog integrations
    description: Request catalog synchronization and inspect sync results and activity.
    summary: Catalog integrations
    kind: nav
    parent: section-integrations
  - name: Service providers
    description: Configure service providers and test their connections.
    summary: Service providers
    kind: nav
    parent: section-integrations
  - name: Webhooks
    description: >-
      Manage webhook subscriptions, rotate their secrets and send test
      deliveries.
    summary: Webhooks
    kind: nav
    parent: section-integrations
  - name: Webhook deliveries
    description: >-
      Inspect webhook delivery logs, retry deliveries and replay events to a
      subscription.
    summary: Webhook deliveries
    kind: nav
    parent: section-integrations
  - name: Events
    description: >-
      Browse recorded events and the event types available for webhook
      subscriptions.
    summary: Events
    kind: nav
    parent: section-integrations
  - name: Live updates
    description: Read the store’s live event stream and global state.
    summary: Live updates
    kind: nav
    parent: section-integrations
  - name: section-analytics
    summary: Analytics
    kind: nav
  - name: Analytics
    description: Query analytics data, read charts and inspect visitor sessions and events.
    summary: Analytics
    kind: nav
    parent: section-analytics
  - name: Metrics
    description: >-
      Read aggregate metrics for catalog, customers, orders, payments,
      fulfillment and webhooks.
    summary: Metrics
    kind: nav
    parent: section-analytics
paths:
  /shipping/shipments:
    get:
      tags:
        - Shipments
      summary: List all shipments
      operationId: list-shipments
      parameters:
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/columnBasedFilters'
        - $ref: '#/components/parameters/sortByOptions'
        - $ref: '#/components/parameters/searchKeyword'
        - name: awb_no
          in: query
          description: Filter by awb no.
          required: false
          schema:
            type: string
        - name: base_shipment_number
          in: query
          description: Filter by base shipment number.
          required: false
          schema:
            type: string
        - name: cancellation_reason
          in: query
          description: Filter by cancellation reason.
          required: false
          schema:
            type: string
        - name: cancelled_by
          in: query
          description: Filter by cancelled by.
          required: false
          schema:
            type: string
        - name: coupon_discount_amount
          in: query
          description: Filter by coupon discount amount.
          required: false
          schema:
            type: number
        - name: courier_aggregator_name
          in: query
          description: Filter by courier aggregator name.
          required: false
          schema:
            type: string
        - name: courier_aggregator_order_id
          in: query
          description: Filter by courier aggregator order id.
          required: false
          schema:
            type: string
        - name: courier_aggregator_reference_no
          in: query
          description: Filter by courier aggregator reference no.
          required: false
          schema:
            type: string
        - name: courier_company_id
          in: query
          description: Filter by courier company id.
          required: false
          schema:
            type: string
        - name: courier_company_name
          in: query
          description: Filter by courier company name.
          required: false
          schema:
            type: string
        - name: created_at
          in: query
          description: Filter by created at.
          required: false
          schema:
            type: string
        - name: davai_shipment_id
          in: query
          description: Filter by davai shipment id.
          required: false
          schema:
            type: number
        - name: delivered_date
          in: query
          description: Filter by delivered date.
          required: false
          schema:
            type: string
        - name: delivery_lead_time
          in: query
          description: Filter by delivery lead time.
          required: false
          schema:
            type: number
        - name: delivery_time_gap
          in: query
          description: Filter by delivery time gap.
          required: false
          schema:
            type: number
        - name: estimated_delivery_date
          in: query
          description: Filter by estimated delivery date.
          required: false
          schema:
            type: string
        - name: eta_delivery
          in: query
          description: Filter by eta delivery.
          required: false
          schema:
            type: string
        - name: fulfillment_type
          in: query
          description: Filter by fulfillment type.
          required: false
          schema:
            type: string
        - name: grand_total
          in: query
          description: Filter by grand total.
          required: false
          schema:
            type: number
        - name: invoice_url
          in: query
          description: Filter by invoice url.
          required: false
          schema:
            type: string
        - name: items_weight
          in: query
          description: Filter by items weight.
          required: false
          schema:
            type: number
        - name: last_tracking_time
          in: query
          description: Filter by last tracking time.
          required: false
          schema:
            type: string
        - name: loyalty_point_redeemed
          in: query
          description: Filter by loyalty point redeemed.
          required: false
          schema:
            type: number
        - name: manual_shipping_charges
          in: query
          description: Filter by manual shipping charges.
          required: false
          schema:
            type: number
        - name: marketplace_id
          in: query
          description: Filter by marketplace id.
          required: false
          schema:
            type: string
        - name: modified_at
          in: query
          description: Filter by modified at.
          required: false
          schema:
            type: string
        - name: order
          in: query
          description: Filter by order.
          required: false
          schema:
            type: integer
        - name: out_for_delivery_date
          in: query
          description: Filter by out for delivery date.
          required: false
          schema:
            type: string
        - name: packing_bin_weight
          in: query
          description: Filter by packing bin weight.
          required: false
          schema:
            type: number
        - name: packing_details_data
          in: query
          description: Filter by packing details data.
          required: false
          schema:
            type: string
        - name: packing_option
          in: query
          description: Filter by packing option.
          required: false
          schema:
            type: string
        - name: promised_delivery_date
          in: query
          description: Filter by promised delivery date.
          required: false
          schema:
            type: string
        - name: promotion_discount_amount
          in: query
          description: Filter by promotion discount amount.
          required: false
          schema:
            type: number
        - name: reference_number
          in: query
          description: Filter by reference number.
          required: false
          schema:
            type: string
        - name: replacement_shipment_number
          in: query
          description: Filter by replacement shipment number.
          required: false
          schema:
            type: string
        - name: return_window
          in: query
          description: Filter by return window.
          required: false
          schema:
            type: string
        - name: returned_date
          in: query
          description: Filter by returned date.
          required: false
          schema:
            type: string
        - name: revised_shipping_date
          in: query
          description: Filter by revised shipping date.
          required: false
          schema:
            type: string
        - name: seller_id
          in: query
          description: Filter by seller id.
          required: false
          schema:
            type: string
        - name: seller_reference_no
          in: query
          description: Filter by seller reference no.
          required: false
          schema:
            type: string
        - name: seller_response_data
          in: query
          description: Filter by seller response data.
          required: false
          schema:
            type: string
        - name: shipment_number
          in: query
          description: Filter by shipment number.
          required: false
          schema:
            type: string
        - name: shipped_date
          in: query
          description: Filter by shipped date.
          required: false
          schema:
            type: string
        - name: shipping_amount
          in: query
          description: Filter by shipping amount.
          required: false
          schema:
            type: number
        - name: shipping_amount_including_tax
          in: query
          description: Filter by shipping amount including tax.
          required: false
          schema:
            type: number
        - name: shipping_discount_amount
          in: query
          description: Filter by shipping discount amount.
          required: false
          schema:
            type: number
        - name: shipping_estimated_cost
          in: query
          description: Filter by shipping estimated cost.
          required: false
          schema:
            type: number
        - name: shipping_label_url
          in: query
          description: Filter by shipping label url.
          required: false
          schema:
            type: string
        - name: shipping_option
          in: query
          description: Filter by shipping option.
          required: false
          schema:
            type: string
        - name: shipping_provider_id
          in: query
          description: Filter by shipping provider id.
          required: false
          schema:
            type: string
        - name: shipping_tax_amount
          in: query
          description: Filter by shipping tax amount.
          required: false
          schema:
            type: number
        - name: shipping_tax_rate
          in: query
          description: Filter by shipping tax rate.
          required: false
          schema:
            type: number
        - name: shipping_tax_type
          in: query
          description: Filter by shipping tax type.
          required: false
          schema:
            type: string
        - name: slo_status
          in: query
          description: Filter by slo status.
          required: false
          schema:
            type: string
        - name: status
          in: query
          description: Filter by one or more shipment statuses, separated by commas.
          required: false
          schema:
            type: string
        - name: store_id
          in: query
          description: Filter by store id.
          required: false
          schema:
            type: string
        - name: sub_total
          in: query
          description: Filter by sub total.
          required: false
          schema:
            type: number
        - name: sub_total_including_tax
          in: query
          description: Filter by sub total including tax.
          required: false
          schema:
            type: number
        - name: total_boxes
          in: query
          description: Filter by total boxes.
          required: false
          schema:
            type: number
        - name: total_weight
          in: query
          description: Filter by total weight.
          required: false
          schema:
            type: number
        - name: track_status
          in: query
          description: Filter by track status.
          required: false
          schema:
            type: boolean
        - name: tracking_url
          in: query
          description: Filter by tracking url.
          required: false
          schema:
            type: string
        - name: warehouse_id
          in: query
          description: Filter by warehouse id.
          required: false
          schema:
            type: string
        - name: warehouse_name
          in: query
          description: Filter by warehouse name.
          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:
                      shipments:
                        type: array
                        items:
                          $ref: '#/components/schemas/ShipmentList'
                      pagination:
                        $ref: '#/components/schemas/Pagination'
                    required:
                      - shipments
                      - pagination
                    type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    pageNumber:
      name: page
      in: query
      required: false
      schema:
        type: integer
        default: 1
        minimum: 1
      description: >-
        Page number, starting at 1. Non-integer values and values below 1 return
        400.
    pageLimit:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        default: 25
        maximum: 500
        minimum: 1
      description: >-
        Results per page. Values below 1 use 1; values above 500 return 400.
        Non-integer input returns 400.
    columnBasedFilters:
      name: filters
      in: query
      required: false
      schema:
        type: string
        example: >-
          {"condition":"AND","filters":[{"type":"data","field":"status","operator":"equals","value":"success"}]}
      description: JSON object
    sortByOptions:
      name: sort_by
      in: query
      required: false
      schema:
        description: >-
          json string in format {'field_name':'asc', 'other_field_name':'desc',
          ...}
        type: string
      description: 'JSON string format: {"field1":"asc", "field2":"desc"}'
    searchKeyword:
      name: search
      in: query
      required: false
      schema:
        type: string
      description: search keyword
  schemas:
    ShipmentList:
      title: ShipmentList
      allOf:
        - type: object
          properties:
            order_number:
              type: string
            sales_channel:
              type: object
              properties:
                id:
                  type:
                    - string
                    - 'null'
                name:
                  type:
                    - string
                    - 'null'
                type:
                  type:
                    - string
                    - 'null'
            reference_number:
              type: string
            sub_total:
              type: number
              format: double
            sub_total_including_tax:
              type: number
              format: double
            grand_total:
              type: number
              format: double
            coupon_discount_amount:
              type: number
              format: double
            promotion_discount_amount:
              type: number
              format: double
            loyalty_point_redeemed:
              type: number
              format: double
            seller_id:
              type:
                - string
                - 'null'
            marketplace_listing:
              type: array
              items:
                type: object
                properties:
                  marketplace_id:
                    type: string
                required:
                  - marketplace_id
            packing:
              description: Per-box packing summary. Empty until packing is assigned.
              type: array
              items:
                $ref: '#/components/schemas/ShipmentBox'
          required:
            - order_number
            - sales_channel
            - reference_number
            - sub_total
            - sub_total_including_tax
            - grand_total
            - coupon_discount_amount
            - promotion_discount_amount
            - loyalty_point_redeemed
            - seller_id
            - marketplace_listing
            - packing
        - $ref: '#/components/schemas/ShipmentInfo'
      x-tags:
        - Shipping
    Pagination:
      title: Pagination
      description: pagination metadata structure
      type: object
      required:
        - total_records
        - total_pages
        - previous_page
        - limit
        - next_page
      properties:
        total_records:
          type: integer
        total_pages:
          type: integer
        previous_page:
          description: Previous page number
          type:
            - integer
            - 'null'
        limit:
          type: integer
          default: 25
        next_page:
          description: Next page number
          type:
            - integer
            - 'null'
    ShipmentBox:
      title: ShipmentBox
      type: object
      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
    ShipmentInfo:
      title: ShipmentInfo
      type: object
      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
        - order_date
        - out_for_delivery_date
        - billing_business_name
      properties:
        order_number:
          type: string
        order_status:
          $ref: '#/components/schemas/OrderStatus'
        shipment_number:
          type: string
        warehouse_id:
          type:
            - string
            - 'null'
        warehouse_name:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/ShipmentStatus'
        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'
        billing_business_name:
          description: >-
            Business name on the billing address. `null` for B2C orders placed
            without business details.
          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
        order_date:
          description: Placement timestamp of the parent order, when available.
          type:
            - string
            - 'null'
      x-tags:
        - Shipping
    OrderStatus:
      title: OrderStatus
      type: string
      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
    ShipmentStatus:
      description: >-
        `refund_shortfall`: items the store could not fulfil and refunded
        instead, split off the order's unscheduled shipment.
      type: string
      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
  responses:
    BadRequest:
      description: The request is invalid or cannot be completed in the current state.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              errors:
                description: Validation details as a field map, a bulk list or a string.
                anyOf:
                  - type: object
                    additionalProperties: true
                  - type: array
                  - type: string
              content:
                type: object
                additionalProperties: true
              details:
                type: string
    Unauthorized:
      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
    InternalServerError:
      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
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: >-
        Sign in to the admin dashboard and use the resulting ID token for a
        store and operation you can access. The authenticated dashboard cookie
        is accepted when the Authorization header is absent. Missing or
        insufficient access returns 401.

````

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