Get All Orders

Get All Orders

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,
      "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"
      }
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "endCursor": "<string>"
  }
}

GET

orders

Get All Orders

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,
      "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"
      }
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "endCursor": "<string>"
  }
}

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.

Query Parameters

cursor

string

The cursor to start from. This is the orderId of the last order in the previous page. This can also be found in the endCursor property of the previous page's response.

Example:

"5a441254-e4b7-43af-98a3-e9012cff7feb"

pageSize

string

The number of results to return. Defaults to 20 and maximum is 100

Example:

"10"

Response

Get all fulfillment orders

orders

object[]

required

Show child attributes

orders.orderId

string

required

Object ID

orders.createdAt

string

required

Created at

orders.updatedAt

string

required

Updated at

orders.orderStatus

enum<string>

required

Order status

Available options:

Created,

Picked,

Printed,

Packaged,

Shipped,

Canceled,

CancelationRequested,

Declined

Example:

"Created"

orders.isTest

boolean

required

Whether this is a test order

Example:

false

orders.toAddress

object

required

Recipient information

Show child attributes

orders.toAddress.name

string

required

Recipient name

Minimum string length: 1

orders.toAddress.street1

string

required

Address line 1

Minimum string length: 1

orders.toAddress.city

string

required

City

Minimum string length: 1

orders.toAddress.state

string

required

State

Minimum string length: 1

orders.toAddress.country

string

required

Country

Minimum string length: 1

orders.toAddress.zip

string

required

ZIP code

Minimum string length: 1

orders.toAddress.email

string

required

Email address

Minimum string length: 1

orders.toAddress.company

string | null

Company name

orders.toAddress.street2

string | null

Address line 2

orders.toAddress.phone

string | null

Phone number

orders.items

object[]

required

List of items in the order

Minimum array length: 1

Show child attributes

orders.items.sku

string

required

SKU is required and tells Roastify the specific product and coffee blend of your line item.

Example:

"COF-WHB-12O-COL-BOX"

orders.items.artworkUrl

string

required

The url to a hosted image containing the line item's artwork. Be sure the image resolution matches the product specs exactly!

Example:

"https://storage.roastify.app/mockup-images/a045d749-8372-44a0-aga3-098688ab6ad2.jpeg"

orders.items.quantity

number

required

Must be a number greater than 0

Required range: x >= 1

Example:

3

orders.items.externalSourceId

string | null

Your external source ID for this line item. This is an optional field that can be used to map line items from your system to Roastify.

Example:

"your-line-item-456"

orders.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"

orders.returnAddress

object

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

Show child attributes

orders.returnAddress.name

string

required

Return address name

Minimum string length: 1

orders.returnAddress.street1

string

required

Address line 1

Minimum string length: 1

orders.returnAddress.city

string

required

City

Minimum string length: 1

orders.returnAddress.state

string

required

State

Minimum string length: 1

orders.returnAddress.country

string

required

Country

Minimum string length: 1

orders.returnAddress.zip

string

required

ZIP code

Minimum string length: 1

orders.returnAddress.email

string

required

Email address

Minimum string length: 1

orders.returnAddress.company

string | null

Company name

orders.returnAddress.street2

string | null

Address line 2

orders.returnAddress.phone

string | null

Phone number

orders.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.

Show child attributes

orders.shipping.carrier

string

required

Shipping carrier

Minimum string length: 1

Example:

"USPS"

orders.shipping.priority

string

required

Shipping priority

Minimum string length: 1

Example:

"Priority"

Example:

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

pageInfo

object

required

Show child attributes

pageInfo.hasNextPage

boolean

required

pageInfo.endCursor

string | null

Get Stock By SKU Create Order

⌘I

Catalog

Variants

Stock

Orders

Transactions

Artwork

Products

Authorizations

Query Parameters

Response