API reference

Checkout API

Pre-purchase endpoints for showing live shipping options at customer checkout. Use the shipping-rates endpoint to fetch carrier rates for a given route, and the delivery-options endpoint to fetch the curated options configured for the merchant. Neither call creates a shipment.

Serverhttps://api.carriyo.comAuthOAuth 2.0 + API KeySpeccheckout.yaml

Checkout

Real-time rate and delivery-option lookups used at the customer checkout step. Stateless: no shipment is created by these calls.

These endpoints are typically called by storefront frontends or headless commerce middleware, and handle higher request volume than the per-shipment management endpoints.

2 operations · 0 objects

post/checkout/shipping-rates

Get shipping rates

Returns live shipping rates from eligible carriers for a future shipment. Stateless: no shipment is created.

Headers

Name	Value	Required	Description
Authorization	Bearer YOUR-ACCESS-TOKEN	Yes	OAuth 2.0 bearer token obtained from `POST /oauth/token`.
x-api-key	YOUR-API-KEY	Yes	Your tenant's API key, issued in the Carriyo Dashboard. Required on every request except `POST /oauth/token`.
tenant-id	YOUR-TENANT-ID	Yes	Your Carriyo tenant ID, shown in the Carriyo Dashboard. Required on every request except `POST /oauth/token`.
Content-Type	application/json	Yes	Media type of the request body.

Request body

Content type: application/jsonSchema: shipping-rates-requestrequired

merchantstring
ID of the merchant
entity_typestring
Values:FORWARDREVERSE
carrier_accountscarrier-account-request[]
List of carrier accounts for which shipping rate is requested.
paymentpayment-request
Payment details including the total value of the shipment and any pending Cash on Delivery amount.
customscustoms-object
Customs declaration details such as total declared value.
collectioncollection-object
Collection details chosen for the shipment, such as scheduled collection date.
deliverydelivery-object
Delivery details chosen for the shipment, such as chosen delivery type and scheduled delivery date.
pickuplocation-request | shipping-rate-location-requestrequired
Pickup address for the shipment. You can either pass a free-form address or a predefined location. For forward shipments, you must pass a predefined pickup location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (partner_location_id), or your own location code (partner_location_code) as defined when you created the location in Carriyo. For reverse shipments, you can pass the customer's pickup address as a free-form pickup address.
dropoffshipping-rate-location-request | location-requestrequired
Dropoff address for the shipment. You can either pass a free-form address or a predefined location. For forward shipments, you can pass the customer's dropoff address as a free-form address. For reverse shipments, you must pass a predefined dropoff location. Carriyo will copy the contact and address fields from the specified location. To specify the location, you can use Carriyo's internal location ID (partner_location_id), or your own location code (partner_location_code) as defined when you created the location in Carriyo.
itemsshipping-rate-item-request[]
List of individual items or SKUs in a shipment.
parcelsshipping-rate-parcel-request[]required
(One of parcels or freight required) List of parcels in a B2C shipment.
freightobject
(One of parcels or freight required) List of packages of type pallet or carton in a B2B shipment.
custom_attributescustom-attributes
Custom attributes in the form of a map: {"attribute1" : ["value1", "value2"], "attribute2" : ["value1", "value2"]} Please Note: You can only use custom attributes if you are subscribed to this feature.

Responses

200Shipping rates from eligible carriers for the requested shipment.Schema: shipping-rates-response

shipping_ratesshipping-rate[]

Need the full machine-readable spec? Download the OpenAPI document →

post/checkout/delivery-options

Get delivery options

Returns the delivery options that match the supplied cart or order details at checkout time.

Delivery options are configured per merchant in the Carriyo dashboard. Each option declares the carrier account that fulfils it, a shipping fee, an estimated delivery window, and a set of optional conditions. This endpoint evaluates the configured conditions against the order details you supply inline and returns the matching options, typically rendered to the shopper as the delivery choices on the checkout page.

Both DELIVERY and COLLECTION options can be returned. The shopper has not chosen between them at this point, so customer represents where the customer is, not where the order is being delivered. For DELIVERY options the customer's location is also the delivery destination; for COLLECTION options it's used to find applicable collection points.

Supplying order details

Pass the order details inline in the request body. Only merchant is required; populate the remaining fields based on which conditions the merchant has configured. This endpoint does not look up existing orders; all order data must be provided directly in the request.

Restricting by delivery method

