openapi: 3.1.0
info:
  title: 'Admin Management: Orders'
  version: 1.0.0
paths:
  /stores/{store_hash}/v2/orders/{order_id}:
    get:
      operationId: getOrder
      summary: Get Order
      description: >-
        Gets an *Order*. To learn more about creating or updating orders, see [Orders
        Overview](/developer/docs/admin/checkout-and-cart/orders).
      tags:
        - orders
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: include
          in: query
          description: >-
            * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments`
            endpoint. Current default array structure is legacy and will be deprecated from **1 Feb 2026**. Specify
            `consignment_structure=object` as a request parameter when including consignments.

            * `consignments.line_items` - include the response returned from the request to the
            `/orders/{order_id}/products` endpoint in consignments. This will also includes the resources associated
            with `include=consignments`. Current default array structure is legacy and will be deprecated from **1 Feb
            2026**. Specify `consignment_structure=object` as a request parameter when including consignments.

            * `fees` - include the response returned from the request to the `/orders/{order_id}/fees` endpoint.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/OrdersOrderIdGetParametersIncludeSchemaItems'
        - name: consignment_structure
          in: query
          description: >-
            Should be specified along with `include=consignments` or `include=consignments.line_items` to return
            consignments in the supported object structure. The default array structure provided is legacy and may not
            be supported in the future.
          required: false
          schema:
            $ref: '#/components/schemas/OrdersOrderIdGetParametersConsignmentStructure'
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: Order Response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_Resp'
        '404':
          description: The requested resource was not found.
          content:
            application/json:
              schema:
                description: Any type
    put:
      operationId: updateOrder
      summary: Update Order
      description: >-
        Updates an *Order*. 


        To add a product to an existing order, don't include `id` in the body. Include `product_options` if adding a
        product with variants.


        To update a product in an order, include `id` in the body. The body should only contain the fields that need to
        be updated. Those fields that are omitted will not be changed.


        To remove a product from an order, set that product’s `quantity` to `0`.


        After the update, the PUT request clears all discounts and promotions applied to the changed order line items.
        Since the order data syncs with other ERP systems, like Amazon or eBay, the updated order returns to the default
        setting, removing any applied discounts.


        To update order fees, include the fee id in the request body along with all relevant fee fields. Fees not
        included will be deleted. Fees with an id will be updated, and fees without an id will be created as new.


        **Notes**


        * Sub-resources like products in the /v2/orders PUT request behave like PATCH, updating only the provided
        fields. Fees, however, follow standard PUT semantics and fees in the request body will fully replace existing
        ones. 

        To retain an existing fee, include it in the body with its associated id. 

        * The values for cost_ex_tax, cost_inc_tax and cost_tax in the fees payload should reflect the tax rate
        associated with the tax_class_id. For a 10% tax rate, the difference between cost_inc_tax and cost_ex_tax should
        be 10%. If no tax_class_id is provided, the store's default "tax class for fee" will apply. Incorrect data may
        lead to issues in downstream operations like refunds.


        To learn more about creating or updating orders, see [Orders
        Overview](/developer/docs/admin/checkout-and-cart/orders).


        > #### Note

        > * If historical orders processed on another eCommerce platform are being migrated to BigCommerce, supply the
        `external_source` field with the code **M-MIG**. This code will exclude the historical orders from the store’s
        GMV/order count, which factors into pricing.
      tags:
        - orders
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: Order Response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_Resp'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/order_Put'
    delete:
      operationId: deleteOrder
      summary: Archive Order
      description: Archives an order. To remove a single product from an order, see `PUT /orders/{order_id}`.
      tags:
        - orders
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
  /stores/{store_hash}/v2/orders/count:
    get:
      operationId: getOrdersCount
      summary: Get Count of Orders
      description: Gets an array of orders in the store organized by order status.
      tags:
        - orders
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: min_id
          in: query
          description: The minimum order ID.
          required: false
          schema:
            type: integer
        - name: max_id
          in: query
          description: The maximum order ID.
          required: false
          schema:
            type: integer
        - name: min_total
          in: query
          description: The minimum order total in floating point format. eg. 12.50
          required: false
          schema:
            type: string
            title: float
        - name: max_total
          in: query
          description: The maximum order total in floating point format. eg. 12.50
          required: false
          schema:
            type: number
            format: double
        - name: customer_id
          in: query
          description: Customer ID.
          required: false
          schema:
            type: integer
        - name: email
          in: query
          description: The email of the customer.
          required: false
          schema:
            type: string
        - name: status_id
          in: query
          description: The status ID of the order. You can get the status id from the `/orders` endpoints.
          required: false
          schema:
            type: integer
        - name: cart_id
          in: query
          description: The cart ID of the order.
          required: false
          schema:
            type: string
        - name: payment_method
          in: query
          description: >-
            The display name of the payment method used on the order. For example, `Manual`, `Credit Card`, `cash`,
            `Test Payment Gateway`, etc.'
          required: false
          schema:
            type: string
        - name: min_date_created
          in: query
          description: |-
            Minimum date the order was created in RFC-2822 or ISO-8601.

            RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400`

            ISO-8601: `2017-04-20T11:32:00.000-04:00`
          required: false
          schema:
            type: string
        - name: max_date_created
          in: query
          description: |-
            Maximum date the order was created in RFC-2822 or ISO-8601.

            RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400`

            ISO-8601: `2017-04-20T11:32:00.000-04:00`
          required: false
          schema:
            type: string
        - name: min_date_modified
          in: query
          description: |-
            Minimum date the order was modified in RFC-2822 or ISO-8601.

            RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400`

            ISO-8601: `2017-04-20T11:32:00.000-04:00`
          required: false
          schema:
            type: string
        - name: max_date_modified
          in: query
          description: |-
            Maximum date the order was modified in RFC-2822 or ISO-8601.

            RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400`

            ISO-8601: `2017-04-20T11:32:00.000-04:00`
          required: false
          schema:
            type: string
        - name: channel_id
          in: query
          description: The channel ID of the sales channel the shopper used to place the order.
          required: false
          schema:
            type: integer
        - name: external_order_id
          in: query
          description: >-
            The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it,
            you can update this field using a POST or PUT request.
          required: false
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: Order Counter response collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ordersCount_Full'
  /stores/{store_hash}/v2/orders:
    get:
      operationId: getOrders
      summary: List Orders
      description: |-
        Gets a list of orders using the filter query.

        **Notes**

        * The default sort is by order id, from lowest to highest.
        * By default, requests sent without parameters will only return 50 orders. 
      tags:
        - orders
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: min_id
          in: query
          description: The minimum order ID.
          required: false
          schema:
            type: integer
        - name: max_id
          in: query
          description: The maximum order ID.
          required: false
          schema:
            type: integer
        - name: min_total
          in: query
          description: The minimum order total in floating point format. eg. 12.50
          required: false
          schema:
            type: string
            title: float
        - name: max_total
          in: query
          description: The maximum order total in floating point format. eg. 12.50
          required: false
          schema:
            type: number
            format: double
        - name: customer_id
          in: query
          description: Customer ID.
          required: false
          schema:
            type: integer
        - name: email
          in: query
          description: The email of the customer.
          required: false
          schema:
            type: string
        - name: status_id
          in: query
          description: The status ID of the order. You can get the status id from the `/orders` endpoints.
          required: false
          schema:
            type: integer
        - name: cart_id
          in: query
          description: The cart ID of the order.
          required: false
          schema:
            type: string
        - name: payment_method
          in: query
          description: >-
            The display name of the payment method used on the order. For example, `Manual`, `Credit Card`, `cash`,
            `Test Payment Gateway`, etc.'
          required: false
          schema:
            type: string
        - name: min_date_created
          in: query
          description: |-
            Minimum date the order was created in RFC-2822 or ISO-8601.

            RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400`

            ISO-8601: `2017-04-20T11:32:00.000-04:00`
          required: false
          schema:
            type: string
        - name: max_date_created
          in: query
          description: |-
            Maximum date the order was created in RFC-2822 or ISO-8601.

            RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400`

            ISO-8601: `2017-04-20T11:32:00.000-04:00`
          required: false
          schema:
            type: string
        - name: min_date_modified
          in: query
          description: |-
            Minimum date the order was modified in RFC-2822 or ISO-8601.

            RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400`

            ISO-8601: `2017-04-20T11:32:00.000-04:00`
          required: false
          schema:
            type: string
        - name: max_date_modified
          in: query
          description: |-
            Maximum date the order was modified in RFC-2822 or ISO-8601.

            RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400`

            ISO-8601: `2017-04-20T11:32:00.000-04:00`
          required: false
          schema:
            type: string
        - name: page
          in: query
          description: The page to return in the response.
          required: false
          schema:
            type: number
            format: double
            default: 1
        - name: limit
          in: query
          description: Number of results to return.
          required: false
          schema:
            type: number
            format: double
            default: 50
        - name: sort
          in: query
          description: >-
            Field and direction to sort orders. To specify the direction, add `:asc` or `:desc` to the end of the query
            parameter. e.g., `sort=date_created:desc`.
          required: false
          schema:
            $ref: '#/components/schemas/OrdersGetParametersSort'
        - name: channel_id
          in: query
          description: The channel ID of the sales channel the shopper used to place the order.
          required: false
          schema:
            type: integer
        - name: include
          in: query
          description: >-
            * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments`
            endpoint. Current default array structure is legacy and will be deprecated from **1 Feb 2026**. Specify
            `consignment_structure=object` as a request parameter when including consignments.

            * `consignments.line_items` - include the response returned from the request to the
            `/orders/{order_id}/products` endpoint in consignments. This will also includes the resources associated
            with `include=consignments`. Current default array structure is legacy and will be deprecated from **1 Feb
            2026**. Specify `consignment_structure=object` as a request parameter when including consignments.

            * `fees` - include the response returned from the request to the `/orders/{order_id}/fees` endpoint.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/OrdersGetParametersIncludeSchemaItems'
        - name: consignment_structure
          in: query
          description: >-
            Should be specified along with `include=consignments` or `include=consignments.line_items` to return
            consignments in the supported object structure. The default array structure provided is legacy and may not
            be supported in the future.
          required: false
          schema:
            $ref: '#/components/schemas/OrdersGetParametersConsignmentStructure'
        - name: external_order_id
          in: query
          description: >-
            The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it,
            you can update this field using a POST or PUT request.
          required: false
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/order_Resp'
    post:
      operationId: createOrder
      summary: Create Order
      description: >-
        Creates an *Order*. To learn more about creating or updating orders, see [Orders
        Overview](/developer/docs/admin/checkout-and-cart/orders).


        Create an order with an existing catalog product or a custom product.


        **Required Fields**


        * `products` or `consignments`

        * `billing_address`


        When you create an order, the `consignment(s)` array allows you to create pickup consignments.

        - An order can have either a pickup or a shipping fulfillment method, but not both.

        - An order can have only one pickup consignment.


        Choose from one of the following:

        1. Create order with a shipping fulfillment method using `shipping_addresses` and `products`, i.e. legacy mode

        2. Create order with a pickup fulfillment method using `consignments`, i.e. Consignment mode


        You can fulfill an order with shipping or pickup, but not both.


        This means that if the `consignments` array is present in the request, then _none_ of the following may be
        present and vice-versa:

        - `shipping_addresses`

        - `products`


        Include the `fees` object along with all its attributes in the request to create order-level fees for the newly
        created order.


        **Notes**


        * The values for cost_ex_tax, cost_inc_tax and cost_tax in the fees payload should reflect the tax rate
        associated with the tax_class_id. For a 10% tax rate, the difference between cost_inc_tax and cost_ex_tax should
        be 10%. If no tax_class_id is provided, the store's default "tax class for fee" will apply. Incorrect data may
        lead to issues in downstream operations like refunds.


        The V2 Orders API will not trigger the typical [Order
        Email](https://support.bigcommerce.com/s/article/Customizing-Emails?language=en_US) when creating orders. To
        create an order that does trigger this email, you can instead [create a
        cart](/developer/api-reference/rest/admin/management/carts/carts-single/create-cart) and [convert that cart into
        an order](/developer/api-reference/rest/admin/management/checkouts/orders/create-order).


        If you are building an app that creates orders, it must include your app's ID in the `external_source` field of
        new orders to be approved for the App Marketplace. See [App Store Approval
        Requirements](/developer/docs/integrations/apps/guide/approval-requirements#functionality) to learn more.


        > #### Note

        > * If historical orders processed on another eCommerce platform are being migrated to BigCommerce, supply the
        `external_source` field with the code **M-MIG**. This code will exclude the historical orders from the store’s
        GMV/order count, which factors into pricing.
      tags:
        - orders
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: include
          in: query
          description: >-
            * `consignments` - include the response returned from the request to the `/orders/{order_id}/consignments`
            endpoint. Current default array structure is legacy and will be deprecated from **1 Feb 2026**. Specify
            `consignment_structure=object` as a request parameter when including consignments.

            * `consignments.line_items` - include the response returned from the request to the
            `/orders/{order_id}/products` endpoint in consignments. This will also includes the resources associated
            with `include=consignments`. Current default array structure is legacy and will be deprecated from **1 Feb
            2026**. Specify `consignment_structure=object` as a request parameter when including consignments.

            * `fees` - include the response returned from the request to the `/orders/{order_id}/fees` endpoint.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/OrdersPostParametersIncludeSchemaItems'
        - name: consignment_structure
          in: query
          description: >-
            Should be specified along with `include=consignments` or `include=consignments.line_items` to return
            consignments in the supported object structure. The default array structure provided is legacy and may not
            be supported in the future.
          required: false
          schema:
            $ref: '#/components/schemas/OrdersPostParametersConsignmentStructure'
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: Order Response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_Resp'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/order_Post'
    delete:
      operationId: deleteOrders
      summary: Delete All Orders
      description: Archives all orders.
      tags:
        - orders
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: limit
          in: query
          description: Number of results to return.
          required: false
          schema:
            type: number
            format: double
            default: 50
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
  /stores/{store_hash}/v2/orders/{order_id}/consignments:
    get:
      operationId: getOrderConsignments
      summary: List Consignments
      description: 'Get all consignments for an order. '
      tags:
        - orderConsignments
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: include
          in: query
          description: >-
            * `consignments.line_items` - include the response returned from the request to the
            `/orders/{order_id}/products` endpoint in consignments.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/OrdersOrderIdConsignmentsGetParametersIncludeSchemaItems'
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orderConsignment_Get'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrdersOrderIdConsignmentsGetResponsesContentApplicationJsonSchemaItems'
  /stores/{store_hash}/v2/orders/{order_id}/consignments/shipping/{shipping_consignment_id}/shipping_quotes:
    get:
      operationId: getOrderConsignmentShippingQuotes
      summary: List Consignment Shipping Quotes
      description: >-
        Get all shipping quotes persisted on an order for a shipping consignment.

        This is a read-only endpoint whose response depends on the shipping quote. You can only generate a shipping
        quote using the storefront at this time. Orders that are created in the control panel, or using the API, return
        a 204 status response since you can't generate a shipping quote during that process.
      tags:
        - orderConsignments
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: shipping_consignment_id
          in: path
          description: Shipping consignment ID.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shippingQuotes_Base'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/OrdersOrderIdConsignmentsShippingShippingConsignmentIdShippingQuotesGetResponsesContentApplicationJsonSchemaItems
  /stores/{store_hash}/v2/orders/{order_id}/coupons:
    get:
      operationId: getOrderCoupons
      summary: List Order Coupons
      description: |-
        Lists all order coupons. Optional parameters can be passed in.

        |Type `int`|Type Name|
        |-|-|
        |`0`|`per_item_discount`|
        |`1`|`percentage_discount`|
        |`2`|`per_total_discount`|
        |`3`|`shipping_discount`|
        |`4`|`free_shipping`|
        |`5`|`promotion`|
      tags:
        - orderCoupons
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: The page to return in the response.
          required: false
          schema:
            type: number
            format: double
            default: 1
        - name: limit
          in: query
          description: Number of results to return.
          required: false
          schema:
            type: number
            format: double
            default: 50
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/orderCoupons_Base'
  /stores/{store_hash}/v2/orders/{order_id}/fees:
    get:
      operationId: getOrderFees
      summary: List Fees
      description: 'Get all fees for an order. '
      tags:
        - orderFees
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orderFees_Resp'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrdersOrderIdFeesGetResponsesContentApplicationJsonSchemaItems'
  /stores/{store_hash}/v2/orders/{order_id}/messages:
    get:
      operationId: getOrderMessages
      summary: List Order Messages
      description: Gets the messages associated with an order.
      tags:
        - orderMessages
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: min_id
          in: query
          description: The minimum order ID.
          required: false
          schema:
            type: integer
        - name: max_id
          in: query
          description: The maximum order ID.
          required: false
          schema:
            type: integer
        - name: customer_id
          in: query
          description: Customer ID.
          required: false
          schema:
            type: integer
        - name: min_date_created
          in: query
          description: |-
            Minimum date the order was created in RFC-2822 or ISO-8601.

            RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400`

            ISO-8601: `2017-04-20T11:32:00.000-04:00`
          required: false
          schema:
            type: string
        - name: max_date_created
          in: query
          description: |-
            Maximum date the order was created in RFC-2822 or ISO-8601.

            RFC-2822: `Thu, 20 Apr 2017 11:32:00 -0400`

            ISO-8601: `2017-04-20T11:32:00.000-04:00`
          required: false
          schema:
            type: string
        - name: is_flagged
          in: query
          description: >-
            Whether the message is
            [flagged](https://support.bigcommerce.com/s/article/Communicating-with-Customers#Messages).
          required: false
          schema:
            type: boolean
        - name: status
          in: query
          description: Status of the order message.
          required: false
          schema:
            $ref: '#/components/schemas/OrdersOrderIdMessagesGetParametersStatus'
        - name: page
          in: query
          description: The page to return in the response.
          required: false
          schema:
            type: number
            format: double
            default: 1
        - name: limit
          in: query
          description: Number of results to return.
          required: false
          schema:
            type: number
            format: double
            default: 50
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orderMessages'
  /stores/{store_hash}/v2/orders/{order_id}/products:
    get:
      operationId: getOrderProducts
      summary: List Order Products
      description: >-
        Lists 50 order products on an order using `order_id`. By default, items are sorted from lowest to highest
        according to a newly created ID, separate from the `order_id` and the `product_id`.


        **Note**: The response `id` is required when you [create order
        shipments](/developer/docs/admin/checkout-and-cart/orders#creating-order-shipments).
      tags:
        - orderProducts
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: The page to return in the response.
          required: false
          schema:
            type: number
            format: double
            default: 1
        - name: limit
          in: query
          description: Number of results to return.
          required: false
          schema:
            type: number
            format: double
            default: 50
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/orderProducts'
  /stores/{store_hash}/v2/orders/{order_id}/products/{product_id}:
    get:
      operationId: getOrderProduct
      summary: Get Order Product
      description: Gets a product line item associated with the order.
      tags:
        - orderProducts
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: product_id
          in: path
          description: ID of the product.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orderProducts'
  /stores/{store_hash}/v2/orders/{order_id}/shipments:
    get:
      operationId: getOrderShipments
      summary: List Order Shipments
      description: Gets a list of all shipments on an order.
      tags:
        - orderShipments
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: The page to return in the response.
          required: false
          schema:
            type: number
            format: double
            default: 1
        - name: limit
          in: query
          description: Number of results to return.
          required: false
          schema:
            type: number
            format: double
            default: 50
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/orderShipment'
    post:
      operationId: createOrderShipments
      summary: Create Order Shipment
      description: >
        Creates an *Order Shipment*. For more details, see [Shipping an
        Order](/developer/docs/admin/checkout-and-cart/orders#creating-order-shipments).


        **Required Fields**

        *   order_address_id

        *   items


        **Usage notes**


        There are three methods for generating a tracking link for a shipment:


        1. Use `shipping_provider` and `tracking_number`: This generates a link to one of our integrated providers that
        you can click from the BigCommerce control panel and customer-facing emails. If a merchant still needs to set up
        a shipping provider or if the provider is not one of our natively integrated providers, you will click on an
        Aftership tracking link instead. The `generated_tracking_link` property in the API response represents one of
        these tracking links. The `tracking_link` property in the API response will remain empty.


        2. Use `tracking_carrier` and `tracking_number`: This also creates a link to one of our integrated providers or
        an Aftership tracking link that you can click in both the BigCommerce control panel and customer-facing emails.
        Like the previous method, the `generated_tracking_link` property in the API response represents this tracking
        link. The `tracking_link` property in the API response will remain empty.


        3. Supply a custom `tracking_link`: By providing a value for the `tracking_link` property, you can use your own
        tracking link within the BigCommerce control panel and in customer-facing emails. The API response will return
        your supplied tracking link as part of the `tracking_link` property in the response. In situations when there
        isn't a `generated_tracking_link`, the property in the API response will remain empty. 


        Acceptable values for `shipping_provider` include the following, and this list may be updated at any time: 
         - `""`, an empty string
         - `auspost`
         - `canadapost`
         - `endicia`
         - `usps`
         - `fedex`
         - `royalmail`
         - `ups`
         - `upsready`
         - `shipperhq`
         - `carrier_{your_carrier_id}`, when the carrier is a [third-party Shipping Provider](/developer/docs/integrations/shipping-providers) 

        Acceptable values for `tracking_carrier` include an empty string (`""`) or one of the valid [tracking-carrier
        values](https://www.aftership.com/docs/tracking/others/supported-couriers).
      tags:
        - orderShipments
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orderShipment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/orderShipment_Post'
    delete:
      operationId: deleteOrderShipments
      summary: Delete Order Shipments
      description: Deletes all shipments associated with an order.
      tags:
        - orderShipments
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
  /stores/{store_hash}/v2/orders/{order_id}/shipments/count:
    get:
      operationId: getOrderShipmentsCount
      summary: Get Count of Order Shipments
      description: Gets a count of the number of shipments that have been made for a single order.
      tags:
        - orderShipments
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orderCount'
  /stores/{store_hash}/v2/orders/{order_id}/shipments/{shipment_id}:
    get:
      operationId: getOrderShipment
      summary: Get Shipment
      description: Gets an order shipment.
      tags:
        - orderShipments
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: shipment_id
          in: path
          description: Shipment ID.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orderShipment'
    put:
      operationId: updateOrderShipment
      summary: Update Shipment
      description: Updates an existing shipment associated with an order.
      tags:
        - orderShipments
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: shipment_id
          in: path
          description: Shipment ID.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orderShipment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/orderShipment_Put'
    delete:
      operationId: deleteOrderShipment
      summary: Delete Order Shipment
      description: Deletes a shipment associated with an order.
      tags:
        - orderShipments
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: shipment_id
          in: path
          description: Shipment ID.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
  /stores/{store_hash}/v2/orders/{order_id}/shipping_addresses:
    get:
      operationId: getOrderShippingAddresses
      summary: List Order Shipping Addresses
      description: >-
        Get all shipping addresses on an order using the `order_id`.


        Returned in the response is shipping_quotes object. Please use the Get Shipping Quotes Endpoint. Using the
        response will return a 204 for the shipping quote.
      tags:
        - orderShippingAddresses
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: The page to return in the response.
          required: false
          schema:
            type: number
            format: double
            default: 1
        - name: limit
          in: query
          description: Number of results to return.
          required: false
          schema:
            type: number
            format: double
            default: 50
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/orderShippingAddress'
  /stores/{store_hash}/v2/orders/{order_id}/shipping_addresses/{id}:
    get:
      operationId: getOrderShippingAddress
      summary: Get Shipping Address
      description: >-
        Gets a shipping address associated with an order.


        Returned in the response is shipping_quotes object. Please use the Get Shipping Quotes Endpoint. Using the
        response will return a 204 for the shipping quote.
      tags:
        - orderShippingAddresses
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: id
          in: path
          description: Shipping address ID.
          required: true
          schema:
            type: string
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orderShippingAddress'
    put:
      operationId: updateOrderShippingAddress
      summary: Update Shipping Address
      description: |-
        Update a shipping address associated with an order.

        **Note**: Updating a shipping address will NOT trigger the recalculation of shipping cost and tax
      tags:
        - orderShippingAddresses
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: id
          in: path
          description: Shipping address ID.
          required: true
          schema:
            type: string
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orderShippingAddress'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrdersOrderIdShippingAddressesIdPutResponsesContentApplicationJsonSchemaItems'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrdersOrderIdShippingAddressesIdPutResponsesContentApplicationJsonSchemaItems'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/shippingAddress_Put'
  /stores/{store_hash}/v2/orders/{order_id}/shipping_addresses/{shipping_address_id}/shipping_quotes:
    get:
      operationId: getOrderShippingAddressShippingQuotes
      summary: List Order Shipping Quotes
      description: >-
        Gets all shipping quotes persisted on an order.


        This is a read-only endpoint and the output can vary based on the shipping quote. A shipping quote can only be
        generated using the storefront at this time. Orders that are created in the control panel or using the API
        return a 204 for this endpoint since a shipping quote is not generated during that process.
      tags:
        - orderShippingAddressesQuotes
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: shipping_address_id
          in: path
          description: Shipping address ID.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: This response can vary depending on the shipping provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shippingQuotes_Base'
  /stores/{store_hash}/v2/order_statuses:
    get:
      operationId: getOrderStatuses
      summary: List Order Statuses
      description: >-
        Returns a Collection of All Order Statuses.


        **Order Status Descriptions:**


        |Status ID | Name  | Description |

        |-|-|-|

        | 0 | Incomplete  | An incomplete order happens when a shopper reached the payment page, but did not complete
        the transaction. |

        | 1 | Pending |Customer started the checkout process, but did not complete it. |

        | 2 | Shipped | Order has been shipped, but receipt has not been confirmed; seller has used the Ship Items
        action. |

        | 3 | Partially Shipped | Only some items in the order have been shipped, due to some products being pre-order
        only or other reasons. |

        | 4 | Refunded | Seller has used the Refund action. |

        | 5 | Cancelled | Seller has cancelled an order, due to a stock inconsistency or other reasons. |

        | 6 | Declined | Seller has marked the order as declined for lack of manual payment, or other reasons. |

        | 7 | Awaiting Payment | Customer has completed checkout process, but payment has yet to be confirmed. |

        | 8 | Awaiting Pickup | Order has been pulled, and is awaiting customer pickup from a seller-specified location.
        |

        | 9 | Awaiting Shipment | Order has been pulled and packaged, and is awaiting collection from a shipping
        provider. |

        | 10 | Completed | Client has paid for their digital product and their file(s) are available for download. |

        | 11 | Awaiting Fulfillment | Customer has completed the checkout process and payment has been confirmed. |

        | 12 | Manual Verification Required | Order is on hold while some aspect needs to be manually confirmed. |

        | 13 | Disputed | Customer has initiated a dispute resolution process for the PayPal transaction that paid for
        the order. |

        | 14 | Partially Refunded | Seller has partially refunded the order. |
      tags:
        - orderStatus
      parameters:
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: Get All Order Status Collection Response.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/orderStatus_Base'
  /stores/{store_hash}/v2/order_statuses/{status_id}:
    get:
      operationId: getOrderStatusesStatus
      summary: Get Single Order Status by ID
      description: >-
        Returns a single order status.


        **Order Status Descriptions**

        |Status ID | Name  | Description |

        |:--|:--|:--|

        | 0 | Incomplete  | An incomplete order happens when a shopper reached the payment page, but did not complete
        the transaction. |

        | 1 | Pending |Customer started the checkout process, but did not complete it. |

        | 2 | Shipped | Order has been shipped, but receipt has not been confirmed; seller has used the Ship Items
        action. |

        | 3 | Partially Shipped | Only some items in the order have been shipped, due to some products being pre-order
        only or other reasons. |

        | 4 | Refunded | Seller has used the Refund action. |

        | 5 | Cancelled | Seller has cancelled an order, due to a stock inconsistency or other reasons. |

        | 6 |Declined | Seller has marked the order as declined for lack of manual payment, or other reasons. |

        | 7 | Awaiting Payment | Customer has completed checkout process, but payment has yet to be confirmed. |

        | 8 | Awaiting Pickup | Order has been pulled, and is awaiting customer pickup from a seller-specified location.
        |

        | 9 | Awaiting Shipment | Order has been pulled and packaged, and is awaiting collection from a shipping
        provider. |

        | 10 | Completed | Client has paid for their digital product and their file(s) are available for download. |

        | 11 | Awaiting Fulfillment | Customer has completed the checkout process and payment has been confirmed. |

        | 12 | Manual Verification Required | Order is on hold while some aspect needs to be manually confirmed. |

        | 13 | Disputed | Customer has initiated a dispute resolution process for the PayPal transaction that paid for
        the order. |

        | 14 | Partially Refunded | Seller has partially refunded the order. |
      tags:
        - orderStatus
      parameters:
        - name: status_id
          in: path
          description: The status ID of the order. You can get the status id from the `/orders` endpoints.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orderStatus_Base'
  /stores/{store_hash}/v2/orders/{order_id}/taxes:
    get:
      operationId: getOrderTaxes
      summary: List Order Taxes
      description: |-
        Gets all order taxes using `order_id`.
        Each tax applied to an order. This information can be useful for reporting purposes.
        Pass in the query parameter `?details=true` to return extra details about order taxes.
        `order_product_id` and `line_item_type` are also returned.

        All values are read-only.
      tags:
        - orderTaxes
      parameters:
        - name: order_id
          in: path
          description: ID of the order.
          required: true
          schema:
            type: integer
        - name: store_hash
          in: path
          description: Permanent ID of the BigCommerce store.
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: The page to return in the response.
          required: false
          schema:
            type: number
            format: double
            default: 1
        - name: limit
          in: query
          description: Number of results to return.
          required: false
          schema:
            type: number
            format: double
            default: 50
        - name: details
          in: query
          description: To return detailed tax information, pass in the details query.
          required: false
          schema:
            type: string
            default: 'false'
        - name: X-Auth-Token
          in: header
          description: >-
            ### OAuth scopes


            | UI Name | Permission | Parameter |

            |:--------|:-----------|:----------|

            |  Orders | modify | `store_v2_orders` |

            |  Orders | read-only | `store_v2_orders_read_only` |


            ### Authentication header


            | Header | Argument | Description |

            |:-------|:---------|:------------|

            | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our
            [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


            ### Further reading


            For example requests and more information about authenticating BigCommerce APIs, see [Authentication and
            Example
            Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


            For more about BigCommerce OAuth scopes, see our [Guide to API
            Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


            For a list of API status codes, see [API Status
            Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: >-
            The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response
            body.
          required: true
          schema:
            type: string
            default: application/json
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/orderTaxes_Base'
servers:
  - url: https://api.bigcommerce.com
    description: https://api.bigcommerce.com
components:
  schemas:
    OrdersOrderIdGetParametersIncludeSchemaItems:
      type: string
      enum:
        - consignments
        - consignments.line_items
        - fees
      title: OrdersOrderIdGetParametersIncludeSchemaItems
    OrdersOrderIdGetParametersConsignmentStructure:
      type: string
      enum:
        - object
      title: OrdersOrderIdGetParametersConsignmentStructure
    OrderRespOnlyPaymentStatus:
      type: string
      enum:
        - authorized
        - captured
        - capture pending
        - declined
        - held for review
        - paid
        - partially refunded
        - pending
        - refunded
        - void
        - void pending
        - ''
      description: A read-only value. Do not attempt to set or modify this value in a POST or PUT request.
      title: OrderRespOnlyPaymentStatus
    orderConsignments_Resource:
      type: object
      properties:
        url:
          type: string
          description: URL where you can use a GET request to get the order consignments.
        resource:
          type: string
          description: Path where you can use a GET request to get the order consignments.
      title: orderConsignments_Resource
    pickupConsignmentLocation_Get:
      type: object
      properties:
        name:
          type: string
          description: The name of the pickup location.
        code:
          type: string
          description: The code of the pickup location.
        address_line_1:
          type: string
          description: Street address (first line).
        address_line_2:
          type: string
          description: Street address (second line).
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        country_alpha2:
          type: string
          description: 2-letter ISO Alpha-2 code for the country.
        email:
          type: string
          description: Pickup locationʼs email address.
        phone:
          type: string
          description: Pickup locationʼs phone number.
        id:
          type: integer
          description: ID of the location.
      title: pickupConsignmentLocation_Get
    products_Resource:
      type: object
      properties:
        url:
          type: string
        resource:
          type: string
      title: products_Resource
    PickupConsignmentGetLineItems0:
      type: array
      items:
        $ref: '#/components/schemas/products_Resource'
      title: PickupConsignmentGetLineItems0
    OrderProductsType:
      type: string
      enum:
        - physical
        - digital
        - giftcertificate
      description: Type of product.
      title: OrderProductsType
    OrderProductsWeight:
      oneOf:
        - type: number
          format: double
        - type: string
      description: Weight of the product. The value can't be negative. (Float, Float-As-String, Integer)
      title: OrderProductsWeight
    OrderProductsBaseWrappingCost:
      oneOf:
        - type: string
        - type: number
          format: double
      description: The value of the base wrapping cost. The value can't be negative. (Float, Float-As-String, Integer)
      title: OrderProductsBaseWrappingCost
    OrderProductAppliedDiscountsTarget:
      type: string
      enum:
        - order
        - product
      description: Determines if the discount if discount was applied at the Order or Product level. Read Only.
      title: OrderProductAppliedDiscountsTarget
    orderProductAppliedDiscounts:
      type: object
      properties:
        id:
          type: string
          description: Name of the coupon applied to order.
        amount:
          type: string
          description: Amount of the discount.(Float, Float-As-String, Integer)
        name:
          type: string
          description: |-
            Name of the coupon.
            `Manual Discount` when creating a manual discount.
        code:
          type:
            - string
            - 'null'
          description: |-
            Coupon Code.
            There is no code when creating a manual discount.
        target:
          $ref: '#/components/schemas/OrderProductAppliedDiscountsTarget'
          description: Determines if the discount if discount was applied at the Order or Product level. Read Only.
      description: >-
        When applying a manual discount to an order (not a product level discount), the discount is distributed across
        products in proportion to the products price.

        `(total_manual_discount*price_ex_tax)/subtotal_ex_tax`
      title: orderProductAppliedDiscounts
    OrderProductOptionsType:
      type: string
      enum:
        - Checkbox
        - Date field
        - File Upload
        - Multi-line text field
        - Multiple choice
        - Product Pick List
        - Swatch
        - Text field
      description: Option Type
      title: OrderProductOptionsType
    orderProductOptions:
      type: object
      properties:
        id:
          type: integer
          description: The unique numerical ID of the option; increments sequentially.
        option_id:
          type: integer
          description: Numeric ID of the associated option.
        order_product_id:
          type: integer
        product_option_id:
          type: integer
          description: Numeric ID of an option applied to the product from a list of options available to the product.
        display_name:
          type: string
          description: Alias for display_name_customer. The product option name that is shown to customer in the storefront.
        display_value:
          type: string
          description: Alias for display_value_customer. The product option value that is shown to customer in storefront.
        value:
          type: string
          description: >-
            For file-upload type, itʼs a unique string describing the properties of the file upload. For other types,
            itʼs the value of the property.
        type:
          $ref: '#/components/schemas/OrderProductOptionsType'
          description: Option Type
        name:
          type: string
          description: The option’s name, as used internally. Must be unique.
        display_style:
          type: string
          description: How it is displayed on the storefront. Examples include Drop-down, radio buttons, or rectangles.
        display_name_customer:
          type: string
          description: The product option name that is shown to customer in storefront.
        display_name_merchant:
          type: string
          description: The product option name that is shown to the merchant in the control panel.
        display_value_customer:
          type: string
          description: The product option value that is shown to customer in storefront.
        display_value_merchant:
          type: string
          description: The product option value that is shown to the merchant in the control panel.
      title: orderProductOptions
    OrderProductsConfigurableFieldsItems:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
      title: OrderProductsConfigurableFieldsItems
    orderProducts:
      type: object
      properties:
        id:
          type: integer
          description: Numeric ID of this product within this order.
        order_id:
          type: integer
          description: Numeric ID of the associated order.
        product_id:
          type: integer
          description: Numeric ID of the product.
        order_pickup_method_id:
          type: integer
          description: >-
            ID of the pickup fulfillment method for this item. Default value is 0 when the item is not fulfilled by
            pickup method.
        order_address_id:
          type: integer
          description: >-
            Numeric ID of the associated order address. Value is `0` for items that are not fulfilled by a pickup
            method.
        name:
          type: string
          description: Alias for name_customer - The product name that is shown to customer in storefront.
        sku:
          type: string
          description: User-defined product code/stock keeping unit (SKU).
        type:
          $ref: '#/components/schemas/OrderProductsType'
          description: Type of product.
        base_price:
          type: string
          description: The product’s base price. (Float, Float-As-String, Integer)
        price_ex_tax:
          type: string
          description: The product’s price excluding tax. The value can't be negative. (Float, Float-As-String, Integer)
        price_inc_tax:
          type: string
          description: The product’s price including tax. The value can't be negative. (Float, Float-As-String, Integer)
        price_tax:
          type: string
          description: |-
            Amount of tax applied to a single product.

            Price tax is calculated as:
            `price_tax = price_inc_tax - price_ex_tax`

            (Float, Float-As-String, Integer)
        base_total:
          type: string
          description: >-
            Total base price. (Float, Float-As-String, Integer)


            **Note**: The `base_total` is affected by the tax options set up in the control panel and is altered on
            tax-free orders. See more details on how `base_total` is affected by visiting the [Responsive Tax Display
            Settings](https://support.bigcommerce.com/s/article/Manual-Tax-Setup) overview. If the `base_total` is `$0`,
            it's due to the store's tax settings. To learn more about tax settings in the control panel, check out this
            [Tax Settings](https://support.bigcommerce.com/s/article/Tax-Overview?language=en_US#tax-settings) support
            article.
        total_ex_tax:
          type: string
          description: Total base price excluding tax. The value can't be negative. (Float, Float-As-String, Integer)
        total_inc_tax:
          type: string
          description: Total base price including tax. The value can't be negative. (Float, Float-As-String, Integer)
        total_tax:
          type: string
          description: >-
            Total tax applied to products.

            For example, if quantity if 2, base price is 5 and tax rate is 10%. price_tax will be $.50 and total_tax
            will be $1.00.


            If there is a manual discount applied total_tax is calculated as the following:

            `(price_ex_tax - discount)*tax_rate=total_tax`.

            (Float, Float-As-String, Integer)
        quantity:
          type: integer
          description: Quantity of the product ordered.
        base_cost_price:
          type: string
          description: The product’s cost price.  This can be set using the Catalog API. (Float, Float-As-String, Integer)
        cost_price_inc_tax:
          type: string
          description: >-
            The product’s cost price including tax. (Float, Float-As-String, Integer)

            The cost of your products to you; this is never shown to customers, but can be used for accounting purposes.
            The value can't be negative.
        cost_price_ex_tax:
          type: string
          description: >-
            The product cost price excluding tax. (Float, Float-As-String, Integer)

            The cost of your products to you; this is never shown to customers, but can be used for accounting purposes.
            The value can't be negative.
        weight:
          $ref: '#/components/schemas/OrderProductsWeight'
          description: Weight of the product. The value can't be negative. (Float, Float-As-String, Integer)
        width:
          type: string
          description: Product width. The value can't be negative.
        height:
          type: string
          description: Product height. The value can't be negative.
        depth:
          type: string
          description: Product depth. The value can't be negative.
        cost_price_tax:
          type: string
          description: >-
            Tax applied to the product’s cost price. (Float, Float-As-String, Integer)

            The cost of your products to you; this is never shown to customers, but can be used for accounting purposes.
            Read Only
        is_refunded:
          type: boolean
          description: Whether the product has been refunded.
        quantity_refunded:
          type: number
          format: double
          description: The total quantity of product refunded from this transaction.
        refund_amount:
          type: string
          description: The amount refunded from this transaction; always returns `0`. (Float, Float-As-String, Integer)
        return_id:
          type: number
          format: double
          description: Numeric ID for the refund.
        wrapping_id:
          type: integer
          description: ID of the gift wrapping option.
        wrapping_name:
          type:
            - string
            - 'null'
          description: Name of gift-wrapping option.
        base_wrapping_cost:
          $ref: '#/components/schemas/OrderProductsBaseWrappingCost'
          description: The value of the base wrapping cost. The value can't be negative. (Float, Float-As-String, Integer)
        wrapping_cost_ex_tax:
          type: string
          description: >-
            The value of the wrapping cost, excluding tax. The value can't be negative. (Float, Float-As-String,
            Integer)
        wrapping_cost_inc_tax:
          type: string
          description: >-
            The value of the wrapping cost, including tax. The value can't be negative. (Float, Float-As-String,
            Integer)
        wrapping_cost_tax:
          type: string
          description: Tax applied to gift-wrapping option. (Float, Float-As-String, Integer)
        wrapping_message:
          type: string
          description: Message to accompany gift-wrapping option.
        quantity_shipped:
          type: number
          format: double
          description: Quantity of this item shipped.
        event_name:
          type:
            - string
            - 'null'
          description: Name of promotional event/delivery date.
        event_date:
          type:
            - string
            - 'null'
          format: date
          description: Date of the promotional event/scheduled delivery.
        fixed_shipping_cost:
          type: string
          description: Fixed shipping cost for this product. (Float, Float-As-String, Integer)
        ebay_item_id:
          type: string
          description: Item ID for this product on eBay.
        ebay_transaction_id:
          type: string
          description: Transaction ID for this product on eBay.
        option_set_id:
          type:
            - integer
            - 'null'
          description: Numeric ID of the option set applied to the product.
        parent_order_product_id:
          type:
            - integer
            - 'null'
          description: ID of a parent product.
        is_bundled_product:
          type: boolean
          description: Whether this product is bundled with other products.
        bin_picking_number:
          type: string
          description: Bin picking number for the physical product.
        external_id:
          type:
            - string
            - 'null'
          description: (Read-only) ID of the order in another system. For example, the Amazon order ID if this is an Amazon order.
        brand:
          type: string
          description: The productʼs brand.
        applied_discounts:
          type: array
          items:
            $ref: '#/components/schemas/orderProductAppliedDiscounts'
          description: Array of objects containing discounts applied to the product.
        product_options:
          type: array
          items:
            $ref: '#/components/schemas/orderProductOptions'
          description: Array of product option objects.
        configurable_fields:
          type: array
          items:
            $ref: '#/components/schemas/OrderProductsConfigurableFieldsItems'
          description: >-
            Available for only [Catalog V2
            stores](/developer/docs/admin/catalog-and-inventory/migrating-from-catalog-v2-to-v3).
        upc:
          type: string
          description: Universal Product Code. Can be written to for custom products and catalog products.
        variant_id:
          type: integer
          description: Products `variant_id`. PUT or POST. This field is not available for custom products.
        name_customer:
          type: string
          description: The product name that is shown to customer in storefront.
        name_merchant:
          type: string
          description: The product name that is shown to the merchant in the control panel.
        gift_certificate_id:
          type:
            - integer
            - 'null'
          description: ID of the associated gift certificate.
        discounted_total_inc_tax:
          type: string
          description: >-
            Represent the correct total amount of the line item after deducting all the discounts and including the tax.
            This number can be used for accounting purpose.


            This makes it easier to have the "shopper paid" value for a line item and api user doesn't have to do any
            calculation to deduct discount on the client side.


            This field includes all types of discounts (automatic, coupon, manual) and therefore if you use this value,
            you don't need to deduct any more discounts at line item level or order level.
      title: orderProducts
    PickupConsignmentGetLineItems1:
      type: array
      items:
        $ref: '#/components/schemas/orderProducts'
      title: PickupConsignmentGetLineItems1
    PickupConsignmentGetLineItems:
      oneOf:
        - $ref: '#/components/schemas/PickupConsignmentGetLineItems0'
        - $ref: '#/components/schemas/PickupConsignmentGetLineItems1'
      title: PickupConsignmentGetLineItems
    pickupConsignment_Get:
      type: object
      properties:
        pickup_method_display_name:
          type: string
          description: A name for the pickup method that can be displayed to shoppers.
        collection_instructions:
          type: string
          description: A message for shoppers explaining how to collect their pickup order.
        collection_time_description:
          type: string
          description: A message for shoppers indicating the estimated time their pickup order will be ready for collection.
        id:
          type: integer
          description: The ID of the pickup consignment to update.
        pickup_method_id:
          type: integer
          description: ID of the pickup method.
        location:
          $ref: '#/components/schemas/pickupConsignmentLocation_Get'
        line_items:
          $ref: '#/components/schemas/PickupConsignmentGetLineItems'
      title: pickupConsignment_Get
    FormFieldsValue:
      oneOf:
        - type: number
          format: double
        - type: string
        - type: array
          items:
            description: Any type
      description: The form field value.
      title: FormFieldsValue
    formFields:
      type: object
      properties:
        name:
          type: string
          description: The form field name.
        value:
          $ref: '#/components/schemas/FormFieldsValue'
          description: The form field value.
      title: formFields
    ShippingConsignmentGetLineItems0:
      type: array
      items:
        $ref: '#/components/schemas/products_Resource'
      title: ShippingConsignmentGetLineItems0
    ShippingConsignmentGetLineItems1:
      type: array
      items:
        $ref: '#/components/schemas/orderProducts'
      title: ShippingConsignmentGetLineItems1
    ShippingConsignmentGetLineItems:
      oneOf:
        - $ref: '#/components/schemas/ShippingConsignmentGetLineItems0'
        - $ref: '#/components/schemas/ShippingConsignmentGetLineItems1'
      title: ShippingConsignmentGetLineItems
    shippingQuotesConsignment_Resource:
      type: object
      properties:
        url:
          type: string
          description: URL where you can use a GET request to get the shipping quotes for the order consignment.
        resource:
          type: string
          description: Path where you can use a GET request to get the shipping quotes for the order consignment.
      title: shippingQuotesConsignment_Resource
    shippingConsignment_Get:
      type: object
      properties:
        first_name:
          type: string
        last_name:
          type: string
        company:
          type: string
        street_1:
          type: string
          description: Street address (first line).
        street_2:
          type: string
          description: Street address (second line).
        city:
          type: string
        zip:
          type: string
          description: Zip or postal code, as a string.
        country:
          type: string
        country_iso2:
          type: string
          description: 2-letter ISO Alpha-2 code for the country.
        state:
          type: string
        email:
          type: string
          description: Recipient’s email address.
        phone:
          type: string
          description: Recipient’s telephone number.
        form_fields:
          type: array
          items:
            $ref: '#/components/schemas/formFields'
        id:
          type: integer
          description: ID of the shipping consignment.
        line_items:
          $ref: '#/components/schemas/ShippingConsignmentGetLineItems'
        items_total:
          type: number
          format: double
          description: The total number of items in the order.
        items_shipped:
          type: number
          format: double
          description: The number of items that have been shipped.
        shipping_method:
          type: string
          description: Text identifying the BigCommerce shipping module selected by the customer.
        base_cost:
          type: number
          format: double
          description: The base shipping cost value.
        cost_ex_tax:
          type: number
          format: double
          description: The shipping cost value excluding tax.
        cost_inc_tax:
          type: number
          format: double
          description: The shipping cost value including tax.
        cost_tax:
          type: number
          format: double
          description: The tax amount on the shipping cost.
        cost_tax_class_id:
          type: integer
          description: The ID of the tax class applied to the shipping cost. Ignored if automatic tax is enabled.
        base_handling_cost:
          type: number
          format: double
          description: The base handling charge. The value can't be negative.
        handling_cost_ex_tax:
          type: number
          format: double
          description: The handling charge, excluding tax. The value can't be negative.
        handling_cost_inc_tax:
          type: number
          format: double
          description: The handling charge, including tax. The value can't be negative.
        handling_cost_tax:
          type: number
          format: double
        handling_cost_tax_class_id:
          type: integer
          description: The ID of the tax class applied to the handling charge. Ignored if automatic tax is enabled.
        shipping_zone_id:
          type: number
          format: double
          description: The numeric ID of the shipping zone.
        shipping_zone_name:
          type: string
          description: The name of the shipping zone.
        shipping_quotes:
          $ref: '#/components/schemas/shippingQuotesConsignment_Resource'
      title: shippingConsignment_Get
    DigitalConsignmentGetLineItems0:
      type: array
      items:
        $ref: '#/components/schemas/products_Resource'
      title: DigitalConsignmentGetLineItems0
    DigitalConsignmentGetLineItems1:
      type: array
      items:
        $ref: '#/components/schemas/orderProducts'
      title: DigitalConsignmentGetLineItems1
    DigitalConsignmentGetLineItems:
      oneOf:
        - $ref: '#/components/schemas/DigitalConsignmentGetLineItems0'
        - $ref: '#/components/schemas/DigitalConsignmentGetLineItems1'
      title: DigitalConsignmentGetLineItems
    digitalConsignment_Get:
      type: object
      properties:
        recipient_email:
          type: string
          description: The recipient email of the digital consignment.
        line_items:
          $ref: '#/components/schemas/DigitalConsignmentGetLineItems'
      title: digitalConsignment_Get
    GiftCertificateConsignmentGetLineItems0:
      type: array
      items:
        $ref: '#/components/schemas/products_Resource'
      title: GiftCertificateConsignmentGetLineItems0
    GiftCertificateConsignmentGetLineItems1:
      type: array
      items:
        $ref: '#/components/schemas/orderProducts'
      title: GiftCertificateConsignmentGetLineItems1
    GiftCertificateConsignmentGetLineItems:
      oneOf:
        - $ref: '#/components/schemas/GiftCertificateConsignmentGetLineItems0'
        - $ref: '#/components/schemas/GiftCertificateConsignmentGetLineItems1'
      title: GiftCertificateConsignmentGetLineItems
    giftCertificateConsignment_Get:
      type: object
      properties:
        recipient_email:
          type: string
          description: The recipient email of the gift certificate.
        line_items:
          $ref: '#/components/schemas/GiftCertificateConsignmentGetLineItems'
      title: giftCertificateConsignment_Get
    OrderConsignmentGetEmail:
      type: object
      properties:
        gift_certificates:
          type: array
          items:
            $ref: '#/components/schemas/giftCertificateConsignment_Get'
      description: Email consignments for gift certificates.
      title: OrderConsignmentGetEmail
    orderConsignment_Get:
      type: object
      properties:
        pickups:
          type: array
          items:
            $ref: '#/components/schemas/pickupConsignment_Get'
          description: Pickup consignments.
        shipping:
          type: array
          items:
            $ref: '#/components/schemas/shippingConsignment_Get'
          description: Shipping consignments.
        downloads:
          type: array
          items:
            $ref: '#/components/schemas/digitalConsignment_Get'
          description: Digital consignments for products that are downloaded.
        email:
          $ref: '#/components/schemas/OrderConsignmentGetEmail'
          description: Email consignments for gift certificates.
      title: orderConsignment_Get
    OrderRespOnlyConsignments:
      oneOf:
        - $ref: '#/components/schemas/orderConsignments_Resource'
        - $ref: '#/components/schemas/orderConsignment_Get'
      title: OrderRespOnlyConsignments
    shippingAddresses_Resource:
      type: object
      properties:
        url:
          type: string
          description: URL of the shipping address for API requests.
        resource:
          type: string
      title: shippingAddresses_Resource
    coupons_Resource:
      type: object
      properties:
        url:
          type: string
          description: URL of the coupons for API requests.
        resource:
          type: string
          description: Resource of the coupons.
      title: coupons_Resource
    billingAddress_Resp:
      type: object
      properties:
        first_name:
          type: string
        last_name:
          type: string
        company:
          type: string
        street_1:
          type: string
        street_2:
          type: string
        city:
          type: string
        state:
          type: string
        zip:
          type: string
          description: The billing address must include the ZIP code. The ZIP code must be two or more characters.
        country:
          type: string
        country_iso2:
          type: string
        phone:
          type: string
        email:
          type: string
        form_fields:
          type: array
          items:
            $ref: '#/components/schemas/formFields'
      required:
        - zip
      title: billingAddress_Resp
    orderFees_Resource:
      type: object
      properties:
        url:
          type: string
          description: URL where you can use a GET request to get the order fees.
        resource:
          type: string
          description: Path where you can use a GET request to get the order fees.
      title: orderFees_Resource
    OrderFeesRespType:
      type: string
      enum:
        - custom_fee
      description: The type of the fee.
      title: OrderFeesRespType
    OrderFeesRespBaseCost:
      oneOf:
        - type: string
        - type: number
          format: double
      description: The base fee cost value. (Float, Float-As-String, Integer)
      title: OrderFeesRespBaseCost
    OrderFeesRespCostExTax:
      oneOf:
        - type: string
        - type: number
          format: double
      description: The fee cost value excluding tax. (Float, Float-As-String, Integer)
      title: OrderFeesRespCostExTax
    OrderFeesRespCostIncTax:
      oneOf:
        - type: string
        - type: number
          format: double
      description: The fee cost value including tax. (Float, Float-As-String, Integer)
      title: OrderFeesRespCostIncTax
    OrderFeesRespCostTax:
      oneOf:
        - type: string
        - type: number
          format: double
      description: The tax amount on the fee cost. (Float, Float-As-String, Integer)
      title: OrderFeesRespCostTax
    orderFees_Resp:
      type: object
      properties:
        id:
          type: integer
          description: The unique numeric identifier of the fees object.
        type:
          $ref: '#/components/schemas/OrderFeesRespType'
          description: The type of the fee.
        display_name_customer:
          type: string
          description: The display name of the fee targeting customers.
        display_name_merchant:
          type: string
          description: The display name of the fee targeting shoppers.
        source:
          type: string
          description: The source of the request.
        base_cost:
          $ref: '#/components/schemas/OrderFeesRespBaseCost'
          description: The base fee cost value. (Float, Float-As-String, Integer)
        cost_ex_tax:
          $ref: '#/components/schemas/OrderFeesRespCostExTax'
          description: The fee cost value excluding tax. (Float, Float-As-String, Integer)
        cost_inc_tax:
          $ref: '#/components/schemas/OrderFeesRespCostIncTax'
          description: The fee cost value including tax. (Float, Float-As-String, Integer)
        cost_tax:
          $ref: '#/components/schemas/OrderFeesRespCostTax'
          description: The tax amount on the fee cost. (Float, Float-As-String, Integer)
        tax_class_id:
          type:
            - integer
            - 'null'
          description: >-
            A unique numeric identifier for the tax class. If not persisted or null, the default fee tax class from the
            control panel is used.
      title: orderFees_Resp
    OrderRespOnlyFees1:
      type: array
      items:
        $ref: '#/components/schemas/orderFees_Resp'
      title: OrderRespOnlyFees1
    OrderRespOnlyFees:
      oneOf:
        - $ref: '#/components/schemas/orderFees_Resource'
        - $ref: '#/components/schemas/OrderRespOnlyFees1'
      title: OrderRespOnlyFees
    OrderSharedPaymentProviderId:
      oneOf:
        - type: string
        - type: number
          format: double
      description: The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was used).
      title: OrderSharedPaymentProviderId
    order_Resp:
      type: object
      properties:
        id:
          type: integer
          description: Read-only. The ID of the order.
        date_modified:
          type: string
          description: >-
            A read-only value representing the last modification of the order. Do not attempt to modify or set this
            value in a POST or PUT request. RFC-2822. This date time is always in UTC in the api response.
        date_shipped:
          type: string
          description: >
            A read-only value representing the date when the order is fully shipped. Do not attempt to modify or set
            this value in a POST or PUT request. RFC-2822
        cart_id:
          type: string
          description: >-
            The cart ID from which this order originated, if applicable. Correlates with the Cart API. This is a
            read-only field; do not set or modify its value in a POST or PUT request.
        status:
          type: string
          description: >-
            The status will include one of the (string, options) - values defined under Order Statuses. This value is
            read-only. Do not attempt to modify or set this value in a POST or PUT operation.
        subtotal_tax:
          type: string
          description: >-
            A read-only value. Do not attempt to set or modify this value in a POST or PUT request. (Float,
            Float-As-String, Integer)
        shipping_cost_tax:
          type: string
          description: >-
            A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (Float,
            Float-As-String, Integer)
        shipping_cost_tax_class_id:
          type: integer
          description: >-
            Shipping-cost tax class. A read-only value. Do not attempt to modify or set this value in a POST or PUT
            request. (NOTE: Value ignored if automatic tax is enabled on the store.)
        handling_cost_tax:
          type: string
          description: >-
            A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (Float,
            Float-As-String, Integer)
        handling_cost_tax_class_id:
          type: integer
          description: |-
            A read-only value. Do not attempt to set or modify this value in a POST or PUT request. 

            (NOTE: Value ignored if automatic tax is enabled on the store.)
        wrapping_cost_tax:
          type: string
          description: >-
            A read-only value. Do not attempt to modify or set this value in a POST or PUT request. (Float,
            Float-As-String, Integer)
        wrapping_cost_tax_class_id:
          type: integer
          description: |-
            A read-only value. Do not attempt to set or modify this value in a POST or PUT request.  

            NOTE: Value ignored if automatic tax is enabled on the store.
        payment_status:
          $ref: '#/components/schemas/OrderRespOnlyPaymentStatus'
          description: A read-only value. Do not attempt to set or modify this value in a POST or PUT request.
        store_credit_amount:
          type: string
          description: >-
            Represents the store credit that the shopper has redeemed on this individual order. This is a read-only
            value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer)
        gift_certificate_amount:
          type: string
          description: A read-only value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer)
        currency_id:
          type: integer
          description: >-
            The display currency ID. Depending on the currency selected, the value can be different from the
            transactional currency. A read-only value. Do not pass in a POST or PUT request. In v2 display currency is
            set to the transactional currency, ''default_currency_id''.
        currency_code:
          type: string
          description: >-
            The currency code of the display currency used to present prices to the shopper on the storefront. Depending
            on the currency selected, the value can be different from the transactional currency. A read-only value. Do
            not pass in a POST or PUT request.
        currency_exchange_rate:
          type: string
          description: >-
            The exchange rate between the store’s default currency and the display currency. A read-only value. Do not
            pass in a POST or PUT request. For orders created using the V2 endpoints, this value is always 1 (only in
            the storefront this value can be different to 1). (Float, Float-As-String, Integer)
        default_currency_id:
          type: integer
          description: The transactional currency ID. A read-only value. Do not pass in a POST or PUT request.
        default_currency_code:
          type: string
          description: The currency code of the transactional currency the shopper pays in.
        store_default_currency_code:
          type: string
          description: The currency code of the storeʼs default currency.
        store_default_to_transactional_exchange_rate:
          type: string
          description: The exchange rate between the storeʼs default currency and the transactional currency used in the order.
        coupon_discount:
          type: string
          description: A read-only value. Do not pass in a POST or PUT request. (Float, Float-As-String, Integer)
        shipping_address_count:
          type: number
          format: double
          description: >-
            The number of shipping addresses associated with this transaction. A read-only value. Do not pass in a POST
            or PUT.
        is_deleted:
          type: boolean
          description: >-
            Indicates whether the order is deleted/archived. When set to true in a PUT request, it has the same result
            as the DELETE an order request.
        total_tax:
          type: string
          description: Total tax amount for the order
        is_tax_inclusive_pricing:
          type: boolean
          description: >-
            Indicate whether the order's base prices include tax.


            If true, the base prices are inclusive of tax, and the values of `subtotal_inc_tax`,
            `shipping_cost_inc_tax`, `handling_cost_inc_tax`, `wrapping_cost_inc_tax` and `total_inc_tax` are not
            estimated but actual values and can be reliable for accounting purposes.


            If false, the base prices are exclusive of tax, and the values of `subtotal_ex_tax`, `shipping_cost_ex_tax`,
            `handling_cost_ex_tax`, `wrapping_cost_ex_tax` and `total_ex_tax` are not estimated but actual values and
            can be reliable for accounting purposes.
        is_email_opt_in:
          type: boolean
          description: >-
            Indicates whether the shopper has selected an opt-in check box (on the checkout page) to receive emails. A
            read-only value. Do not pass in a POST or PUT.
        order_source:
          type: string
          description: >-
            The `order_source` reflects the origin of the order. It will indicate whether the order was created by one
            of the following:

            * storefront 

            * control panel

            * manual order

            * /v2/orders API

            * Checkout API

            * or by an integration with an external platform such as Facebook by Meta or Amazon.
        consignments:
          $ref: '#/components/schemas/OrderRespOnlyConsignments'
        products:
          $ref: '#/components/schemas/products_Resource'
        shipping_addresses:
          $ref: '#/components/schemas/shippingAddresses_Resource'
        coupons:
          $ref: '#/components/schemas/coupons_Resource'
        status_id:
          type: integer
          description: The status ID of the order.
        billing_address:
          $ref: '#/components/schemas/billingAddress_Resp'
        fees:
          $ref: '#/components/schemas/OrderRespOnlyFees'
        base_handling_cost:
          type: string
          description: The value of the base handling cost. The value can't be negative. (Float, Float-As-String, Integer)
        base_shipping_cost:
          type: string
          description: The value of the base shipping cost. The value can't be negative. (Float, Float-As-String, Integer)
        base_wrapping_cost:
          type: string
          description: >-
            The value of the base wrapping cost expressed as a floating point number to four decimal places in string
            format. The value can't be negative.
        channel_id:
          type: integer
          description: >-
            Shows where the order originated. The channel_id defaults to 1. The value must match the ID of a valid and
            enabled channel. If the ID refers to a non-existing or disconnected channel, the POST and PUT `/v2/orders`
            endpoints return a validation error.
        customer_id:
          type: number
          format: double
        customer_message:
          type: string
          description: Message that the customer entered (number, options) -o the `Order Comments` box during checkout.
        date_created:
          type: string
          description: >-
            The date the order was created, formatted in the RFC-2822 standard. You set this attribute on Order creation
            (POST) to support the migration of historical orders. If you do not provide a value, then it will default to
            the current date/time. e.g., `Tue, 20 Nov 2012 00:00:00 +0000`. This date time is always in UTC in the api
            response.
        discount_amount:
          type: string
          description: Amount of discount for this transaction. The value can't be negative. (Float, Float-As-String, Integer)
        ebay_order_id:
          type: string
          description: >-
            If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be
            `0`.
        external_id:
          type:
            - string
            - 'null'
          description: (Read-only) The order ID in another system, such as the Amazon order ID if this is an Amazon order.
        external_merchant_id:
          type:
            - string
            - 'null'
          description: >-
            The merchant ID represents an upstream order from an external system. It is the source of truth for orders.
            After setting it, you cannot write to or update the `external_merchant_id`. For example, you can update the
            Facebook by Meta page ID in a POST request, but a PUT request to update the order will return a 400 error.
            Please remove it from your request before trying again.
        external_source:
          type:
            - string
            - 'null'
          description: >-
            This value identifies an external system that generated the order and submitted it to BigCommerce with the
            Orders API.

            * When supplying the value, we recommend combining the type of system and vendor, e.g., ERP (Acumatica) or
            POS (Square).

            * If you are migrating historical orders processed on another eCommerce platform to BigCommerce, supply the
            following code as the value: M-MIG. This code will exclude historical orders from the store’s GMV/order
            count, which factors into pricing.

            * If you do not provide a value, then it will default to null.
        geoip_country:
          type: string
          description: The full name of the country where the customer made the purchase, based on the IP.
        geoip_country_iso2:
          type: string
          description: The country where the customer made the purchase, in ISO2 format, based on the IP.
        handling_cost_ex_tax:
          type: string
          description: >-
            The value of the handling cost, excluding tax. The value can't be negative. (Float, Float-As-String,
            Integer)
        handling_cost_inc_tax:
          type: string
          description: >-
            The value of the handling cost, including tax. The value can't be negative. (Float, Float-As-String,
            Integer)
        ip_address:
          type: string
          description: >-
            IPv4 Address of the customer, if known.


            Note: You can set either `ip_address` or `ip_address_v6`. Setting the `ip_address` value will reset the
            `ip_address_v6` value and vice versa.
        ip_address_v6:
          type: string
          description: >-
            IPv6 Address of the customer, if known.


            Note: You can set either `ip_address` or `ip_address_v6`. Setting the `ip_address_v6` value will reset the
            `ip_address` value and vice versa.
        items_shipped:
          type: number
          format: double
          description: The number of items that have been shipped.
        items_total:
          type: number
          format: double
          description: The total number of items in the order.
        order_is_digital:
          type: boolean
          description: Whether this is an order for digital products.
        payment_method:
          type: string
          description: >-
            The payment method for this order. For example, `Manual`, `Credit Card`, `cash`, `Test Payment Gateway`,
            etc.
        payment_provider_id:
          $ref: '#/components/schemas/OrderSharedPaymentProviderId'
          description: >-
            The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was
            used).
        refunded_amount:
          type: string
          description: >-
            The amount refunded from this transaction; always returns `0`. The value can't be negative. (Float,
            Float-As-String, Integer)
        shipping_cost_ex_tax:
          type: string
          description: >
            The value of shipping cost, excluding tax. When specified in a POST or PUT request, the field
            `shipping_cost_inc_tax` is also required. The value can't be negative (Float, Float-As-String, Integer)
        shipping_cost_inc_tax:
          type: string
          description: >
            The value of shipping cost, including tax. When specified in a POST or PUT request, the field
            `shipping_cost_ex_tax` is also required. The value can't be negative. (Float, Float-As-String, Integer)
        staff_notes:
          type: string
          description: Any additional notes for staff.
        subtotal_ex_tax:
          type: string
          description: >-
            Override value for subtotal excluding tax. The value can't be negative. If specified, the field
            `subtotal_inc_tax` is also required. (Float, Float-As-String, Integer)
        subtotal_inc_tax:
          type: string
          description: >-
            Override value for subtotal including tax. The value can't be negative. If specified, the field
            `subtotal_ex_tax` is also required. (Float, Float-As-String, Integer)
        tax_provider_id:
          type: string
          description: |
            Read-only.
            BasicTaxProvider - Tax is set to manual and order is created in the store.

            AvaTaxProvider - Tax is set to automatic and order is created in the store. Used for Avalara.

            "" (empty string) - The order is created with the API, or the tax provider is unknown.
        customer_locale:
          type: string
          description: >
            The customer’s locale. The supported formats are:

            - 2-char lowercase characters. e.g., `en`

            - 3-char lowercase characters. e.g., `asa`

            - 5-char the language code is 2 lowercase characters and the region code is 2 uppercase characters, with `-`
            in the middle. e.g., `en-US`

            - 6-char the language code is 2 lowercase character and the region code is three digit number, with `-` in
            the middle. e.g., `es-419`
        external_order_id:
          type: string
          description: >-
            The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it,
            you can update this field using a POST or PUT request.
        total_ex_tax:
          type: string
          description: >-
            Override value for the total, excluding tax. If specified, the field `total_inc_tax` is also required. The
            value can't be negative. (Float, Float-As-String, Integer)
        total_inc_tax:
          type: string
          description: >-
            Override value for the total, including tax. If specified, the field `total_ex_tax` is also required. The
            value can't be negative. (Float, Float-As-String, Integer)
        wrapping_cost_ex_tax:
          type: string
          description: >-
            The value of the wrapping cost, excluding tax. The value can't be negative. (Float, Float-As-String,
            Integer)
        wrapping_cost_inc_tax:
          type: string
          description: >-
            The value of the wrapping cost, including tax. The value can't be negative. (Float, Float-As-String,
            Integer)
      description: Order object returned in responses.
      title: order_Resp
    billingAddress_Put:
      type: object
      properties:
        first_name:
          type: string
        last_name:
          type: string
        company:
          type: string
        street_1:
          type: string
        street_2:
          type: string
        city:
          type: string
        state:
          type: string
        zip:
          type: string
          description: The billing address must include the ZIP code. The ZIP code must be two or more characters.
        country:
          type: string
        country_iso2:
          type: string
        phone:
          type: string
        email:
          type: string
        form_fields:
          type: array
          items:
            $ref: '#/components/schemas/formFields'
      required:
        - zip
      title: billingAddress_Put
    pickupConsignmentLocation_Put:
      type: object
      properties:
        name:
          type: string
          description: The name of the pickup location.
        code:
          type: string
          description: The code of the pickup location.
        address_line_1:
          type: string
          description: Street address (first line).
        address_line_2:
          type: string
          description: Street address (second line).
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        country_alpha2:
          type: string
          description: 2-letter ISO Alpha-2 code for the country.
        email:
          type: string
          description: Pickup locationʼs email address.
        phone:
          type: string
          description: Pickup locationʼs phone number.
      title: pickupConsignmentLocation_Put
    orderCustomProduct_Put:
      type: object
      properties:
        name:
          type: string
          description: |
            Alias for name_customer. The product name that is shown to customer in storefront.
        name_customer:
          type: string
          description: The product name that is shown to customer in storefront.
        name_merchant:
          type: string
          description: The product name that is shown to the merchant in the control panel.
        quantity:
          type: integer
        price_ex_tax:
          type: number
          format: double
        price_inc_tax:
          type: number
          format: double
        sku:
          type: string
        upc:
          type: string
        id:
          type: integer
          description: ID of the product line.
      required:
        - name
        - quantity
        - price_ex_tax
        - price_inc_tax
      description: >-
        **Usage notes:**


        To `add` a custom product to an existing order, don't include `id` in the payload. You must provide a non-empty
        value for at least one of these fields: `name`, `name_customer`, or `name_merchant`.

        To `update` an order product line, `id` is required. The payload should only contain the fields that need to be
        updated. You cannot change omitted fields.


        Note the following constraints and default field values:
         - Empty strings `''` and `null` are invalid for `xxx`, `xxx_customer`, and `xxx_merchant`.
         - `name` and `name_customer` always hold the same value; updating either `name` or `name_customer` will change the value for both of those fields.
         - If both fields `name` and `name_customer` are present, they must have the same value.
         - When updating an existing order product, if you omit both fields `name` and `name_customer` from the request, they will not be updated.
         - When updating an existing order product, if you omit `name_merchant` from the request, it will not be updated.
         - When adding a product, if you omit `name_merchant`, it will be set to the value of `name` (or `name_customer`).
         - When adding a new product to an existing order, if you omit both fields `name` and `name_customer`, they will be set to the value of `name_merchant`.
      title: orderCustomProduct_Put
    OrderCatalogProductPostProductOptionsItems:
      type: object
      properties:
        id:
          type: integer
          description: >-
            Numeric ID of an option applied to the product from a list of options available to the product. This field
            has the same value as `product_option_id` when [retrieving products in an
            order](/developer/api-reference/rest/admin/management/orders/order-products/get-order-products).
        value:
          type: string
          description: >-
            Depending on the option type, value can be one of the following:

            - The variant option value id or the modifier value id for modifier types with a list of defined values,
            such as drop down or checkbox modifiers.

            - The modifier value for modifier types without a list of defined values, such as text field or date field
            modifiers.


            Notes:

            - The API does not currently support the following option types:
              - File upload
              - Pick list
            - For date modifiers use either the `YYYY-MM-DDThh:mm:ss±hh:mm` or the `YYYY-MM-DD` ISO-8601 formats. The
            date field modifier values are saved and returned as timestamps. For values entered using the YYYY-MM-DD
            format, the store timezone is used when creating the timestamp.

            - For multi-line text field modifiers, use the `\n` characters for separating the lines.
        display_name:
          type: string
          description: >-
            Alias for display_name_customer. The product option name that is shown to customer in storefront. `xxx` and
            `xxx_customer` always hold the same value, updating either `xxx` or `xxx_customer` will change value for
            both of those fields.
        display_name_customer:
          type: string
          description: >-
            The product option name that is shown to customer in storefront. `xxx` and `xxx_customer` always hold the
            same value, updating either `xxx` or `xxx_customer` will change value for both of those fields.
        display_name_merchant:
          type: string
          description: The product option name that is shown to the merchant in the control panel.
        display_value:
          type: string
          description: >-
            Alias for display_value_customer. The product option value that is shown to customer in storefront. `xxx`
            and `xxx_customer` always hold the same value, updating either `xxx` or `xxx_customer` will change value for
            both of those fields.
        display_value_merchant:
          type: string
          description: The product option value that is shown to the merchant in the control panel.
        display_value_customer:
          type: string
          description: >-
            The product option value that is shown to a customer in storefront.`xxx` and `xxx_customer` always hold the
            same value, updating either `xxx` or `xxx_customer` will change value for both of those fields.
      title: OrderCatalogProductPostProductOptionsItems
    orderCatalogProduct_Put:
      type: object
      properties:
        product_id:
          type: integer
        name:
          type: string
          description: >-
            Alias for `name_customer`. The product name that is shown to customer in storefront. `xxx` and
            `xxx_customer` always hold the same value, updating either `xxx` or `xxx_customer` will change value for
            both of those fields.
        name_customer:
          type: string
          description: >-
            The product name that is shown to customer in storefront. `xxx` and `xxx_customer` always hold the same
            value, updating either `xxx` or `xxx_customer` will change value for both of those fields.
        name_merchant:
          type: string
          description: The product name that is shown to the merchant in the control panel.
        product_options:
          type: array
          items:
            $ref: '#/components/schemas/OrderCatalogProductPostProductOptionsItems'
          description: >-
            List of product variant options and modifiers. `product_options` are required when adding a product with
            variants and not specifying the `variant_id`, or when products have mandatory modifiers.
        quantity:
          type: integer
        price_inc_tax:
          type: number
          format: double
        price_ex_tax:
          type: number
          format: double
        upc:
          type: string
        variant_id:
          type: integer
          description: Products `variant_id`. PUT or POST. This field is not available for custom products.
        wrapping_id:
          type: integer
          description: >-
            ID of the gift wrapping that will be used for this product. If provided, then `wrapping_cost_ex_tax` and
            `wrapping_cost_inc_tax` are required. When updating an order product line item, if `wrapping_id` is set to
            `0` and no other wrapping fields are provided,then the wrapping will be removed from the order product.
        wrapping_name:
          type: string
          description: >-
            If the `wrapping_id` is provided, this field will populate with the name of the gift wrapping that is to be
            used.
        wrapping_message:
          type: string
        wrapping_cost_ex_tax:
          type: number
          format: double
          description: >-
            When provided, this value should be equal to `wrapping_cost_ex_tax` times quantity to accurately reflect
            wrapping cost per unit. The value can't be negative.
        wrapping_cost_inc_tax:
          type: number
          format: double
          description: >-
            When provided, this value should be equal to `wrapping_cost_inc_tax` times quantity to accurately reflect
            wrapping cost per unit. The value can't be negative.
        id:
          type: integer
          description: >-
            The order product `id`. To add a product to an existing order, donʼt include `id` in the payload. `id` is
            required when updating an order product.
      description: |
        **Usage notes**

         To `add` a product to an existing order, don't include `id` in the payload. When adding a product with variants, `product_options` are required.
         To `update` an order product line, `id` is required. The payload should only contain the fields that need to be updated. The fields that you omit will not be changed.

         Note the following constraints and default field values:
         - `xxx` and `xxx_customer` always hold the same value. Updating either `xxx` or `xxx_customer` will change the value of both fields.
         - If both fields `xxx` and `xxx_customer` are present, they must have same value.
         - Empty strings `''` and `null` are invalid for `xxx`, `xxx_customer`, and `xxx_merchant`.
         - When updating an existing order product without changing the variant, product, or product options, requests that do not contain `xxx_merchant` will fail.
         - When updating an existing order product, requests that do not contain both fields `xxx` and `xxx_customer` will fail.
         - Empty strings `''` and `null` are invalid for `xxx`, `xxx_customer, and `xxx_merchant`. If `xxx_merchant` is omitted, it will default to have the catalog value.
         - If both fields `xxx` and `xxx_customer` are omitted from the request, they will default to the catalog value.
      title: orderCatalogProduct_Put
    orderProduct_Put:
      oneOf:
        - $ref: '#/components/schemas/orderCustomProduct_Put'
        - $ref: '#/components/schemas/orderCatalogProduct_Put'
      title: orderProduct_Put
    pickupConsignment_Put:
      type: object
      properties:
        pickup_method_display_name:
          type: string
          description: A name for the pickup method that can be displayed to shoppers.
        collection_instructions:
          type: string
          description: A message for shoppers explaining how to collect their pickup order.
        collection_time_description:
          type: string
          description: A message for shoppers indicating the estimated time their pickup order will be ready for collection.
        id:
          type: integer
          description: ID of the pickup consignment to update.
        pickup_method_id:
          type: integer
          description: ID of the pickup method.
        location:
          $ref: '#/components/schemas/pickupConsignmentLocation_Put'
        line_items:
          type: array
          items:
            $ref: '#/components/schemas/orderProduct_Put'
      required:
        - id
      title: pickupConsignment_Put
    orderConsignment_Put:
      type: object
      properties:
        pickups:
          type: array
          items:
            $ref: '#/components/schemas/pickupConsignment_Put'
      title: orderConsignment_Put
    OrderPutPaymentProviderId:
      oneOf:
        - type: string
        - type: number
          format: double
      description: The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was used).
      title: OrderPutPaymentProviderId
    OrderRemoveProductPutProductOptionsItems:
      type: object
      properties:
        cost_price_inc_tax:
          type: string
          description: >-
            The product’s cost price including tax. (Float, Float-As-String, Integer)

            The cost of your products to you; this is never shown to customers, but can be used for accounting purposes.
            The value can't be negative.
        price_ex_tax:
          type: string
          description: >-
            The products cost price excluding tax. (Float, Float-As-String, Integer)

            The cost of your products to you; this is never shown to customers, but can be used for accounting purposes.
            Read Only. The value can't be negative.
      title: OrderRemoveProductPutProductOptionsItems
    orderRemoveProduct_Put:
      type: object
      properties:
        id:
          type: integer
          description: >-
            The `id` returned from a request to the [List order
            products](/developer/api-reference/rest/admin/management/orders/order-products/get-order-products) or the
            [Get an order
            product](/developer/api-reference/rest/admin/management/orders/order-products/get-order-product) endpoint.
        product_id:
          type: integer
          description: The numeric ID of the product.
        quantity:
          type: integer
          description: The quantity of product being removed.
        product_options:
          type: array
          items:
            $ref: '#/components/schemas/OrderRemoveProductPutProductOptionsItems'
          description: >-
            List of product variant options and modifiers. `product_options` are required when removing a product with
            variants and not specifying the `variant_id`, or when products have mandatory modifiers.
      title: orderRemoveProduct_Put
    OrderPutProductsItems:
      oneOf:
        - $ref: '#/components/schemas/orderCatalogProduct_Put'
        - $ref: '#/components/schemas/orderCustomProduct_Put'
        - $ref: '#/components/schemas/orderRemoveProduct_Put'
      title: OrderPutProductsItems
    OrderPutShippingAddressesItems:
      type: object
      properties:
        id:
          type: integer
        first_name:
          type: string
        last_name:
          type: string
        company:
          type: string
        street_1:
          type: string
          description: Street address (first line).
        street_2:
          type: string
          description: Street address (second line).
        city:
          type: string
        state:
          type: string
        zip:
          type: string
          description: Zip or postal code, as a string.
        country:
          type: string
        country_iso2:
          type: string
          description: 2-letter ISO Alpha-2 code for the country.
        phone:
          type: string
          description: Recipient’s telephone number.
        email:
          type: string
          description: 'Recipient’s email address. '
        shipping_method:
          type: string
          description: Text code identifying the BigCommerce shipping module selected by the customer.
        form_fields:
          type: array
          items:
            $ref: '#/components/schemas/formFields'
      description: Shipping Address properties common to all requests and responses.
      title: OrderPutShippingAddressesItems
    OrderFeesPutType:
      type: string
      enum:
        - custom_fee
      description: The type of the fee.
      title: OrderFeesPutType
    OrderFeesPutCostExTax:
      oneOf:
        - type: string
        - type: number
          format: double
      description: The fee cost value excluding tax. (Float, Float-As-String, Integer)
      title: OrderFeesPutCostExTax
    OrderFeesPutCostIncTax:
      oneOf:
        - type: string
        - type: number
          format: double
      description: The fee cost value including tax. (Float, Float-As-String, Integer)
      title: OrderFeesPutCostIncTax
    OrderFeesPutCostTax:
      oneOf:
        - type: string
        - type: number
          format: double
      description: >-
        The tax amount on the fee cost. (Float, Float-As-String, Integer) NOTE - At least two of the following fields
        (cost_ex_tax, cost_inc_tax, and cost_tax) must be included in the request.
      title: OrderFeesPutCostTax
    orderFees_Put:
      type: object
      properties:
        id:
          type: integer
          description: The unique numeric identifier of the fees object.
        type:
          $ref: '#/components/schemas/OrderFeesPutType'
          description: The type of the fee.
        display_name_customer:
          type: string
          description: The display name of the fee targeting customers.
        display_name_merchant:
          type: string
          description: >-
            The display name of the fee targeting shoppers. NOTE - At least one of the following fields
            (display_name_customer, display_name_merchant) must be included in the request.
        source:
          type: string
          description: The source of the request.
        cost_ex_tax:
          $ref: '#/components/schemas/OrderFeesPutCostExTax'
          description: The fee cost value excluding tax. (Float, Float-As-String, Integer)
        cost_inc_tax:
          $ref: '#/components/schemas/OrderFeesPutCostIncTax'
          description: The fee cost value including tax. (Float, Float-As-String, Integer)
        cost_tax:
          $ref: '#/components/schemas/OrderFeesPutCostTax'
          description: >-
            The tax amount on the fee cost. (Float, Float-As-String, Integer) NOTE - At least two of the following
            fields (cost_ex_tax, cost_inc_tax, and cost_tax) must be included in the request.
        tax_class_id:
          type:
            - integer
            - 'null'
          description: >-
            A unique numeric identifier for the tax class. If not provided or null, the default fee tax class from the
            control panel is used.
      title: orderFees_Put
    order_Put:
      type: object
      properties:
        base_handling_cost:
          type: string
          description: The value of the base handling cost. The value can't be negative. (Float, Float-As-String, Integer)
        base_shipping_cost:
          type: string
          description: The value of the base shipping cost. The value can't be negative. (Float, Float-As-String, Integer)
        base_wrapping_cost:
          type: string
          description: >-
            The value of the base wrapping cost expressed as a floating point number to four decimal places in string
            format. The value can't be negative.
        billing_address:
          $ref: '#/components/schemas/billingAddress_Put'
        channel_id:
          type: integer
          description: >-
            Shows where the order originated. The channel_id defaults to 1. The value must match the ID of a valid and
            enabled channel. If the ID refers to a non-existing or disconnected channel, the POST and PUT `/v2/orders`
            endpoints return a validation error.
        consignments:
          $ref: '#/components/schemas/orderConsignment_Put'
        customer_id:
          type: number
          format: double
        customer_message:
          type: string
          description: Message that the customer entered (number, options) -o the `Order Comments` box during checkout.
        date_created:
          type: string
          description: >-
            The date the order was created, formatted in the RFC-2822 standard. You set this attribute on Order creation
            (POST) to support the migration of historical orders. If you do not provide a value, then it will default to
            the current date/time. e.g., `Tue, 20 Nov 2012 00:00:00 +0000`.
        default_currency_code:
          type: string
          description: >-
            A read-only field displays the currency code of the [transactional
            currency](/developer/docs/admin/store-configuration/currencies#display-vs-transactional) the shopper uses.
        discount_amount:
          type: string
          description: Amount of discount for this transaction. The value can't be negative. (Float, Float-As-String, Integer)
        order_source:
          type: string
          description: >-
            The `order_source` reflects the origin of the order. It will indicate whether the order was created by one
            of the following:

            * storefront 

            * control panel

            * manual order

            * /v2/orders API

            * Checkout API

            * or by an integration with an external platform such as Facebook by Meta or Amazon.
        ebay_order_id:
          type: string
          description: >-
            If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be
            `0`.
        external_id:
          type:
            - string
            - 'null'
          description: (Read-only) The order ID in another system, such as the Amazon Order ID if this is an Amazon order.
        external_merchant_id:
          type:
            - string
            - 'null'
          description: >-
            The merchant ID represents an upstream order from an external system. It is the source of truth for orders.
            After setting it, you cannot write to or update the `external_merchant_id`. For example, you can update the
            Facebook by Meta page ID in a POST request, but a PUT request to update the order will return a 400 error.
            Please remove it from your request before trying again.
        external_source:
          type:
            - string
            - 'null'
          description: >-
            This value identifies an external system that generated the order and submitted it to BigCommerce with the
            Orders API.

            * When supplying the value, we recommend combining the type of system and vendor, e.g., ERP (Acumatica) or
            POS (Square).

            * If you are migrating historical orders processed on another eCommerce platform to BigCommerce, supply the
            following code as the value: M-MIG. This code will exclude historical orders from the store’s GMV/order
            count, which factors into pricing. Also, this code will not affect the `total_sold` on products for imported
            orders. 

            * If you do not provide a value, then it will default to null.
        geoip_country:
          type: string
          description: The full name of the country where the customer made the purchase, based on the IP.
        geoip_country_iso2:
          type: string
          description: The country where the customer made the purchase, in ISO2 format, based on the IP.
        handling_cost_ex_tax:
          type: string
          description: >-
            The value of the handling cost, excluding tax. The value can't be negative. (Float, Float-As-String,
            Integer)
        handling_cost_inc_tax:
          type: string
          description: >-
            The value of the handling cost, including tax. The value can't be negative. (Float, Float-As-String,
            Integer)
        ip_address:
          type: string
          description: >-
            IPv4 Address of the customer, if known.


            Note: You can set either `ip_address` or `ip_address_v6`. Setting the `ip_address` value will reset the
            `ip_address_v6` value and vice versa.
        ip_address_v6:
          type: string
          description: >-
            IPv6 Address of the customer, if known.


            Note: You can set either `ip_address` or `ip_address_v6`. Setting the `ip_address_v6` value will reset the
            `ip_address` value and vice versa.
        items_shipped:
          type: number
          format: double
          description: The number of items that have been shipped.
        items_total:
          type: number
          format: double
          description: The total number of items in the order.
        order_is_digital:
          type: boolean
          description: Whether this is an order for digital products.
        payment_method:
          type: string
          description: The payment method for this order. For example, `Manual`, `Credit Card`, `Cash`,`Test Payment Gateway`, etc.
        payment_provider_id:
          $ref: '#/components/schemas/OrderPutPaymentProviderId'
          description: >-
            The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was
            used).
        products:
          type: array
          items:
            $ref: '#/components/schemas/OrderPutProductsItems'
        refunded_amount:
          type: string
          description: >-
            The amount refunded from this transaction; always returns `0`. The value can't be negative. (Float,
            Float-As-String, Integer)
        shipping_cost_ex_tax:
          type: string
          description: The value of shipping cost, excluding tax. The value can't be negative. (Float, Float-As-String, Integer)
        shipping_cost_inc_tax:
          type: string
          description: The value of shipping cost, including tax. The value can't be negative. (Float, Float-As-String, Integer)
        staff_notes:
          type: string
          description: Any additional notes for staff.
        shipping_addresses:
          type: array
          items:
            $ref: '#/components/schemas/OrderPutShippingAddressesItems'
        status_id:
          type: integer
          description: The status ID of the order.
        subtotal_ex_tax:
          type: string
          description: >-
            Override value for subtotal excluding tax. The value can't be negative. If specified, the field
            `subtotal_inc_tax` is also required. (Float, Float-As-String, Integer)
        subtotal_inc_tax:
          type: string
          description: >-
            Override value for subtotal including tax. The value can't be negative. If specified, the field
            `subtotal_ex_tax` is also required. (Float, Float-As-String, Integer)
        tax_provider_id:
          type: string
          description: |
            Read-only.
            BasicTaxProvider - Tax is set to manual and order is created in the store.

            AvaTaxProvider - Tax is set to automatic and order is created in the store. Used for Avalara.

            "" (empty string) - The order is created with the API, or the tax provider is unknown.
        customer_locale:
          type: string
          description: >
            The customer’s locale. The supported formats are:

            - 2-char lowercase characters. e.g., `en`

            - 3-char lowercase characters. e.g., `asa`

            - 5-char the language code is 2 lowercase characters and the region code is 2 uppercase characters, with `-`
            in the middle. e.g., `en-US`

            - 6-char the language code is 2 lowercase character and the region code is three digit number, with `-` in
            the middle. e.g., `es-419`
        external_order_id:
          type:
            - string
            - 'null'
          description: >-
            The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it,
            you can update this field using a POST or PUT request.
        total_ex_tax:
          type: string
          description: >-
            Override value for the total, excluding tax. If specified, the field `total_inc_tax` is also required. The
            value can't be negative. (Float, Float-As-String, Integer)
        total_inc_tax:
          type: string
          description: >-
            Override value for the total, including tax. If specified, the field `total_ex_tax` is also required. The
            value can't be negative. (Float, Float-As-String, Integer)
        wrapping_cost_ex_tax:
          type: string
          description: >-
            The value of the wrapping cost, excluding tax. The value can't be negative. (Float, Float-As-String,
            Integer)
        wrapping_cost_inc_tax:
          type: string
          description: >-
            The value of the wrapping cost, including tax. The value can't be negative. (Float, Float-As-String,
            Integer)
        fees:
          type: array
          items:
            $ref: '#/components/schemas/orderFees_Put'
      title: order_Put
    ordersCountStatus:
      type: object
      properties:
        id:
          type: integer
          description: The ID of the type of order status.
        name:
          type: string
          description: Name of the type of order status.
        system_label:
          type: string
          description: System name of the type of order status.
        custom_label:
          type: string
          description: Custom order status label given in the control panel.
        system_description:
          type: string
          description: System description of the order status.
        count:
          type: integer
          description: Number of orders that exist with this status.
        sort_order:
          type: integer
          description: The sort order of the order status from the control panel.
      title: ordersCountStatus
    ordersCount_Full:
      type: object
      properties:
        statuses:
          type: array
          items:
            $ref: '#/components/schemas/ordersCountStatus'
        count:
          type: number
          format: double
          description: Total number of orders in the store.
      title: ordersCount_Full
    OrdersGetParametersSort:
      type: string
      enum:
        - id
        - customer_id
        - date_created
        - date_modified
        - status_id
        - channel_id
        - external_id
      title: OrdersGetParametersSort
    OrdersGetParametersIncludeSchemaItems:
      type: string
      enum:
        - consignments
        - consignments.line_items
        - fees
      title: OrdersGetParametersIncludeSchemaItems
    OrdersGetParametersConsignmentStructure:
      type: string
      enum:
        - object
      title: OrdersGetParametersConsignmentStructure
    OrdersPostParametersIncludeSchemaItems:
      type: string
      enum:
        - consignments
        - consignments.line_items
        - fees
      title: OrdersPostParametersIncludeSchemaItems
    OrdersPostParametersConsignmentStructure:
      type: string
      enum:
        - object
      title: OrdersPostParametersConsignmentStructure
    billingAddress_Base:
      type: object
      properties:
        first_name:
          type: string
        last_name:
          type: string
        company:
          type: string
        street_1:
          type: string
        street_2:
          type: string
        city:
          type: string
        state:
          type: string
        zip:
          type: string
          description: The billing address must include the ZIP code. The ZIP code must be two or more characters.
        country:
          type: string
        country_iso2:
          type: string
        phone:
          type: string
        email:
          type: string
      required:
        - zip
      title: billingAddress_Base
    orderCatalogProduct_Post:
      type: object
      properties:
        product_id:
          type: integer
        name:
          type: string
          description: >-
            Alias for `name_customer`. The product name that is shown to customer in storefront. `xxx` and
            `xxx_customer` always hold the same value, updating either `xxx` or `xxx_customer` will change value for
            both of those fields.
        name_customer:
          type: string
          description: >-
            The product name that is shown to customer in storefront. `xxx` and `xxx_customer` always hold the same
            value, updating either `xxx` or `xxx_customer` will change value for both of those fields.
        name_merchant:
          type: string
          description: The product name that is shown to the merchant in the control panel.
        product_options:
          type: array
          items:
            $ref: '#/components/schemas/OrderCatalogProductPostProductOptionsItems'
          description: >-
            List of product variant options and modifiers. `product_options` are required when adding a product with
            variants and not specifying the `variant_id`, or when products have mandatory modifiers.
        quantity:
          type: integer
        price_inc_tax:
          type: number
          format: double
        price_ex_tax:
          type: number
          format: double
        upc:
          type: string
        variant_id:
          type: integer
          description: Products `variant_id`. PUT or POST. This field is not available for custom products.
        wrapping_id:
          type: integer
          description: >-
            ID of the gift wrapping that will be used for this product. If provided, then `wrapping_cost_ex_tax` and
            `wrapping_cost_inc_tax` are required. When updating an order product line item, if `wrapping_id` is set to
            `0` and no other wrapping fields are provided,then the wrapping will be removed from the order product.
        wrapping_name:
          type: string
          description: >-
            If the `wrapping_id` is provided, this field will populate with the name of the gift wrapping that is to be
            used.
        wrapping_message:
          type: string
        wrapping_cost_ex_tax:
          type: number
          format: double
          description: >-
            When provided, this value should be equal to `wrapping_cost_ex_tax` times quantity to accurately reflect
            wrapping cost per unit. The value can't be negative.
        wrapping_cost_inc_tax:
          type: number
          format: double
          description: >-
            When provided, this value should be equal to `wrapping_cost_inc_tax` times quantity to accurately reflect
            wrapping cost per unit. The value can't be negative.
      description: >
        Note:

        - `xxx` and `xxx_customer` always hold the same value, updating either `xxx` or `xxx_customer` will change value
        for both of those fields.

        - If both fields `xxx` and `xxx_customer` are present, they must have same value.

        - Empty strings `''` and `null` are invalid for `xxx` and `xxx_customer, and `xxx_merchant`.

        - `xxx`, `xxx_customer`, and `xxx_merchant` default to the value from `catalog` if not supplied in the request.
      title: orderCatalogProduct_Post
    orderCustomProduct_Post:
      type: object
      properties:
        name:
          type: string
          description: Alias for name_customer. The product name that is shown to customer in storefront.
        name_customer:
          type: string
          description: The product name that is shown to customer in storefront.
        name_merchant:
          type: string
          description: The product name that is shown to the merchant in the control panel.
        quantity:
          type: integer
        price_inc_tax:
          type: number
          format: double
        price_ex_tax:
          type: number
          format: double
        upc:
          type: string
        sku:
          type: string
      required:
        - name
        - quantity
        - price_inc_tax
        - price_ex_tax
      description: |-
        **Usage notes**

        Provide one of these fields with a non-empty value:
          - `name`
          - `name_customer`
          - `name_merchant`

        Note the following constraints and default field values:
          - Null and `''` empty strings are invalid for `name`, `name_customer`, and `name_merchant`.
          - `name` and `name_customer` always share the same value; updating one updates the other.
          - When you omit both `name` and `name_customer`, they default to the value of `name_merchant`. 
          - When you omit `name_merchant`, it defaults to the value that `name` and `name_customer` share.
      title: orderCustomProduct_Post
    OrderPostProductsItems:
      oneOf:
        - $ref: '#/components/schemas/orderCatalogProduct_Post'
        - $ref: '#/components/schemas/orderCustomProduct_Post'
      title: OrderPostProductsItems
    OrderPostShippingAddressesItems:
      type: object
      properties:
        first_name:
          type: string
        last_name:
          type: string
        company:
          type: string
        street_1:
          type: string
          description: Street address (first line).
        street_2:
          type: string
          description: Street address (second line).
        city:
          type: string
        state:
          type: string
        zip:
          type: string
          description: Zip or postal code, as a string.
        country:
          type: string
        country_iso2:
          type: string
          description: 2-letter ISO Alpha-2 code for the country.
        phone:
          type: string
          description: Recipient’s telephone number.
        email:
          type: string
          description: 'Recipient’s email address. '
        shipping_method:
          type: string
          description: Text code identifying the BigCommerce shipping module selected by the customer.
      description: Shipping Address properties common to all requests and responses.
      title: OrderPostShippingAddressesItems
    pickupConsignmentLocation_Post:
      type: object
      properties:
        name:
          type: string
          description: The name of the pickup location.
        code:
          type: string
          description: The code of the pickup location.
        address_line_1:
          type: string
          description: Street address (first line).
        address_line_2:
          type: string
          description: Street address (second line).
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        country_alpha2:
          type: string
          description: 2-letter ISO Alpha-2 code for the country.
        email:
          type: string
          description: Pickup locationʼs email address.
        phone:
          type: string
          description: Pickup locationʼs phone number.
      title: pickupConsignmentLocation_Post
    orderProduct_Post:
      oneOf:
        - $ref: '#/components/schemas/orderCustomProduct_Post'
        - $ref: '#/components/schemas/orderCatalogProduct_Post'
      title: orderProduct_Post
    pickupConsignment_Post:
      type: object
      properties:
        pickup_method_display_name:
          type: string
          description: A name for the pickup method that can be displayed to shoppers.
        collection_instructions:
          type: string
          description: A message for shoppers explaining how to collect their pickup order.
        collection_time_description:
          type: string
          description: A message for shoppers indicating the estimated time their pickup order will be ready for collection.
        pickup_method_id:
          type: integer
          description: ID of the pickup method.
        location:
          $ref: '#/components/schemas/pickupConsignmentLocation_Post'
        line_items:
          type: array
          items:
            $ref: '#/components/schemas/orderProduct_Post'
      required:
        - pickup_method_id
        - line_items
      title: pickupConsignment_Post
    orderConsignment_Post:
      type: object
      properties:
        pickups:
          type: array
          items:
            $ref: '#/components/schemas/pickupConsignment_Post'
      required:
        - pickups
      title: orderConsignment_Post
    OrderFeesPostType:
      type: string
      enum:
        - custom_fee
      description: The type of the fee.
      title: OrderFeesPostType
    OrderFeesPostCostExTax:
      oneOf:
        - type: string
        - type: number
          format: double
      description: The fee cost value excluding tax. (Float, Float-As-String, Integer)
      title: OrderFeesPostCostExTax
    OrderFeesPostCostIncTax:
      oneOf:
        - type: string
        - type: number
          format: double
      description: The fee cost value including tax. (Float, Float-As-String, Integer)
      title: OrderFeesPostCostIncTax
    OrderFeesPostCostTax:
      oneOf:
        - type: string
        - type: number
          format: double
      description: >-
        The tax amount on the fee cost. (Float, Float-As-String, Integer) NOTE - At least two of the following fields
        (cost_ex_tax, cost_inc_tax, and cost_tax) must be included in the request.
      title: OrderFeesPostCostTax
    orderFees_Post:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/OrderFeesPostType'
          description: The type of the fee.
        display_name_customer:
          type: string
          description: The display name of the fee targeting customers.
        display_name_merchant:
          type: string
          description: >-
            The display name of the fee targeting shoppers. NOTE - At least one of the following fields
            (display_name_customer, display_name_merchant) must be included in the request.
        source:
          type: string
          description: The source of the request.
        cost_ex_tax:
          $ref: '#/components/schemas/OrderFeesPostCostExTax'
          description: The fee cost value excluding tax. (Float, Float-As-String, Integer)
        cost_inc_tax:
          $ref: '#/components/schemas/OrderFeesPostCostIncTax'
          description: The fee cost value including tax. (Float, Float-As-String, Integer)
        cost_tax:
          $ref: '#/components/schemas/OrderFeesPostCostTax'
          description: >-
            The tax amount on the fee cost. (Float, Float-As-String, Integer) NOTE - At least two of the following
            fields (cost_ex_tax, cost_inc_tax, and cost_tax) must be included in the request.
        tax_class_id:
          type:
            - integer
            - 'null'
          description: >-
            A unique numeric identifier for the tax class. If not provided or null, the default fee tax class from the
            control panel is used.
      title: orderFees_Post
    order_Post:
      type: object
      properties:
        base_handling_cost:
          type: string
          description: The value of the base handling cost. The value can't be negative. (Float, Float-As-String, Integer)
        base_shipping_cost:
          type: string
          description: The value of the base shipping cost. The value can't be negative. (Float, Float-As-String, Integer)
        base_wrapping_cost:
          type: string
          description: >-
            The value of the base wrapping cost expressed as a floating point number to four decimal places in string
            format. The value can't be negative.
        channel_id:
          type: integer
          description: >-
            Shows where the order originated. The channel_id defaults to 1. The value must match the ID of a valid and
            enabled channel. If the ID refers to a non-existing or disconnected channel, the POST and PUT `/v2/orders`
            endpoints return a validation error.
        customer_id:
          type: number
          format: double
        customer_message:
          type: string
          description: Message that the customer entered (number, options) -o the `Order Comments` box during checkout.
        date_created:
          type: string
          description: >-
            The date the order was created, formatted in the RFC-2822 standard. You set this attribute on Order creation
            (POST) to support the migration of historical orders. If you do not provide a value, then it will default to
            the current date/time. e.g., `Tue, 20 Nov 2012 00:00:00 +0000`. This date time is always in UTC in the api
            response.
        discount_amount:
          type: string
          description: Amount of discount for this transaction. The value can't be negative. (Float, Float-As-String, Integer)
        order_source:
          type: string
          description: >-
            The `order_source` reflects the origin of the order. It will indicate whether the order was created by one
            of the following:

            * storefront 

            * control panel

            * manual order

            * /v2/orders API

            * Checkout API

            * or by an integration with an external platform such as Facebook by Meta or Amazon.
        ebay_order_id:
          type: string
          description: >-
            If the order was placed through eBay, the eBay order number will be included. Otherwise, the value will be
            `0`.
        external_id:
          type:
            - string
            - 'null'
          description: (Read-only) The order ID in another system, such as the Amazon order ID if this is an Amazon order.
        external_merchant_id:
          type:
            - string
            - 'null'
          description: >-
            The merchant ID represents an upstream order from an external system. It is the source of truth for orders.
            After setting it, you cannot write to or update the `external_merchant_id`. For example, you can update the
            Facebook by Meta page ID in a POST request, but a PUT request to update the order will return a 400 error.
            Please remove it from your request before trying again.
        external_source:
          type:
            - string
            - 'null'
          description: >-
            This value identifies an external system that generated the order and submitted it to BigCommerce with the
            Orders API.

            * When supplying the value, we recommend combining the type of system and vendor, e.g., ERP (Acumatica) or
            POS (Square).

            * If you are migrating historical orders processed on another eCommerce platform to BigCommerce, supply the
            following code as the value: M-MIG. This code will exclude historical orders from the store’s GMV/order
            count, which factors into pricing.

            * If you do not provide a value, then it will default to null.
        geoip_country:
          type: string
          description: The full name of the country where the customer made the purchase, based on the IP.
        geoip_country_iso2:
          type: string
          description: The country where the customer made the purchase, in ISO2 format, based on the IP.
        handling_cost_ex_tax:
          type: string
          description: >-
            The value of the handling cost, excluding tax. The value can't be negative. (Float, Float-As-String,
            Integer)
        handling_cost_inc_tax:
          type: string
          description: >-
            The value of the handling cost, including tax. The value can't be negative. (Float, Float-As-String,
            Integer)
        ip_address:
          type: string
          description: >-
            IPv4 Address of the customer, if known.


            Note: You can set either `ip_address` or `ip_address_v6`. Setting the `ip_address` value will reset the
            `ip_address_v6` value and vice versa.
        ip_address_v6:
          type: string
          description: >-
            IPv6 Address of the customer, if known.


            Note: You can set either `ip_address` or `ip_address_v6`. Setting the `ip_address_v6` value will reset the
            `ip_address` value and vice versa.
        items_shipped:
          type: number
          format: double
          description: The number of items that have been shipped.
        items_total:
          type: number
          format: double
          description: The total number of items in the order.
        order_is_digital:
          type: boolean
          description: Whether this is an order for digital products.
        payment_method:
          type: string
          description: >-
            The payment method for this order. For example, `Manual`, `Credit Card`, `cash`, `Test Payment Gateway`,
            etc.
        payment_provider_id:
          $ref: '#/components/schemas/OrderSharedPaymentProviderId'
          description: >-
            The external Transaction ID/Payment ID within this order’s payment provider (if a payment provider was
            used).
        refunded_amount:
          type: string
          description: >-
            The amount refunded from this transaction; always returns `0`. The value can't be negative. (Float,
            Float-As-String, Integer)
        shipping_cost_ex_tax:
          type: string
          description: >
            The value of shipping cost, excluding tax. When specified in a POST or PUT request, the field
            `shipping_cost_inc_tax` is also required. The value can't be negative (Float, Float-As-String, Integer)
        shipping_cost_inc_tax:
          type: string
          description: >
            The value of shipping cost, including tax. When specified in a POST or PUT request, the field
            `shipping_cost_ex_tax` is also required. The value can't be negative. (Float, Float-As-String, Integer)
        staff_notes:
          type: string
          description: Any additional notes for staff.
        status_id:
          type: integer
          description: The status ID of the order.
        subtotal_ex_tax:
          type: string
          description: >-
            Override value for subtotal excluding tax. The value can't be negative. If specified, the field
            `subtotal_inc_tax` is also required. (Float, Float-As-String, Integer)
        subtotal_inc_tax:
          type: string
          description: >-
            Override value for subtotal including tax. The value can't be negative. If specified, the field
            `subtotal_ex_tax` is also required. (Float, Float-As-String, Integer)
        tax_provider_id:
          type: string
          description: |
            Read-only.
            BasicTaxProvider - Tax is set to manual and order is created in the store.

            AvaTaxProvider - Tax is set to automatic and order is created in the store. Used for Avalara.

            "" (empty string) - The order is created with the API, or the tax provider is unknown.
        customer_locale:
          type: string
          description: >
            The customer’s locale. The supported formats are:

            - 2-char lowercase characters. e.g., `en`

            - 3-char lowercase characters. e.g., `asa`

            - 5-char the language code is 2 lowercase characters and the region code is 2 uppercase characters, with `-`
            in the middle. e.g., `en-US`

            - 6-char the language code is 2 lowercase character and the region code is three digit number, with `-` in
            the middle. e.g., `es-419`
        external_order_id:
          type: string
          description: >-
            The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it,
            you can update this field using a POST or PUT request.
        total_ex_tax:
          type: string
          description: >-
            Override value for the total, excluding tax. If specified, the field `total_inc_tax` is also required. The
            value can't be negative. (Float, Float-As-String, Integer)
        total_inc_tax:
          type: string
          description: >-
            Override value for the total, including tax. If specified, the field `total_ex_tax` is also required. The
            value can't be negative. (Float, Float-As-String, Integer)
        wrapping_cost_ex_tax:
          type: string
          description: >-
            The value of the wrapping cost, excluding tax. The value can't be negative. (Float, Float-As-String,
            Integer)
        wrapping_cost_inc_tax:
          type: string
          description: >-
            The value of the wrapping cost, including tax. The value can't be negative. (Float, Float-As-String,
            Integer)
        billing_address:
          $ref: '#/components/schemas/billingAddress_Base'
        default_currency_code:
          type: string
          description: >-
            The currency code of the transactional currency the shopper pays in is writable when multi-currency is
            enabled.
        products:
          type: array
          items:
            $ref: '#/components/schemas/OrderPostProductsItems'
        shipping_addresses:
          type: array
          items:
            $ref: '#/components/schemas/OrderPostShippingAddressesItems'
        consignments:
          $ref: '#/components/schemas/orderConsignment_Post'
        fees:
          type: array
          items:
            $ref: '#/components/schemas/orderFees_Post'
      description: Products and Billing address only required for POST operation.
      title: order_Post
    OrdersOrderIdConsignmentsGetParametersIncludeSchemaItems:
      type: string
      enum:
        - consignments.line_items
      title: OrdersOrderIdConsignmentsGetParametersIncludeSchemaItems
    OrdersOrderIdConsignmentsGetResponsesContentApplicationJsonSchemaItems:
      type: object
      properties:
        status:
          type: integer
        message:
          type: string
      title: OrdersOrderIdConsignmentsGetResponsesContentApplicationJsonSchemaItems
    ShippingQuotesBaseShippingProviderQuoteItems:
      type: object
      properties: {}
      title: ShippingQuotesBaseShippingProviderQuoteItems
    shippingQuotes_Base:
      type: object
      properties:
        id:
          type: string
          description: ID of the shipping quote.
        uuid:
          type: string
          description: UUID of the shipping quote.
        timestamp:
          type: string
          description: Time the order was created in RFC 2822 format.
        shipping_provider_id:
          type: string
          description: ID of the shipping provider.
        shipping_provider_quote:
          type: array
          items:
            $ref: '#/components/schemas/ShippingQuotesBaseShippingProviderQuoteItems'
          description: >-
            This can vary based on the shipping provider. Manual shipping methods such as fixed will return an empty
            array. Shipping providers such as UPS will return an object with the shipping information. Since the
            shipping quote is tied to a shipping address only one quote will return in the response.
        provider_code:
          type: string
          description: Code of the shipping provider.
        carrier_code:
          type: string
          description: Code of the shipping carrier.
        rate_code:
          type: string
          description: Type of delivery. This can vary based on shipping quote.
        rate_id:
          type: string
          description: This can vary based on shipping quote.
        method_id:
          type: integer
          description: Shipping method ID
      title: shippingQuotes_Base
    OrdersOrderIdConsignmentsShippingShippingConsignmentIdShippingQuotesGetResponsesContentApplicationJsonSchemaItems:
      type: object
      properties:
        status:
          type: integer
        message:
          type: string
      title: >-
        OrdersOrderIdConsignmentsShippingShippingConsignmentIdShippingQuotesGetResponsesContentApplicationJsonSchemaItems
    OrderCouponsBaseAmount:
      oneOf:
        - type: string
        - type: number
          format: double
        - type: integer
      description: >-
        Amount of the discount. This information is returned as in integer. Dollar and percentage discounts will return
        the same. For example, $3 returns as `3` while 5% will return as `5`. Check the discount type to see what type
        of discount is available.
      title: OrderCouponsBaseAmount
    OrderCouponsBaseType:
      type: string
      enum:
        - '0'
        - '1'
        - '2'
        - '3'
        - '4'
        - '5'
      description: |-
        0: per_item_discount
        1: percentage_discount
        2: per_total_discount
        3: shipping_discount
        4: free_shipping
        5: promotions
      title: OrderCouponsBaseType
    orderCoupons_Base:
      type: object
      properties:
        id:
          type: integer
          description: Numeric ID of the coupon code.
        coupon_id:
          type: integer
          description: Numeric ID of the associated coupon.
        order_id:
          type: integer
          description: Numeric ID of the associated order.
        code:
          type:
            - string
            - 'null'
          description: Coupon code, as a string.
        amount:
          $ref: '#/components/schemas/OrderCouponsBaseAmount'
          description: >-
            Amount of the discount. This information is returned as in integer. Dollar and percentage discounts will
            return the same. For example, $3 returns as `3` while 5% will return as `5`. Check the discount type to see
            what type of discount is available.
        type:
          $ref: '#/components/schemas/OrderCouponsBaseType'
          description: |-
            0: per_item_discount
            1: percentage_discount
            2: per_total_discount
            3: shipping_discount
            4: free_shipping
            5: promotions
        discount:
          type: number
          format: double
          description: >-
            The amount off the order the discount is worth. For example, if an order subtotal is $90 and the discount is
            $3 then it will return as 3.000. If the discount is

            3% then will return as 2.7000 or the amount of the order. (Float, Float-As-String, Integer)
      title: orderCoupons_Base
    OrdersOrderIdFeesGetResponsesContentApplicationJsonSchemaItems:
      type: object
      properties:
        status:
          type: integer
        message:
          type: string
      title: OrdersOrderIdFeesGetResponsesContentApplicationJsonSchemaItems
    OrdersOrderIdMessagesGetParametersStatus:
      type: string
      enum:
        - read
        - unread
      title: OrdersOrderIdMessagesGetParametersStatus
    OrderMessagesItemsCustomer:
      type: object
      properties: {}
      title: OrderMessagesItemsCustomer
    OrderMessagesItems:
      type: object
      properties:
        id:
          type: integer
        order_id:
          type: integer
        staff_id:
          type: integer
        customer_id:
          type: integer
        type:
          type: string
        subject:
          type: string
        message:
          type: string
        status:
          type: string
        is_flagged:
          type: boolean
        date_created:
          type: string
        customer:
          $ref: '#/components/schemas/OrderMessagesItemsCustomer'
      title: OrderMessagesItems
    orderMessages:
      type: array
      items:
        $ref: '#/components/schemas/OrderMessagesItems'
      title: orderMessages
    shipping_provider_standard:
      type: string
      enum:
        - auspost
        - canadapost
        - endicia
        - usps
        - fedex
        - ups
        - upsready
        - upsonline
        - shipperhq
        - royalmail
        - ''
      description: An enum identifying one of several core shipping providers.
      title: shipping_provider_standard
    shipping_provider_custom:
      type: string
      description: >-
        A string identifying the shipping provider. Some shipping providers may not be listed in the preceding enum
        list. In addition, if the carrier is a [third-party Shipping
        Provider](/developer/docs/integrations/shipping-providers), the string takes the form
        `carrier_{your_carrier_id}`.
      title: shipping_provider_custom
    OrderShipmentShippingProvider:
      oneOf:
        - $ref: '#/components/schemas/shipping_provider_standard'
        - $ref: '#/components/schemas/shipping_provider_custom'
      title: OrderShipmentShippingProvider
    shippingAddress_Base:
      type: object
      properties:
        first_name:
          type: string
        last_name:
          type: string
        company:
          type: string
        street_1:
          type: string
          description: Street address (first line).
        street_2:
          type: string
          description: Street address (second line).
        city:
          type: string
        state:
          type: string
        zip:
          type: string
          description: Zip or postal code, as a string.
        country:
          type: string
        country_iso2:
          type: string
          description: 2-letter ISO Alpha-2 code for the country.
        phone:
          type: string
          description: Recipient’s telephone number.
        email:
          type: string
          description: 'Recipient’s email address. '
      description: Shipping Address properties common to all requests and responses.
      title: shippingAddress_Base
    OrderShipmentItemsItems:
      type: object
      properties:
        order_product_id:
          type: integer
        product_id:
          type: integer
        quantity:
          type: integer
      title: OrderShipmentItemsItems
    orderShipment:
      type: object
      properties:
        id:
          type: integer
          description: Shipment ID.
        order_id:
          type: integer
          description: ID of the order associated with this shipment.
        customer_id:
          type: integer
          description: ID of this order’s customer.
        order_address_id:
          type: integer
          description: ID of the desired `shipping_address` associated with the shipment.
        date_created:
          type: string
          description: Creation date for the shipment.
        tracking_number:
          type: string
          description: Tracking number of the shipment.
        merchant_shipping_cost:
          type: string
          description: Shipping cost for the merchant.
        shipping_method:
          type: string
          description: >-
            Additional information to describe the method of shipment (ex. Standard, Ship by Weight, Custom Shipment).
            Can be used for live quotes from certain shipping providers.

            If different from `shipping_provider`, `shipping_method` should correspond to `tracking_carrier`.
        shipping_provider:
          $ref: '#/components/schemas/OrderShipmentShippingProvider'
        tracking_carrier:
          type: string
          description: >-
            Tracking carrier for the shipment.

            Acceptable values for `tracking_carrier` include an empty string (`""`) or one of the valid
            [tracking-carrier values](https://www.aftership.com/docs/tracking/others/supported-couriers).
        tracking_link:
          type: string
          description: >-
            The custom tracking link supplied on POST or PUT shipments. For the link to one of our integrated providers
            or Aftership tracking link, see the `generated_tracking_link` property.
        comments:
          type: string
          description: Comments the shipper wishes to add.
        billing_address:
          $ref: '#/components/schemas/billingAddress_Base'
        shipping_address:
          $ref: '#/components/schemas/shippingAddress_Base'
        items:
          type: array
          items:
            $ref: '#/components/schemas/OrderShipmentItemsItems'
          description: >-
            The items in the shipment. This object has the following members, all integer: order_product_id (required),
            quantity (required), product_id (read-only). A sample items value might be: [
            {"order_product_id":16,"product_id": 0,"quantity":2} ]
        shipping_provider_display_name:
          type: string
          description: The human-readable name for the `shipping_provider`.
        generated_tracking_link:
          type: string
          description: >-
            The link to one of our integrated providers or Aftership tracking link that is generated using the
            combination of either the `tracking_number` and `shipping_provider` or `tracking_number` and
            `tracking_carrier`. This will be empty if the custom `tracking_link` value is provided.
      title: orderShipment
    OrderShipmentPostShippingProvider:
      oneOf:
        - $ref: '#/components/schemas/shipping_provider_standard'
        - $ref: '#/components/schemas/shipping_provider_custom'
      title: OrderShipmentPostShippingProvider
    OrderShipmentPostItemsItems:
      type: object
      properties:
        order_product_id:
          type: integer
        quantity:
          type: integer
      title: OrderShipmentPostItemsItems
    orderShipment_Post:
      type: object
      properties:
        order_address_id:
          type: integer
          description: ID of the desired `shipping_address` associated with the shipment.
        tracking_number:
          type: string
          description: Tracking number of the shipment.
        tracking_link:
          type: string
          description: >-
            The custom tracking link supplied on POST or PUT shipments. For the link to one of our integrated providers
            or Aftership tracking link see the `generated_tracking_link` property.
        merchant_shipping_cost:
          type: string
          description: Shipping cost for the merchant.
        shipping_method:
          type: string
          description: >
            Additional information to describe the method of shipment (ex. Standard, Ship by Weight, Custom Shipment).
            Can be used for live quotes from certain shipping providers.

            If different from `shipping_provider`, `shipping_method` should correspond to `tracking_carrier`.
        shipping_provider:
          $ref: '#/components/schemas/OrderShipmentPostShippingProvider'
        tracking_carrier:
          type: string
          description: >-
            Tracking carrier for the shipment.

            Acceptable values for `tracking_carrier` include an empty string (`""`) or one of the valid
            [tracking-carrier values](https://www.aftership.com/docs/tracking/others/supported-couriers).
        comments:
          type: string
          description: Comments the shipper wishes to add.
        items:
          type: array
          items:
            $ref: '#/components/schemas/OrderShipmentPostItemsItems'
          description: >-
            The items in the shipment. This object has the following members, all integer: order_product_id (required),
            quantity (required), product_id (read-only). A sample items value might be: [
            {"order_product_id":16,"product_id": 0,"quantity":2} ]
      title: orderShipment_Post
    orderCount:
      type: object
      properties:
        count:
          type: number
          format: double
      title: orderCount
    OrderShipmentPutShippingProvider:
      oneOf:
        - $ref: '#/components/schemas/shipping_provider_standard'
        - $ref: '#/components/schemas/shipping_provider_custom'
      title: OrderShipmentPutShippingProvider
    orderShipment_Put:
      type: object
      properties:
        order_address_id:
          type: integer
          description: ID of the desired `shipping_address` associated with the shipment.
        tracking_number:
          type: string
          description: Tracking number of the shipment.
        merchant_shipping_cost:
          type: string
          description: Shipping cost for the merchant.
        shipping_method:
          type: string
          description: >
            Additional information to describe the method of shipment (ex. Standard, Ship by Weight, Custom Shipment).
            Can be used for live quotes from certain shipping providers.

            If different from `shipping_provider`, `shipping_method` should correspond to `tracking_carrier`.
        shipping_provider:
          $ref: '#/components/schemas/OrderShipmentPutShippingProvider'
        tracking_carrier:
          type: string
          description: >-
            Tracking carrier for the shipment.

            Acceptable values for `tracking_carrier` include an empty string (`""`) or one of the valid
            [tracking-carrier values](https://www.aftership.com/docs/tracking/others/supported-couriers).
        tracking_link:
          type: string
          description: >-
            The custom tracking link supplied on POST or PUT shipments. For the link to one of our integrated providers
            or Aftership tracking link see the `generated_tracking_link` property.
        comments:
          type: string
          description: Comments the shipper wishes to add.
      title: orderShipment_Put
    shippingQuotes_Resource:
      type: object
      properties:
        url:
          type: string
          description: |-
            This URL will return a 204 for shipping quotes. To return shipping quotes:
            `/shipping_addresses/shipping_address_id/shipping_quotes`
        resource:
          type: string
          description: |-
            This URL will return a 204 for shipping quotes. To return shipping quotes:
            `/shipping_addresses/shipping_address_id/shipping_quotes`
      title: shippingQuotes_Resource
    orderShippingAddress:
      type: object
      properties:
        first_name:
          type: string
        last_name:
          type: string
        company:
          type: string
        street_1:
          type: string
          description: Street address (first line).
        street_2:
          type: string
          description: Street address (second line).
        city:
          type: string
        state:
          type: string
        zip:
          type: string
          description: Zip or postal code, as a string.
        country:
          type: string
        country_iso2:
          type: string
          description: 2-letter ISO Alpha-2 code for the country.
        phone:
          type: string
          description: Recipient’s telephone number.
        email:
          type: string
          description: 'Recipient’s email address. '
        id:
          type: integer
          description: ID of this shipping address.
        order_id:
          type: integer
          description: ID of the order.
        items_total:
          type: number
          format: double
          description: The total number of items in the order.
        items_shipped:
          type: number
          format: double
          description: The number of items that have been shipped.
        base_cost:
          type: string
          description: The base value of the order’s items. (Float, Float-As-String, Integer)
        cost_ex_tax:
          type: string
          description: The value of the order’s items, excluding tax. (Float, Float-As-String, Integer)
        cost_inc_tax:
          type: string
          description: The value of the order’s items, including tax. (Float, Float-As-String, Integer)
        cost_tax:
          type: string
          description: The tax amount on the order. (Float, Float-As-String, Integer)
        cost_tax_class_id:
          type: integer
          description: 'The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)'
        base_handling_cost:
          type: string
          description: The base handling charge. The value can't be negative. (Float, Float-As-String, Integer)
        handling_cost_ex_tax:
          type: string
          description: The handling charge, excluding tax. The value can't be negative. (Float, Float-As-String, Integer)
        handling_cost_inc_tax:
          type: string
          description: The handling charge, including tax. The value can't be negative. (Float, Float-As-String, Integer)
        handling_cost_tax:
          type: string
        handling_cost_tax_class_id:
          type: integer
          description: >-
            A read-only value. Do not attempt to set or modify this value in a POST or PUT operation. (NOTE: Value
            ignored if automatic tax is enabled on the store.)
        shipping_zone_id:
          type: number
          format: double
          description: Numeric ID of the shipping zone.
        shipping_zone_name:
          type: string
          description: Name of the shipping zone.
        form_fields:
          type: array
          items:
            $ref: '#/components/schemas/formFields'
        shipping_quotes:
          $ref: '#/components/schemas/shippingQuotes_Resource'
        shipping_method:
          type: string
          description: Text code identifying the BigCommerce shipping module selected by the customer.
      title: orderShippingAddress
    shippingAddress_Put:
      type: object
      properties:
        first_name:
          type: string
        last_name:
          type: string
        company:
          type: string
        street_1:
          type: string
          description: Street address (first line).
        street_2:
          type: string
          description: Street address (second line).
        city:
          type: string
        state:
          type: string
        zip:
          type: string
          description: Zip or postal code, as a string.
        country:
          type: string
        country_iso2:
          type: string
          description: 2-letter ISO Alpha-2 code for the country.
        phone:
          type: string
          description: Recipient’s telephone number.
        email:
          type: string
          description: 'Recipient’s email address. '
        shipping_method:
          type: string
          description: Text code identifying the BigCommerce shipping module selected by the customer.
        form_fields:
          type: array
          items:
            $ref: '#/components/schemas/formFields'
      description: Shipping Address properties common to all requests and responses.
      title: shippingAddress_Put
    OrdersOrderIdShippingAddressesIdPutResponsesContentApplicationJsonSchemaItems:
      type: object
      properties:
        status:
          type: integer
        message:
          type: string
      title: OrdersOrderIdShippingAddressesIdPutResponsesContentApplicationJsonSchemaItems
    orderStatus_Base:
      type: object
      properties:
        id:
          type: integer
          description: The ID of the type of order status.
        name:
          type: string
          description: Name of the type of order status.
        system_label:
          type: string
          description: System name of the type of order status.
        custom_label:
          type: string
          description: Custom order status label given in the control panel.
        system_description:
          type: string
          description: System description of the order status.
      title: orderStatus_Base
    OrderTaxesBaseLineItemType:
      type: string
      enum:
        - item
        - shipping
        - handling
        - gift-wrapping
      description: Type of tax on item.
      title: OrderTaxesBaseLineItemType
    orderTaxes_Base:
      type: object
      properties:
        id:
          type: integer
          description: The unique numeric identifier of the taxes object.
        order_id:
          type: integer
          description: >-
            The unique numeric identifier of the order to which the tax was applied. NOTE: Not included if the store was
            using the automatic tax feature.
        order_address_id:
          type: integer
          description: >-
            The unique numeric identifier of the order address object associated with the order. NOTE: Not included if
            the store was using the automatic tax feature.
        tax_rate_id:
          type: integer
          description: The unique numeric identifier of the tax rate. This field has been deprecated, use sales_tax_id instead.
        sales_tax_id:
          type: string
          description: A unique identifier for the applied tax rate. This may be a third-party tax provider's identifier.
        tax_class_id:
          type:
            - integer
            - 'null'
          description: >-
            A unique numeric identifier for the tax class. If not provided or null, the default fee tax class from the
            control panel is used.
        name:
          type: string
          description: The name of the tax class object.
        class:
          type: string
          description: >-
            The name of the type of tax that was applied. NOTE: It will be "Automatic Tax" if automatic tax was enabled.
            It will be "API Tax Override" if the order was created with V2 Orders API.
        rate:
          type: string
          description: The tax rate.  The priority order in which the tax is applied (Float, Float-As-String, Integer)
        priority:
          type: number
          format: double
          description: The order in which the tax is applied.
        priority_amount:
          type: string
          description: The amount of tax calculated on the order. (Float, Float-As-String, Integer)
        line_amount:
          type: string
          description: (Float, Float-As-String, Integer)
        order_pickup_method_id:
          type: number
          format: double
          description: The ID of the order pickup method object (which contains pickup location details) associated with the order.
        order_product_id:
          type: string
          description: >-
            If the `line_item_type` is `item` or `handling` then this field will be the order product id. Otherwise the
            field will return as null.
        line_item_type:
          $ref: '#/components/schemas/OrderTaxesBaseLineItemType'
          description: Type of tax on item.
      title: orderTaxes_Base
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        ### OAuth scopes


        | UI Name | Permission | Parameter |

        |:--------|:-----------|:----------|

        |  Orders | modify | `store_v2_orders` |

        |  Orders | read-only | `store_v2_orders_read_only` |


        ### Authentication header


        | Header | Argument | Description |

        |:-------|:---------|:------------|

        | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to
        API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |


        ### Further reading


        For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example
        Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).


        For more about BigCommerce OAuth scopes, see our [Guide to API
        Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).


        For a list of API status codes, see [API Status
        Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
