Item catalog
The item twin of the box catalog: your catalog items,
each with its type, value, images, stock and shipping cost. It
knows nothing about what you use it for; a shop of physical goods, for example,
asks it for filter[type]=physical.
GET https://{operator}.app.lootboxsolutions.com/api/s2s/itemsQuery parameters
| Param | Required | Notes |
|---|---|---|
ids | — | Comma-separated item ids. Returns exactly those items, active or not (an archived item is gone); isActive says which. Without it, only active items are listed. |
filter[type] | — | Comma-separated item types (physical, digital, bonus, nuggets); an item matches any of them. An unknown type matches nothing. |
filter[inStock] | — | true for items in stock, false for items out of stock. |
filter[hasValue] | — | true for items with a retail value above zero, false for items without one. |
filter[search] | — | Part of the item name, in any case, or an exact item id. |
currency | — | ISO-4217 code. Reprices valueMinor and shippingCostMinor into it at current rates, as the box catalog reprices a box price. Defaults to your operator currency; a code you have not configured is refused with UNSUPPORTED_CURRENCY (422). |
locale | — | The language of name, falling back to the best available copy. Defaults to your default language. |
page, perPage | — | 1-based page and page size (default 100, at most 200), as on the box catalog. |
While your operator has collectibles switched off, collectible items are never listed, in either mode, as on the box catalog.
Response — 200
{ "dataVersion": 2, "items": [ { "itemId": 906, "name": "Logo hoodie", "type": "physical", "isActive": true, "valueMinor": 4000, "shippingCostMinor": 500, "currency": "USD", "inStock": true, "images": [ { "url": "https://cdn…/items/hoodie-card.png", "urlLarge": "https://cdn…/items/hoodie-detail.webp" } ] } ], "pagination": { "page": 1, "perPage": 100, "total": 1, "totalPages": 1, "hasMore": false }}| Field | Notes |
|---|---|
itemId | The catalog item id — the id box detail, the inventory and a goods grant use. |
name | Display name in the requested language. |
type | Item type. |
isActive | false for an item switched off; only reachable through ids. |
valueMinor | The item’s value (its retail value), in currency. |
shippingCostMinor | This item’s shipping cost today: its own, or your default one when it has none, in currency. A shipping order costs the shipping cost of its most expensive item, once per order. |
inStock | false when the item is out of stock. |
images | The item’s images in order: url card size, urlLarge detail size. Empty when it has none. |
Items are sorted by name. Walk pagination.hasMore to read the whole catalog.
Errors
| Code | Status | When |
|---|---|---|
UNSUPPORTED_CURRENCY | 422 | currency is not one you configured, or has no rate |