Create order

Create a new e-commerce order.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Create a new order for e-commerce products. The order will include the specified SKUs and process payment from the customer.

Example: Create an order when a customer completes checkout with multiple items in their cart.


Conditional Requirements

ConditionRequired Fields
Alwaysuser_id, items, items.*.sku_id, items.*.quantity
Any SKU has shippable product OR account has taxes enabled for e-commerceaddress_id OR address.* fields
address_id not provided AND address is requiredaddress.first_name, address.last_name, address.line1, address.city, address.country, address.postal_code, address.state (unless country=GB)
Query Params
int32
required

The unique identifier of the site associated with your account.

int32
required

The unique identifier of the customer.

int32

The unique identifier of the payment method.

items
array of objects

A list of items being part of the order.

items
string

Optional coupon code to apply to order. Must be a valid coupon code of type ecommerce and of duration once.

int32

The unique identifier of the shipping address. Required if any product are shippable and if address is not provided.

address
object

The shipping address to associate with the order. Required if any product are shippable and if address_id is not provided.

int32

Optional campaign key identifier.

string

Optional campaign key.

Headers
string
required
Defaults to Bearer eyJ***
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json