Basket

What is the Basket Service?

The Basket Service (lets-trade-basket) is a core microservice in the LetsTrade platform responsible for managing shopping carts, checkout processes, and order creation. It handles the entire shopping journey from adding products to a basket through to final checkout and payment processing.

This service provides APIs for:

• Creating and managing shopping baskets

• Adding, updating, and removing products from baskets

• Applying discounts, vouchers, and promotional deals

• Processing checkout with various payment methods

• Generating delivery quotes and estimates

• POS (Point of Sale) basket operations

• Kiosk-based ordering

• Basket analytics and abandonment tracking

---

Core Entities

Basket

The central entity representing a shopping cart. A basket contains:

• client_id: The merchant/business that owns this basket

• user_id: The customer who owns the basket (optional for guest checkouts)

• branch_id: The specific store/branch location

• channel: The sales channel (e.g., "WEB", "APP", "POS", "KIOSK")

• status: Current state of the basket (ACTIVE, CHECKED_OUT, ABANDONED, etc.)

• product_list: Array of products in the basket

• totals: Calculated subtotal, VAT, discounts, and final total

• delivery_address: Shipping destination (if applicable)

• payment: Payment method and transaction details

• subscription: Subscription/recurring order details

• deal: Applied promotional deals

• extra_data: Custom key-value pairs for client-specific data

Basket Product

Individual items within a basket:

• product_id: Reference to the product catalog

• title: Product name

• sku: Stock keeping unit

• quantity: Number of items

• price: Unit price

• variations: Selected product variations (size, color, etc.)

• condiments: Add-ons or modifiers

• instructions: Special instructions for this item

Payment

Payment information attached to a basket:

• type: Payment method (CARD, EFT, WALLET, CASH, etc.)

• card_token: Tokenized card reference

• wallet_id: Customer wallet identifier

• amount: Payment amount

• status: Payment status

Delivery

Shipping/delivery information:

• type: Fulfillment method (DELIVERY, COLLECTION, DINE_IN)

• address: Delivery destination

• fee: Calculated delivery fee

• estimated_time: Expected delivery/collection time

---

Basket Lifecycle

┌─────────────┐
│   CREATE    │  Customer starts shopping
└──────┬──────┘
       │
       ▼
┌─────────────┐
│   ACTIVE    │  Products added/modified, discounts applied
└──────┬──────┘
       │
       ├──────────────────┐
       │                  │
       ▼                  ▼
┌─────────────┐    ┌─────────────┐
│  CHECKOUT   │    │  ABANDONED  │  No activity for configured period
└──────┬──────┘    └─────────────┘
       │
       ▼
┌─────────────┐
│ CHECKED_OUT │  Payment processed, order created
└─────────────┘

---

Basket Statuses

Status	Description
ACTIVE	Basket is open and can be modified
CHECKED_OUT	Checkout completed, payment processed
ABANDONED	Basket inactive beyond abandonment threshold
EXPIRED	Basket validity period exceeded

---

Fulfillment Methods

The basket service supports multiple fulfillment types:

Type	Description
DELIVERY	Products shipped to customer address
COLLECTION	Customer picks up from store/branch
DINE_IN	For restaurant orders consumed on premises
DRIVE_THROUGH	For quick-service restaurant drive-through

---

Key API Operations

Basket Management

Endpoint	Method	Description
/create/basket	POST	Create a new basket
/basket/{id}	GET	Retrieve basket by ID
/user/basket	GET	Get user's active basket
/user/baskets	GET	List all baskets for a user
/basket/list	GET	List baskets with filters

Product Operations

Endpoint	Method	Description
/add/product	POST	Add product to basket
/update/product	POST	Update product quantity/options
/remove/product	POST	Remove product from basket
/clear/basket	POST	Remove all products from basket

Checkout & Payment

Endpoint	Method	Description
/checkout	POST	Process basket checkout
/pos/checkout	POST	POS-specific checkout
/add/payment	POST	Add payment method to basket
/add/subscription	POST	Convert to subscription order

Discounts & Deals

Endpoint	Method	Description
/add/voucher	POST	Apply voucher/promo code
/remove/voucher	POST	Remove applied voucher
/add/deal	POST	Apply promotional deal
/remove/deal	POST	Remove applied deal

Delivery

Endpoint	Method	Description
/add/delivery	POST	Set delivery address and method
/quote	POST	Get delivery quote/estimate

Analytics & Dashboard

Endpoint	Method	Description
/client/dashboard	GET	Basket dashboard metrics
/client/basket/analytics	GET	Client-level analytics
/user/basket/analytics	GET	User-level basket analytics
/highest/basket/spent	GET	Top spending customer

Kiosk Operations

Endpoint	Method	Description
/create/kiosk/basket	POST	Create and checkout kiosk order

Abandonment

Endpoint	Method	Description
/config/basket/abandonment	POST	Configure abandonment settings

---

Authentication

All Basket API endpoints require JWT Bearer token authentication:

Authorization: Bearer <jwt_token>

API Base URL

The base URL for all API endpoints is:

https://lets-trade-basket-prod.letstrade.global

---

Response Format

All responses follow the standard LetsTrade format:

Success Response:

{
  "success": true,
  "message": "Basket successfully created!",
  "content": {
    "_id": "basket_123",
    "status": "ACTIVE",
    "product_list": [],
    "totals": {
      "subtotal": 0,
      "vat": 0,
      "total": 0
    }
  }
}

