<- Orders API

Orders API

Create order

POST

 /v2/orders

Creates a new order that can include information about products for purchase and settings to apply to the purchase.

To pay for a created order, see Pay for Orders.

You can modify open orders using the UpdateOrder endpoint.

Permissions:ORDERS_WRITE

Guide

Create Orders

Try in API Explorer
Link to section

Request body

Example code

Link to section

order

The order to create. If this field is set, the only other top-level field that can be set is the idempotency_key.

Link to section

idempotency_key

string

A value you specify that uniquely identifies this order among orders you have created.

If you are unsure whether a particular order was created successfully, you can try it again with the same idempotency key without worrying about creating duplicate orders.

For more information, see Idempotency.

Max Length
192
Link to section

Response fields

Link to section

order

The newly created order.

Link to section

errors

Any errors that occurred during the request.