Skip to navigation
RESTAdminManagementCheckoutsOrders

Create Order

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

OAuth scopes

UI NamePermissionParameter
Checkoutsmodifystore_checkouts
Checkoutsread-onlystore_checkouts_read_only
Checkout Contentmodifystore_checkout_content
Checkout Contentread-onlystore_checkout_content_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Path parameters

checkoutIdstringRequired

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

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Response

OK
dataobjectOptional
metaobjectOptional
Response metadata.