Order

What is the Order Service?

The Order service is the core transactional engine of the LetsTrade platform. It manages the complete lifecycle of customer purchases - from the moment a customer checks out, through fulfillment and delivery, to potential refunds.

Core Entities

Order

An Order is a customer purchase transaction. It's created when:

A customer completes checkout from their shopping basket
An order comes in from an external sales channel (Shopify, Uber Eats, Takealot, etc.)

Each order contains:

Products: The items being purchased with quantities and prices
Customer info: Who placed the order and where to deliver
Payment details: How the order was paid for
Status tracking: Current state and full history of status changes
Fulfillment method: Delivery to address or collection from store

Parcel

A Parcel is the physical package used to ship an order. Think of it as the "shipping side" of an order:

One order can have multiple parcels (e.g., items shipped separately)
One parcel can combine items from multiple orders (batch shipping)
Parcels track the physical journey: packed → collected by driver → in transit → delivered

Quote

A Quote is a formal price proposal before an order is created. Useful for:

B2B transactions requiring approval
Custom pricing or bulk orders
Customers who want to review pricing before committing

Quotes can be sent to customers, tracked (viewed/accepted/declined), and converted into orders.

Order Lifecycle

Customer Checkout
       ↓
   ORDERED ─────────────────────────────────────┐
       ↓                                        │
   PROCESSING (store prepares items)            │
       ↓                                        │
   DELIVERY-READY                               │ Can be CANCELLED
       ↓                                        │ at any point
   Parcel: IN-TRANSIT                           │
       ↓                                        │
   FULFILLED (delivered/collected)              │
       ↓                                        │
   Complete ────── or ────── REFUNDED ──────────┘

Order Statuses

Status

What it means

ORDERED

Order placed, awaiting processing

PROCESSING

Store is preparing the order

DELIVERY-READY

Packed and ready to ship or collect

PARTIALLY-FULFILLED

Some items delivered, others pending

FULFILLED

All items successfully delivered/collected

CANCELLED

Order was cancelled before completion

REFUNDED

Payment returned to customer

PARTIALLY-REFUNDED

Some items refunded

Parcel Statuses

Status

What it means

OPEN

Parcel created, not yet packed

PACKED

Items packed into boxes

READY

Ready for courier pickup

COLLECTED-BY-DRIVER

Driver has the parcel

IN-TRANSIT

On the way to destination

ARRIVED

At delivery location

DELIVERED

Successfully handed to customer

COLLECTED

Customer picked up from store

RETURNED

Sent back to sender

Fulfillment Methods

Method

Description

Delivery

Items shipped to customer's address

Collection

Customer picks up from store (click & collect)

Refund Scenarios

When things go wrong, the system supports 5 refund scenarios:

Scenario

Situation

What happens

Store can't fulfill (no stock, weather, no driver)

Full refund + delivery fee returned

Customer not available at delivery

Refund minus delivery fee (customer's fault)

Customer rejects (wrong items, damaged goods)

Full refund + delivery fee returned

Store issues voucher (e.g., delayed delivery compensation)

Voucher/store credit issued

POS or loyalty program refunds

Handled externally

Refunds can be issued to:

Wallet: Credit added to customer's account balance
Voucher: Store credit for future purchases

Sales Channels

Orders can come from multiple sources:

Channel

Description

Internal

LetsTrade apps and website

Shopify

Shopify e-commerce stores

Takealot

Takealot marketplace

Uber Eats

Food delivery orders

Munch

Point-of-sale integration

Custom

Other integrated platforms

Each channel order includes the external reference ID for tracking across systems.

Key API Operations

Orders

Create order - From basket checkout or external channel
Get order - Retrieve by ID, code, or basket reference
List orders - Paginated list with filters
Export orders - Download as CSV for reporting
Cancel order - Cancel and optionally refund
Refund order - Issue full or partial refund

Parcels

Create parcel - Create shipping package for order
Get parcel - Track parcel by ID or code

Quotes

Create quote - Generate price proposal
Get quote - Retrieve quote details
Convert to order - Accept quote and create order

Authentication

All API endpoints require JWT Bearer token authentication:

Authorization: Bearer <your-token>

Response Format

All responses follow a consistent structure:

Success:

{
  "success": true,
  "message": "Order created successfully",
  "content": { /* order data */ }
}

Error:

{
  "success": false,
  "message": "Order not found",
  "content": null
}

Create order from external channel

post

Creates an order from an external sales channel (e.g., Uber Eats, Takealot). Used for integrating third-party marketplace orders.

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Body

orderobjectOptional

Order data from external channel

channelstringRequired

Channel name (e.g., UBER, TAKEALOT)

channel_idstringRequired

Channel-specific order ID

basket_idstring | nullableOptional

totalstring | nullableOptional

vatstring | nullableOptional

sub_totalstring | nullableOptional

statusstring | nullableOptional

user_idstring | nullableOptional

branch_idstring | nullableOptional

payment_typestring[] | nullableOptional

product_listobject[] | nullableOptional

requestobject | nullableOptional

Original request from channel

transaction_detailsobject | nullableOptional

Responses

200

Channel order created successfully

application/json

400

Validation error or bad request

application/json

401

Authentication required or invalid token

application/json

post

/create/channel/order

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

{
  "order": {},
  "channel": "text",
  "channel_id": "text",
  "basket_id": "text",
  "total": "text",
  "vat": "text",
  "sub_total": "text",
  "status": "text",
  "user_id": "text",
  "branch_id": "text",
  "payment_type": [
    "text"
  ],
  "product_list": [
    {}
  ],
  "request": {},
  "transaction_details": {}
}

{
  "success": true,
  "message": "Channel order successfully created!",
  "content": {
    "_id": "507f1f77bcf86cd799439011",
    "code": "ORD-2024-001234",
    "user_id": "text",
    "client_id": "text",
    "basket_id": "text",
    "status": "ORDERED",
    "payment_type": [
      "text"
    ],
    "order_date": "2026-01-20T11:54:21.478Z",
    "total": "199.99",
    "vat": "26.09",
    "sub_total": "173.90",
    "delivery_fee": "50.00",
    "number_of_items": "text",
    "type": "text",
    "method": "DELIVERY",
    "channel": "text",
    "product_list": [
      {
        "_id": "text",
        "product_id": "text",
        "title": "text",
        "sku": "text",
        "pid": "text",
        "quantity": "text",
        "price": "text",
        "promotion_price": "text",
        "on_promotion": true,
        "status": "DRAFT",
        "image_url": "text",
        "variations": [
          {}
        ],
        "add_ons": [
          {}
        ]
      }
    ],
    "delivery_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "line_one": "text",
      "line_two": "text",
      "town": "text",
      "city": "text",
      "province": "text",
      "province_code": "text",
      "country": "text",
      "postal_code": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text",
      "full_name": "text",
      "name": "text",
      "surname": "text",
      "cell_number": "text",
      "tracking_url": "text"
    },
    "collection_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "tracking_url": "text",
      "instructions": "text",
      "scheduled_time": "text"
    },
    "branch": {
      "_id": "text",
      "name": "text",
      "display_name": "text"
    },
    "store": {
      "store_id": "text",
      "store_name": "text"
    },
    "user": {
      "_id": "text",
      "name": "text",
      "surname": "text",
      "email": "text",
      "cell_number": "text"
    },
    "transaction_details": {},
    "notes": [
      {
        "user": {
          "_id": "text",
          "display_name": "text"
        },
        "message": "text",
        "date": "2026-01-20T11:54:21.478Z"
      }
    ],
    "status_history": [
      {
        "status": "text",
        "date": "2026-01-20T11:54:21.478Z"
      }
    ],
    "createdAt": "2026-01-20T11:54:21.478Z",
    "updatedAt": "2026-01-20T11:54:21.478Z"
  }
}