Error Response:

{
  "success": false,
  "message": "Product not found in basket",
  "content": null
}

Configure basket abandonment

post

Configures the basket abandonment settings for the client, specifying how long before an inactive basket is marked as abandoned.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Abandonment configuration saved

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

post

/config/basket/abandonment

HTTPcURLJavaScriptPython

POST /v2/config/basket/abandonment HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "frequency": {
    "unit": "HOURS",
    "value": "24"
  }
}

{
  "success": true,
  "message": "Successully configured basket abandonment.",
  "content": {
    "_id": "text",
    "client_id": "text",
    "status": "text",
    "frequency": {
      "unit": "HOURS",
      "value": "text"
    }
  }
}

Get highest spending customer

get

Retrieves the customer with the highest basket spending for the client.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Highest spending customer retrieved

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

get

/highest/basket/spent

HTTPcURLJavaScriptPython

GET /v2/highest/basket/spent HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Highest basket spent successfully retrieved!",
  "content": {
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "total_spent": "text",
    "order_count": 1
  }
}

Get client basket analytics

get

Retrieves aggregated basket analytics for the client.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Client analytics retrieved

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

get

/client/basket/analytics

HTTPcURLJavaScriptPython

GET /v2/client/basket/analytics HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Client basket analytics successfully retrieved!",
  "content": {
    "total_baskets": 1,
    "total_revenue": "text",
    "average_basket_value": "text",
    "active_baskets": 1,
    "abandoned_baskets": 1
  }
}

Get user dashboard analytics

get

Retrieves dashboard analytics for a specific user.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

user_idstringRequired

User ID

Responses

200

User dashboard analytics retrieved

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

get

/user/dashboard/analytics

HTTPcURLJavaScriptPython

GET /v2/user/dashboard/analytics?user_id=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "User dashboard analytics successfully retrieved!",
  "content": {
    "recent_orders": [
      {
        "_id": "text",
        "user_id": "text",
        "user": {
          "_id": "text",
          "user_id": "text",
          "name": "John",
          "surname": "Doe",
          "email": "[email protected]",
          "mobile": "[phone]"
        },
        "client_id": "text",
        "delivery_fee": "50.00",
        "total": "250.00",
        "vat": "32.61",
        "sub_total": "200.00",
        "discount_total": "0.00",
        "deal_total": "0.00",
        "voucher_total": "0.00",
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "branch_group": {
          "_id": "text",
          "name": "text"
        },
        "status": "ACTIVE",
        "channel": "WEB",
        "provider": "text",
        "straw": true,
        "cutlery": true,
        "serviettes": true,
        "instructions": "text",
        "type": "DELIVERY",
        "scheduled_time": "text",
        "product_list": [
          {
            "_id": "text",
            "title": "text",
            "price": "text",
            "quantity": "text",
            "instructions": "text",
            "variations": [
              {}
            ],
            "condiments": [
              {}
            ],
            "branch": {
              "_id": "text",
              "name": "text"
            },
            "address": {
              "full_address": "123 Main Street, Sandton, Johannesburg",
              "longitude": "28.0436",
              "latitude": "-26.1076",
              "line_one": "123 Main Street",
              "line_two": "Suite 100",
              "town": "Sandton",
              "city": "Johannesburg",
              "province": "Gauteng",
              "country": "South Africa",
              "postal_code": "2196",
              "platform": "text",
              "scheduled_time": "text",
              "instructions": "text",
              "is_residential": true,
              "business_name": "text",
              "complex_building_details": "text"
            }
          }
        ],
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        },
        "outstanding_amount": "text",
        "paid_amount": "text",
        "deals": [
          {
            "id": "text",
            "quantity": 1,
            "value": 1,
            "pid": "text",
            "sku": "text",
            "name": "text"
          }
        ],
        "vouchers": [
          {
            "id": "text",
            "certificate_code": "text",
            "quantity": 1,
            "value": 1,
            "pid": "text",
            "sku": "text",
            "name": "text"
          }
        ],
        "extra_data": {},
        "createdAt": "2026-01-20T11:52:20.410Z",
        "updatedAt": "2026-01-20T11:52:20.410Z"
      }
    ],
    "total_spent": "text",
    "order_count": 1
  }
}

Get user basket analytics

get

Retrieves basket analytics for a specific user.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

user_idstringRequired

User ID

Responses

200

User basket analytics retrieved

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

get

/user/basket/analytics

HTTPcURLJavaScriptPython

GET /v2/user/basket/analytics?user_id=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "User basket analytics successfully retrieved!",
  "content": {
    "total_orders": 1,
    "total_spent": "text",
    "average_order_value": "text",
    "last_purchase_date": "2026-01-20T11:52:20.410Z"
  }
}

Checkout a basket

post

Completes the checkout process for a basket, processing payment and finalizing the order.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

_idstringRequired

Basket ID

transactionobjectOptional

Transaction details

walletobjectOptional

Wallet payment details

loan_amountstringOptional

Loan amount if applicable

laybuy_amountstringOptional

Laybuy amount if applicable

strawbooleanOptional

Include straw

cutlerybooleanOptional

Include cutlery

serviettesbooleanOptional

Include serviettes

instructionsstringOptional

Special instructions

time_stampstringOptional

Checkout timestamp

Responses

200

Basket successfully checked out

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

post

/checkout

HTTPcURLJavaScriptPython

POST /v2/checkout HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 559

