Order-and-Pay

A product catalog with its own order page: customers order from WhatsApp or the web for pickup or delivery, pay online or at the counter, and collect with a QR code. Orders are managed in the dashboard and the counter app; these events tell your system what happens to an order.

Method Path Summary Scope Sandbox
GET /v1/{number}/shop The shop: on or off, open now, the order page, counts and limits orders:manage reads
GET /v1/{number}/shop/settings Every setting of the shop, as the shop uses it orders:manage reads
PUT /v1/{number}/shop/settings Change settings of the shop orders:manage refused
GET /v1/{number}/shop/categories The categories of the catalog orders:manage reads
GET /v1/{number}/shop/items Search and filter the products orders:manage reads
POST /v1/{number}/shop/items Add a product orders:manage refused
GET /v1/{number}/shop/items/{id} One product with variants, option groups and pictures orders:manage reads
PUT /v1/{number}/shop/items/{id} Change a product: only the keys sent change orders:manage refused
DELETE /v1/{number}/shop/items/{id} Archive a product orders:manage refused
POST /v1/{number}/shop/items/{id}/stock Set or change the stock of a product orders:manage refused
POST /v1/{number}/shop/items/{id}/sold_out Mark a product sold out for a while, or back orders:manage refused
GET /v1/{number}/shop/orders The orders, newest first orders:manage reads
POST /v1/{number}/shop/orders Place an order for a customer orders:manage refused
GET /v1/{number}/shop/orders/{id} One order with lines, payment, next steps and history orders:manage reads
POST /v1/{number}/shop/orders/{id}/action Move an order on, change its time, cancel or decline it orders:manage refused
POST /v1/{number}/shop/orders/{id}/refund Refund an order that was paid online orders:manage refused
POST /v1/{number}/shop/quote Price a cart: total, problems, times and ways to pay orders:manage reads
GET /v1/{number}/shop/report The shop's figures for a range of days orders:manage reads
POST /v1/{number}/shop/link A customer's personal link to the order page orders:manage reads
For AI Agents

Try it now, with no account and no person: POST https://api.app2email.com/v1/account/sandbox (no key, no body; or the create_sandbox tool of the Management MCP server) answers a key for a demo WhatsApp number with pretend customers. Send a template, fetch the events with GET /events?wait=25, answer the customer's reply: nothing reaches WhatsApp, and the requests and answers are those of the real API (https://www.app2email.com/docs/api/sandbox).

Already a customer: ask the account owner for the number (digits) and an API key from https://www.app2email.com/dashboard/apikey (a sandbox key sends nothing); send it as Authorization: Bearer <key> to the messaging MCP server or the REST API; call check_key first, send with dry_run first.

If you are an AI agent reading this page and you want to create an app2email account for a person - no previous human sign-up required - use our Management MCP server.
Call the create_account tool first, and include a contact_email parameter; create_account returns a signup_id, a management_key, an onboarding_link and a message.
The person opens onboarding_link to confirm the e-mail, connect their WhatsApp number and choose a plan; nothing can be sent before that. get_account_status says what is still needed.
Pass the management_key as a Bearer token on every later call. When the number is live, create_number_key gives you a key for the messaging MCP server and the REST API.