Create order from basket

post

Converts an existing shopping basket into a confirmed order. Requires a valid basket ID and payment transaction details.

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Body

basket_idstringRequired

Basket ID to convert to order

transaction_detailsobjectOptional

Payment transaction details

channelstring | nullableOptional

Sales channel identifier

basket_signaturestring | nullableOptional

Basket signature for validation

is_supplier_orderboolean | nullableOptional

Whether this is a supplier order

Responses

200

Order created successfully

application/json

400

Validation error or bad request

application/json

401

Authentication required or invalid token

application/json

post

/create/order

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

{
  "basket_id": "text",
  "transaction_details": {},
  "channel": "text",
  "basket_signature": "text",
  "is_supplier_order": true
}

{
  "success": true,
  "message": "Order successfully created!",
  "content": {
    "_id": "507f1f77bcf86cd799439011",
    "code": "ORD-2024-001234",
    "user_id": "text",
    "client_id": "text",
    "basket_id": "text",
    "status": "ORDERED",
    "payment_type": [
      "text"
    ],
    "order_date": "2026-01-20T11:54:21.478Z",
    "total": "199.99",
    "vat": "26.09",
    "sub_total": "173.90",
    "delivery_fee": "50.00",
    "number_of_items": "text",
    "type": "text",
    "method": "DELIVERY",
    "channel": "text",
    "product_list": [
      {
        "_id": "text",
        "product_id": "text",
        "title": "text",
        "sku": "text",
        "pid": "text",
        "quantity": "text",
        "price": "text",
        "promotion_price": "text",
        "on_promotion": true,
        "status": "DRAFT",
        "image_url": "text",
        "variations": [
          {}
        ],
        "add_ons": [
          {}
        ]
      }
    ],
    "delivery_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "line_one": "text",
      "line_two": "text",
      "town": "text",
      "city": "text",
      "province": "text",
      "province_code": "text",
      "country": "text",
      "postal_code": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text",
      "full_name": "text",
      "name": "text",
      "surname": "text",
      "cell_number": "text",
      "tracking_url": "text"
    },
    "collection_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "tracking_url": "text",
      "instructions": "text",
      "scheduled_time": "text"
    },
    "branch": {
      "_id": "text",
      "name": "text",
      "display_name": "text"
    },
    "store": {
      "store_id": "text",
      "store_name": "text"
    },
    "user": {
      "_id": "text",
      "name": "text",
      "surname": "text",
      "email": "text",
      "cell_number": "text"
    },
    "transaction_details": {},
    "notes": [
      {
        "user": {
          "_id": "text",
          "display_name": "text"
        },
        "message": "text",
        "date": "2026-01-20T11:54:21.478Z"
      }
    ],
    "status_history": [
      {
        "status": "text",
        "date": "2026-01-20T11:54:21.478Z"
      }
    ],
    "createdAt": "2026-01-20T11:54:21.478Z",
    "updatedAt": "2026-01-20T11:54:21.478Z"
  }
}

Create order from customer quote

post

Converts an approved customer quote into a confirmed order. The quote must exist and be in an appropriate status.

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Body

quote_idstringRequired

Customer quote ID to convert to order

transaction_detailsobjectOptional

Payment transaction details

channelstring | nullableOptional

Responses

200

Order created successfully from quote

application/json

400

Validation error or bad request

application/json

401

Authentication required or invalid token

application/json

500

Internal server error

application/json

post

/create/customer/quote/order

POST /v2/create/customer/quote/order HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "quote_id": "text",
  "transaction_details": {},
  "channel": "text"
}

