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

> Lists shipments matching the supplied filters. Staff can retrieve shipments across all store locations.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-pos.json get /pos/shipping/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/shipping/shipments:
    get:
      tags:
        - Shipments
      summary: List all shipments
      description: >-
        Lists shipments matching the supplied filters. Staff can retrieve
        shipments across all store locations.
      operationId: pos-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/AdminPagination'
                    required:
                      - shipments
                      - pagination
                    type: object
        '400':
          $ref: '#/components/responses/AdminBadRequest'
        '401':
          $ref: '#/components/responses/AdminUnauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/AdminInternalServerError'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      security:
        - Authorization: []
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/admin-pos/operations/pos-list-shipments
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: 100
        minimum: 1
      description: >-
        Results per page. Values outside 1–100 are clamped to that range.
        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
      description: search keyword
      required: false
      schema:
        type: string
  schemas:
    ShipmentList:
      title: ShipmentList
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/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
    AdminPagination:
      title: Pagination
      description: pagination metadata structure
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/AdminPagination
      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
      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
    ShipmentInfo:
      title: ShipmentInfo
      type: object
      externalDocs:
        url: https://llm-docs.commercengine.io/admin-pos/schemas/ShipmentInfo
      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/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'
        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
    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
    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
  responses:
    AdminBadRequest:
      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
    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
    NotFound:
      description: Requested resource not found
      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
              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.