Order
Class name: Order
| Property | Type | Description | Required |
|---|---|---|---|
| customerId | string | The ID of the customer who placed the order | Yes |
| vendorId | string | The ID of the vendor who fulfils the order | Yes |
| productId | string | The ID of the product ordered | Yes |
| variationId | string | The ID of the variation of the product ordered (if this is a variable product) | No |
| quantity | int | The quantity of the product ordered | Yes |
| completedAt | string | The date and time the order was completed in UTC ISO 8601 format | No |
| platform | enum | The platform where the order was placed. Options: web, android, ios | Yes |
| status | enum | The status of the order. Options: pending, confirmed, readyToShip, shipping, shipped, delivered, canceled, returned | Yes |
| orderTrackingInfo | OrderTrackingInfo[] | The tracking information of the order | Yes |
| currency | string | The currency the order was placed in | Yes |
| subTotal | double | The sub total of the order | Yes |
| shippingCost | double | The shipping cost of the order | Yes |
| total | double | The total of the order | Yes |
| paymentMethod | enum | The payment method used to pay for the order. Options: stripe, paypal | Yes |
| shippingMethod | enum | The shipping method used to ship the order. Options: freeShipping, more to be added | Yes |
| shippingAddress | Address | The shipping address of the order | Yes |
| expectedDeliveryDate | string | The expected delivery date of the order in UTC ISO 8601 format | Yes |