{
  "success": true,
  "message": "Order successfully created!",
  "content": {
    "_id": "507f1f77bcf86cd799439011",
    "code": "ORD-2024-001234",
    "user_id": "text",
    "client_id": "text",
    "basket_id": "text",
    "status": "ORDERED",
    "payment_type": [
      "text"
    ],
    "order_date": "2026-01-20T11:54:21.478Z",
    "total": "199.99",
    "vat": "26.09",
    "sub_total": "173.90",
    "delivery_fee": "50.00",
    "number_of_items": "text",
    "type": "text",
    "method": "DELIVERY",
    "channel": "text",
    "product_list": [
      {
        "_id": "text",
        "product_id": "text",
        "title": "text",
        "sku": "text",
        "pid": "text",
        "quantity": "text",
        "price": "text",
        "promotion_price": "text",
        "on_promotion": true,
        "status": "DRAFT",
        "image_url": "text",
        "variations": [
          {}
        ],
        "add_ons": [
          {}
        ]
      }
    ],
    "delivery_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "line_one": "text",
      "line_two": "text",
      "town": "text",
      "city": "text",
      "province": "text",
      "province_code": "text",
      "country": "text",
      "postal_code": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text",
      "full_name": "text",
      "name": "text",
      "surname": "text",
      "cell_number": "text",
      "tracking_url": "text"
    },
    "collection_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "tracking_url": "text",
      "instructions": "text",
      "scheduled_time": "text"
    },
    "branch": {
      "_id": "text",
      "name": "text",
      "display_name": "text"
    },
    "store": {
      "store_id": "text",
      "store_name": "text"
    },
    "user": {
      "_id": "text",
      "name": "text",
      "surname": "text",
      "email": "text",
      "cell_number": "text"
    },
    "transaction_details": {},
    "notes": [
      {
        "user": {
          "_id": "text",
          "display_name": "text"
        },
        "message": "text",
        "date": "2026-01-20T11:54:21.478Z"
      }
    ],
    "status_history": [
      {
        "status": "text",
        "date": "2026-01-20T11:54:21.478Z"
      }
    ],
    "createdAt": "2026-01-20T11:54:21.478Z",
    "updatedAt": "2026-01-20T11:54:21.478Z"
  }
}

Get a single order

get

Retrieve an order by its ID, code, or associated basket ID. At least one identifier must be provided.

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Query parameters

_idstringOptional

Order MongoDB ObjectId

codestringOptional

Order reference code (e.g., ORD-2024-001234)

basket_idstringOptional

Associated basket ID

Responses

200

Order retrieved successfully

application/json

400

Validation error or bad request

application/json

401

Authentication required or invalid token

application/json

get

/order

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

{
  "success": true,
  "message": "Successfully retrieved order!",
  "content": {
    "_id": "507f1f77bcf86cd799439011",
    "code": "ORD-2024-001234",
    "user_id": "text",
    "client_id": "text",
    "basket_id": "text",
    "status": "ORDERED",
    "payment_type": [
      "text"
    ],
    "order_date": "2026-01-20T11:54:21.478Z",
    "total": "199.99",
    "vat": "26.09",
    "sub_total": "173.90",
    "delivery_fee": "50.00",
    "number_of_items": "text",
    "type": "text",
    "method": "DELIVERY",
    "channel": "text",
    "product_list": [
      {
        "_id": "text",
        "product_id": "text",
        "title": "text",
        "sku": "text",
        "pid": "text",
        "quantity": "text",
        "price": "text",
        "promotion_price": "text",
        "on_promotion": true,
        "status": "DRAFT",
        "image_url": "text",
        "variations": [
          {}
        ],
        "add_ons": [
          {}
        ]
      }
    ],
    "delivery_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "line_one": "text",
      "line_two": "text",
      "town": "text",
      "city": "text",
      "province": "text",
      "province_code": "text",
      "country": "text",
      "postal_code": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text",
      "full_name": "text",
      "name": "text",
      "surname": "text",
      "cell_number": "text",
      "tracking_url": "text"
    },
    "collection_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "tracking_url": "text",
      "instructions": "text",
      "scheduled_time": "text"
    },
    "branch": {
      "_id": "text",
      "name": "text",
      "display_name": "text"
    },
    "store": {
      "store_id": "text",
      "store_name": "text"
    },
    "user": {
      "_id": "text",
      "name": "text",
      "surname": "text",
      "email": "text",
      "cell_number": "text"
    },
    "transaction_details": {},
    "notes": [
      {
        "user": {
          "_id": "text",
          "display_name": "text"
        },
        "message": "text",
        "date": "2026-01-20T11:54:21.478Z"
      }
    ],
    "status_history": [
      {
        "status": "text",
        "date": "2026-01-20T11:54:21.478Z"
      }
    ],
    "createdAt": "2026-01-20T11:54:21.478Z",
    "updatedAt": "2026-01-20T11:54:21.478Z"
  }
}

Get order by extra data value

get

Retrieve an order using a value stored in its extra_data field. Useful for finding orders by external reference numbers.

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Query parameters

valuestringRequired

The extra data value to search for

Responses

200

Order retrieved successfully

application/json

400

Validation error or bad request

application/json

401

Authentication required or invalid token

application/json

get

/order/by/extra/data

GET /v2/order/by/extra/data?value=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Successfully retrieved order by extra data!",
  "content": {
    "_id": "507f1f77bcf86cd799439011",
    "code": "ORD-2024-001234",
    "user_id": "text",
    "client_id": "text",
    "basket_id": "text",
    "status": "ORDERED",
    "payment_type": [
      "text"
    ],
    "order_date": "2026-01-20T11:54:21.478Z",
    "total": "199.99",
    "vat": "26.09",
    "sub_total": "173.90",
    "delivery_fee": "50.00",
    "number_of_items": "text",
    "type": "text",
    "method": "DELIVERY",
    "channel": "text",
    "product_list": [
      {
        "_id": "text",
        "product_id": "text",
        "title": "text",
        "sku": "text",
        "pid": "text",
        "quantity": "text",
        "price": "text",
        "promotion_price": "text",
        "on_promotion": true,
        "status": "DRAFT",
        "image_url": "text",
        "variations": [
          {}
        ],
        "add_ons": [
          {}
        ]
      }
    ],
    "delivery_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "line_one": "text",
      "line_two": "text",
      "town": "text",
      "city": "text",
      "province": "text",
      "province_code": "text",
      "country": "text",
      "postal_code": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text",
      "full_name": "text",
      "name": "text",
      "surname": "text",
      "cell_number": "text",
      "tracking_url": "text"
    },
    "collection_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "tracking_url": "text",
      "instructions": "text",
      "scheduled_time": "text"
    },
    "branch": {
      "_id": "text",
      "name": "text",
      "display_name": "text"
    },
    "store": {
      "store_id": "text",
      "store_name": "text"
    },
    "user": {
      "_id": "text",
      "name": "text",
      "surname": "text",
      "email": "text",
      "cell_number": "text"
    },
    "transaction_details": {},
    "notes": [
      {
        "user": {
          "_id": "text",
          "display_name": "text"
        },
        "message": "text",
        "date": "2026-01-20T11:54:21.478Z"
      }
    ],
    "status_history": [
      {
        "status": "text",
        "date": "2026-01-20T11:54:21.478Z"
      }
    ],
    "createdAt": "2026-01-20T11:54:21.478Z",
    "updatedAt": "2026-01-20T11:54:21.478Z"
  }
}

