List business orders

Requires the order:list scope. Retrieves a paginated list of orders with optional filtering. The data is sorted by created_at in descending order and cannot be changed. Uses cursor-based pagination with default page size of 25 and maximum of 25.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≤ 25

Number of items per page (default: 25, max: 25)

string

Opaque cursor for the next page.

string

Opaque cursor for the previous page.

string

Search term for the selected search_field. Defaults to order ID search when search_field is omitted or unsupported.

string
enum
Defaults to order_id

Field used by search. Defaults to order_id when omitted or unsupported.

string
enum

Filter spam orders

Allowed:
string
enum

Filter by business role

Allowed:
string

Filter orders by draft time until (ISO 8601 format)

string

Filter orders by confirmed time since (ISO 8601 format)

string

Filter orders by confirmed time until (ISO 8601 format)

string

Filter orders by shipped time since (ISO 8601 format)

string

Filter orders by shipped time until (ISO 8601 format)

string

Filter orders by completed time since (ISO 8601 format)

string

Filter orders by completed time until (ISO 8601 format)

string
enum

Filter orders created from a form

Allowed:
string
enum

Filter repeat orders

Allowed:
string

Comma-separated list of tags to filter orders

string

Filter orders containing a specific product ID

string
enum

Filter orders with transfer proof

Allowed:
string

Filter orders by specific order ID

string
enum

Filter orders by AWB status

Allowed:
string
enum

Filter orders by status

string
enum

Filter orders by payment status

Allowed:
string
enum

Filter orders by payment method

string

Filter orders by shipment status

string

Filter orders by business ID

string

Filter orders by store ID

string

Filter orders by warehouse ID

string

Filter orders by courier ID

string

Filter orders by handler ID

string

Filter orders by advertiser ID

string
enum

Filter orders by platform

string

Filter orders by financial entity ID

string

Filter orders by page ID

string

Filter orders by external ID

integer

Filter orders by affiliate business ID (for affiliates to see orders they brought)

string

Filter orders by UTM source

string

Comma-separated list of columns to include. Available columns: secret_slug, public_order_url, payment_url, final_variants, store, origin_address, address_location, handler_phone, order_id, destination_address, quantity, product_price, total_weight, courier_service, shipping_cost, payment_method, gross_revenue, shipment_receipt, courier_additional_info, payment_status, status, customer, draft_time, orderlines, is_dropshipping, dropshipper_name, dropshipper_phone, unique_code_discount, tags, awb_status, awb_ca_status, follow_up_chats, follow_up_chat_type, message_history, metadata, notes, courier_aggregator_code, shipment_account, payment_account, financial_entity, payment_account_holder, payment_account_number, transferproof_url, transfer_time, product_discount, shipping_discount, other_income, other_income_name, shipment_status, is_repeat, platform, external_id, is_purchase_fb, is_purchase_tiktok, is_purchase_kwai, fb_pixel_ids, tiktok_pixel_ids, kwai_pixel_ids, pending_time, confirmed_time, shipped_time, completed_time, rts_time, canceled_time, closed_time, warehouse, page, channel_name, handler, advertiser, pg_payment_info, epayment_provider, invoice_url, pg_reference_id, net_revenue, payment_fee, scalev_fee, net_payment_revenue, discount_code_discount, discount_code_code, discount_code_applied_to, utm_source

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json