GET
/
v1
/
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>",
        "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>"
      },
      "shipping": {
        "carrier": "USPS",
        "priority": "GroundAdvantage"
      },
      "items": [
        {
          "sku": "COF-WHB-12O-COL-BOX",
          "artworkUrl": "https://storage.roastify.app/mockup-images/a045d749-8372-44a0-aga3-098688ab6ad2.jpeg",
          "quantity": 3
        }
      ]
    }
  ],
  "pageInfo": {
    "endCursor": "<string>",
    "hasNextPage": true
  }
}

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

200
application/json

Get all fulfillment orders

The response is of type object.