Orders

Get All Orders

Get all fulfillment orders for a service integration store.

get/v1/orders

Request

  • Base URL: https://api.roastify.app
  • URL: https://api.roastify.app/v1/orders
  • Auth: API key in header x-api-key

Query parameters

cursorstring

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
pageSizestring

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

Example:10

Response

Get all fulfillment orders

Example response

{
  "orders": [
    {
      "orderStatus": "Created",
      "externalSourceId": "your-order-123",
      "shipping": {
        "carrier": "USPS",
        "priority": "GroundAdvantage"
      },
      "items": [
        {
          "externalSourceId": "your-line-item-456",
          "sku": "COF-WHB-12O-COL-BOX",
          "artworkUrl": "https://storage.roastify.app/mockup-images/a045d749-8372-44a0-aga3-098688ab6ad2.jpeg",
          "quantity": 3
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.