API Reference - Orders
Update order metadata
API Reference - Orders
Update order metadata
Replace the metadata for an order with a new set of values
POST
/
api
/
v2
/
orders
/
{public_id}
/
Authorizations
Authorization
string
headerrequiredToken-based authentication with required prefix "Token"
Path Parameters
public_id
string
requiredThe ID of the order to retrieve.
Body
application/json
metadata
object
The metadata to replace the existing metadata with.
Response
200 - application/json
order_id
string
The unique identifier of the order.
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[]
created
string
The date and time the order was created.
updated
string
The date and time the order was last updated.
metadata
object | null
An optional dictionary of key-value pairs stored with the order.