One product with variants, option groups and pictures
https://api.app2email.com/v1/{number}/shop/items/{id} Scope: orders:manage. Everything needed to put the item in a cart: variants (an item with has_variants needs a variant_id in the cart line), option_groups with their choices, price changes and how many must and may be chosen, the stock of the item or of each variant, and images.
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
Responses
Fields
- e.g.
true -
35 fields
- id integer
- sku string
Your own product code; unique in the shop, may be empty.
- name string
- description string
- category_id integer | null
- price integer
Whole minor units (cents): 1250 = 12.50.
- price_label stringe.g.
$10.00 - compare_at integer | null
A higher "was" price in minor units, shown struck through.
- tax_class string
- status string
activehiddenarchived - has_variants boolean
-
Attributes customers filter by, eg {"colour": "Red"}.
- allergens string[]
- dietary string[]
- track_stock boolean
- stock_qty integer
- low_stock_at integer | null
- stock_state string
ok, low, out, untracked, or variants (the figures are on the variants).
- daily_limit integer | null
- sold_out_until string (date-time) | null
- sold_out_now boolean
- no_whatsapp boolean
true = shown on the order page only, never in a WhatsApp message.
- min_qty integer
- max_qty integer
0 = no limit of its own.
- prep_minutes integer | null
- sort integer
- sold_count integer
-
The main picture's addresses by size (thumb, card, full).
- created_at string (date-time)
- updated_at string (date-time)
- variants object[]
Only in GET /shop/items/{id} and the answers of a save.
12 item fields
- id integer
- sku string
-
What makes this version, eg {"size": "M", "colour": "Red"}.
- price integer | null
Its own price in minor units; null = the item's price.
- price_effective integer
Whole minor units (cents): 1250 = 12.50.
- price_label string
- track_stock boolean
- stock_qty integer
- stock_state string
- barcode string
- status string
activehidden - sort integer
- option_group_ids integer[]
- option_groups object[]
5 item fields
- id integer
- name string
- min_choices integer
How many the customer must choose at least (0 = optional).
- max_choices integer
How many at most.
- options object[]
- images object[]
- currency string
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.