GET
/
v1
/
orders
/
{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,
  "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
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

The API key to authenticate requests provided by Roastify. If you do not have an API key, please contact [email protected]

Path Parameters

​
orderId
string
required

The Id of the order

Minimum length: 1
Example:

"1ef87e47-266e-466f-ab06-a64994aefbb0"

Response

200
application/json
Get an order by orderId
​
orderId
string
required

Object ID

​
createdAt
string
required

Created at

​
updatedAt
string
required

Updated at

​
orderStatus
enum<string>
required

Order status

Available options:
Created,
Picked,
Printed,
Packaged,
Shipped,
Canceled,
CancelationRequested,
Declined
Example:

"Created"

​
isTest
boolean
required

Whether this is a test order

Example:

false

​
retailCosts
object
required

Retail costs

​
toAddress
object
required

Recipient information

​
items
object[]
required

List of items in the order