Skip to main content
GET
/
v1
/
orders
/
{orderId}
Get Order
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>",
    "street1": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zip": "<string>",
    "email": "<string>",
    "company": "<string>",
    "street2": "<string>",
    "phone": "<string>"
  },
  "items": [
    {
      "sku": "COF-WHB-12O-COL-BOX",
      "artworkUrl": "https://storage.roastify.app/mockup-images/a045d749-8372-44a0-aga3-098688ab6ad2.jpeg",
      "quantity": 3,
      "externalSourceId": "your-line-item-456"
    }
  ],
  "externalSourceId": "your-order-123",
  "returnAddress": {
    "name": "<string>",
    "street1": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zip": "<string>",
    "email": "<string>",
    "company": "<string>",
    "street2": "<string>",
    "phone": "<string>"
  },
  "shipping": {
    "carrier": "USPS",
    "priority": "GroundAdvantage"
  }
}

Authorizations

​
x-api-key
string
header
required

The API key to authenticate requests provided by Roastify. A Base or Pro plan is required to use the API.

Path Parameters

​
orderId
string
required

The Id of the order

Minimum string length: 1
Example:

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

Response

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

​
toAddress
object
required

Recipient information

​
items
object[]
required

List of items in the order

Minimum array length: 1
​
externalSourceId
string | null

Your external source ID. This is an optional field that can be used to map orders from your system to Roastify.

Example:

"your-order-123"

​
returnAddress
object

Optional return address. If not provided, uses the Roastify default distribution center address.

​
shipping
object

Optional shipping information. This is only required for API users with custom shipping integrations with Roastify. Carrier and Priority need to be camelCase or PascalCase.

Example:
{
  "carrier": "USPS",
  "priority": "GroundAdvantage"
}