The shop's figures for a range of days

GET https://api.app2email.com/v1/{number}/shop/report
scope: orders:manage sandbox: reads MCP: get_shop_report

Scope: orders:manage. Both days are included, in the shop's time zone; the default is the last 7 days and a range covers 366 days at most. Orders by state, sales, what was paid online and at the counter by cash and card, delivery fees, tips, discounts, tax and refunds, the best sellers, orders per hour and per day, the customers who spent most, the discount codes used, where the orders came from, and the hand-over log.

Path

  • number string required pattern ^[0-9]{8,15}$

    Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.

    e.g. 4976659348270

Query

  • from string

    First day, YYYY-MM-DD. Default: six days before to.

    e.g. 2026-11-07
  • to string

    Last day, YYYY-MM-DD. Default: today.

    e.g. 2026-11-13

Responses

200 The figures. The example is shortened.
Fields
  • success boolean required
    e.g. true
  • request_id string required
  • report object any keys

    orders (counts by state), money (sales, paid online, at the counter by cash and card, delivery fees, tips, discounts, tax, refunds), items (best sellers), hours, hand-overs, per day, top customers, codes, sources; from, to, timezone.

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.
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.