Orders

Get Order

Get an order by orderId

get/v1/orders/{orderId}

Request

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

Path parameters

orderIdstring required

The Id of the order

Example:1ef87e47-266e-466f-ab06-a64994aefbb0

Response

Get an order by orderId

orderIdstring required

Object ID

createdAtstring required

Created at

updatedAtstring required

Updated at

orderStatus'Created' | 'Picked' | 'Printed' | 'Packaged' | 'Shipped' | 'Canceled' | 'CancelationRequested' | 'Declined' required

Order status

isTestboolean required

Whether this is a test order

externalSourceIdstring nullable

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

Example response

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