Skip to content

List orders (or get one)

GET
/api/v1/business/website/orders/

Without order_id, returns the shopper's order history (compact rows). With ?order_id=…, returns that order's full detail including line items.

Authorizations

apiKey

Your business API key (sb_live_*) — identifies which store the request is for. Required on every /api/v1/business/website/ request.

Type
API Key (header: X-Periscale-Key)
+
shopperToken

The shopper's access token from the shopper authentication endpoints. Required for cart, checkout, orders, and account actions.

Type
HTTP (bearer)

Parameters

Query Parameters

order_id

Return full detail for this order instead of the list.

Type
integer

Responses

Order list (or single order detail when order_id is given).

application/json
JSON
{
  
"status": true,
  
"status_code": 200,
  
"message": "",
  
"data": [
  
  
{
  
  
  
"id": 1001,
  
  
  
"order_number": "1001",
  
  
  
"status": "PENDING",
  
  
  
"total": "1210.00",
  
  
  
"payment_method": "COD",
  
  
  
"created_at": "2026-07-02T10:15:00+00:00",
  
  
  
"item_count": 2
  
  
}
  
]
}

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

© Periscale