Order Filter Fields
Use the order filters to get faster responses with exactly the information needed. Below you can find the request example on how to use filters:
https://api.api2cart.com/v1.0/product.list.xml?api_key=<your_api_key>&store_key=<your_store_key>&start=0&count=4¶ms= <filters that you need separated by commas>
In the params field, you can specify any of the filters listed below. If you need all the fields allowed by the shopping cart in one response, use force_all.
| Name filter field | Description |
|---|---|
| id | Internal order ID |
| order_id | Order ID |
| customer | Customer’s info |
| address | Billing and Shipping addresses of order |
| currency | Orders currency info |
| create_at | Time of order creation |
| modified_at | Time of order modification |
| payment_method | Orders payment method name |
| shipping_method | Orders shipping method name |
| status | Current order status with status history |
| totals | Order totals (ex. total price, shipping price, tax and etc) |
| order_products | Orders details |
| comment | Orders comment |
System filter params:
| Name filter field | Description |
|---|---|
| force_all * | Display all fields possible to show |
* This filter also includes the fields that were created in the shopping cart backend (admin section) and the specific fields, which are set for this shopping cart by default.