{
  "_id": "text",
  "transaction": {},
  "wallet": {},
  "loan_amount": "text",
  "laybuy_amount": "text",
  "card": {
    "id": "text",
    "card_type": "text",
    "card_number": "text",
    "expiry_date": "text",
    "vault_id": "text"
  },
  "straw": true,
  "cutlery": true,
  "serviettes": true,
  "instructions": "text",
  "time_stamp": "text",
  "vouchers": [
    {
      "id": "text",
      "certificate_code": "text",
      "quantity": 1,
      "value": 1,
      "pid": "text",
      "sku": "text",
      "name": "text"
    }
  ],
  "subscriptions": [
    {
      "id": "text",
      "quantity": 1,
      "value": 1,
      "pid": "text",
      "sku": "text"
    }
  ],
  "deals": [
    {
      "id": "text",
      "quantity": 1,
      "value": 1,
      "pid": "text",
      "sku": "text",
      "name": "text"
    }
  ]
}

{
  "success": true,
  "message": "Basket successfully checked out!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Request payment for a basket

post

Sends a payment request to a user for a basket, typically via email.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

_idstringRequired

Basket ID

notesstringOptional

Payment notes

Responses

200

Payment request sent successfully

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

post

/payment/request

HTTPcURLJavaScriptPython

POST /v2/payment/request HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "_id": "text",
  "notes": "text",
  "user": {
    "_id": "text",
    "email": "text",
    "name": "text",
    "surname": "text"
  }
}

