The shop: on or off, open now, the order page, counts and limits
https://api.app2email.com/v1/{number}/shop Scope: orders:manage. Start here. enabled says whether the shop takes orders; open_now and paused what a customer would find right now; page_url is the public order page; counts and limits say how big the catalog is and may get (10,000 items, archived ones not counted). A number that never opened Order-and-Pay answers set_up false.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Responses
Fields
- e.g.
true -
14 fields
- set_up boolean
- enabled boolean
The shop takes orders.
- name string
- preset string
- currency string
- timezone string
- page_url string
- open_now boolean
- paused boolean
- pickup boolean
- delivery boolean
- browse string
How the chat lets customers order: page, flow or choose.
-
3 fields
- items integer
- active integer
- categories integer
-
4 fields
- items integer
- categories integer
- variants integer
- search_limit integer
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.