Check out the current cart into an order

curl --request POST \
  --url https://api.example.com/v1/orders/checkout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "type": "RETAIL",
  "addressId": "b6a1e2d4-8f3c-4a5b-9e2d-1f4c6a8b9d0e",
  "deliveryMethod": "STANDARD_DELIVERY",
  "paymentMethod": "PAYSTACK",
  "recipientName": "Jane Doe",
  "usePoints": 800
}
'

import requests

url = "https://api.example.com/v1/orders/checkout"

payload = {
    "type": "RETAIL",
    "addressId": "b6a1e2d4-8f3c-4a5b-9e2d-1f4c6a8b9d0e",
    "deliveryMethod": "STANDARD_DELIVERY",
    "paymentMethod": "PAYSTACK",
    "recipientName": "Jane Doe",
    "usePoints": 800
}
headers = {
    "authorization": "<authorization>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    authorization: '<authorization>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    type: 'RETAIL',
    addressId: 'b6a1e2d4-8f3c-4a5b-9e2d-1f4c6a8b9d0e',
    deliveryMethod: 'STANDARD_DELIVERY',
    paymentMethod: 'PAYSTACK',
    recipientName: 'Jane Doe',
    usePoints: 800
  })
};

fetch('https://api.example.com/v1/orders/checkout', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/orders/checkout",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'RETAIL',
    'addressId' => 'b6a1e2d4-8f3c-4a5b-9e2d-1f4c6a8b9d0e',
    'deliveryMethod' => 'STANDARD_DELIVERY',
    'paymentMethod' => 'PAYSTACK',
    'recipientName' => 'Jane Doe',
    'usePoints' => 800
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/orders/checkout"

	payload := strings.NewReader("{\n  \"type\": \"RETAIL\",\n  \"addressId\": \"b6a1e2d4-8f3c-4a5b-9e2d-1f4c6a8b9d0e\",\n  \"deliveryMethod\": \"STANDARD_DELIVERY\",\n  \"paymentMethod\": \"PAYSTACK\",\n  \"recipientName\": \"Jane Doe\",\n  \"usePoints\": 800\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("authorization", "<authorization>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/orders/checkout")
  .header("authorization", "<authorization>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"RETAIL\",\n  \"addressId\": \"b6a1e2d4-8f3c-4a5b-9e2d-1f4c6a8b9d0e\",\n  \"deliveryMethod\": \"STANDARD_DELIVERY\",\n  \"paymentMethod\": \"PAYSTACK\",\n  \"recipientName\": \"Jane Doe\",\n  \"usePoints\": 800\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/orders/checkout")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"RETAIL\",\n  \"addressId\": \"b6a1e2d4-8f3c-4a5b-9e2d-1f4c6a8b9d0e\",\n  \"deliveryMethod\": \"STANDARD_DELIVERY\",\n  \"paymentMethod\": \"PAYSTACK\",\n  \"recipientName\": \"Jane Doe\",\n  \"usePoints\": 800\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "orderNumber": "<string>",
  "date": "<string>",
  "status": "PENDING_PAYMENT",
  "type": "RETAIL",
  "items": [
    {
      "productId": "<string>",
      "productName": "<string>",
      "quantity": 123,
      "price": 123,
      "productImage": "<string>",
      "sizeId": "<string>",
      "variantName": "<string>",
      "sizeLabel": "<string>",
      "sku": "<string>",
      "size": "<string>"
    }
  ],
  "bundles": [
    {
      "id": "<string>",
      "bundleId": "<string>",
      "name": "<string>",
      "quantity": 123,
      "unitPrice": 123,
      "lineTotal": 123,
      "components": [
        {
          "productId": "<string>",
          "sizeId": "<string>",
          "productName": "<string>",
          "variantName": "<string>",
          "sizeLabel": "<string>",
          "sku": "<string>",
          "quantity": 123
        }
      ],
      "image": "<string>"
    }
  ],
  "subtotalAmount": 123,
  "deliveryAmount": 123,
  "rewardAmount": 123,
  "pointsRedeemed": 123,
  "discountAmount": 123,
  "discounts": [
    {
      "discountId": "<string>",
      "name": "Summer 10% off",
      "type": "PERCENTAGE",
      "amount": 4.5
    }
  ],
  "totalAmount": 123,
  "deliveryInfo": {
    "deliveryMethod": "STANDARD_DELIVERY",
    "recipientName": "<string>",
    "recipientContact": "<string>",
    "recipientAddress": "<string>",
    "preferredLogisticsProvider": "DPD",
    "logisticsProvider": "DPD",
    "courierTrackingNumber": "<string>"
  },
  "orderInfo": {
    "paymentMethod": "STRIPE",
    "orderNo": "<string>",
    "orderDate": "<string>"
  }
}

POST

orders

checkout

Check out the current cart into an order

curl --request POST \
  --url https://api.example.com/v1/orders/checkout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "type": "RETAIL",
  "addressId": "b6a1e2d4-8f3c-4a5b-9e2d-1f4c6a8b9d0e",
  "deliveryMethod": "STANDARD_DELIVERY",
  "paymentMethod": "PAYSTACK",
  "recipientName": "Jane Doe",
  "usePoints": 800
}
'

import requests

url = "https://api.example.com/v1/orders/checkout"

