Authorizations
The API key to authenticate requests provided by Roastify. A Base or Pro plan is required to use the API.
Headers
The idempotency key to use for the request (V4 UUID recommended)
"123e4567-e89b-12d3-a456-426614174000"
Body
Recipient information
List of items in the order
1
Your external source ID. This is an optional field that can be used to map orders from your system to Roastify.
"your-order-123"
Optional return address. If not provided, uses the Roastify default distribution center address.
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
.
{
"carrier": "USPS",
"priority": "GroundAdvantage"
}
Response
Succesful order. Returns the orderId of the new order