Get paginated order list

get

Retrieves a paginated list of orders with optional filtering by user, branch, status, method, channel, date range, and total amount range. When both created and modified date ranges are provided, returns orders that match either range (OR logic).

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Query parameters

user_idstringOptional

Filter by user ID

branch_idstringOptional

Filter by single branch ID

branch_id_liststringOptional

Comma-separated list of branch IDs

branch_group_idstringOptional

Filter by branch group ID

search_stringstringOptional

Search orders by code, user name, etc.

statusstring · enumOptional

Filter by order status

Possible values:

methodstring · enumOptional

Filter by fulfillment method

Possible values:

channelstringOptional

Filter by sales channel

pagestringOptional

Page number for pagination (1-based)

Default: 1

sizestringOptional

Number of items per page

Default: 20

sort_bystring · enumOptional

Field to sort by

Possible values:

order_bystring · enumOptional

Sort direction

Default: descPossible values:

start_datestring · dateOptional

Filter orders created after this date

end_datestring · dateOptional

Filter orders created before this date

modified_start_datestring · dateOptional

Filter orders modified after this date

modified_end_datestring · dateOptional

Filter orders modified before this date

total_minnumberOptional

Minimum order total

total_maxnumberOptional

Maximum order total

Responses

200

Orders retrieved successfully

application/json

400

Validation error or bad request

application/json

401

Authentication required or invalid token

application/json

get

/order/list

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

{
  "success": true,
  "message": "Successfully retrieved 25 orders!",
  "content": {
    "count": 150,
    "order_list": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "code": "ORD-2024-001234",
        "user_id": "text",
        "client_id": "text",
        "basket_id": "text",
        "status": "ORDERED",
        "payment_type": [
          "text"
        ],
        "order_date": "2026-01-20T11:54:21.478Z",
        "total": "199.99",
        "vat": "26.09",
        "sub_total": "173.90",
        "delivery_fee": "50.00",
        "number_of_items": "text",
        "type": "text",
        "method": "DELIVERY",
        "channel": "text",
        "product_list": [
          {
            "_id": "text",
            "product_id": "text",
            "title": "text",
            "sku": "text",
            "pid": "text",
            "quantity": "text",
            "price": "text",
            "promotion_price": "text",
            "on_promotion": true,
            "status": "DRAFT",
            "image_url": "text",
            "variations": [
              {}
            ],
            "add_ons": [
              {}
            ]
          }
        ],
        "delivery_address": {
          "platform": "text",
          "full_address": "text",
          "lon": "text",
          "lat": "text",
          "line_one": "text",
          "line_two": "text",
          "town": "text",
          "city": "text",
          "province": "text",
          "province_code": "text",
          "country": "text",
          "postal_code": "text",
          "scheduled_time": "text",
          "instructions": "text",
          "is_residential": true,
          "business_name": "text",
          "complex_building_details": "text",
          "full_name": "text",
          "name": "text",
          "surname": "text",
          "cell_number": "text",
          "tracking_url": "text"
        },
        "collection_address": {
          "platform": "text",
          "full_address": "text",
          "lon": "text",
          "lat": "text",
          "tracking_url": "text",
          "instructions": "text",
          "scheduled_time": "text"
        },
        "branch": {
          "_id": "text",
          "name": "text",
          "display_name": "text"
        },
        "store": {
          "store_id": "text",
          "store_name": "text"
        },
        "user": {
          "_id": "text",
          "name": "text",
          "surname": "text",
          "email": "text",
          "cell_number": "text"
        },
        "transaction_details": {},
        "notes": [
          {
            "user": {
              "_id": "text",
              "display_name": "text"
            },
            "message": "text",
            "date": "2026-01-20T11:54:21.478Z"
          }
        ],
        "status_history": [
          {
            "status": "text",
            "date": "2026-01-20T11:54:21.478Z"
          }
        ],
        "createdAt": "2026-01-20T11:54:21.478Z",
        "updatedAt": "2026-01-20T11:54:21.478Z"
      }
    ]
  }
}

Export orders to CSV or Excel

get

Export orders matching the specified filters to CSV or Excel format. Returns a downloadable file.

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Query parameters

formatstring · enumOptional

Export file format

Default: csvPossible values:

user_idstringOptional

Filter by user ID

branch_idstringOptional

Filter by branch ID

statusstringOptional

Filter by order status

start_datestring · dateOptional

Filter orders created after this date

end_datestring · dateOptional

Filter orders created before this date

Responses

200

File downloaded successfully

400

Validation error or bad request

application/json

401

Authentication required or invalid token

application/json

get

/order/export

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

binary

Correct TLC orders (internal)

put

Internal endpoint to correct TLC (The Loyalty Channel) orders. Used for order data fixes.

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Responses

200

Orders corrected successfully

application/json

400

Validation error or bad request

application/json

put

/correct

