GET
/
v1
/
orders

Headers

X-BUSINESS-API-KEY
string
required

Query Parameters

perPage
integer
default: 25
Required range: x < 100
version
enum<string>

Order version: 1.0 or 2.0. Return all orders as default

Available options:
1.0,
2.0
keywords
string

Search for fields: amount ,created_at ,order id, remark, customer_name

statuses[]
enum<string>

The available status: completed, sent, draft, expired, canceled

Available options:
completed,
sent,
draft,
expired,
canceled
dateFrom
string

Example: 2023-04-18

dateTo
string

Example: 2023-04-18

with
string

If we want to show the product or charge detail=> add the value: products or charges. For both: products,charges

Response

200 - application/json
id
string
order_display_number
integer
business_id
string
channel
string
version
string
customer_id
null
business_customer_id
null
customer
null
customer_pickup
boolean
currency
string
order_discount_name
null
status
string
remark
string
created_at
string
updated_at
string
closed_at
null
location_id
null
location
null
business_user_id
string
slot_date
null
slot_time
null
messages
null
products
any[]
charges
any[]
line_items
any[]
order_form
object
order_form_response
any[]
coupon
null
payment_status
null
fulfilment_status
string
line_items_total
integer
order_discount_amount
integer
line_item_discount_amount
integer
line_item_tax_amount
integer
additional_discount_amount
integer
total_discount_amount
integer
line_item_price
integer
shipping_amount
integer
total_coupon_amount
integer
amount
integer
subtotal
integer

Was this page helpful?

Get Account StatusCreate Order