Get Items
Use this API to retrieve all the items.
Query Parameters
- page number
Default value:
1By default first page will be listed. For navigating through pages, use the page parameter.
- limit number
Default value:
20The number of results to return per request.
- id number[]
Unique identifier of the item.
- slug string[]
A common or friendly name for the item, should be in lowercase.
- sku string[]
Stock Keeping Unit value of item, should be unique throughout the item.
- categoryId number[]
Unique identifier of the category.
- brandId number[]
Unique identifier of the brand.
- search string
The query string to be searched for the item.
- zipCode number
The zip or postal code of the address.
- attributes[color] string
filter the item based on color.
- attributes[size] string
filter the item based on size.
- active string
Possible values: [
true,false]The current state of the Item.
Example: true - sort[inventories.price] number
This filter helps to sort the item based on inventory price.
- sort[createdAt] number
This filter helps to sort the item based on created date.
- createdAt[$eq] string
Item created date equal to
- createdAt[$gt] string
Item created date greater than
- createdAt[$gte] string
Item created date greater than or equal to
- createdAt[$lt] string
Item created date less than
- createdAt[$lte] string
Item created date less than or equal to
- createdAt[$ne] string
Item created date not equal to
- price[$eq] number
price equal to
- price[$gt] number
price greater than
- price[$gte] number
price greater than or equal to
- price[$lt] number
price less than
- price[$lte] number
price less than or equal to
- price[$ne] number
price not equal to
- 200
Success response
- application/json
- Example
{
"statusCode": 200,
"data": {
"results": [
{
"_id": 343467,
"attributes": [
{
"_id": 440,
"parentAttribute": {
"_id": 67,
"name": "Size",
"slug": "size"
},
"label": "Regular",
"value": "R"
},
{
"_id": 441,
"parentAttribute": {
"_id": 67,
"name": "Size",
"slug": "size"
},
"label": "Medium",
"value": "M"
},
{
"_id": 442,
"parentAttribute": {
"_id": 67,
"name": "Size",
"slug": "size"
},
"label": "Large",
"value": "L"
}
],
"categoryId": 34258,
"description": "Double Cheese Margarita Large",
"item": {
"_id": 343467,
"name": "Double Cheese Margarita"
},
"name": "Double Cheese Margarita",
"slug": "double-cheese-margarita",
"subItems": [
{
"_id": 352182,
"attributes": [
{
"_id": 440,
"parentAttribute": {
"_id": 67,
"name": "Size",
"slug": "size"
},
"label": "Regular",
"value": "R"
}
],
"categoryId": 34258,
"description": "",
"item": {
"_id": 343467,
"name": "Double Cheese Margarita"
},
"name": "Double Cheese Margarita Regular",
"slug": "double-cheese-margarita-regular",
"inventory": {
"_id": 364538,
"location": {
"_id": 1364,
"name": "Annanagar"
},
"mrp": 0,
"price": 200,
"pricingType": "fixed",
"taxes": [],
"priceCategories": [],
"stock": 100,
"active": true,
"available": true
},
"attributesGroup": [
{
"_id": 67,
"name": "Size",
"slug": "size",
"options": [
{
"_id": 440,
"label": "Regular",
"value": "R"
}
]
}
]
},
{
"_id": 352776,
"attributes": [
{
"_id": 441,
"parentAttribute": {
"_id": 67,
"name": "Size",
"slug": "size"
},
"label": "Medium",
"value": "M"
}
],
"categoryId": 34258,
"description": "",
"item": {
"_id": 343467,
"name": "Double Cheese Margarita"
},
"name": "Double Cheese Margarita Medium",
"slug": "double-cheese-margarita-medium",
"inventory": {
"_id": 364539,
"location": {
"_id": 1364,
"name": "Annanagar"
},
"mrp": 0,
"price": 225,
"pricingType": "fixed",
"taxes": [],
"priceCategories": [],
"stock": 100,
"active": true,
"available": true
},
"attributesGroup": [
{
"_id": 67,
"name": "Size",
"slug": "size",
"options": [
{
"_id": 441,
"label": "Medium",
"value": "M"
}
]
}
]
},
{
"_id": 352777,
"attributes": [
{
"_id": 442,
"parentAttribute": {
"_id": 67,
"name": "Size",
"slug": "size"
},
"label": "Large",
"value": "L"
}
],
"categoryId": 34258,
"description": "Double Cheese Margarita Large",
"item": {
"_id": 343467,
"name": "Double Cheese Margarita"
},
"name": "Double Cheese Margarita Large",
"slug": "double-cheese-margarita-large",
"inventory": {
"_id": 364540,
"location": {
"_id": 1364,
"name": "Annanagar"
},
"mrp": 0,
"price": 250,
"pricingType": "fixed",
"taxes": [],
"priceCategories": [],
"stock": 100,
"active": true,
"available": true
},
"attributesGroup": [
{
"_id": 67,
"name": "Size",
"slug": "size",
"options": [
{
"_id": 442,
"label": "Large",
"value": "L"
}
]
}
]
}
],
"category": {
"_id": 34258,
"name": "Pizza",
"slug": "pizza",
"parentCategories": []
},
"attributesGroup": [
{
"_id": 67,
"name": "Size",
"slug": "size",
"options": [
{
"_id": 440,
"label": "Regular",
"value": "R"
},
{
"_id": 441,
"label": "Medium",
"value": "M"
},
{
"_id": 442,
"label": "Large",
"value": "L"
}
]
}
]
}
],
"pagination": {
"currentPage": 1,
"lastPage": 1,
"perPage": 20,
"totalResults": 1
},
"filters": {
"brand": [],
"price": [
{
"_id": {
"min": 1,
"max": 10
},
"count": 4
},
{
"_id": {
"min": 10,
"max": 20
},
"count": 4
},
{
"_id": {
"min": 20,
"max": 100
},
"count": 4
},
{
"_id": {
"min": 100,
"max": 180
},
"count": 4
},
{
"_id": {
"min": 180,
"max": 250
},
"count": 5
}
],
"color": [],
"size": [
{
"_id": "R",
"name": "Regular",
"count": 2
},
{
"_id": "L",
"name": "Large",
"count": 1
},
{
"_id": "M",
"name": "Medium",
"count": 1
}
]
},
"appliedFilters": {
"page": 1,
"limit": 20,
"id": 343467
}
}
}