Get Products by Hierarchy
GET Get the List of Products in a Hierarchy
https://api.moltin.com/catalog/hierarchies/:hierarchyId/products
Returns the products associated with the specified hierarchy in the catalog. The products must be in the live status.
If you have multiple catalog rules defined, the rule that best matches the shopperʼs context is used to determine which catalog is retrieved. For information about how rules are matched, see Resolving Catalog Rules.
You can see the parent nodes a product is associated with in the bread_crumbs and bread_crumb_nodes metadata for each product. This is useful if you want to improve how your shoppers search your store, for example. For more information, see Catalog Releases Overview.
Parameters
Path parameters
| Name | Required | Type | Description |
|---|---|---|---|
hierarchyId | Required | string | The unique identifier of a hierarchy. |
Headers
| Name | Required | Type | Description |
|---|---|---|---|
Authorization | Required | string | The Bearer token to grant access to the API. Implicit Bearer token only returns products with live status; products with draft status won’t be included. |
X-Moltin-Customer-Token | Optional | string | The unique identifier of a signed-in customer. Corresponds to the customer_ids attribute in a rule object. |
EP-Channel | Optional | string | The channel, such as website or mobile app. Corresponds to the channel attribute in a rule object. |
EP-Context-Tag | Optional | string | A tag defined in the store, such as clearance. Corresponds to the tag attribute in a rule object. |
Query parameters
| Name | Required | Type | Description |
|---|---|---|---|
page[limit] | Optional | string | The number of items to return per page. Minimum value is 1. |
page[offset] | Optional | string | The number of items to offset the results by. Offset is zero-based. |
Request Example
curl -X GET https://api.moltin.com/catalog/hierarchies/0e119de2-5fb0-4bca-9b84-b3fc6c903007/products \
-H "Authorization: Bearer XXXX"
Response Example
200 OK
},
"data": [
{
"attributes": {
"availability": "available",
"published_at": "2021-04-20T20:53:44.392Z",
"base_product": false,
"base_product_id": "cdf574bc-e36e-48fc-9eac-01c87839b285",
"commodity_type": "physical",
"upc_ean": "0123456",
"manufacturer_part_num": "mfn1",
"created_at": "2021-03-10T20:00:43.734Z",
"description": "This is a product",
"dimensions": "4x5x2",
"manage_stock": false,
"name": "Blue shirt",
"price": {
"USD": {
"amount": 100,
"includes_tax": false
},
"CAD": {
"amount": 100,
"includes_tax": false
},
"GBP": {
"amount": 100,
"includes_tax": false
}
},
"tiers": {
"min_5": {
"minimum_quantity": 5,
"price": {
"USD": {
"amount": 100,
"includes_tax": false
},
"CAD": {
"amount": 100,
"includes_tax": false
},
"GBP": {
"amount": 100,
"includes_tax": false
}
}
},
"min_10": {
"minimum_quantity": 10,
"price": {
"USD": {
"amount": 150,
"includes_tax": false
},
"CAD": {
"amount": 150,
"includes_tax": false
},
"GBP": {
"amount": 150,
"includes_tax": false
}
}
},
"min_15": {
"minimum_quantity": 15,
"price": {
"USD": {
"amount": 175,
"includes_tax": false
},
"CAD": {
"amount": 175,
"includes_tax": false
},
"GBP": {
"amount": 175,
"includes_tax": false
}
}
}
},
"components": {
"buttons": {
"name": "Button down shirt",
"options": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "product",
"quantity": 2
}
]
},
"pockets": {
"name": "Shirt with pockets",
"options": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "product",
"quantity": 2
}
]
},
"collar": {
"name": "Shirt with collar",
"options": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "product",
"quantity": 2
}
]
}
},
"product_hash": "string",
"sku": "blue-shirt",
"slug": "blue-shirt",
"status": "live",
"updated_at": "2021-04-20T20:46:27.089Z",
"weight": {
"g": 997.903,
"kg": 1,
"lb": 2.20,
"oz": 32
},
"extensions": {
"size": {
"size": {},
"medium": {},
"large": {}
},
"additionalProp2": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"additionalProp3": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
}
},
"id": "8fccaa19-dba9-4621-8d11-31a222a68c7c",
"relationships": {
"categories": [
{
"id": "65477ce0-fcb8-436b-a120-3d57979421dd",
"label": "category",
"name": "Formal dresswear"
}
],
"brands": [
{
"id": "65477ce0-fcb8-436b-a120-3d57979421dd",
"label": "category",
"name": "Formal dresswear"
}
],
"collections": [
{
"id": "65477ce0-fcb8-436b-a120-3d57979421dd",
"label": "category",
"name": "Formal dresswear"
}
],
"parent": {
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "product"
}
},
"children": {
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "product"
}
]
},
"files": {
"data": [
{
"type": "file",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"created_at": "2021-03-10T20:00:43.734Z"
}
]
},
"main_image": {
"data": {
"type": "main_image",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
},
"type": "product",
"meta": {
"catalog_id": "362a16dc-f7c6-4280-83d6-4fcc152af091",
"display_price": {
"with_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
},
"without_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
}
},
"catalog_source": "pim",
"bread_crumb_nodes": [
"04e748f1-83db-4013-85c8-9edfb0e1b5fa",
"a96a898b-444c-40b6-9c27-5fc74d08e685"
],
"bread_crumbs": {
"04e748f1-83db-4013-85c8-9edfb0e1b5fa": [
"e5a64eae-56c2-48cd-b8b1-f5d3be734d52",
"94b882fa-85de-470e-acb3-5b11358e02de"
],
"a96a898b-444c-40b6-9c27-5fc74d08e685": [
"e5a64eae-56c2-48cd-b8b1-f5d3be734d52"
]
},
"sale_id": "string",
"sale_expires": "1970-01-01T00:00:00.000",
"original_price": {
"USD": {
"amount": 100,
"includes_tax": false
},
"CAD": {
"amount": 100,
"includes_tax": false
},
"GBP": {
"amount": 100,
"includes_tax": false
}
},
"original_display_price": {
"with_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
},
"without_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
}
},
"component_products": {
"summerSale": {
"sale_id": "summer_sale2022",
"sale_expires": "2022-01-01T00:00:00.000",
"price": {
"USD": {
"amount": 100,
"includes_tax": false
},
"CAD": {
"amount": 100,
"includes_tax": false
},
"GBP": {
"amount": 100,
"includes_tax": false
}
},
"display_price": {
"with_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
},
"without_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
}
},
"original_price": {
"USD": {
"amount": 100,
"includes_tax": false
},
"CAD": {
"amount": 100,
"includes_tax": false
},
"GBP": {
"amount": 100,
"includes_tax": false
}
},
"original_display_price": {
"with_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
},
"without_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
}
}
},
"fallSale": {
"sale_id": "fall_sale22",
"sale_expires": "2022-08-01T00:00:00.000",
"price": {
"USD": {
"amount": 100,
"includes_tax": false
},
"CAD": {
"amount": 100,
"includes_tax": false
},
"GBP": {
"amount": 100,
"includes_tax": false
}
},
"display_price": {
"with_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
},
"without_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
}
},
"original_price": {
"USD": {
"amount": 100,
"includes_tax": false
},
"CAD": {
"amount": 100,
"includes_tax": false
},
"GBP": {
"amount": 100,
"includes_tax": false
}
},
"original_display_price": {
"with_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
},
"without_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
}
}
},
"winterSale": {
"sale_id": "winter_sale23",
"sale_expires": "2023-03-01T00:00:00.000",
"price": {
"USD": {
"amount": 100,
"includes_tax": false
},
"CAD": {
"amount": 100,
"includes_tax": false
},
"GBP": {
"amount": 100,
"includes_tax": false
}
},
"display_price": {
"with_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
},
"without_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
}
},
"original_price": {
"USD": {
"amount": 100,
"includes_tax": false
},
"CAD": {
"amount": 100,
"includes_tax": false
},
"GBP": {
"amount": 100,
"includes_tax": false
}
},
"original_display_price": {
"with_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
},
"without_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
}
}
}
},
"tiers": {
"springSale": {
"sale_id": "spring_sale22",
"sale_expires": "2022-06-01T00:00:00.000",
"display_price": {
"with_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
},
"without_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
}
},
"original_price": {
"USD": {
"amount": 100,
"includes_tax": false
},
"CAD": {
"amount": 100,
"includes_tax": false
},
"GBP": {
"amount": 100,
"includes_tax": false
}
},
"original_display_price": {
"with_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
},
"without_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
}
}
},
"midSummerSale": {
"sale_id": "midSummer_sale23",
"sale_expires": "2023-06-01T00:00:00.000",
"display_price": {
"with_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
},
"without_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
}
},
"original_price": {
"USD": {
"amount": 100,
"includes_tax": false
},
"CAD": {
"amount": 100,
"includes_tax": false
},
"GBP": {
"amount": 100,
"includes_tax": false
}
},
"original_display_price": {
"with_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
},
"without_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
}
}
},
"midFallSale": {
"sale_id": "midFall_sale23",
"sale_expires": "2023-09-01T00:00:00.000",
"display_price": {
"with_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
},
"without_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
}
},
"original_price": {
"USD": {
"amount": 100,
"includes_tax": false
},
"CAD": {
"amount": 100,
"includes_tax": false
},
"GBP": {
"amount": 100,
"includes_tax": false
}
},
"original_display_price": {
"with_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
},
"without_tax": {
"amount": 47500,
"currency": "USD",
"formatted": "$475.00"
}
}
}
},
"variation_matrix":
{"3fa85f64-5717-4562-b3fc-2c963f66afa6": "4cd092fe-8878-4d93-8438-c305d2c6fb1f"
},
"variations": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "color",
"options": [
{
"id": "4cd092fe-8878-4d93-8438-c305d2c6fb1f",
"name": "Red",
"description": "Red"
}
]
}
],
"language": "en-GB"
}
}
],
"links": {
"self": "catalog/products"
}
}