{
  "success": true,
  "message": "Payment request sent successfully!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Create a new basket

post

Creates a new shopping basket for a user with optional products and delivery address.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

user_idstringOptional

User ID

branch_idstringOptional

Branch ID

branch_group_idstringOptional

Branch group ID

typestring · enumOptionalPossible values:

channelstringOptional

Sales channel

extra_dataobjectOptional

Additional custom data

Responses

200

Basket successfully created

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

post

/create

HTTPcURLJavaScriptPython

POST /v2/create HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1296

{
  "user_id": "text",
  "user": {
    "_id": "text",
    "user_id": "text",
    "name": "John",
    "surname": "Doe",
    "email": "[email protected]",
    "mobile": "[phone]"
  },
  "branch_id": "text",
  "branch_group_id": "text",
  "type": "DELIVERY",
  "address": {
    "full_address": "123 Main Street, Sandton, Johannesburg",
    "longitude": "28.0436",
    "latitude": "-26.1076",
    "line_one": "123 Main Street",
    "line_two": "Suite 100",
    "town": "Sandton",
    "city": "Johannesburg",
    "province": "Gauteng",
    "country": "South Africa",
    "postal_code": "2196",
    "platform": "text",
    "scheduled_time": "text",
    "instructions": "text",
    "is_residential": true,
    "business_name": "text",
    "complex_building_details": "text"
  },
  "product_list": [
    {
      "_id": "text",
      "quantity": "1",
      "instructions": "text",
      "variations": [
        {
          "_id": "text",
          "quantity": "text",
          "condiments": [
            {
              "_id": "text",
              "quantity": "text"
            }
          ]
        }
      ],
      "condiments": [
        {
          "_id": "text",
          "quantity": "text"
        }
      ],
      "branch": {
        "_id": "text"
      },
      "address": {
        "full_address": "123 Main Street, Sandton, Johannesburg",
        "longitude": "28.0436",
        "latitude": "-26.1076",
        "line_one": "123 Main Street",
        "line_two": "Suite 100",
        "town": "Sandton",
        "city": "Johannesburg",
        "province": "Gauteng",
        "country": "South Africa",
        "postal_code": "2196",
        "platform": "text",
        "scheduled_time": "text",
        "instructions": "text",
        "is_residential": true,
        "business_name": "text",
        "complex_building_details": "text"
      }
    }
  ],
  "channel": "text",
  "extra_data": {}
}

{
  "success": true,
  "message": "Basket successfully created!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Cancel a basket

put

Cancels an existing basket by setting its status to CANCELLED.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

_idstringRequired

Basket ID to cancel

Responses

200

Basket successfully cancelled

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

put

/cancel

HTTPcURLJavaScriptPython

PUT /v2/cancel HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "_id": "text"
}

{
  "success": true,
  "message": "Successfully cancelled basket!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Create and checkout a POS basket

post

Creates a Point of Sale basket and immediately checks it out. Used for in-store transactions.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

client_idstringOptional

Client ID

user_idstringOptional

User ID

branch_idstringOptional

Branch ID

uuidstringOptional

Unique identifier for the basket

delivery_feestringOptional

Delivery fee

outstanding_amountstringOptional

Outstanding amount

totalstringOptional

Total amount

service_feestringOptional

Service fee

product_handling_feesstringOptional

Product handling fees

vatstringOptional

VAT amount

sub_totalstringOptional

Subtotal

Responses

200

POS basket successfully created and checked out

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

post

/create/pos/basket

HTTPcURLJavaScriptPython

POST /v2/create/pos/basket HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 626

{
  "client_id": "text",
  "user_id": "text",
  "branch_id": "text",
  "user": {
    "_id": "text",
    "user_id": "text",
    "name": "John",
    "surname": "Doe",
    "email": "[email protected]",
    "mobile": "[phone]"
  },
  "uuid": "text",
  "delivery_fee": "text",
  "outstanding_amount": "text",
  "total": "text",
  "service_fee": "text",
  "product_handling_fees": "text",
  "vat": "text",
  "sub_total": "text",
  "product_list": [
    {
      "pid": "text",
      "title": "text",
      "name": "text",
      "sub_title": "text",
      "price": "text",
      "quantity": "text",
      "sku": "text",
      "barcode": "text",
      "discount": "text",
      "on_promotion": true,
      "promotion_price": "text",
      "description": "text",
      "image_url": "text",
      "deal": {},
      "vouchers": [
        {}
      ],
      "add_ons": [
        {}
      ]
    }
  ]
}

{
  "success": true,
  "message": "Successfully create and checkout basket!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Create and immediately checkout a basket

post

Creates a new basket with products and immediately proceeds to checkout.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

branch_idstringRequired

Branch ID

typestringRequired

Order type (DELIVERY, COLLECTION, etc.)

Responses

200

Basket successfully created and checked out

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

post

/create/checkout/basket

HTTPcURLJavaScriptPython

POST /v2/create/checkout/basket HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1119

{
  "branch_id": "text",
  "type": "text",
  "user": {
    "user_id": "text",
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    }
  },
  "products": [
    {
      "_id": "text",
      "quantity": "1",
      "instructions": "text",
      "variations": [
        {
          "_id": "text",
          "quantity": "text",
          "condiments": [
            {
              "_id": "text",
              "quantity": "text"
            }
          ]
        }
      ],
      "condiments": [
        {
          "_id": "text",
          "quantity": "text"
        }
      ],
      "branch": {
        "_id": "text"
      },
      "address": {
        "full_address": "123 Main Street, Sandton, Johannesburg",
        "longitude": "28.0436",
        "latitude": "-26.1076",
        "line_one": "123 Main Street",
        "line_two": "Suite 100",
        "town": "Sandton",
        "city": "Johannesburg",
        "province": "Gauteng",
        "country": "South Africa",
        "postal_code": "2196",
        "platform": "text",
        "scheduled_time": "text",
        "instructions": "text",
        "is_residential": true,
        "business_name": "text",
        "complex_building_details": "text"
      }
    }
  ]
}

{
  "success": true,
  "message": "Successfully create and checkout basket!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Submit basket as quote

post

Submits a basket as a quote for review, typically used for B2B or custom pricing scenarios.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

_idstringRequired

Basket ID to submit as quote

Responses

200

Quote successfully submitted

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

post

/submit/quote

HTTPcURLJavaScriptPython

POST /v2/submit/quote HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "_id": "text"
}

{
  "success": true,
  "message": "Successfully submitted basket quote!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Retrieve a basket

get

Retrieves a specific basket by ID, user ID, or UUID.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

_idstringOptional

Basket ID

user_idstringOptional

User ID

uuidstringOptional

Basket UUID

flat_structurebooleanOptional

Return flat product structure

branch_idstringOptional

Branch ID filter

Responses

200

Basket successfully retrieved

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

get

/basket

HTTPcURLJavaScriptPython

GET /v2/basket HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Successfully retrieved basket!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Get latest basket

post

Retrieves the most recent basket for a user or UUID with optional status filtering.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

_idstringOptional

Basket ID

user_idstringOptional

User ID

uuidstringOptional

Basket UUID

flat_structurebooleanOptional

Return flat product structure

branch_idstringOptional

Branch ID filter

status_liststring[]Optional

List of statuses to filter by

Responses

200

Latest basket successfully retrieved

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

post

/get/latest/basket

HTTPcURLJavaScriptPython

POST /v2/get/latest/basket HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Successfully retrieved basket!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Get baskets for branches

post

Retrieves baskets for specified branches with optional date filtering and pagination.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

branch_id_liststring[]Required

List of branch IDs

from_datestringOptional

Start date filter (ISO format)

to_datestringOptional

End date filter (ISO format)

pagestringOptional

Page number

sizestringOptional

Page size

Responses

200

Branch baskets successfully retrieved

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

post

/get/branch/basket

HTTPcURLJavaScriptPython

POST /v2/get/branch/basket HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "branch_id_list": [
    "text"
  ],
  "from_date": "text",
  "to_date": "text",
  "page": "text",
  "size": "text"
}

{
  "success": true,
  "message": "Successfully branch basket list!",
  "content": [
    {
      "_id": "text",
      "user_id": "text",
      "user": {
        "_id": "text",
        "user_id": "text",
        "name": "John",
        "surname": "Doe",
        "email": "[email protected]",
        "mobile": "[phone]"
      },
      "client_id": "text",
      "delivery_fee": "50.00",
      "total": "250.00",
      "vat": "32.61",
      "sub_total": "200.00",
      "discount_total": "0.00",
      "deal_total": "0.00",
      "voucher_total": "0.00",
      "branch": {
        "_id": "text",
        "name": "text"
      },
      "branch_group": {
        "_id": "text",
        "name": "text"
      },
      "status": "ACTIVE",
      "channel": "WEB",
      "provider": "text",
      "straw": true,
      "cutlery": true,
      "serviettes": true,
      "instructions": "text",
      "type": "DELIVERY",
      "scheduled_time": "text",
      "product_list": [
        {
          "_id": "text",
          "title": "text",
          "price": "text",
          "quantity": "text",
          "instructions": "text",
          "variations": [
            {}
          ],
          "condiments": [
            {}
          ],
          "branch": {
            "_id": "text",
            "name": "text"
          },
          "address": {
            "full_address": "123 Main Street, Sandton, Johannesburg",
            "longitude": "28.0436",
            "latitude": "-26.1076",
            "line_one": "123 Main Street",
            "line_two": "Suite 100",
            "town": "Sandton",
            "city": "Johannesburg",
            "province": "Gauteng",
            "country": "South Africa",
            "postal_code": "2196",
            "platform": "text",
            "scheduled_time": "text",
            "instructions": "text",
            "is_residential": true,
            "business_name": "text",
            "complex_building_details": "text"
          }
        }
      ],
      "address": {
        "full_address": "123 Main Street, Sandton, Johannesburg",
        "longitude": "28.0436",
        "latitude": "-26.1076",
        "line_one": "123 Main Street",
        "line_two": "Suite 100",
        "town": "Sandton",
        "city": "Johannesburg",
        "province": "Gauteng",
        "country": "South Africa",
        "postal_code": "2196",
        "platform": "text",
        "scheduled_time": "text",
        "instructions": "text",
        "is_residential": true,
        "business_name": "text",
        "complex_building_details": "text"
      },
      "outstanding_amount": "text",
      "paid_amount": "text",
      "deals": [
        {
          "id": "text",
          "quantity": 1,
          "value": 1,
          "pid": "text",
          "sku": "text",
          "name": "text"
        }
      ],
      "vouchers": [
        {
          "id": "text",
          "certificate_code": "text",
          "quantity": 1,
          "value": 1,
          "pid": "text",
          "sku": "text",
          "name": "text"
        }
      ],
      "extra_data": {},
      "createdAt": "2026-01-20T11:52:20.410Z",
      "updatedAt": "2026-01-20T11:52:20.410Z"
    }
  ]
}

Get user basket list

get

Retrieves a paginated list of baskets for a specific user with filtering options.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

user_idstringRequired

User ID

branch_idstringOptional

Branch ID filter

pagestringOptional

Page number

sizestringOptional

Page size

from_datestringOptional

Start date filter

to_datestringOptional

End date filter

statusstringOptional

Status filter

typestringOptional

Order type filter

search_stringstringOptional

Search string

Responses

200

User basket list successfully retrieved

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

get

/user/basket/list

HTTPcURLJavaScriptPython

GET /v2/user/basket/list?user_id=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Successfully retrieved user basket list!",
  "content": [
    {
      "_id": "text",
      "user_id": "text",
      "user": {
        "_id": "text",
        "user_id": "text",
        "name": "John",
        "surname": "Doe",
        "email": "[email protected]",
        "mobile": "[phone]"
      },
      "client_id": "text",
      "delivery_fee": "50.00",
      "total": "250.00",
      "vat": "32.61",
      "sub_total": "200.00",
      "discount_total": "0.00",
      "deal_total": "0.00",
      "voucher_total": "0.00",
      "branch": {
        "_id": "text",
        "name": "text"
      },
      "branch_group": {
        "_id": "text",
        "name": "text"
      },
      "status": "ACTIVE",
      "channel": "WEB",
      "provider": "text",
      "straw": true,
      "cutlery": true,
      "serviettes": true,
      "instructions": "text",
      "type": "DELIVERY",
      "scheduled_time": "text",
      "product_list": [
        {
          "_id": "text",
          "title": "text",
          "price": "text",
          "quantity": "text",
          "instructions": "text",
          "variations": [
            {}
          ],
          "condiments": [
            {}
          ],
          "branch": {
            "_id": "text",
            "name": "text"
          },
          "address": {
            "full_address": "123 Main Street, Sandton, Johannesburg",
            "longitude": "28.0436",
            "latitude": "-26.1076",
            "line_one": "123 Main Street",
            "line_two": "Suite 100",
            "town": "Sandton",
            "city": "Johannesburg",
            "province": "Gauteng",
            "country": "South Africa",
            "postal_code": "2196",
            "platform": "text",
            "scheduled_time": "text",
            "instructions": "text",
            "is_residential": true,
            "business_name": "text",
            "complex_building_details": "text"
          }
        }
      ],
      "address": {
        "full_address": "123 Main Street, Sandton, Johannesburg",
        "longitude": "28.0436",
        "latitude": "-26.1076",
        "line_one": "123 Main Street",
        "line_two": "Suite 100",
        "town": "Sandton",
        "city": "Johannesburg",
        "province": "Gauteng",
        "country": "South Africa",
        "postal_code": "2196",
        "platform": "text",
        "scheduled_time": "text",
        "instructions": "text",
        "is_residential": true,
        "business_name": "text",
        "complex_building_details": "text"
      },
      "outstanding_amount": "text",
      "paid_amount": "text",
      "deals": [
        {
          "id": "text",
          "quantity": 1,
          "value": 1,
          "pid": "text",
          "sku": "text",
          "name": "text"
        }
      ],
      "vouchers": [
        {
          "id": "text",
          "certificate_code": "text",
          "quantity": 1,
          "value": 1,
          "pid": "text",
          "sku": "text",
          "name": "text"
        }
      ],
      "extra_data": {},
      "createdAt": "2026-01-20T11:52:20.410Z",
      "updatedAt": "2026-01-20T11:52:20.410Z"
    }
  ]
}

Get client basket list

get

Retrieves a paginated list of all baskets for the client with advanced filtering and sorting options.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pagestringOptional

Page number

sizestringOptional

Page size

from_datestringOptional

Start date filter (created)

to_datestringOptional

End date filter (created)

statusstringOptional

Status filter

typestringOptional

Order type filter

branch_idstringOptional

Branch ID filter

search_stringstringOptional

Search string

sort_bystringOptional

Field to sort by

order_bystringOptional

Sort order (asc/desc)

Responses

200

Client basket list successfully retrieved

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

get

/client/basket/list

HTTPcURLJavaScriptPython

GET /v2/client/basket/list HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Successfully retrieved branch basket list!",
  "content": [
    {
      "_id": "text",
      "user_id": "text",
      "user": {
        "_id": "text",
        "user_id": "text",
        "name": "John",
        "surname": "Doe",
        "email": "[email protected]",
        "mobile": "[phone]"
      },
      "client_id": "text",
      "delivery_fee": "50.00",
      "total": "250.00",
      "vat": "32.61",
      "sub_total": "200.00",
      "discount_total": "0.00",
      "deal_total": "0.00",
      "voucher_total": "0.00",
      "branch": {
        "_id": "text",
        "name": "text"
      },
      "branch_group": {
        "_id": "text",
        "name": "text"
      },
      "status": "ACTIVE",
      "channel": "WEB",
      "provider": "text",
      "straw": true,
      "cutlery": true,
      "serviettes": true,
      "instructions": "text",
      "type": "DELIVERY",
      "scheduled_time": "text",
      "product_list": [
        {
          "_id": "text",
          "title": "text",
          "price": "text",
          "quantity": "text",
          "instructions": "text",
          "variations": [
            {}
          ],
          "condiments": [
            {}
          ],
          "branch": {
            "_id": "text",
            "name": "text"
          },
          "address": {
            "full_address": "123 Main Street, Sandton, Johannesburg",
            "longitude": "28.0436",
            "latitude": "-26.1076",
            "line_one": "123 Main Street",
            "line_two": "Suite 100",
            "town": "Sandton",
            "city": "Johannesburg",
            "province": "Gauteng",
            "country": "South Africa",
            "postal_code": "2196",
            "platform": "text",
            "scheduled_time": "text",
            "instructions": "text",
            "is_residential": true,
            "business_name": "text",
            "complex_building_details": "text"
          }
        }
      ],
      "address": {
        "full_address": "123 Main Street, Sandton, Johannesburg",
        "longitude": "28.0436",
        "latitude": "-26.1076",
        "line_one": "123 Main Street",
        "line_two": "Suite 100",
        "town": "Sandton",
        "city": "Johannesburg",
        "province": "Gauteng",
        "country": "South Africa",
        "postal_code": "2196",
        "platform": "text",
        "scheduled_time": "text",
        "instructions": "text",
        "is_residential": true,
        "business_name": "text",
        "complex_building_details": "text"
      },
      "outstanding_amount": "text",
      "paid_amount": "text",
      "deals": [
        {
          "id": "text",
          "quantity": 1,
          "value": 1,
          "pid": "text",
          "sku": "text",
          "name": "text"
        }
      ],
      "vouchers": [
        {
          "id": "text",
          "certificate_code": "text",
          "quantity": 1,
          "value": 1,
          "pid": "text",
          "sku": "text",
          "name": "text"
        }
      ],
      "extra_data": {},
      "createdAt": "2026-01-20T11:52:20.410Z",
      "updatedAt": "2026-01-20T11:52:20.410Z"
    }
  ]
}

