Docs
Management API
Checkout Orders

Checkouts

Create an Order

POST /checkouts/{checkoutId}/orders

Request

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.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • checkoutId in path - string
    required

    ID of the checkout; the same as the cart ID.

  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Response

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

example

Did you find what you were looking for?