Checkout Options API
Your storefront sends us the basket, the customer's location and the currency. We return the delivery and collection options for that order, each with its price and an estimated delivery date.
Capabilities
Our Checkout Options API is the part of Carriyo that runs before the order exists. It is built for retailers and integrators who want the delivery section of checkout decided per basket rather than copied from a fixed table, and who want the promise a shopper sees to be the promise the operation is then held to.
Named options you configure once and we evaluate on every checkout, by destination, order value, basket weight, payment type and product category.
Free, a fee you set with tiers by order value, or the live rate quoted by the carrier. We return the free-shipping threshold with the response.
Calculated for this basket and this address from the option's estimate, working days, blackout dates and the location that would serve it.
Stores, lockers and partner pickup points are configured as locations; we return the eligible ones nearest first, with distance.
With inventory management on and the stock check requested, we check real-time availability per line and leave out any option that cannot supply the basket.
A product-level endpoint returns options and promise for up to fifty products at once, so a listing or product page can show "arrives by".
Configuration
A delivery option carries its delivery method, home delivery or customer collection, its pricing, its delivery estimate, the customer geography it serves and the fulfillment locations that may serve it. You set the conditions under which it appears, including the working days and blackout dates that apply in the customer's timezone. When a tiered fee ends in a free tier we return the threshold, so your checkout can tell the shopper how much more to add for free shipping.
Options, conditions and prices are configuration, not code: change a threshold or add an express tier in one market and measure what it does to conversion.
Click and collect
A collection option uses the same shape as home delivery, with the pickup point in place of the customer's address. When your storefront sends the customer's coordinates we return the eligible points within the radius and up to the number you set.
In local collection the item is already at the pickup location, so no shipment is created. In remote collection the item ships from a warehouse or another store to the pickup point, and we create that shipment.
The response never quietly promises a split.
From checkout to doorstep
The Storefront API reads your configuration and creates nothing. When the shopper chooses, your storefront places the order with the code of the option they picked, and our order management takes over: the option is recorded on the fulfillment order, the estimate the shopper saw becomes the customer promise on the shipment, and our allocation engine restricts its search to the locations attached to that option.
Service levels and late flags then track that promise, and the branded tracking page and notifications show it. Once the shipment exists, our own delivery-date estimate and the carrier's sit alongside that promise, so you can see in our reports where promises hold and where they slip.
Checkout widgets stop at the buy button. On Carriyo the promise, the allocation, the carrier booking and the tracking page are one record on one platform, from checkout to doorstep.
YOUR WAY. RULES. OR AI.
Your team creates delivery options in the dashboard and sets their conditions, prices and estimates.
Your storefront sends the basket, the customer's location and the currency.
We return the options that apply, each with its price and an arrival window, filtered against stock when you ask us to check.
The order is placed with the option's code; the estimate becomes the promise on the shipment and allocation is restricted to the locations attached to that option.
Your team creates delivery options and sets their conditions, prices and estimates.
The configuration is the automation: every checkout is priced and promised without anyone looking, and every order is allocated to a location that honours the option chosen.
Through our native MCP layer, an agent can list, create and edit delivery options with the permissions of the user who authorised it, so a growth team can ask an assistant to tighten a free-shipping threshold or add a same-day option in one city and see it applied.
Checkout Options API
An API your storefront calls during checkout with the basket, destination and currency, which returns the delivery choices to show the shopper, each with a price and an estimated delivery date.
Yes. Every option carries an arrival window calculated for that request from the option's delivery estimate, working and blackout days and the location that would serve the order. When the shopper chooses, that date becomes the promise on the shipment.
Yes. Collection is a delivery method on the same API. Stores, lockers and partner pickup points are configured as locations, and we return the eligible ones nearest the customer within the radius you set.
Not if you ask us to check. With inventory management on and the stock check requested, we filter options by real-time availability and leave out any option that cannot supply the basket.
Both. Shopify merchants surface carrier shipping rates from Carriyo at checkout through our Shopify connector. Headless, custom and mobile storefronts call the Storefront API directly.
To see what your delivery section could offer for a basket, an address and a store network like yours, get in touch.