Skip to content

Inventorum Api Documentation Categories

Categories¶

GET /categories¶

Returns list of categories with number of products and list of product ids assigned to categories.

Required scopes: categories

GET Params

param	type/format	required	sample value	description
limit	integer	false	40	default and max value: 40
page	integer	false	10	page number
channel	string	false	ipad	Options: ipad, shop, ebay, ece, backoffice, atalanda, click_and_collect
q	string	false	clothes	search query

Request¶

curl -X GET \
  https://app.inventorum.com/api/categories/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {{oauth_token}}' \

Response¶

{
    "total": 137,
    "data": [
        {
            "parent": null,
            "is_leaf": true,
            "hint": "1# rksv test",
            "tree_id": 83566,
            "id": 145091,
            "channel": null,
            "translations": [
                {
                    "name": "1# rksv test",
                    "language": "de",
                    "id": null
                }
            ],
            "image": "http://app.inventorum.com/uploads/1627/category/...jpg",
            "name": "1# rksv test",
            "products_count": 6,
            "products": [
                10863093,
                10863099,
                10863101,
                12190393,
                12219067,
                12800250
            ]
        }
    ]
}

GET /categories/{category_id}¶

Returns details of a specified category.

Required scopes: categories

Request¶

curl -X GET \
  https://app.inventorum.com/api/categories/163032 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {{oauth_token}}' \

Response¶

{
    "parent": null,
    "is_leaf": true,
    "hint": "1# rksv test",
    "tree_id": 83566,
    "id": 145091,
    "channel": null,
    "translations": [
        {
            "name": "1# rksv test",
            "language": "de",
            "id": null
        }
    ],
    "image": {
        "id": 711238,
        "urls": {
            "ipad": "https://app.inventorum.com/uploads/1627/category/....ipad.png",
            "thumb": "https://app.inventorum.com/uploads/1627/category/....thumb.png",
            "image": "https://app.inventorum.com/uploads/1627/category/....ipad.png",
            "ipad_retina": "https://app.inventorum.com/uploads/1627/category/....ipad_retina.png",
            "ebay": "https://app.inventorum.com/uploads/1627/category/....ebay.png",
            "thumb_retina": "https://app.inventorum.com/uploads/1627/category/....thumb_retina.png",
            "original": "https://app.inventorum.com/uploads/1627/category/....original.png"
        },
        "type": 3,
        "new": true
    },
    "name": "1# rksv test",
    "products_count": 74,
    "products": [
        10863093,
        10863099,
        10863101,
        12190393,
        12219067,
        12219074,
    ]
}

Error¶

Status: 404 Not found
{
    "error": {
        "fields": {},
        "description": null,
        "key": "common.unknown"
    }
}