Recipes.

Step-by-step walkthroughs that combine a few endpoints to do something concrete: place an order, fulfill it, book a shipment. Each recipe is self-contained: the cURL commands and JSON payloads run end-to-end without you needing to consult the API reference for every field.

Updated May 31, 20261 min read

These recipes follow the order lifecycle — place an order, fulfill it, ship it, track it. We're starting with a small, curated set of the flows we're most confident about, with more recipes on the way.

If you'd rather understand the model first, start in Platform. If you'd rather do it in the Dashboard than via API, see How-to. If you're using the API from an LLM agent, see MCP.

Getting started

Get API credentials Make your first API call

Order

Place a home delivery order Place a click-and-collect order Place an order with a delivery option Place an order with multiple fulfillment orders

Fulfillment

Split a fulfillment order Fulfill a fulfillment order

Shipping

Book a shipment Draft then confirm a shipment Fix or reassign a shipment Ship cross-border Track pre-booked shipments Cancel a shipment

Prerequisites for every recipe

All Carriyo API calls share the same authentication shape:

tenant-id header: your Carriyo tenant id.
x-api-key header: the tenant's API key.
Authorization: Bearer <access_token> header: an OAuth access token minted from your client credentials.

Get those from the Dashboard once and reuse across recipes. See Get API credentials for the one-time setup, and Make your first API call for the OAuth-token exchange.

The base URLs:

Production: https://api.carriyo.com
Demo: https://demo-api.carriyo.com

Every recipe assumes those headers are set; the cURL examples show them on the first call and reference $AUTH_HEADERS in subsequent calls for brevity.