Sign in

v1

latestOpenAPI 3.0.02026-07-26868170.3 KB
Sales data

List orders with their status

Get the list of orders with their status.

get/data/v2/orders

Query parameters

per_pageinteger

Number of items displayed per page.

page_numberinteger

Page number.

key'external_id' | 'shipping_amount' | 'discount_amount' | 'total_price' | 'tax_amount' | 'currency' | 'sales_person' | 'created_at' | 'ordered_at'

search fields, in contacts

operator'is' | 'after' | 'before' | 'contains' | 'ends' | 'equal' | 'greater' | 'isnot' | 'lower' | 'notequal' | 'starts'

operator for search operators are limited by the type of value expected

valuestring

Use a combination of field, operator and searched value. It will return orders that matched your search. Fields available on search in orders are 'external_id', 'shipping_amount', 'discount_amount', 'total_price', 'tax_amount', 'currency', 'sales_person', 'created_at', 'ordered_at' and custom fields numbers (0, 1, 2, ...)

Response

Orders retrieval is successful.