Orders

Create Order

Create a new fulfillment order. This will automatically create a new order in Roastify with a 'Created' status.

post/v1/orders

Request

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

Headers

Idempotency-Keystring

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

Example:123e4567-e89b-12d3-a456-426614174000

Request body

externalSourceIdstring nullable

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

Example request

{
  "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
    }
  ]
}

Response

Succesful order. Returns the orderId of the new order

orderIdstring required

Changes

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