Set or change the stock of a product
https://api.app2email.com/v1/{number}/shop/items/{id}/stock Scope: orders:manage. Not with a sandbox key. mode set writes the figure, mode add changes it by value (negative takes away) in one step that cannot lose a sale happening at the same moment. For an item with variants send variant_id. Every change is written to the stock history with the key's name and the note. 409 shop_not_tracked when the item does not count stock: send start_tracking true to switch it on with this figure.
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
-
setadd -
The new figure (set) or the change (add; negative takes away).
- variant_id integer | null
- start_tracking boolean
Switch stock counting on for an item that does not count yet.
Responses
Fields
- e.g.
true - item_id integer
- variant_id integer | null
- stock_qty integer
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.