API Reference - Orders
Create order
API Reference - Orders
Create order
Create an order for delivering kits to a client, which will be created with a status of ‘pending’.The order will be created with the user making the request as the ‘placed_by’ user.
POST
/
api
/
v2
/
orders
/
Authorizations
Authorization
string
headerrequiredToken-based authentication with required prefix "Token"
Body
kit_types
string[]
requiredA list of all the kit types to place in the order.
recipient
object
requiredmetadata
object | null
An optional dictionary of key-value pairs stored with the order.
Response
201 - application/json
order_id
string
The unique identifier of the order.
created
string
status
enum<string>
Available options:
pending, in_progress, completed, canceled recipient
object
kit_types
string[]
A list of the kit types that are included in this order.
kits
object[]
metadata
object | null
An optional dictionary of key-value pairs stored with the order.