The Wherehouse Public API is in BETA. Please contact us should you wish to build a feature rich integration dev@wherehouse.co.za.
/orders
Testing
GET
https://api.wherehouse.co.za/v1/orders
Request
Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:passwordExample:
Authorization: Basic *****************Query Params
_limit
string
required
Example:
10
_start
string
required
Example:
0
_sort
string
required
Example:
date_placed:desc
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.wherehouse.co.za/v1/orders?_limit=10&_start=0&_sort=date_placed:desc' \
--header 'Authorization: Basic Og=='Responses
🟢200Success
application/json
Body
meta
object
required
total
integer
required
limit
integer
required
start
integer
required
orders
array[object (Order) {39}]
required
catalogue
object (Catalogue)
required
billing_address_line
string
optional
billing_city
string
optional
billing_country
string
optional
billing_postcode
string
optional
billing_state
string
optional
billing_suburb
string
optional
code
string
required
courier_name
string
optional
created_at
string
required
currency_code
string
required
customer_cellphone
string
required
customer_email
string
required
customer_first_name
string
required
customer_last_name
string
required
date_placed
string
required
id
integer
required
order_total
integer
required
order_type
string
optional
origin_connector_type
object (Connector Type)
required
origin_status
string
optional
products_sold
array[object (Product Sale) {18}]
required
shipment_create_date
string
optional
shipment_status
string
optional
shipment_status_code
string
optional
shipping
object
optional
shipping_address_line
string
required
shipping_address_line2
string
required
shipping_city
string
required
shipping_country
string
required
shipping_postcode
string
required
shipping_state
string
required
shipping_suburb
string
required
status
string
required
tags
string
optional
tracking_link
string
optional
tracking_number
string
optional
updated_at
string
optional
waybill_pdf_url
string
optional
Example
{
"meta": {
"total": 10000,
"limit": 100,
"start": 0
},
"orders": [
{
"billing_address_line": null,
"billing_city": null,
"billing_country": null,
"billing_postcode": null,
"billing_state": null,
"billing_suburb": null,
"catalogue": null,
"code": "DEMO95619489",
"courier_name": null,
"created_at": "2025-02-20T11:04:12.584Z",
"currency_code": "ZAR",
"customer_cellphone": "0820997783",
"customer_email": "lemon@nine.co.za",
"customer_first_name": "Light",
"customer_last_name": "Popular",
"date_placed": "2024-11-17T15:04:21.034Z",
"id": 469472,
"order_total": 32998,
"order_type": null,
"origin_connector_type": null,
"origin_status": null,
"products_sold": [
{
"code": "TALFEE2",
"created_at": "2025-02-20T11:04:12.619Z",
"discount": null,
"fulfillment_fee": null,
"id": 2455524,
"is_additional_charge": null,
"is_discount": null,
"is_fee": true,
"marketplace_commission": null,
"order_type": null,
"origin_status": null,
"product": null,
"quantity": 1,
"sell_price": 50,
"status": "paid",
"title": "Takealot Fulfillment Fee",
"total_fees": null,
"updated_at": "2025-02-20T11:04:12.622Z"
},
{
"code": "TALFEE4",
"created_at": "2025-02-20T11:04:12.630Z",
"discount": null,
"fulfillment_fee": null,
"id": 2455525,
"is_additional_charge": null,
"is_discount": null,
"is_fee": true,
"marketplace_commission": null,
"order_type": null,
"origin_status": null,
"product": null,
"quantity": 1,
"sell_price": 4949.7,
"status": "paid",
"title": "Takealot Success Fee",
"total_fees": null,
"updated_at": "2025-02-20T11:04:12.633Z"
},
{
"code": "APL-IPH-29",
"created_at": "2025-02-20T11:04:12.642Z",
"discount": null,
"fulfillment_fee": null,
"id": 2455526,
"is_additional_charge": null,
"is_discount": null,
"is_fee": null,
"marketplace_commission": null,
"order_type": null,
"origin_status": null,
"product": {
"archived": false,
"barcode": "9032816743",
"brand": "Apple",
"catalogue": null,
"category": "Smartphone",
"code": "APL-IPH-29",
"colour": "Blue",
"cost_price": 10239.36,
"created_at": "2024-07-18T11:34:45.410Z",
"currency_code": null,
"description": "Color Choices\n\nSilver\nGraphite\nGold\nPacific Blue\nBattery\n\nCurrent: 3,687mAh\nPower: 14.13Wh\nVoltage: 3.83V\nCameras\n\nFront: 12MP camera.\nRear: 12MP Wide camera.\nStorage Choices\n\n128GB\n256GB\n512GB\nCPU Specs\n\nCPU: T8101 \"A14 Bionic\"\nClock rate: 2.99 GHz\nCore Design: Apple Firestorm x 2 and Apple Icestorm x 4\nInstruction Set: ARMv8.5-A\nRAM: 6GB\nConnectivity and Wireless\n\nBluetooth 5.0\nNFC with reader mode\n802.11ax Wi-Fi 6 with 2x2 MIMO\nGigabit-class LTE with 4x4 MIMO and LAA\n5G (sub‑6 GHz and mmWave)\nBaseband Device: SDX55M\nFirmwares\n\nInitial firmware: 14.1 (18A8395)\nLatest public firmware: 15.5 (19F77)\nLatest beta firmware: 15.6 beta (19G5027e)\nFirmware Identifiers: iPhone13,4",
"draft": null,
"excerpt": null,
"fee_estimates": null,
"height_cm": 3.5,
"id": 1776771,
"images": null,
"length_cm": 1,
"main_image": "https://www.theiphonewiki.com/w/images/6/60/IPhone_12_Pro_Max.jpg",
"material": null,
"parent_code": null,
"retail_price": 15999,
"rich_description": null,
"sale_price": null,
"soh": 28,
"tags": null,
"title": "iPhone 12 Pro Max",
"type": null,
"updated_at": "2024-07-18T11:34:45.410Z",
"weight_g": 0.545,
"wholesale_price": 12799.2,
"width_cm": 1.5
},
"quantity": 1,
"sell_price": 15999,
"status": "paid",
"title": "iPhone 12 Pro Max",
"total_fees": null,
"updated_at": "2025-02-20T11:04:12.645Z"
},
{
"code": "APL-IPH-31",
"created_at": "2025-02-20T11:04:12.656Z",
"discount": null,
"fulfillment_fee": null,
"id": 2455527,
"is_additional_charge": null,
"is_discount": null,
"is_fee": null,
"marketplace_commission": null,
"order_type": null,
"origin_status": null,
"product": {
"archived": false,
"barcode": "9489443226",
"brand": "Apple",
"catalogue": null,
"category": "Smartphone",
"code": "APL-IPH-31",
"colour": "Blue",
"cost_price": 10879.36,
"created_at": "2024-07-18T11:34:45.421Z",
"currency_code": null,
"description": "Color Choices\n\nStarlight\nMidnight\n(PRODUCT)RED\nBlue\nPink\nBattery\n\nCurrent: 3,227mAh\nPower: ?Wh\nVoltage: ?V\nCameras\n\nFront: 12MP camera.\nRear: 12MP Wide camera.\nStorage Choices\n\n128GB\n256GB\n512GB\nCPU Specs\n\nCPU: T8110 \"A15 Bionic\"\nClock rate: 3.23 GHz\nCore Design: Apple Avalanche x 2 and Apple Blizzard x 4\nInstruction Set: ?\nRAM: 4GB\nConnectivity and Wireless\n\nBluetooth 5.0\nNFC with reader mode\n802.11ax Wi-Fi 6 with 2x2 MIMO\nGigabit LTE with 4x4 MIMO and LAA\n5G (sub‑6 GHz)\nBaseband Device: SDX60M\nFirmwares\n\nInitial firmware(s): 15.0 (19A340, 19A341 and 19A346)\nLatest public firmware: 15.5 (19F77)\nLatest beta firmware: 15.6 beta (19G5027e)\nFirmware Identifiers: iPhone14,5",
"draft": null,
"excerpt": null,
"fee_estimates": null,
"height_cm": 3.5,
"id": 1776773,
"images": null,
"length_cm": 1,
"main_image": "https://www.theiphonewiki.com/w/images/3/37/IPhone_13.png",
"material": null,
"parent_code": null,
"retail_price": 16999,
"rich_description": null,
"sale_price": null,
"soh": 89,
"tags": null,
"title": "iPhone 13",
"type": null,
"updated_at": "2024-07-18T11:34:45.421Z",
"weight_g": 0.545,
"wholesale_price": 13599.2,
"width_cm": 1.5
},
"quantity": 1,
"sell_price": 16999,
"status": "paid",
"title": "iPhone 13",
"total_fees": null,
"updated_at": "2025-02-20T11:04:12.670Z"
}
],
"shipment_create_date": null,
"shipment_status": null,
"shipment_status_code": null,
"shipping": null,
"shipping_address_line": "4 Ipsum eu",
"shipping_address_line2": null,
"shipping_city": "Pariatur",
"shipping_country": "Qui",
"shipping_postcode": "1049",
"shipping_state": "Cillum",
"shipping_suburb": null,
"status": "paid",
"tags": null,
"tracking_link": null,
"tracking_number": null,
"updated_at": "2025-02-20T11:04:12.591Z",
"waybill_pdf_url": null
}]}Modified at 2025-07-14 14:42:22