List Orders
List orders with the optimized projection and search strategy
Authorization
api_key In: header
Query Parameters
Page number for pagination (starting from 0)
double0Number of items per page
double20Search term (minimum 3 characters) to filter by order-number prefix or customer name/email substring
""Filter by order status (comma-separated for multiple)
""Filter by payment status (comma-separated for multiple)
""Filter by fulfillment status (comma-separated for multiple)
""Filter orders created on or after this date (ISO 8601 format)
""Filter orders created on or before this date (ISO 8601 format)
""Filter orders updated on or after this date (ISO 8601 format)
""Filter orders updated on or before this date (ISO 8601 format)
""Field to order results by
"created_at"Value in
- "created_at"
- "updated_at"
- "order_number"
Order direction
Value in
- "asc"
- "desc"
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/shipos/orders/list"{ "data": [ { "id": "string", "created_at": "2019-08-24T14:15:22Z", "closed_at": "2019-08-24T14:15:22Z", "cancelled_at": "2019-08-24T14:15:22Z", "merchant_team_name": "string", "shop_name": "string", "shop_type": "SHOPIFY", "fulfillment_status": "FULFILLED", "payment_status": "PENDING", "priority": "LOW", "order_number": "string", "currency": "string", "note": "string", "shipping_method": "string", "tags": [ "string" ], "total_price": 0.1, "customer_email": "string", "customer_name": "string", "customer_phone": "string", "shipping_address_company": "string", "shipping_address_address1": "string", "shipping_address_address2": "string", "shipping_address_city": "string", "shipping_address_state": "string", "shipping_address_country": "string", "shipping_address_zip": "string", "address_verified": true, "address_residential": "RESIDENTIAL", "core_line_item_count": 0.1, "unique_core_line_item_count": 0.1, "fulfillment_count": 0.1, "line_item_image_urls": [ "string" ], "status": "OPEN" } ], "meta": { "page": 0.1, "page_size": 0.1, "has_next_page": true, "has_previous_page": true, "start_index": 0.1, "end_index": 0.1 }}