Orders
These keys are specified to use as defined in docs, they are case-sensitive. Any change in these keys may cause issues during data sync
postGet orders
{"current_page": 1,"data": [{"id": 101905,"ordered_at": "2020-12-02 14:42:29.000000","total_price": 350,"subtotal_price": 300,"total_tax": 0,"taxes_included": 0,"currency": "EGP","country_code": "CA","financial_status": "processing", // order status, (successful, canceled, etc...) your own statuses"total_discounts": 0,"phone": "01226699662","customer_locale": null, // en, ar"contact_email": "[email protected]","line_items" : [{"product_id": 324,"quantity": 2,"price": 50}]}],"from": 1,"last_page": 30,"per_page": 100,"to": 100,"total": 3000}
key | Description | Validation Rule |
id | Unique identifier for order | Required |
ordered_at | Order date, Format: Y-m-d H:i:s, ex: 2020-12-15 19:00:00 | Required |
total_price | Order total payment by customer, decimal | Required |
subtotal_price | Order subtotal / goods price,, decimal | Required |
total_tax | Order taxes, decimal default 0 | Required |
taxes_included | Is taxes included (0, 1) | Required |
currency | Order currency in ISO code (USD, EUR, etc...) | Required |
country_code | Client country code in ISO code (US, GB) | Required |
financial_status | Order status (processing, successful, canceled, refunded) | Not required |
total_discounts | Order discount, decimal default 0 | Required |
phone | Client phone | Required |
customer_locale | | Not Required |
contact_email | | Required |
line_items | items array as shown in response example | Required |
