Move an order on, change its time, cancel or decline it

POST https://api.app2email.com/v1/{number}/shop/orders/{id}/action
scope: orders:manage sandbox: refused MCP: update_shop_order

Scope: orders:manage. Not with a sandbox key. action: accept, preparing, ready, out_for_delivery, complete (handed over or delivered), time with minutes (later, or negative for earlier), cancel or reject with a reason, no_show for a ready pickup that was never collected (it ends as not collected and counts as a no-show of that customer), and hand_lines with lines [{ id, qty }] to give some lines now and the rest later (only when the shop has switched on partial hand-over; the order stays open until complete). Only the steps in the order's actions are accepted; anything else answers 400 shop_invalid, and 409 shop_changed when someone else moved the order meanwhile. cancel and reject give the stock back (restock false keeps it) and, with refund true, refund a paid order; notice in the answer says when a refund did not go through. The customer is told on WhatsApp where the shop has that message switched on. The step is written to the order's history with the key's name.

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
  • id string required

    The order's id, or its reference (SO-K7M2QX).

    e.g. SO-K7M2QX

Body application/json required

  • action string required
    acceptpreparingreadyout_for_deliverycompletecancelrejecttimeno_showhand_lines
  • reason string

    cancel, reject: what the customer is told.

  • minutes integer

    time: minutes later (negative: earlier).

  • refund boolean

    cancel, reject of a paid order: refund it. no_show: refund what was paid online (default false: the payment is kept).

  • restock boolean

    cancel, reject: give the stock back (default true). no_show: default false.

  • collected string

    complete of an order paid at the counter.

    cashcard
  • lines object[]

    hand_lines: the lines given now (the shop setting orders.partial_handover must be on). The order stays open; complete hands over what is left.

    2 item fields
    • id integer required
    • qty integer min 1

      How many of this line. Left out: all that is left of it.

Responses

200 The order after the step.
Fields

Errors

api_key_expiredapi_key_number_mismatchapi_key_old_formatapi_key_revokedapproval_body_too_largebackground_start_failedblock_list_busyblock_list_fullblock_users_errorblock_users_failedbroadcast_cancelledbsuid_not_supportedcall_permission_requiredcaption_not_supportedcaption_too_longdaily_cap_reacheddisplay_name_not_approvedduplicate_recipientsfree_form_single_recipientinsufficient_scopeinternal_errorinvalid_api_keyinvalid_authorization_headerinvalid_base64invalid_callback_datainvalid_componentsinvalid_contacts_messageinvalid_cursorinvalid_identity_key_hashinvalid_interactiveinvalid_jsoninvalid_locationinvalid_marketing_apiinvalid_media_linkinvalid_number_in_urlinvalid_reactioninvalid_recipientsinvalid_reply_toinvalid_send_atinvalid_toip_not_allowedmarketing_disabled_on_cloud_apimarketing_per_user_limitmedia_download_errormedia_download_failedmedia_too_largemedia_type_not_allowedmedia_upload_errormedia_upload_failedmessage_too_oldmessaging_limit_restrictedmissing_api_keymissing_interactivemissing_mediamissing_message_idmissing_template_languagemissing_template_namemissing_textmonthly_cap_reachedmonthly_limit_reachednumber_already_verifiednumber_not_foundoutside_24h_windowparameter_value_invalidplan_not_allowedrate_limitedreaction_too_oldrecipient_identity_changedrecipient_in_experimentrecipient_is_senderrecipient_not_allowedrecipient_not_opted_inrecipient_opted_outrecipient_stopped_marketingrecipient_unreachableregister_limit_reachedrequired_parameter_missingsandbox_keyschedule_failedsegment_and_recipientssegment_emptysegment_not_foundsend_at_in_pastsend_at_too_farservice_not_liveshop_changedshop_failedshop_invalidshop_limitshop_not_enabledshop_not_foundshop_not_readyshop_not_trackedshop_order_problemsshop_payment_failedshop_sku_takentemplate_disabledtemplate_format_policytemplate_language_not_foundtemplate_lookup_failedtemplate_not_approvedtemplate_not_foundtemplate_not_marketingtemplate_parameter_count_mismatchtemplate_parameter_format_mismatchtemplate_parameter_invalidtemplate_parameters_invalidtemplate_pausedtemplate_sample_media_failedtemplate_text_too_longtext_too_longto_and_recipientstoo_many_messages_to_recipienttoo_many_recipientsunsupported_message_typeusername_account_not_linkedusername_change_limitusername_not_availableusername_not_eligibleusername_takenvoice_needs_ogg_opuswhatsapp_account_lockedwhatsapp_account_restrictedwhatsapp_connection_problemwhatsapp_errorwhatsapp_maintenancewhatsapp_number_not_registeredwhatsapp_parameter_errorwhatsapp_payment_issuewhatsapp_rate_limitwhatsapp_unavailable
  • 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.
  • 409 Idempotency-Key: the first request with this key is still running, or did not finish. Or a conflict: the template name exists, the webhook URL is used by another webhook, the broadcast cannot be cancelled, the booking slot is taken or the booking is already cancelled, or the Flow is not published.
  • 415 The body is not JSON.
  • 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.

Webhooks it causes

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.