payload = {
    "type": "RETAIL",
    "addressId": "b6a1e2d4-8f3c-4a5b-9e2d-1f4c6a8b9d0e",
    "deliveryMethod": "STANDARD_DELIVERY",
    "paymentMethod": "PAYSTACK",
    "recipientName": "Jane Doe",
    "usePoints": 800
}
headers = {
    "authorization": "<authorization>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    authorization: '<authorization>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    type: 'RETAIL',
    addressId: 'b6a1e2d4-8f3c-4a5b-9e2d-1f4c6a8b9d0e',
    deliveryMethod: 'STANDARD_DELIVERY',
    paymentMethod: 'PAYSTACK',
    recipientName: 'Jane Doe',
    usePoints: 800
  })
};

fetch('https://api.example.com/v1/orders/checkout', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/orders/checkout",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'RETAIL',
    'addressId' => 'b6a1e2d4-8f3c-4a5b-9e2d-1f4c6a8b9d0e',
    'deliveryMethod' => 'STANDARD_DELIVERY',
    'paymentMethod' => 'PAYSTACK',
    'recipientName' => 'Jane Doe',
    'usePoints' => 800
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/orders/checkout"

	payload := strings.NewReader("{\n  \"type\": \"RETAIL\",\n  \"addressId\": \"b6a1e2d4-8f3c-4a5b-9e2d-1f4c6a8b9d0e\",\n  \"deliveryMethod\": \"STANDARD_DELIVERY\",\n  \"paymentMethod\": \"PAYSTACK\",\n  \"recipientName\": \"Jane Doe\",\n  \"usePoints\": 800\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("authorization", "<authorization>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/orders/checkout")
  .header("authorization", "<authorization>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"RETAIL\",\n  \"addressId\": \"b6a1e2d4-8f3c-4a5b-9e2d-1f4c6a8b9d0e\",\n  \"deliveryMethod\": \"STANDARD_DELIVERY\",\n  \"paymentMethod\": \"PAYSTACK\",\n  \"recipientName\": \"Jane Doe\",\n  \"usePoints\": 800\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/orders/checkout")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"RETAIL\",\n  \"addressId\": \"b6a1e2d4-8f3c-4a5b-9e2d-1f4c6a8b9d0e\",\n  \"deliveryMethod\": \"STANDARD_DELIVERY\",\n  \"paymentMethod\": \"PAYSTACK\",\n  \"recipientName\": \"Jane Doe\",\n  \"usePoints\": 800\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "orderNumber": "<string>",
  "date": "<string>",
  "status": "PENDING_PAYMENT",
  "type": "RETAIL",
  "items": [
    {
      "productId": "<string>",
      "productName": "<string>",
      "quantity": 123,
      "price": 123,
      "productImage": "<string>",
      "sizeId": "<string>",
      "variantName": "<string>",
      "sizeLabel": "<string>",
      "sku": "<string>",
      "size": "<string>"
    }
  ],
  "bundles": [
    {
      "id": "<string>",
      "bundleId": "<string>",
      "name": "<string>",
      "quantity": 123,
      "unitPrice": 123,
      "lineTotal": 123,
      "components": [
        {
          "productId": "<string>",
          "sizeId": "<string>",
          "productName": "<string>",
          "variantName": "<string>",
          "sizeLabel": "<string>",
          "sku": "<string>",
          "quantity": 123
        }
      ],
      "image": "<string>"
    }
  ],
  "subtotalAmount": 123,
  "deliveryAmount": 123,
  "rewardAmount": 123,
  "pointsRedeemed": 123,
  "discountAmount": 123,
  "discounts": [
    {
      "discountId": "<string>",
      "name": "Summer 10% off",
      "type": "PERCENTAGE",
      "amount": 4.5
    }
  ],
  "totalAmount": 123,
  "deliveryInfo": {
    "deliveryMethod": "STANDARD_DELIVERY",
    "recipientName": "<string>",
    "recipientContact": "<string>",
    "recipientAddress": "<string>",
    "preferredLogisticsProvider": "DPD",
    "logisticsProvider": "DPD",
    "courierTrackingNumber": "<string>"
  },
  "orderInfo": {
    "paymentMethod": "STRIPE",
    "orderNo": "<string>",
    "orderDate": "<string>"
  }
}

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"

preferredLogisticsProvider

enum<string>

Preferred courier — omit for no preference (dispatch falls back to the platform default).

Available options:

DPD,

EVRI,

ROYAL_MAIL

usePoints

number

Loyalty points to spend on this order (2000 = £7.50; at least 500; at most the balance and what is left to pay — GET /cart/quote points.maxUsable). Comes off as rewardAmount. 400 if not allowed; no order is created.

Required range: x >= 500

Example:

800

Response

201 - application/json

string

required

orderNumber

string

required

date

string

required

status

enum<string>

required

Available options:

PENDING_PAYMENT,

CONFIRMED,

PROCESSING,

DISPATCHED,

DELIVERED,

CANCELLED,

REFUNDED

type

enum<string>

required

Available options:

RETAIL,

TRADE

items

object[]

required

Show child attributes

bundles

object[]

required

Bundle packages bought, each at its bundle price

Show child attributes

subtotalAmount

number

required

Items + bundles

deliveryAmount

number

required

rewardAmount

number

required

What loyalty points took off

pointsRedeemed

number

required

Loyalty points spent on this order

discountAmount

number

required

Taken off the subtotal by the discount applied at checkout

discounts

object[]

required

The discount(s) behind discountAmount — at most one today

Show child attributes

totalAmount

number

required

deliveryInfo

object

required

Show child attributes

orderInfo

object

required

Show child attributes

Auth & Account

Catalogue

Inventory (Admin)

Orders & Cart

Payments & Webhooks

Notifications, Loyalty & Campaigns

Admin

Check out the current cart into an order

Authorizations

Headers

Body

Response