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

# Update shipment detail

> Updates shipment fields. An unscheduled shipment must be scheduled first. Setting `shipped` requires `shipped_date`; setting `delivered` requires `delivered_date` and a shipping date. Collect-in-store shipments become `ready_to_collect` from `processing` (after the shipment is approved) and can be delivered from `ready_to_collect`.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json put /shipping/shipments/{reference_number}/manual-update
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/{reference_number}/manual-update:
    parameters:
      - name: reference_number
        in: path
        description: Shipment reference number
        required: true
        schema:
          type: string
    put:
      tags:
        - Shipments
      summary: Update shipment detail
      description: >-
        Updates shipment fields. An unscheduled shipment must be scheduled
        first. Setting `shipped` requires `shipped_date`; setting `delivered`
        requires `delivered_date` and a shipping date. Collect-in-store
        shipments become `ready_to_collect` from `processing` (after the
        shipment is approved) and can be delivered from `ready_to_collect`.
      operationId: update-shipment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - unscheduled
                    - scheduled
                    - packed
                    - shipped
                    - delivered
                    - in_transit
                    - out_for_delivery
                    - undelivered
                    - return_to_origin
                    - ready_to_collect
                warehouse_id:
                  type: string
                awb_no:
                  type: string
                courier_company_name:
                  type: string
                shipping_label_url:
                  type:
                    - string
                    - 'null'
                tracking_url:
                  type:
                    - string
                    - 'null'
                manual_shipping_charges:
                  type:
                    - number
                    - 'null'
                eta_delivery:
                  type:
                    - string
                    - 'null'
                shipped_date:
                  type: string
                  format: date-time
                out_for_delivery_date:
                  type:
                    - string
                    - 'null'
                  format: date-time
                delivered_date:
                  type:
                    - string
                    - 'null'
                  format: date-time
                revised_shipping_date:
                  type:
                    - string
                    - 'null'
                  format: date-time
      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/ShipmentDetail'
                    required:
                      - shipment
                    type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
          description: Unsupported method. Use PUT.
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ShipmentDetail:
      title: ShipmentDetail
      type: object
      required:
        - order_number
        - order_date
        - order_status
        - sales_channel
        - payment_status
        - shipment_detail
        - allowed_actions
        - customer_id
        - customer_name
        - billing_business_name
        - sales_channel_type
      properties:
        order_number:
          type: string
        order_date:
          type:
            - string
            - 'null'
          format: date-time
        order_status:
          $ref: '#/components/schemas/OrderStatus'
        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
            - 'null'
        billing_business_name:
          description: >-
            Business name on the billing address. `null` for B2C orders placed
            without business details.
          type:
            - string
            - 'null'
        shipment_detail:
          $ref: '#/components/schemas/Shipment'
        allowed_actions:
          type: array
          items:
            $ref: '#/components/schemas/ShipmentAction'
        customer_id:
          type: string
        sales_channel_type:
          description: Type of the sales channel, repeated flat alongside `sales_channel`.
          type:
            - string
            - 'null'
        base_shipment:
          description: >-
            The base shipment this replacement was created for. Present
            (non-null) only when this shipment is a replacement shipment.
          oneOf:
            - $ref: '#/components/schemas/RelatedShipmentSummary'
            - type: 'null'
        replacement_shipment:
          description: >-
            The replacement shipment created for this shipment. Present
            (non-null) only when this shipment has a replacement.
          oneOf:
            - $ref: '#/components/schemas/RelatedShipmentSummary'
            - type: 'null'
    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
    PaymentStatus:
      title: PaymentStatus
      type: string
      enum:
        - pending
        - success
        - failed
        - partially_paid
        - refund_initiated
        - refunded
        - unsettled
        - settled
        - partially_settled
        - manual_review
        - debit_scheduled
        - collection_due
    Shipment:
      title: Shipment
      allOf:
        - $ref: '#/components/schemas/ShipmentInfo'
        - type: object
          properties:
            shipment_items:
              type: array
              items:
                $ref: '#/components/schemas/ShipmentLine'
        - $ref: '#/components/schemas/ShipmentAmounts'
        - $ref: '#/components/schemas/ShipmentPackingAndProgression'
    ShipmentAction:
      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
    RelatedShipmentSummary:
      title: RelatedShipmentSummary
      description: >-
        Summary of a related shipment (the base shipment of a replacement, or
        the replacement of a base). Included on a shipment detail only when the
        shipment is part of a replacement.
      type: object
      properties:
        reference_number:
          type: string
        status:
          type: string
        fulfillment_type:
          type: string
        warehouse_id:
          type:
            - string
            - 'null'
        warehouse_name:
          type:
            - string
            - 'null'
        items:
          type: array
          items:
            $ref: '#/components/schemas/ShipmentItem'
        created_at:
          type: string
          format: date-time
        modified_at:
          type: string
          format: date-time
    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
    ShipmentLine:
      title: ShipmentLine
      description: >-
        Line item on a shipment. Seller details are null when no seller
        information is associated with the item.
      type: object
      required:
        - product_id
        - variant_id
        - quantity
      properties:
        product_id:
          type: string
        product_name:
          type:
            - string
            - 'null'
          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
        seller_detail:
          description: >-
            Seller detail information. This field is relevant for marketplace
            type stores only. Will return null for b2b and b2c type stores.
          oneOf:
            - $ref: '#/components/schemas/SellerBasicDetail'
            - type: 'null'
      x-tags:
        - Shipping
    ShipmentAmounts:
      title: ShipmentAmounts
      description: Amounts and references returned for every shipment.
      type: object
      required:
        - reference_number
        - sub_total
        - sub_total_including_tax
        - grand_total
        - coupon_discount_amount
        - promotion_discount_amount
        - loyalty_point_redeemed
      properties:
        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
        sales_channel:
          type: object
          properties:
            id:
              type:
                - string
                - 'null'
            name:
              type:
                - string
                - 'null'
            type:
              type:
                - string
                - 'null'
          required:
            - id
            - name
            - type
      x-tags:
        - Shipping
    ShipmentPackingAndProgression:
      title: ShipmentPackingAndProgression
      type: object
      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
    ShipmentItem:
      title: ShipmentItem
      description: Shipment item model
      type: object
      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
        seller_detail:
          description: >-
            Seller detail information. This field is relevant for marketplace
            type stores only. Will return null for b2b and b2c type stores.
          oneOf:
            - $ref: '#/components/schemas/SellerBasicDetail'
            - type: 'null'
    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
    SellerBasicDetail:
      title: SellerBasicDetail
      type: object
      properties:
        id:
          type: string
        trade_name:
          type: string
        legal_name:
          type: string
        business_type:
          $ref: '#/components/schemas/SellerBusinessType'
        tax_identification_number:
          type: string
    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
    ShipmentProgression:
      title: ShipmentProgression
      type: object
      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
    SellerBusinessType:
      title: SellerBusinessType
      type: string
      enum:
        - sole_proprietorship
        - private_limited
        - public_listed
        - public_limited
        - state_owned
        - charity
        - individual
    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
      enum:
        - Created
        - Packed
        - Shipped
        - Delivered
      x-tags:
        - Shipping
  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
    NotFound:
      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
    MethodNotAllowed:
      description: Unsupported method.
      headers:
        Allow:
          schema:
            type: string
          description: Supported HTTP methods.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - code
              - success
            properties:
              message:
                type: string
              code:
                type: string
                const: method-not-allowed
              success:
                type: boolean
                const: false
              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.