PUT /v2/correct HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Successfully corrected orders!"
}

Cancel an order

put

Cancels an order and optionally issues a refund. Supports different refund types and scenarios:

S1: Store can't fulfill (weather, no driver, etc.) - refund + delivery fee
S2: Customer unavailable at delivery - refund minus delivery fee
S3: Customer rejects order (wrong items) - refund + delivery fee
S4: Store issues voucher (e.g., 7-day delivery) - App-only, no wallet credit
S5: POS or loyalty refunds - No dev required

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Body

order_idstringRequired

Order ID to cancel

reasonstring | nullableOptional

Reason for cancellation

user_idstring | nullableOptional

User ID initiating cancellation

refund_typestring · enumOptional

Type of refund to issue

Possible values:

scenariostring | nullableOptional

Refund scenario (S1-S5)

product_id_liststring[] | nullableOptional

List of product IDs to cancel (partial cancellation)

Responses

200

Order cancelled successfully

application/json

400

Validation error or bad request

application/json

401

Authentication required or invalid token

application/json

put

/order/cancel

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

{
  "order_id": "text",
  "reason": "text",
  "user_id": "text",
  "refund_type": "WALLET",
  "scenario": "text",
  "product_id_list": [
    "text"
  ]
}

{
  "success": true,
  "message": "Successfully cancelled order!",
  "content": {
    "_id": "507f1f77bcf86cd799439011",
    "code": "ORD-2024-001234",
    "user_id": "text",
    "client_id": "text",
    "basket_id": "text",
    "status": "ORDERED",
    "payment_type": [
      "text"
    ],
    "order_date": "2026-01-20T11:54:21.478Z",
    "total": "199.99",
    "vat": "26.09",
    "sub_total": "173.90",
    "delivery_fee": "50.00",
    "number_of_items": "text",
    "type": "text",
    "method": "DELIVERY",
    "channel": "text",
    "product_list": [
      {
        "_id": "text",
        "product_id": "text",
        "title": "text",
        "sku": "text",
        "pid": "text",
        "quantity": "text",
        "price": "text",
        "promotion_price": "text",
        "on_promotion": true,
        "status": "DRAFT",
        "image_url": "text",
        "variations": [
          {}
        ],
        "add_ons": [
          {}
        ]
      }
    ],
    "delivery_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "line_one": "text",
      "line_two": "text",
      "town": "text",
      "city": "text",
      "province": "text",
      "province_code": "text",
      "country": "text",
      "postal_code": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text",
      "full_name": "text",
      "name": "text",
      "surname": "text",
      "cell_number": "text",
      "tracking_url": "text"
    },
    "collection_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "tracking_url": "text",
      "instructions": "text",
      "scheduled_time": "text"
    },
    "branch": {
      "_id": "text",
      "name": "text",
      "display_name": "text"
    },
    "store": {
      "store_id": "text",
      "store_name": "text"
    },
    "user": {
      "_id": "text",
      "name": "text",
      "surname": "text",
      "email": "text",
      "cell_number": "text"
    },
    "transaction_details": {},
    "notes": [
      {
        "user": {
          "_id": "text",
          "display_name": "text"
        },
        "message": "text",
        "date": "2026-01-20T11:54:21.478Z"
      }
    ],
    "status_history": [
      {
        "status": "text",
        "date": "2026-01-20T11:54:21.478Z"
      }
    ],
    "createdAt": "2026-01-20T11:54:21.478Z",
    "updatedAt": "2026-01-20T11:54:21.478Z"
  }
}

Refund an order

put

Issues a refund for an order. Can refund to wallet or as a voucher.

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Body

order_idstringRequired

Order ID to refund

refund_typestring · enumOptional

Type of refund to issue

Possible values:

scenariostring | nullableOptional

Refund scenario

product_id_liststring[] | nullableOptional

List of product IDs to refund (partial refund)

Responses

200

Order refunded successfully

application/json

400

Validation error or bad request

application/json

401

Authentication required or invalid token

application/json

put

/order/refund

PUT /v2/order/refund HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "order_id": "text",
  "refund_type": "WALLET",
  "scenario": "text",
  "product_id_list": [
    "text"
  ]
}

{
  "success": true,
  "message": "Successfully cancelled order!",
  "content": {
    "_id": "507f1f77bcf86cd799439011",
    "code": "ORD-2024-001234",
    "user_id": "text",
    "client_id": "text",
    "basket_id": "text",
    "status": "ORDERED",
    "payment_type": [
      "text"
    ],
    "order_date": "2026-01-20T11:54:21.478Z",
    "total": "199.99",
    "vat": "26.09",
    "sub_total": "173.90",
    "delivery_fee": "50.00",
    "number_of_items": "text",
    "type": "text",
    "method": "DELIVERY",
    "channel": "text",
    "product_list": [
      {
        "_id": "text",
        "product_id": "text",
        "title": "text",
        "sku": "text",
        "pid": "text",
        "quantity": "text",
        "price": "text",
        "promotion_price": "text",
        "on_promotion": true,
        "status": "DRAFT",
        "image_url": "text",
        "variations": [
          {}
        ],
        "add_ons": [
          {}
        ]
      }
    ],
    "delivery_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "line_one": "text",
      "line_two": "text",
      "town": "text",
      "city": "text",
      "province": "text",
      "province_code": "text",
      "country": "text",
      "postal_code": "text",
      "scheduled_time": "text",
      "instructions": "text",
      "is_residential": true,
      "business_name": "text",
      "complex_building_details": "text",
      "full_name": "text",
      "name": "text",
      "surname": "text",
      "cell_number": "text",
      "tracking_url": "text"
    },
    "collection_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "tracking_url": "text",
      "instructions": "text",
      "scheduled_time": "text"
    },
    "branch": {
      "_id": "text",
      "name": "text",
      "display_name": "text"
    },
    "store": {
      "store_id": "text",
      "store_name": "text"
    },
    "user": {
      "_id": "text",
      "name": "text",
      "surname": "text",
      "email": "text",
      "cell_number": "text"
    },
    "transaction_details": {},
    "notes": [
      {
        "user": {
          "_id": "text",
          "display_name": "text"
        },
        "message": "text",
        "date": "2026-01-20T11:54:21.478Z"
      }
    ],
    "status_history": [
      {
        "status": "text",
        "date": "2026-01-20T11:54:21.478Z"
      }
    ],
    "createdAt": "2026-01-20T11:54:21.478Z",
    "updatedAt": "2026-01-20T11:54:21.478Z"
  }
}

