Skip to navigation
StorefrontAccountAddresses

Create Address

View as Markdown

Saves an address. An account can keep up to 20.

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
shopper-tokenstringRequired

The token returned when the shopper signed in. Treat it as a secret: never put it in a URL or a log.

Request

This endpoint expects an object.
namestringRequired<=100 characters
Label or recipient.
line1stringRequired<=120 characters
First address line.
line2stringOptional<=120 characters
citystringOptional<=120 characters
statestringOptional<=120 characters
postal_codestringOptional<=20 characters
country_codestringOptional=2 characters

ISO 3166-1 alpha-2 code.

phonestringOptional<=30 characters
is_defaultbooleanOptional
Make this the default address. The first address saved is always the default.
areastringOptional<=120 characters

Neighbourhood or area the store delivers to, as listed in Get Delivery Areas (for example Lekki). Delivery options are matched on it.

landmarkstringOptional<=255 characters

Directions for the rider, for example Opposite the Total filling station.

Response

Successfully saved address
statusboolean

Always true on success.

messagestring

Human-readable outcome.

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
422
Unprocessable Entity Error