- API Reference - Orders
- Update order metadata
API Reference - Orders
Update order metadata
POST
/api/v2/orders/{public_id}/
public_id*
curl --request POST \
--url https://app.spotdx.com/api/v2/orders/{public_id}/ \
Parameters
public_idRequired
string
The ID of the order to retrieve.
Body
metadata
object
The metadata to replace the existing metadata with.
Response
order_id
string
The unique identifier of the order.
status
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
array
created
string
The date and time the order was created.
updated
string
The date and time the order was last updated.
metadata
object
An optional dictionary of key-value pairs stored with the order.
curl --request POST \
--url https://app.spotdx.com/api/v2/orders/{public_id}/ \