Get All Orders
Get all fulfillment orders for a service integration store.
curl --request GET \
--url https://api.roastify.app/v1/orders \
--header 'x-api-key: <api-key>'{
"orders": [
{
"orderId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"orderStatus": "Created",
"isTest": false,
"retailCosts": {
"currency": "usd",
"subtotal": 2500,
"discount": 100,
"tax": 150,
"total": 2900
},
"toAddress": {
"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://acme-aws-s3.com/designs/12oz-coffee-box-artwork.png",
"quantity": 3
}
]
}
],
"pageInfo": {
"endCursor": "<string>",
"hasNextPage": true
}
}Authorizations
The API key to authenticate requests provided by Roastify. If you do not have an API key, please contact [email protected]
Response
Object ID
Created at
Updated at
Order status
Created, Picked, Printed, Packaged, Shipped, Canceled, CancelationRequested, Declined "Created"
Whether this is a test order
false
Retail costs
Currency type
USD, usd "usd"
Subtotal amount (in cents)
2500
Discount amount (in cents)
100
Tax amount (in cents)
150
Total amount (in cents)
2900
Recipient information
Recipient name
1Address line 1
1City
1State
1Country
1ZIP code
1Email address
1Company name
Address line 2
Phone number
List of items in the order
SKU is required and tells Roastify the specific product and coffee blend of your line item.
"COF-WHB-12O-COL-BOX"
The url to a hosted image containing the line item's artwork. Be sure the image resolution matches the product specs exactly!
"https://acme-aws-s3.com/designs/12oz-coffee-box-artwork.png"
Must be a number greater than 0
x >= 13
curl --request GET \
--url https://api.roastify.app/v1/orders \
--header 'x-api-key: <api-key>'{
"orders": [
{
"orderId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"orderStatus": "Created",
"isTest": false,
"retailCosts": {
"currency": "usd",
"subtotal": 2500,
"discount": 100,
"tax": 150,
"total": 2900
},
"toAddress": {
"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://acme-aws-s3.com/designs/12oz-coffee-box-artwork.png",
"quantity": 3
}
]
}
],
"pageInfo": {
"endCursor": "<string>",
"hasNextPage": true
}
}