Skip to main content
POST
Check out the current cart into an order

Authorizations

Authorization
string
header
required

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

Headers

authorization
string
required

Body

application/json
type
enum<string>
required
Available options:
RETAIL,
TRADE
Example:

"RETAIL"

addressId
string
required

Must be the id of one of the caller's saved addresses (GET /users/me/addresses).

Example:

"b6a1e2d4-8f3c-4a5b-9e2d-1f4c6a8b9d0e"

deliveryMethod
enum<string>
required
Available options:
STANDARD_DELIVERY,
NEXT_DAY_DELIVERY,
PICKUP
Example:

"STANDARD_DELIVERY"

paymentMethod
enum<string>
required
Available options:
STRIPE,
PAYPAL,
PAYSTACK,
INVOICE
Example:

"PAYSTACK"

recipientName
string

Defaults to the account holder's name — set this only when the order is for someone else.

Example:

"Jane Doe"

Response

201 - undefined