Skip to navigation

Get Delivery Options

View as Markdown

Lists the delivery options and pickup points for the cart and the shopper’s address, each with its fee in the cart’s currency and the promised date. Options follow the merchant’s cutoff times, closed days, order value and weight rules, so ask again when the cart or address changes. Pickup points come back without an address.

Keys: public key or secret key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active workspace.

Headers

channelstringRequired
cart-tokenstringRequired

The token returned when the cart was created. Treat it as a secret: never put it in a URL or a log.

Query parameters

country_codestringOptional

ISO 3166-1 alpha-2 code. Defaults to the cart’s country.

statestringOptional

Shopper’s state, for example Lagos.

areastringOptional

Shopper’s area, for example Lekki.

Response

Successfully fetched delivery options
statusboolean

Always true on success.

messagestring

Human-readable outcome.

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error