curl --request GET \
--url https://api.roastify.app/v1/orders/{orderId} \
--header 'x-api-key: <api-key>'
{
"orderId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"orderStatus": "Created",
"isTest": false,
"toAddress": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zip": "<string>",
"phone": "<string>",
"email": "<string>"
},
"returnAddress": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zip": "<string>",
"phone": "<string>",
"email": "<string>"
},
"items": [
{
"sku": "COF-WHB-12O-COL-BOX",
"artworkUrl": "https://storage.roastify.app/mockup-images/a045d749-8372-44a0-aga3-098688ab6ad2.jpeg",
"quantity": 3
}
]
}
Get an order by orderId
curl --request GET \
--url https://api.roastify.app/v1/orders/{orderId} \
--header 'x-api-key: <api-key>'
{
"orderId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"orderStatus": "Created",
"isTest": false,
"toAddress": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zip": "<string>",
"phone": "<string>",
"email": "<string>"
},
"returnAddress": {
"name": "<string>",
"company": "<string>",
"street1": "<string>",
"street2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zip": "<string>",
"phone": "<string>",
"email": "<string>"
},
"items": [
{
"sku": "COF-WHB-12O-COL-BOX",
"artworkUrl": "https://storage.roastify.app/mockup-images/a045d749-8372-44a0-aga3-098688ab6ad2.jpeg",
"quantity": 3
}
]
}
The API key to authenticate requests provided by Roastify. A Base or Pro plan is required to use the API.
The Id of the order
1
"1ef87e47-266e-466f-ab06-a64994aefbb0"
Get an order by orderId
The response is of type object
.