Get Product Categories

Retrieves the details of all product categories.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response Parameters

ParameterDescription
response.status.successIndicates if the request was successful.
response.status.codeStatus code for the response.
response.status.messageMessage associated with request status.
response.product.itemList of product items retrieved.
.item\_idUnique ID of the item.
.skuStock Keeping Unit of the item.
.item\_eanEuropean Article Number or barcode of the item.
.pricePrice of the item.
.img\_urlURL of item's image.
.in\_stockIndicates if item is in stock.
.descriptionShort description of the item.
.long\_descriptionLonger description of the item (if available).
.sizeSize of the item (if available).
.styleStyle of the item (if available).
.brandBrand of the item (if available).
.colorColor of the item (if available).
.categoryCategory of the item (if available).
.attributesAdditional attributes of item (if available).
.attributes.attribute.nameName of the attribute (e.g., "Color", "Size").
.attributes.attribute.valueValue of attribute (e.g., "Black", "XXL").
.added\_onDate and time when the item was added.
.item\_status.statusIndicates if item retrieval was successful.
.item\_status.codeStatus code for the item retrieval.
.item\_status.messageMessage associated with item retrieval status.
Query Params
boolean

Retrieves category ids of each category fetched.

boolean

Retrieves all child categories if values=true.

int32
Defaults to 20

Limits number of child categories to be retrieved.

string

Retrieves the details of a specific product category based on the category name passed (not case sensitive).

int64

Retrieves the details of a specific product category based on the product id.

int64

Retrieves the details of a specific product category and its child categories based on the parent product id passed.

string

Fetch categories by name of the parent product.

int32

Limits the number of product categories to be retrieved.

int32

Entries to be ignored from the top.

string

Identifier code of the organisation.

string
enum

ALL - Fetches details of product associated with both master org and org unit. ORG-Fetches details of products associated with master ORG. SCOPE-Fetches details of products associated with an org unit.

Allowed:
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json