POST
/
v1
/
orders
curl --request POST \
  --url https://api.roastify.app/v1/orders \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "toAddress": {
    "name": "<string>",
    "company": "<string>",
    "street1": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zip": "<string>",
    "phone": "<string>",
    "email": "<string>"
  },
  "items": [
    {
      "sku": "COF-WHB-12O-COL-BOX",
      "artworkUrl": "https://storage.roastify.app/mockup-images/a045d749-8372-44a0-aga3-098688ab6ad2.jpeg",
      "quantity": 3
    }
  ]
}'
{
  "orderId": "<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.

Headers

​
Idempotency-Key
string

The idempotency key to use for the request (V4 UUID recommended)

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json

Response

201
application/json

Succesful order. Returns the orderId of the new order

The response is of type object.