Pass delivery_methods to limit the response to only the methods you can render. For example, send ["DELIVERY"] from a storefront that doesn't support pickup points, or ["COLLECTION"] from a click-and-collect locator screen. Omit the field to receive all matching methods.

What gets evaluated

Each condition only applies when the merchant has configured it on a delivery option. The corresponding order field is read only if such a condition exists, so callers only need to populate the fields relevant to the rules in use.

| Condition (configured on the option) | Evaluated against |

|---|---|

| Working days / blackout days | order_date (defaults to now); timezone derived from customer.country |

| Customer geography | customer.{country, state, city, area} |

| Order value range | payment.order_total |

| Weight range | Sum of line_items[].weight (converted to kg) |

| Payment type | Derived: CASH_ON_DELIVERY if payment.payment_on_delivery > 0, otherwise PRE_PAID |

| Fulfillment location | fulfillment_locations[]. Pass one or more candidate fulfillment locations. An option matches if at least one of the supplied locations is in the option's allowlist (or the option has no allowlist). For a configured Carriyo location, supply either partner_location_code (your own code, recommended for storefront integrations) or partner_location_id (Carriyo's internal ID); free-form address fields are also accepted |

Collection points for `COLLECTION` options

For each matching COLLECTION option, Carriyo also returns a list of eligible collection points (configured Carriyo locations with the collection_location flag enabled) under customer_collection_locations on the response item. Three pieces of input shape the result:

customer.coords: when supplied (latitude/longitude), Carriyo computes the distance from the customer to each location and sorts the result nearest-first. Locations without coordinates are excluded from a distance-bound result. When customer coordinates aren't supplied, locations are returned in the merchant-configured order with no distance field.
max_collection_distance (request): a client-supplied upper bound on the returned distance. Effective only when customer coordinates are supplied.
customer_collection_max_distance (per-option, configured by the merchant): a hard upper bound the merchant authored for this option. Carriyo applies the smaller of this and the request's max_collection_distance when filtering.

The result list is capped at max_collection_locations (defaults to 10 when omitted, capped server-side at 50).

Response

An array of matching delivery options, each with its carrier account, computed shipping fee, and estimated arrival window. The array is empty if no configured option matches the supplied order.

Headers

Name	Value	Required	Description
Authorization	Bearer YOUR-ACCESS-TOKEN	Yes	OAuth 2.0 bearer token obtained from `POST /oauth/token`.
x-api-key	YOUR-API-KEY	Yes	Your tenant's API key, issued in the Carriyo Dashboard. Required on every request except `POST /oauth/token`.
tenant-id	YOUR-TENANT-ID	Yes	Your Carriyo tenant ID, shown in the Carriyo Dashboard. Required on every request except `POST /oauth/token`.
Content-Type	application/json	Yes	Media type of the request body.

Request body

Content type: application/jsonSchema: delivery-options-requestrequired

