List Orders By Status
Returns all orders matching the given status for this cart. <br/><br/> Possible statuses: new, at_wms, shipped, confirmed, error, canceled, new_or_at_wms, shipped_or_confirmed, any <br/><br/> New Orders: After downloading new orders, it is recommended you mark the orders as at_wms so that you, the client, and CartRover know that the order has been received.
Filters
Any filters should be passed with the URL as GET arguments.
| Argument | Description |
|---|---|
| from_date | Optional Timestamp |
| to_date | Optional Timestamp |
| order_source | Optional. To get a list call List Setup Carts: /cart/list Warning: some sources like CSV carts allow for multiple order sources in the same cart. There is no way to lookup if additional sources have been used by a CSV cart. It is not recommended to use this filter. |
| limit | Number of orders to return at once. Default 20, max 100 |
| page | Page of results to return. Default 1 |
| include_filtered_items | Y or N. Default N. If Y, items that should not be shipped will be included in response. The filtered_sku field will be set to Y for these items. |
| include_order_extras | Y or N. Default N. If Y, order header meta data fields (from original order source) will be returned as a key/value array in the order.source_meta field. |
| include_line_extras | Y or N. Default N. If Y, line item meta data fields (from original order source) will be returned as a key/value array in the item.source_meta field. |
| include_aliases | Y or N. Default N. If Y, any known aliases will be returned with the item record, including the WMS Master SKU. |
| include_attachments | Y or N. Default N. If Y, any attachment documents will be included in the 'attachments' element. This could include packing slips or shipping labels. |
The from_date and to_date fields perform a different search depending on the status you are searching. These are designed so you only have to search back though the time of your last successful API call in order to get all the new results.
Date Time Filters
| Status | Date Filter Searches By: |
|---|---|
| new | Order Created Date |
| at_wms | Order Delivered to WMS Date |
| new_or_at_wms | Order Created Date |
| partial | Shipment Loaded Date |
| shipped | Shipment Loaded Date |
| confirmed | Date Shipment Sent to Cart |
| shipped_or_confirmed | Shipment Loaded Date |
| error | Error Raised Date |
| canceled | Canceled Date |
| any | Order Created Date |
Note: If you have a lot of orders and your API response time is slow, use narrower date ranges. For example, only search the past hour instead of the past day.
Response Fields
The response will contain an array of orders with format/fields matching the New Orders endpoint.
Orders may also contain shipment records. Shipment records will match to the format of the View Order Status endpoint.
Multiple Items
When reading item data, note that there may be multiple lines for the same SKU. If your system cannot handle this, you must check for this and summarize the item's total quantity when loading into your system. When posting back tracking data you may list the item in a single entry instead of breaking into two.
Item SKU
The item field will contain the product code as provided by the order source. If you need this translated to another code, ensure you have Product Aliases setup in CartRover and pass the include_aliases field when requesting orders.
Request
- Base URLhttp://{{base_url}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.