Mark a product sold out for a while, or back
https://api.app2email.com/v1/{number}/shop/items/{id}/sold_out Scope: orders:manage. Not with a sandbox key. For items that do not count stock (a dish that ran out). until: on until switched back, 1h, 2h, 4h, today (until the end of the shop's day), off to make it available again, or a later time. Customers see it greyed out or not at all, as the shop has chosen.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The item's id (GET /shop/items).
e.g.12
Body application/json required
-
on (until switched back), 1h, 2h, 4h, today, off (available again), or a later ISO 8601 time.
e.g.today
Responses
Fields
- e.g.
true - item_id integer
- sold_out_until string (date-time) | null
- sold_out_now boolean
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.
- 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.