Add product to basket

post

Adds a single product to an existing basket with optional variations and condiments.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

_idstringRequired

Basket ID

dynamic_pricestringOptional

Override product price

Responses

200

Product successfully added

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

post

/add/product

HTTPcURLJavaScriptPython

POST /v2/add/product HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 680

{
  "_id": "text",
  "product": {
    "_id": "text",
    "quantity": "1",
    "instructions": "text",
    "variations": [
      {
        "_id": "text",
        "quantity": "text",
        "condiments": [
          {
            "_id": "text",
            "quantity": "text"
          }
        ]
      }
    ],
    "condiments": [
      {
        "_id": "text",
        "quantity": "text"
      }
    ],
    "branch": {
      "_id": "text"
    },
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    }
  },
  "dynamic_price": "text"
}

{
  "success": true,
  "message": "Successfully added product to basket.",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Add multiple products to basket

post

Adds multiple products to an existing basket in a single request.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

_idstringRequired

Basket ID

Responses

200

Products successfully added

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

post

/add/products

HTTPcURLJavaScriptPython

POST /v2/add/products HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 660

{
  "_id": "text",
  "products": [
    {
      "_id": "text",
      "quantity": "1",
      "instructions": "text",
      "variations": [
        {
          "_id": "text",
          "quantity": "text",
          "condiments": [
            {
              "_id": "text",
              "quantity": "text"
            }
          ]
        }
      ],
      "condiments": [
        {
          "_id": "text",
          "quantity": "text"
        }
      ],
      "branch": {
        "_id": "text"
      },
      "address": {
        "full_address": "123 Main Street, Sandton, Johannesburg",
        "longitude": "28.0436",
        "latitude": "-26.1076",
        "line_one": "123 Main Street",
        "line_two": "Suite 100",
        "town": "Sandton",
        "city": "Johannesburg",
        "province": "Gauteng",
        "country": "South Africa",
        "postal_code": "2196",
        "platform": "text",
        "scheduled_time": "text",
        "instructions": "text",
        "is_residential": true,
        "business_name": "text",
        "complex_building_details": "text"
      }
    }
  ]
}

{
  "success": true,
  "message": "Successfully added product to basket.",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Update basket status

put

Updates the status of a basket (ACTIVE, PROCESSING, ABANDONED, CANCELLED, QUOTE).

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

_idstringRequired

Basket ID

statusstring · enumRequired

New basket status

Possible values:

Responses

200

Status successfully updated

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

put

/update/basket/status

HTTPcURLJavaScriptPython

PUT /v2/update/basket/status HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "_id": "text",
  "status": "ACTIVE"
}

{
  "success": true,
  "message": "Successfully updated basket status!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Remove products from basket

put

Removes specified products from a basket by their IDs.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

_idstringRequired

Basket ID

product_id_liststring[]Required

List of product IDs to remove

Responses

200

Products successfully removed

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

put

/remove/products

HTTPcURLJavaScriptPython

PUT /v2/remove/products HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "_id": "text",
  "product_id_list": [
    "text"
  ]
}

{
  "success": true,
  "message": "Successfully removed products from the basket!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Update basket

put

Updates basket properties such as delivery address, type, provider, and scheduled time.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

_idstringRequired

Basket ID

Responses

200

Basket successfully updated

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

put

/update/basket

HTTPcURLJavaScriptPython

PUT /v2/update/basket HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 710

{
  "_id": "text",
  "basket": {
    "outstanding_amount": "text",
    "paid_amount": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "type": "text",
    "provider": "text",
    "branch_id": "text",
    "user_id": "text",
    "branch_group_id": "text",
    "scheduled_time": "text",
    "instructions": "text",
    "delivery_fee": "text",
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "extra_data": {}
  }
}

{
  "success": true,
  "message": "Basket successfully updated!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Apply or remove voucher from basket

put

Applies or removes a voucher from a basket.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

basket_idstringRequired

Basket ID

voucher_codestringRequired

Voucher code to apply

appliedbooleanRequired

Whether to apply or remove voucher

redemption_idstringOptional

Redemption ID if applicable

Responses

200

Voucher application successfully updated

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

put

/update/basket/voucher

HTTPcURLJavaScriptPython

PUT /v2/update/basket/voucher HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "basket_id": "text",
  "voucher_code": "text",
  "applied": true,
  "redemption_id": "text"
}

{
  "success": true,
  "message": "Voucher application successfully updated.",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Update product in basket

put

Updates a specific product in a basket (quantity, instructions, etc.).

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

_idstringRequired

Basket ID

Responses

200

Product successfully updated

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

put

/update/product

HTTPcURLJavaScriptPython

PUT /v2/update/product HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 515

{
  "_id": "text",
  "product": {
    "_id": "text",
    "quantity": "text",
    "instruction": "text",
    "branch": {
      "_id": "text"
    },
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    }
  }
}

{
  "success": true,
  "message": "Successfully updated basket product",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Update POS basket

put

Updates a Point of Sale basket with amounts, products, deals, and vouchers.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

_idstringRequired

Basket ID

Responses

200

POS basket successfully updated

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

put

/update/pos/basket

HTTPcURLJavaScriptPython

PUT /v2/update/pos/basket HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 596

{
  "_id": "text",
  "basket": {
    "outstanding_amount": "text",
    "paid_amount": "text",
    "product_list": [
      {
        "pid": "text",
        "title": "text",
        "name": "text",
        "sub_title": "text",
        "price": "text",
        "quantity": "text",
        "sku": "text",
        "barcode": "text",
        "discount": "text",
        "on_promotion": true,
        "promotion_price": "text",
        "description": "text",
        "image_url": "text",
        "deal": {},
        "vouchers": [
          {}
        ],
        "add_ons": [
          {}
        ]
      }
    ],
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vat": "text",
    "sub_total": "text"
  }
}

{
  "success": true,
  "message": "POS basket amounts successfully updated!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Apply Starshipit delivery rate

post

Applies a selected Starshipit shipping rate to a basket.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

basket_idstringRequired

Basket ID

Responses

200

Rate successfully applied

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

post

/basket/apply/starshipit/rate

HTTPcURLJavaScriptPython

POST /v2/basket/apply/starshipit/rate HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "basket_id": "text",
  "rate": {
    "rate_id": "text",
    "id": "text",
    "carrier": "text",
    "service": "text",
    "price": 1,
    "currency": "text",
    "estimated_delivery_days": 1
  }
}

{
  "success": true,
  "message": "Successfully applied Starshipit rate to basket!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}

Prepare Starshipit rate request

post

Prepares a rate request for Starshipit shipping based on basket and address.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

basket_idstringRequired

Basket ID

Responses

200

Rate request prepared successfully

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

post

/basket/starshipit/rates/prepare

HTTPcURLJavaScriptPython

POST /v2/basket/starshipit/rates/prepare HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 433

{
  "basket_id": "text",
  "address": {
    "full_address": "123 Main Street, Sandton, Johannesburg",
    "longitude": "28.0436",
    "latitude": "-26.1076",
    "line_one": "123 Main Street",
    "line_two": "Suite 100",
    "town": "Sandton",
    "city": "Johannesburg",
    "province": "Gauteng",
    "country": "South Africa",
    "postal_code": "2196",
    "platform": "text",
    "scheduled_time": "text",
    "instructions": "text",
    "is_residential": true,
    "business_name": "text",
    "complex_building_details": "text"
  }
}

{
  "success": true,
  "message": "Successfully prepared Starshipit rate request!",
  "content": {
    "rates": [
      {
        "rate_id": "text",
        "id": "text",
        "carrier": "text",
        "service": "text",
        "price": 1,
        "currency": "text",
        "estimated_delivery_days": 1
      }
    ],
    "request_id": "text"
  }
}

Get client basket dashboard

get

Retrieves basket dashboard data for a client including basket status groupings.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

periodstringRequired

Dashboard period (e.g., daily, weekly, monthly)

branch_idstringOptional

Branch ID filter

branch_id_liststringOptional

Comma-separated branch IDs

Responses

200

Dashboard data retrieved

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

get

/client/dashboard

HTTPcURLJavaScriptPython

GET /v2/client/dashboard?period=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Successfully retrieved basket dashboard!",
  "content": {
    "period": "text",
    "total_baskets": 1,
    "total_revenue": "text",
    "average_basket_value": "text",
    "baskets_by_status": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "baskets_by_type": {
      "ANY_ADDITIONAL_PROPERTY": 1
    }
  }
}

Create kiosk basket

post

Creates a new basket for kiosk orders and immediately checks it out.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

user_idstringOptional

User ID

branch_idstringOptional

Branch ID

channelstringOptional

Sales channel (e.g., KIOSK)

extra_dataobjectOptional

Additional custom data

instructionsstringOptional

Order instructions

Responses

200

Kiosk basket created and checked out

application/json

400

Bad request - validation failed or invalid parameters

application/json

401

Unauthorized - missing or invalid JWT token

application/json

post

/create/kiosk/basket

HTTPcURLJavaScriptPython

POST /v2/create/kiosk/basket HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 862

{
  "user_id": "text",
  "user": {
    "_id": "text",
    "user_id": "text",
    "name": "John",
    "surname": "Doe",
    "email": "[email protected]",
    "mobile": "[phone]"
  },
  "branch_id": "text",
  "channel": "text",
  "extra_data": {},
  "product_list": [
    {
      "_id": "text",
      "quantity": "1",
      "instructions": "text",
      "variations": [
        {
          "_id": "text",
          "quantity": "text",
          "condiments": [
            {
              "_id": "text",
              "quantity": "text"
            }
          ]
        }
      ],
      "condiments": [
        {
          "_id": "text",
          "quantity": "text"
        }
      ],
      "branch": {
        "_id": "text"
      },
      "address": {
        "full_address": "123 Main Street, Sandton, Johannesburg",
        "longitude": "28.0436",
        "latitude": "-26.1076",
        "line_one": "123 Main Street",
        "line_two": "Suite 100",
        "town": "Sandton",
        "city": "Johannesburg",
        "province": "Gauteng",
        "country": "South Africa",
        "postal_code": "2196",
        "platform": "text",
        "scheduled_time": "text",
        "instructions": "text",
        "is_residential": true,
        "business_name": "text",
        "complex_building_details": "text"
      }
    }
  ],
  "instructions": "text"
}

{
  "success": true,
  "message": "Basket successfully checked out!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "user": {
      "_id": "text",
      "user_id": "text",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "mobile": "[phone]"
    },
    "client_id": "text",
    "delivery_fee": "50.00",
    "total": "250.00",
    "vat": "32.61",
    "sub_total": "200.00",
    "discount_total": "0.00",
    "deal_total": "0.00",
    "voucher_total": "0.00",
    "branch": {
      "_id": "text",
      "name": "text"
    },
    "branch_group": {
      "_id": "text",
      "name": "text"
    },
    "status": "ACTIVE",
    "channel": "WEB",
    "provider": "text",
    "straw": true,
    "cutlery": true,
    "serviettes": true,
    "instructions": "text",
    "type": "DELIVERY",
    "scheduled_time": "text",
    "product_list": [
      {
        "_id": "text",
        "title": "text",
        "price": "text",
        "quantity": "text",
        "instructions": "text",
        "variations": [
          {}
        ],
        "condiments": [
          {}
        ],
        "branch": {
          "_id": "text",
          "name": "text"
        },
        "address": {
          "full_address": "123 Main Street, Sandton, Johannesburg",
          "longitude": "28.0436",
          "latitude": "-26.1076",
          "line_one": "123 Main Street",
          "line_two": "Suite 100",
          "town": "Sandton",
          "city": "Johannesburg",
          "province": "Gauteng",
          "country": "South Africa",
          "postal_code": "2196",
          "platform": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text"
        }
      }
    ],
    "address": {
      "full_address": "123 Main Street, Sandton, Johannesburg",
      "longitude": "28.0436",
      "latitude": "-26.1076",
      "line_one": "123 Main Street",
      "line_two": "Suite 100",
      "town": "Sandton",
      "city": "Johannesburg",
      "province": "Gauteng",
      "country": "South Africa",
      "postal_code": "2196",
      "platform": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text"
    },
    "outstanding_amount": "text",
    "paid_amount": "text",
    "deals": [
      {
        "id": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "vouchers": [
      {
        "id": "text",
        "certificate_code": "text",
        "quantity": 1,
        "value": 1,
        "pid": "text",
        "sku": "text",
        "name": "text"
      }
    ],
    "extra_data": {},
    "createdAt": "2026-01-20T11:52:20.410Z",
    "updatedAt": "2026-01-20T11:52:20.410Z"
  }
}