Price a cart: total, problems, times and ways to pay

POST https://api.app2email.com/v1/{number}/shop/quote
scope: orders:manage sandbox: reads MCP: quote_shop_order

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

  • 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

Body application/json required

  • lines object[] required min 1 items
    5 item fields
    • item_id integer required
    • qty integer min 1 default 1
    • variant_id integer | null

      Needed for an item with variants.

    • option_ids integer[]

      Choices from the item's option groups.

    • note string max 200 chars
  • fulfilment string default pickup
    pickupdelivery
  • address object more keys allowed

    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.

  • When the shop has several delivery options: the id of one (GET /shop/settings, config.delivery.methods).

  • tip_percent integer 0–100
  • tip_minor integer min 0

    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

200 The quote.
Fields
  • success boolean required
    e.g. true
  • request_id string required
  • quote object more keys allowed

    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.

    • fulfilment string
    • delivery_fee integer

      Whole minor units (cents): 1250 = 12.50.

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

  • times object any keys

    asap { offered, ok, ready_label, ready_at, message }, slots_on, days [{ date, label, slots [{ start, label, full }] }], open_now, paused.

  • pay object more keys allowed
    4 fields

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.