merchantstringrequired
The merchant the order belongs to. The API key must have access to this merchant.
order_datestringformat: date-time
The date the order was placed (ISO 8601). Defaults to the time of the request. Used as the reference date for working-day and blackout-day evaluation.
paymentdelivery-options-payment
Payment details for the order. Drives order_value and payment_type conditions.
line_itemsdelivery-options-line-item[]
The items in the order. The total order weight used for weight range condition evaluation is the sum of weight.value across line items, converted to kg. Quantity is not factored in. If a line ships multiple units, set weight.value to the total weight contributed by that line, not the per-unit weight.
parcelsdelivery-options-parcel[]
Parcels in the order. Used by the carrier rate calculator when a matching option's pricing strategy is PASS_THROUGH (i.e., the carrier-quoted rate is shown to the shopper). Not used by condition matching; weight conditions are evaluated against line_items.
fulfillment_locationsdelivery-options-address[]
Candidate locations the order could be fulfilled from (origin/warehouse/store). Pass one or more, and Carriyo returns the options whose fulfillment-location allowlist contains at least one of these (options without an allowlist are unconstrained). Per option, the first matching location is used to drive origin-country-based estimated arrival and, for PASS_THROUGH pricing, the carrier rate quote. Each entry may be a free-form address, or, for a configured Carriyo location, supply partner_location_code (your own code, recommended) or partner_location_id (Carriyo's internal ID), and the rest of the address is populated from the location record.
customerdelivery-options-address
The customer's location. Drives customer-geography conditions and the timezone used for working-day / blackout-day evaluation. Strongly recommended for any non-trivial result. For DELIVERY options this is also the implicit delivery destination. For COLLECTION options it's used to find applicable collection points. The shopper has not chosen between the two at this stage; the field captures where the customer is, not where the order is being delivered.
carriyo_metadatacarriyo-metadata-entry[]
Custom name/value pairs attached to the order. Stored on the order but not currently used by condition evaluation.
delivery_methodsstring[]
Restrict the response to options of the listed methods. When omitted or empty, all methods are returned. Useful when the storefront has separate UI tabs for delivery and click-and-collect, or when the integration only supports one method (e.g., Shopify's standard Carrier Service API has no pickup-point concept, so the Shopify connector sets this to ["DELIVERY"]).
max_collection_locationsinteger
Maximum number of customer collection locations to return per matching COLLECTION option. Defaults to 10 when omitted; capped server-side at 50. Ignored for DELIVERY and DIGITAL options.
max_collection_distancedistance
Client-supplied upper bound on the distance from the customer's location to a returned collection point. The effective cap used by Carriyo is the smaller of this value and any per-option customer_collection_max_distance configured by the merchant. When the customer's coordinates aren't supplied, this cap can't be enforced and is ignored.

Responses

200The delivery options that match the supplied order.

idstring
Unique identifier for this delivery option.
delivery_methodstring
The fulfilment method for this option: - DELIVERY: courier delivers to the customer's address. - COLLECTION: customer collects from a designated location. - DIGITAL: no physical fulfilment. Aligns with FulfillmentOrder.delivery_method on the order model.
Values:COLLECTIONDELIVERYDIGITAL
codestring
The merchant-defined code identifying the delivery option.
namestring
Display name of the delivery option (shown to the shopper).
descriptionstring
image_urlstring
URL to an icon or image associated with the option.
carrier_account_idstring
The Carriyo carrier account that fulfils this option.
shipping_feedelivery-options-shipping-fee
estimated_arrival_fromstringformat: date-time
Earliest estimated arrival date/time (ISO 8601).
estimated_arrival_tostringformat: date-time
Latest estimated arrival date/time (ISO 8601).
customer_collection_locationscustomer-collection-location[]
Eligible collection points for this option. Populated only when delivery_method is COLLECTION. Sorted nearest-first when the customer's coordinates are supplied; otherwise returned in the merchant-configured order. May be empty if the option has no linked locations or none are within the effective distance cap.

Need the full machine-readable spec? Download the OpenAPI document →

Delivery Options

Manage the curated delivery options shown at customer checkout. Each option carries the carrier account that fulfils it, the customer-facing pricing and timing, and the eligibility conditions (geography, order value, weight, payment type) under which it appears.

These are the management endpoints: create, read, update, delete. For the runtime endpoint shoppers indirectly hit at checkout, see the Checkout tag above.

5 operations · 0 objects

post/delivery-options

Create delivery option

Setup endpoint

Manage this in the Carriyo Dashboard, not the API.

Creates a customer-facing delivery option (e.g. 'Same Day', 'Next Day Premium') with its associated carrier, schedule, fee, and eligibility conditions.

Headers

Name	Value	Required	Description
Authorization	Bearer YOUR-ACCESS-TOKEN	Yes	OAuth 2.0 bearer token obtained from `POST /oauth/token`.
x-api-key	YOUR-API-KEY	Yes	Your tenant's API key, issued in the Carriyo Dashboard. Required on every request except `POST /oauth/token`.
tenant-id	YOUR-TENANT-ID	Yes	Your Carriyo tenant ID, shown in the Carriyo Dashboard. Required on every request except `POST /oauth/token`.
Content-Type	application/json	Yes	Media type of the request body.

Request body

Content type: application/jsonSchema: delivery-optionrequired

idstring
Carriyo-issued identifier. Server-assigned on create.
codestring
Merchant-supplied code used as the option's stable identifier (e.g. EXPRESS_AE).
namestring
Human-readable display name shown to the customer.
descriptionstring
Optional longer description shown to the customer.
image_urlstring
URL of an icon / illustration for the option.
delivery_methodstring
Delivery method (home delivery, customer pickup, or digital fulfilment).
Values:DELIVERYCOLLECTIONDIGITAL
merchantstring
Merchant the option belongs to.
carrier_account_idstring
Carrier account that fulfils shipments booked via this option.
statusstring
Option status.
Values:ACTIVEINACTIVE
schedulecarrier-schedule
Working days / blackout dates for this option.
shipping_feeshipping-fee
Pricing configuration.
delivery_estimationdelivery-estimation
Customer-facing delivery-time estimation configuration.
order_valuenumber-area-condition
Make the option visible only when order value is in range.
weightnumber-area-condition
Make the option visible only when total weight is in range.
payment_typestring-condition
Make the option visible only for matching payment types.
customercountry-states-condition-v2
Make the option visible only when the customer address falls in matching country / states / cities / areas.
fulfillment_locationsstring[]
Carriyo location codes/IDs eligible to fulfil this option.
customer_collection_locationsstring[]
For COLLECTION methods: location codes/IDs where the customer can collect from.
customer_collection_max_distancedistance
For COLLECTION methods: maximum distance from the customer to a candidate collection location.
updated_by_userstring
User identifier (email) of the last updater. Read-only.
creation_datestringformat: date-time
Creation timestamp (ISO 8601).
update_datestringformat: date-time
Last update timestamp (ISO 8601).

Responses

201Created.Schema: delivery-option

idstring
Carriyo-issued identifier. Server-assigned on create.
codestring
Merchant-supplied code used as the option's stable identifier (e.g. EXPRESS_AE).
namestring
Human-readable display name shown to the customer.
descriptionstring
Optional longer description shown to the customer.
image_urlstring
URL of an icon / illustration for the option.
delivery_methodstring
Delivery method (home delivery, customer pickup, or digital fulfilment).
Values:DELIVERYCOLLECTIONDIGITAL
merchantstring
Merchant the option belongs to.
carrier_account_idstring
Carrier account that fulfils shipments booked via this option.
statusstring
Option status.
Values:ACTIVEINACTIVE
schedulecarrier-schedule
Working days / blackout dates for this option.
shipping_feeshipping-fee
Pricing configuration.
delivery_estimationdelivery-estimation
Customer-facing delivery-time estimation configuration.
order_valuenumber-area-condition
Make the option visible only when order value is in range.
weightnumber-area-condition
Make the option visible only when total weight is in range.
payment_typestring-condition
Make the option visible only for matching payment types.
customercountry-states-condition-v2
Make the option visible only when the customer address falls in matching country / states / cities / areas.
fulfillment_locationsstring[]
Carriyo location codes/IDs eligible to fulfil this option.
customer_collection_locationsstring[]
For COLLECTION methods: location codes/IDs where the customer can collect from.
customer_collection_max_distancedistance
For COLLECTION methods: maximum distance from the customer to a candidate collection location.
updated_by_userstring
User identifier (email) of the last updater. Read-only.
creation_datestringformat: date-time
Creation timestamp (ISO 8601).
update_datestringformat: date-time
Last update timestamp (ISO 8601).

Need the full machine-readable spec? Download the OpenAPI document →

get/delivery-options

List delivery options

Setup endpoint

Manage this in the Carriyo Dashboard, not the API.

Returns the merchant's delivery options.

Headers

Name	Value	Required	Description
Authorization	Bearer YOUR-ACCESS-TOKEN	Yes	OAuth 2.0 bearer token obtained from `POST /oauth/token`.
x-api-key	YOUR-API-KEY	Yes	Your tenant's API key, issued in the Carriyo Dashboard. Required on every request except `POST /oauth/token`.
tenant-id	YOUR-TENANT-ID	Yes	Your Carriyo tenant ID, shown in the Carriyo Dashboard. Required on every request except `POST /oauth/token`.

Responses

200Success.

idstring
Carriyo-issued identifier. Server-assigned on create.
codestring
Merchant-supplied code used as the option's stable identifier (e.g. EXPRESS_AE).
namestring
Human-readable display name shown to the customer.
descriptionstring
Optional longer description shown to the customer.
image_urlstring
URL of an icon / illustration for the option.
delivery_methodstring
Delivery method (home delivery, customer pickup, or digital fulfilment).
Values:DELIVERYCOLLECTIONDIGITAL
merchantstring
Merchant the option belongs to.
carrier_account_idstring
Carrier account that fulfils shipments booked via this option.
statusstring
Option status.
Values:ACTIVEINACTIVE
schedulecarrier-schedule
Working days / blackout dates for this option.
shipping_feeshipping-fee
Pricing configuration.
delivery_estimationdelivery-estimation
Customer-facing delivery-time estimation configuration.
order_valuenumber-area-condition
Make the option visible only when order value is in range.
weightnumber-area-condition
Make the option visible only when total weight is in range.
payment_typestring-condition
Make the option visible only for matching payment types.
customercountry-states-condition-v2
Make the option visible only when the customer address falls in matching country / states / cities / areas.
fulfillment_locationsstring[]
Carriyo location codes/IDs eligible to fulfil this option.
customer_collection_locationsstring[]
For COLLECTION methods: location codes/IDs where the customer can collect from.
customer_collection_max_distancedistance
For COLLECTION methods: maximum distance from the customer to a candidate collection location.
updated_by_userstring
User identifier (email) of the last updater. Read-only.
creation_datestringformat: date-time
Creation timestamp (ISO 8601).
update_datestringformat: date-time
Last update timestamp (ISO 8601).

Need the full machine-readable spec? Download the OpenAPI document →

get/delivery-options/{id}

Get delivery option

Setup endpoint

Manage this in the Carriyo Dashboard, not the API.

Returns the specified delivery option.

Path parameters

Name	Type	Required	Description
id	string	Yes	Delivery option ID.

Headers

Name	Value	Required	Description
Authorization	Bearer YOUR-ACCESS-TOKEN	Yes	OAuth 2.0 bearer token obtained from `POST /oauth/token`.
x-api-key	YOUR-API-KEY	Yes	Your tenant's API key, issued in the Carriyo Dashboard. Required on every request except `POST /oauth/token`.
tenant-id	YOUR-TENANT-ID	Yes	Your Carriyo tenant ID, shown in the Carriyo Dashboard. Required on every request except `POST /oauth/token`.

Responses

200Success.Schema: delivery-option

idstring
Carriyo-issued identifier. Server-assigned on create.
codestring
Merchant-supplied code used as the option's stable identifier (e.g. EXPRESS_AE).
namestring
Human-readable display name shown to the customer.
descriptionstring
Optional longer description shown to the customer.
image_urlstring
URL of an icon / illustration for the option.
delivery_methodstring
Delivery method (home delivery, customer pickup, or digital fulfilment).
Values:DELIVERYCOLLECTIONDIGITAL
merchantstring
Merchant the option belongs to.
carrier_account_idstring
Carrier account that fulfils shipments booked via this option.
statusstring
Option status.
Values:ACTIVEINACTIVE
schedulecarrier-schedule
Working days / blackout dates for this option.
shipping_feeshipping-fee
Pricing configuration.
delivery_estimationdelivery-estimation
Customer-facing delivery-time estimation configuration.
order_valuenumber-area-condition
Make the option visible only when order value is in range.
weightnumber-area-condition
Make the option visible only when total weight is in range.
payment_typestring-condition
Make the option visible only for matching payment types.
customercountry-states-condition-v2
Make the option visible only when the customer address falls in matching country / states / cities / areas.
fulfillment_locationsstring[]
Carriyo location codes/IDs eligible to fulfil this option.
customer_collection_locationsstring[]
For COLLECTION methods: location codes/IDs where the customer can collect from.
customer_collection_max_distancedistance
For COLLECTION methods: maximum distance from the customer to a candidate collection location.
updated_by_userstring
User identifier (email) of the last updater. Read-only.
creation_datestringformat: date-time
Creation timestamp (ISO 8601).
update_datestringformat: date-time
Last update timestamp (ISO 8601).

Need the full machine-readable spec? Download the OpenAPI document →

put/delivery-options/{id}

Update delivery option

Setup endpoint

Manage this in the Carriyo Dashboard, not the API.

Updates the specified delivery option.

Path parameters

Name	Type	Required	Description
id	string	Yes	Delivery option ID.

Headers

Name	Value	Required	Description
Authorization	Bearer YOUR-ACCESS-TOKEN	Yes	OAuth 2.0 bearer token obtained from `POST /oauth/token`.
x-api-key	YOUR-API-KEY	Yes	Your tenant's API key, issued in the Carriyo Dashboard. Required on every request except `POST /oauth/token`.
tenant-id	YOUR-TENANT-ID	Yes	Your Carriyo tenant ID, shown in the Carriyo Dashboard. Required on every request except `POST /oauth/token`.
Content-Type	application/json	Yes	Media type of the request body.

Request body

Content type: application/jsonSchema: delivery-optionrequired

idstring
Carriyo-issued identifier. Server-assigned on create.
codestring
Merchant-supplied code used as the option's stable identifier (e.g. EXPRESS_AE).
namestring
Human-readable display name shown to the customer.
descriptionstring
Optional longer description shown to the customer.
image_urlstring
URL of an icon / illustration for the option.
delivery_methodstring
Delivery method (home delivery, customer pickup, or digital fulfilment).
Values:DELIVERYCOLLECTIONDIGITAL
merchantstring
Merchant the option belongs to.
carrier_account_idstring
Carrier account that fulfils shipments booked via this option.
statusstring
Option status.
Values:ACTIVEINACTIVE
schedulecarrier-schedule
Working days / blackout dates for this option.
shipping_feeshipping-fee
Pricing configuration.
delivery_estimationdelivery-estimation
Customer-facing delivery-time estimation configuration.
order_valuenumber-area-condition
Make the option visible only when order value is in range.
weightnumber-area-condition
Make the option visible only when total weight is in range.
payment_typestring-condition
Make the option visible only for matching payment types.
customercountry-states-condition-v2
Make the option visible only when the customer address falls in matching country / states / cities / areas.
fulfillment_locationsstring[]
Carriyo location codes/IDs eligible to fulfil this option.
customer_collection_locationsstring[]
For COLLECTION methods: location codes/IDs where the customer can collect from.
customer_collection_max_distancedistance
For COLLECTION methods: maximum distance from the customer to a candidate collection location.
updated_by_userstring
User identifier (email) of the last updater. Read-only.
creation_datestringformat: date-time
Creation timestamp (ISO 8601).
update_datestringformat: date-time
Last update timestamp (ISO 8601).

Responses

200Success.Schema: delivery-option

idstring
Carriyo-issued identifier. Server-assigned on create.
codestring
Merchant-supplied code used as the option's stable identifier (e.g. EXPRESS_AE).
namestring
Human-readable display name shown to the customer.
descriptionstring
Optional longer description shown to the customer.
image_urlstring
URL of an icon / illustration for the option.
delivery_methodstring
Delivery method (home delivery, customer pickup, or digital fulfilment).
Values:DELIVERYCOLLECTIONDIGITAL
merchantstring
Merchant the option belongs to.
carrier_account_idstring
Carrier account that fulfils shipments booked via this option.
statusstring
Option status.
Values:ACTIVEINACTIVE
schedulecarrier-schedule
Working days / blackout dates for this option.
shipping_feeshipping-fee
Pricing configuration.
delivery_estimationdelivery-estimation
Customer-facing delivery-time estimation configuration.
order_valuenumber-area-condition
Make the option visible only when order value is in range.
weightnumber-area-condition
Make the option visible only when total weight is in range.
payment_typestring-condition
Make the option visible only for matching payment types.
customercountry-states-condition-v2
Make the option visible only when the customer address falls in matching country / states / cities / areas.
fulfillment_locationsstring[]
Carriyo location codes/IDs eligible to fulfil this option.
customer_collection_locationsstring[]
For COLLECTION methods: location codes/IDs where the customer can collect from.
customer_collection_max_distancedistance
For COLLECTION methods: maximum distance from the customer to a candidate collection location.
updated_by_userstring
User identifier (email) of the last updater. Read-only.
creation_datestringformat: date-time
Creation timestamp (ISO 8601).
update_datestringformat: date-time
Last update timestamp (ISO 8601).

Need the full machine-readable spec? Download the OpenAPI document →

delete/delivery-options/{id}

Delete delivery option

Setup endpoint

Manage this in the Carriyo Dashboard, not the API.

Permanently deletes the specified delivery option.

Path parameters

Name	Type	Required	Description
id	string	Yes	Delivery option ID.

Headers

Name	Value	Required	Description
Authorization	Bearer YOUR-ACCESS-TOKEN	Yes	OAuth 2.0 bearer token obtained from `POST /oauth/token`.
x-api-key	YOUR-API-KEY	Yes	Your tenant's API key, issued in the Carriyo Dashboard. Required on every request except `POST /oauth/token`.
tenant-id	YOUR-TENANT-ID	Yes	Your Carriyo tenant ID, shown in the Carriyo Dashboard. Required on every request except `POST /oauth/token`.

Responses

204Deleted.

Need the full machine-readable spec? Download the OpenAPI document →

Authentication

Every endpoint uses OAuth 2.0. Exchange your client credentials for an access token:

Get a token

curl -X POST 'https://api.carriyo.com/oauth/token' \
  -H 'Content-Type: application/json' \
  -d '{
    "grant_type": "client_credentials",
    "client_id": "<your-client-id>",
    "client_secret": "<your-client-secret>"
  }'

Then send on every request

Authorization:Bearer <access-token>

tenant-id:<your-tenant-id>

x-api-key:<your-api-key>