Price a cart: total, problems, times and ways to pay
https://api.app2email.com/v1/{number}/shop/quote Scope: orders:manage. Nothing is saved and no stock is taken. quote has the lines with their prices, the discount (or why a code gives none), the delivery fee for the address, fees, tip, tax and total; problems lists what is in the way (empty = the order can be placed). times says whether as-soon-as-possible is offered and when it would be ready, and the time slots when the shop uses them; pay which ways to pay this order has. Quote first, show the total, then POST /shop/orders with expected_total.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Body application/json required
-
5 item fields
- variant_id integer | null
Needed for an item with variants.
- option_ids integer[]
Choices from the item's option groups.
-
pickupdelivery -
Needed for delivery: line1 and at least one of suburb, city or postcode.
10 fields
- line1 string
Street and number.
- line2 string
- suburb string
- city string
- region string
- postcode string
- country string
- notes string
For the driver.
- lat number
Where the customer is (latitude), with lng. Only the delivery options that charge by distance read it; without it they answer code
location. - lng number
Longitude, with lat.
- delivery_method string
When the shop has several delivery options: the id of one (GET /shop/settings, config.delivery.methods).
- discount_code string
-
A tip as an amount; wins over tip_percent.
- contact string
The customer's WhatsApp number, for discount codes that depend on the customer.
Responses
Fields
- e.g.
true -
The cart priced from the shop's data as it is now.
20 fields
- currency string
- lines object[]
- items_count integer
- subtotal integer
Whole minor units (cents): 1250 = 12.50.
- discount integer
Whole minor units (cents): 1250 = 12.50.
- discount_code string
- discount_message string
- fulfilment string
- delivery_fee integer
Whole minor units (cents): 1250 = 12.50.
- delivery_method string
- delivery_zone string
- fees_total integer
Whole minor units (cents): 1250 = 12.50.
- tip integer
Whole minor units (cents): 1250 = 12.50.
- tax integer
Whole minor units (cents): 1250 = 12.50.
- tax_included boolean
- total integer
Whole minor units (cents): 1250 = 12.50.
- total_label string
- prep_minutes integer
- ok boolean
true = nothing is in the way.
- problems object[]
4 item fields
- code string
unavailable, sold_out, choose_variant, option_min, option_max, option_sold_out, min_qty, max_qty, stock, min_order, discount, fulfilment, delivery_method, delivery_area or delivery_min_order.
- message string
- line integer
The index of the line in your request; -1 = the whole order.
- left integer
For stock: how many can be had.
-
asap { offered, ok, ready_label, ready_at, message }, slots_on, days [{ date, label, slots [{ start, label, full }] }], open_now, paused.
-
4 fields
- online string[]
The connected ways to pay online (stripe, paypal).
- later boolean
- must_prepay boolean
- free boolean
Errors
- 400 The request is malformed (missing or invalid fields, query parameters or times).
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.
- 503 app2email's connection to the WhatsApp account needs attention, or the request log is not available right now.