BigCommerce Checkout Orders API

openapi: 3.2.0
info:
  title: BigCommerce Checkouts Checkout Orders API
  description: 'For more information on authenticating BigCommerce APIs, see [Authentication](/docs/start/authentication).


    Create and manage checkouts from existing carts using BigCommerce checkout logic.'
  version: '3.0'
  termsOfService: http://www.bigcommerce.com/terms
  contact:
    name: BigCommerce
    url: https://www.bigcommerce.com
    email: support@bigcommerce.com
servers:
- url: https://api.bigcommerce.com/stores/{store_hash}/v3
  variables:
    store_hash:
      default: store_hash
      description: Permanent ID of the BigCommerce store.
  description: BigCommerce API Gateway
security:
- X-Auth-Token: []
tags:
- name: Checkout Orders
paths:
  /checkouts/{checkoutId}/orders:
    post:
      tags:
      - Checkout Orders
      summary: BigCommerce Create an Order
      description: 'Creates an order.


        ## Usage notes

        * Orders created will be set to incomplete order status.

        * You can create as many orders from the same order (cart) as you want.

        * Order duplication copies the existing order, assigns a new order number, and sets the new order status to `incomplete`.

        * Once the order is paid, the cart is deleted.

        * Cart deletion occurs if you are using BigCommerce to accept payments on orders.'
      operationId: createOrder
      parameters:
      - $ref: '#/components/parameters/checkoutId'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/Content-Type'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Order'
                  meta:
                    $ref: '#/components/schemas/MetaOpen'
              example:
                data:
                  id: 75
                meta: {}
components:
  schemas:
    MetaOpen:
      title: Response meta
      type: object
      properties: {}
      additionalProperties: true
      description: Response metadata.
    Order:
      title: Order
      type: object
      properties:
        id:
          type: integer
          description: The order ID.
          example: 75
      x-internal: false
  parameters:
    Accept:
      name: Accept
      in: header
      required: true
      description: The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.
      schema:
        type: string
        default: application/json
    Content-Type:
      name: Content-Type
      in: header
      required: true
      description: The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.
      schema:
        type: string
        default: application/json
    checkoutId:
      name: checkoutId
      in: path
      description: ID of the checkout; the same as the cart ID.
      required: true
      schema:
        type: string
  securitySchemes:
    X-Auth-Token:
      name: X-Auth-Token
      description: '### OAuth scopes


        | UI Name | Permission | Parameter |

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

        |  Checkouts | modify | `store_checkouts` |

        |  Checkouts | read-only | `store_checkouts_read_only` |

        |  Checkout Content | modify | `store_checkout_content` |

        |  Checkout Content | read-only | `store_checkout_content_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](/docs/start/authentication/api-accounts). |


        ### Further reading


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


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


        For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes).'
      type: apiKey
      in: header