Create a parcel

post

Creates a new parcel for shipping/delivery with recipient and collection details.

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Body

user_idstringRequired

User ID creating the parcel

order_idstring | nullableOptional

Associated order ID

statusstring | nullableOptional

floating_fleetboolean | nullableOptional

parcel_datestring | nullableOptional

boxesstring | nullableOptional

methodstringRequired

Parcel method (required)

delivery_methodstring | nullableOptional

namestring | nullableOptional

descriptionstring | nullableOptional

conditionstring | nullableOptional

collection_timestring | nullableOptional

collection_datestring | nullableOptional

notesstring | nullableOptional

image_urlstring | nullableOptional

product_listobject[] | nullableOptional

Responses

200

Parcel created successfully

application/json

400

Validation error or bad request

application/json

401

Authentication required or invalid token

application/json

post

/create/parcel

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

{
  "user_id": "text",
  "order_id": "text",
  "status": "text",
  "floating_fleet": true,
  "parcel_date": "text",
  "boxes": "text",
  "branch": {
    "_id": "text"
  },
  "branch_group": {
    "_id": "text"
  },
  "method": "text",
  "delivery_method": "text",
  "name": "text",
  "description": "text",
  "condition": "text",
  "collection_address": {
    "platform": "text",
    "full_address": "text",
    "lon": "text",
    "lat": "text",
    "tracking_url": "text",
    "instructions": "text",
    "scheduled_time": "text"
  },
  "collection_time": "text",
  "collection_date": "text",
  "recipient": {
    "full_name": "text",
    "phone_number": "text",
    "email": "text"
  },
  "delivery_address": {
    "platform": "text",
    "full_address": "text",
    "lon": "text",
    "lat": "text",
    "tracking_url": "text",
    "instructions": "text",
    "scheduled_time": "text"
  },
  "notes": "text",
  "image_url": "text",
  "image_list": [
    {
      "url": "text",
      "order": 1
    }
  ],
  "product_list": [
    {}
  ],
  "size": {
    "amount": "text",
    "unit": "text"
  }
}

{
  "success": true,
  "message": "Parcel successfully created!",
  "content": {
    "_id": "text",
    "code": "text",
    "user_id": "text",
    "client_id": "text",
    "order_id": "text",
    "status": "OPEN",
    "parcel_date": "text",
    "method": "text",
    "delivery_method": "DOOR TO STORE",
    "name": "text",
    "description": "text",
    "condition": "text",
    "boxes": "text",
    "floating_fleet": true,
    "branch": {
      "_id": "text",
      "name": "text",
      "display_name": "text"
    },
    "branch_group": {
      "_id": "text"
    },
    "collection_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "tracking_url": "text",
      "instructions": "text",
      "scheduled_time": "text"
    },
    "collection_time": "text",
    "collection_date": "text",
    "recipient": {
      "full_name": "text",
      "phone_number": "text",
      "email": "[email protected]"
    },
    "sender": {
      "full_name": "text",
      "phone_number": "text",
      "email": "[email protected]"
    },
    "delivery_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "tracking_url": "text",
      "instructions": "text",
      "scheduled_time": "text"
    },
    "notes": "text",
    "instructions": "text",
    "image_url": "text",
    "image_list": [
      {
        "url": "text",
        "order": 1
      }
    ],
    "product_list": [
      {}
    ],
    "size": {
      "amount": "text",
      "unit": "text"
    },
    "scan_status": "text",
    "scan_history": [
      {}
    ],
    "createdAt": "2026-01-20T11:54:21.478Z",
    "updatedAt": "2026-01-20T11:54:21.478Z"
  }
}

Get a parcel

get

Retrieve a parcel by its ID or code.

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Query parameters

_idstringOptional

Parcel MongoDB ObjectId

codestringOptional

Parcel reference code

Responses

200

Parcel retrieved successfully

application/json

400

Validation error or bad request

application/json

get

/parcel

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

{
  "success": true,
  "message": "Successfully retrieved parcel!",
  "content": {
    "_id": "text",
    "code": "text",
    "user_id": "text",
    "client_id": "text",
    "order_id": "text",
    "status": "OPEN",
    "parcel_date": "text",
    "method": "text",
    "delivery_method": "DOOR TO STORE",
    "name": "text",
    "description": "text",
    "condition": "text",
    "boxes": "text",
    "floating_fleet": true,
    "branch": {
      "_id": "text",
      "name": "text",
      "display_name": "text"
    },
    "branch_group": {
      "_id": "text"
    },
    "collection_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "tracking_url": "text",
      "instructions": "text",
      "scheduled_time": "text"
    },
    "collection_time": "text",
    "collection_date": "text",
    "recipient": {
      "full_name": "text",
      "phone_number": "text",
      "email": "[email protected]"
    },
    "sender": {
      "full_name": "text",
      "phone_number": "text",
      "email": "[email protected]"
    },
    "delivery_address": {
      "platform": "text",
      "full_address": "text",
      "lon": "text",
      "lat": "text",
      "tracking_url": "text",
      "instructions": "text",
      "scheduled_time": "text"
    },
    "notes": "text",
    "instructions": "text",
    "image_url": "text",
    "image_list": [
      {
        "url": "text",
        "order": 1
      }
    ],
    "product_list": [
      {}
    ],
    "size": {
      "amount": "text",
      "unit": "text"
    },
    "scan_status": "text",
    "scan_history": [
      {}
    ],
    "createdAt": "2026-01-20T11:54:21.478Z",
    "updatedAt": "2026-01-20T11:54:21.478Z"
  }
}

