Create an order for a customer
idempotencyKey strategy. For every request to create an order, the request body must include an idempotencyKey which is a unique UUID v4 string.
If an order for this key has already been placed, it will be returned as the data instead of placing a duplicate order.
In order to simplify this process for integrators, an idempotencyKey is returned from the pricing request (POST /api/v1/orders/pricing). Please save the key from the last pricing request you use and submit it along with the order.
Please reach out if you have any questions about this.The key assigned to your company and provided via Meadow
The key generated and provided by our mutual client
Order type - must be either delivery or pickup
An array of products to buy
The customer for this order.
Key to help avoid double orders due to server miscommunication. Please see "Idempotent Requests" section. Please use the string provided to you by the pricing endpoint. This value must be a v4 UUID.
The address of the customer. Required if type is set to delivery
Optional notes field to help fulfill the order (Example: please call on delivery)
A fee that will be passed through and added onto the customerGrandTotal
A passthrough title for the delivery fee
An array of promo codes to redeem. These codes must already exist in the Meadow backend.
Create order response
The ID for the order. Used to fetch status updates
The status of the order. Will be set to draft or new depending on the organization's settings.
The subtotal price before discounts, credits, adjustments are taken into account.
The final price of the order before payment & delivery fees.
The cost of the order that the customer will pay
The line items with pricing information attached
An array of order level discounts
An array of credits applied. May be store credit or promo codes attached to the customers account.
An array of adjustments made to the order. May be a tax exemption or other future Meadow POS behavior.
All of the taxes applied to this order
The matched customer for this order