Create a quote

post

Creates a new quote for a user with the specified products and terms.

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Body

user_idstring | nullableOptional

branch_idstring | nullableOptional

branch_group_idstring | nullableOptional

issue_datestring | nullableOptional

titlestring | nullableOptional

summarystring | nullableOptional

expiry_datestring | nullableOptional

currencystring | nullableOptional

deposit_amountstring | nullableOptional

subscriptionbooleanRequired

Whether this is a subscription quote

termsstring | nullableOptional

product_id_liststring[] | nullableOptional

List of product IDs to include

commentsstring | nullableOptional

Responses

200

Quote created successfully

application/json

400

Validation error or bad request

application/json

401

Authentication required or invalid token

application/json

post

/create/quote

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

{
  "user_id": "text",
  "user": {
    "name": "text",
    "email": "text",
    "cell_number": "text"
  },
  "branch_id": "text",
  "branch_group_id": "text",
  "issue_date": "text",
  "title": "text",
  "summary": "text",
  "expiry_date": "text",
  "currency": "text",
  "deposit_amount": "text",
  "subscription": true,
  "terms": "text",
  "product_id_list": [
    "text"
  ],
  "comments": "text"
}

{
  "success": true,
  "message": "Quote successfully created!",
  "content": {
    "_id": "text",
    "user_id": "text",
    "client_id": "text",
    "user": {
      "name": "text",
      "email": "text",
      "cell_number": "text"
    },
    "branch": {
      "_id": "text",
      "name": "text",
      "display_name": "text"
    },
    "branch_group": {
      "_id": "text"
    },
    "provider": "text",
    "issue_date": "2026-01-20T11:54:21.478Z",
    "title": "text",
    "summary": "text",
    "status": "text",
    "expiry_date": "2026-01-20T11:54:21.478Z",
    "number": "text",
    "reference": "text",
    "currency": "text",
    "deposit_amount": "text",
    "tax": "text",
    "subscription": true,
    "terms": "text",
    "number_of_items": "text",
    "product_list": [
      {}
    ],
    "comments": "text",
    "vat": "text",
    "sub_total": "text",
    "total": "text",
    "quote_number": "text",
    "createdAt": "2026-01-20T11:54:21.478Z",
    "updatedAt": "2026-01-20T11:54:21.478Z"
  }
}

Create a customer quote

post

Creates a detailed customer quote with customer information, addresses, products, and pricing.

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Body

statusstring | nullableOptional

product_listobject[]Optional

branch_idstring | nullableOptional

totalstring | nullableOptional

sub_totalstring | nullableOptional

vatstring | nullableOptional

discountstring | nullableOptional

dealsobject[] | nullableOptional

vouchersobject[] | nullableOptional

quote_expiry_datestring | nullableOptional

outstanding_amountstring | nullableOptional

paid_amountstring | nullableOptional

Responses

200

Customer quote created successfully

application/json

400

Validation error or bad request

application/json

401

Authentication required or invalid token

application/json

500

Internal server error

application/json

post

/create/customer/quote

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

{
  "customer": {
    "_id": "text",
    "name": "text",
    "surname": "text",
    "cell_number": "text",
    "email": "text",
    "client_name": "text"
  },
  "billing_address": {
    "full_address": "text",
    "latitude": "text",
    "longitude": "text",
    "city": "text",
    "province": "text",
    "country": "text",
    "postal_code": "text",
    "complex_building_details": "text",
    "is_residential": true,
    "business_name": "text",
    "directions": "text",
    "use_same_as_billing": false
  },
  "shipping_address": {
    "full_address": "text",
    "latitude": "text",
    "longitude": "text",
    "city": "text",
    "province": "text",
    "country": "text",
    "postal_code": "text",
    "complex_building_details": "text",
    "is_residential": true,
    "business_name": "text",
    "directions": "text",
    "use_same_as_billing": false
  },
  "status": "text",
  "product_list": [
    {}
  ],
  "branch_id": "text",
  "order_type": {
    "label": "text",
    "value": "text"
  },
  "total": "text",
  "sub_total": "text",
  "vat": "text",
  "discount": "text",
  "deals": [
    {}
  ],
  "vouchers": [
    {}
  ],
  "quote_expiry_date": "text",
  "outstanding_amount": "text",
  "paid_amount": "text"
}

{
  "success": true,
  "message": "Customer Quote successfully created!",
  "content": {
    "_id": "text",
    "client_name": "text",
    "customer": {
      "_id": "text",
      "name": "text",
      "surname": "text",
      "cell_number": "text",
      "email": "text",
      "client_name": "text"
    },
    "quote_id": "text",
    "billing_address": {
      "full_address": "text",
      "latitude": "text",
      "longitude": "text",
      "city": "text",
      "province": "text",
      "country": "text",
      "postal_code": "text",
      "complex_building_details": "text",
      "is_residential": true,
      "business_name": "text",
      "directions": "text",
      "use_same_as_billing": false
    },
    "invoice_address": {
      "full_address": "text",
      "latitude": "text",
      "longitude": "text",
      "city": "text",
      "province": "text",
      "country": "text",
      "postal_code": "text",
      "complex_building_details": "text",
      "is_residential": true,
      "business_name": "text",
      "directions": "text",
      "use_same_as_billing": false
    },
    "shipping_address": {
      "full_address": "text",
      "latitude": "text",
      "longitude": "text",
      "city": "text",
      "province": "text",
      "country": "text",
      "postal_code": "text",
      "complex_building_details": "text",
      "is_residential": true,
      "business_name": "text",
      "directions": "text",
      "use_same_as_billing": false
    },
    "creation_time": "text",
    "status": "text",
    "product_list": [
      {}
    ],
    "actions": [
      {}
    ],
    "branch_id": "text",
    "order_type": {
      "label": "text",
      "value": "text"
    },
    "quote_calculations": {},
    "dynamic_price": {},
    "total": "text",
    "sub_total": "text",
    "vat": "text",
    "discount": "text",
    "deals": [
      {}
    ],
    "vouchers": [
      {}
    ],
    "quote_expiry_date": "text",
    "outstanding_amount": "text",
    "paid_amount": "text"
  }
}

Get a quote for deals

get

Retrieve a flattened quote structure for deals processing.

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Query parameters

quote_idstringRequired

Quote ID

user_idstringRequired

User ID

flatbooleanRequired

Must be true for flattened format

Responses

200

Quote retrieved successfully

application/json

400

Validation error or bad request

application/json

401

Authentication required or invalid token

application/json

404

Resource not found

application/json

get

/quote

GET /v2/quote?quote_id=text&user_id=text&flat=true HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Quote successfully retrieved",
  "content": {
    "_id": "text",
    "user_id": "text",
    "client_id": "text",
    "user": {
      "name": "text",
      "email": "text",
      "cell_number": "text"
    },
    "branch": {
      "_id": "text",
      "name": "text",
      "display_name": "text"
    },
    "branch_group": {
      "_id": "text"
    },
    "provider": "text",
    "issue_date": "2026-01-20T11:54:21.478Z",
    "title": "text",
    "summary": "text",
    "status": "text",
    "expiry_date": "2026-01-20T11:54:21.478Z",
    "number": "text",
    "reference": "text",
    "currency": "text",
    "deposit_amount": "text",
    "tax": "text",
    "subscription": true,
    "terms": "text",
    "number_of_items": "text",
    "product_list": [
      {}
    ],
    "comments": "text",
    "vat": "text",
    "sub_total": "text",
    "total": "text",
    "quote_number": "text",
    "createdAt": "2026-01-20T11:54:21.478Z",
    "updatedAt": "2026-01-20T11:54:21.478Z"
  }
}

Get customer quote by ID

get

Retrieve a customer quote by its ID.

Authorizations

AuthorizationstringRequired

JWT authentication token. Obtain from the authentication service.

Query parameters

_idstringRequired

Customer quote ID

Responses

200

Customer quote retrieved successfully

application/json

400

Validation error or bad request

application/json

401

Authentication required or invalid token

application/json

500

Internal server error

application/json

get

/customer/quote

GET /v2/customer/quote?_id=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "Successfully retrieved customer quote!",
  "content": {
    "_id": "text",
    "client_name": "text",
    "customer": {
      "_id": "text",
      "name": "text",
      "surname": "text",
      "cell_number": "text",
      "email": "text",
      "client_name": "text"
    },
    "quote_id": "text",
    "billing_address": {
      "full_address": "text",
      "latitude": "text",
      "longitude": "text",
      "city": "text",
      "province": "text",
      "country": "text",
      "postal_code": "text",
      "complex_building_details": "text",
      "is_residential": true,
      "business_name": "text",
      "directions": "text",
      "use_same_as_billing": false
    },
    "invoice_address": {
      "full_address": "text",
      "latitude": "text",
      "longitude": "text",
      "city": "text",
      "province": "text",
      "country": "text",
      "postal_code": "text",
      "complex_building_details": "text",
      "is_residential": true,
      "business_name": "text",
      "directions": "text",
      "use_same_as_billing": false
    },
    "shipping_address": {
      "full_address": "text",
      "latitude": "text",
      "longitude": "text",
      "city": "text",
      "province": "text",
      "country": "text",
      "postal_code": "text",
      "complex_building_details": "text",
      "is_residential": true,
      "business_name": "text",
      "directions": "text",
      "use_same_as_billing": false
    },
    "creation_time": "text",
    "status": "text",
    "product_list": [
      {}
    ],
    "actions": [
      {}
    ],
    "branch_id": "text",
    "order_type": {
      "label": "text",
      "value": "text"
    },
    "quote_calculations": {},
    "dynamic_price": {},
    "total": "text",
    "sub_total": "text",
    "vat": "text",
    "discount": "text",
    "deals": [
      {}
    ],
    "vouchers": [
      {}
    ],
    "quote_expiry_date": "text",
    "outstanding_amount": "text",
    "paid_amount": "text"
  }
}

PreviousBasket NextOrder - Payload

Last updated 1 hour ago

hashtagWhat is the Order Service?

hashtagCore Entities

hashtagOrder

hashtagParcel

hashtagQuote

hashtagOrder Lifecycle

hashtagOrder Statuses

hashtagParcel Statuses

hashtagFulfillment Methods

hashtagRefund Scenarios

hashtagSales Channels

hashtagKey API Operations

hashtagOrders

hashtagParcels

hashtagQuotes

hashtagAuthentication

hashtagResponse Format

hashtagCreate order from external channel

hashtagCreate order from basket

hashtagCreate order from customer quote

hashtagGet a single order

hashtagGet order by extra data value

hashtagGet paginated order list

hashtagExport orders to CSV or Excel

hashtagCorrect TLC orders (internal)

hashtagCancel an order

hashtagRefund an order

hashtagCreate a parcel

hashtagGet a parcel

hashtagCreate a quote

hashtagCreate a customer quote

hashtagGet a quote for deals

hashtagGet customer quote by ID

What is the Order Service?

Core Entities

Order

Parcel

Quote

Order Lifecycle

Order Statuses

Parcel Statuses

Fulfillment Methods

Refund Scenarios

Sales Channels

Key API Operations

Orders

Parcels

Quotes

Authentication

Response Format

Create order from external channel

Create order from basket

Create order from customer quote

Get a single order

Get order by extra data value

Get paginated order list

Export orders to CSV or Excel

Correct TLC orders (internal)

Cancel an order

Refund an order

Create a parcel

Get a parcel

Create a quote

Create a customer quote

Get a quote for deals

Get customer quote by ID