XM

Retrieve Product

Path:

GET https://{baseurl}/api-product/v1/product?size=10&page=1

Enables you to retrieve the product details based on the specified query parameters.

Headers

Content-Type : application/json

x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }

Parameters

Type : query

Name : The page and size number for a focused search results.

Required: true

or

Type : query

Name : The SKUs to narrow down the search results. To use this query parameter, you must uncheck the page and itemIds parameters.

Required: true

or

Type : query

Name : The itemIds for a focused search results. To use this query parameter, you must uncheck the page and SKU parameters.

Required: true

1. Sample Request for active products, in a paginated response.

GET https://{baseurl}/api-product/v1/product?page=0&size=10

Sample Response

Response Code: 200

Message: OK

Description: You will see this paginated response when active products are successfully retrieved based on the query parameters 'page' and 'size.'

{
"pageSize": 10,
"totalSize": 15,
"pages": 2,
"products": [
{
"sku": "1615717-config",
"itemId": 5,
"children": [],
"type": "ITEM",
"status": true,
"bundleItems": [],
"categories": [
{
"id": "60ab85de9e69ae00080042e4",
"name": "Duvets + Shams",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "hidden",
"attributes": []
},
{
"id": "60ab85a19e69ae00080042e1",
"name": "Bedding",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "Simple Linen Queen Duvet Mustard"
},
{
"name": "Image 1",
"description": "",
"mapping": "image",
"type": "TEXT",
"value": "https://fabric-abc.imgix.net/products/1615717_4811.jpg?w=700&q=60&auto=format&dpr=1"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
},
{
"name": "Vendor Id",
"description": "",
"type": "DECIMAL",
"value": "101"
}
]
},
{
"sku": "1578269-config",
"itemId": 18,
"children": [],
"type": "ITEM",
"status": true,
"bundleItems": [],
"categories": [
{
"id": "60aba6dc3194f3000881736e",
"name": "Sofas",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "hidden",
"attributes": []
},
{
"id": "60aba6a33194f30008817362",
"name": "Furniture",
"attributes": []
},
{
"id": "60aba6b83194f30008817365",
"name": "Living",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Final Sale",
"description": "",
"type": "BOOLEAN",
"value": "false"
},
{
"name": "Dropship",
"description": "",
"type": "BOOLEAN",
"value": "true"
},
{
"name": "Vendor Id",
"description": "",
"type": "DECIMAL",
"value": "101"
},
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "Hannah Apartment Sofa"
},
{
"name": "Image 1",
"description": "",
"mapping": "image",
"type": "TEXT",
"value": "https://fabric-abc.imgix.net/products/1578269-cobble-hill-hannah-brass-apartment-sofa-a.jpg?w=700&q=60&auto=format&dpr=1"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
},
{
"sku": "1616732-config",
"itemId": 20,
"children": [],
"type": "ITEM",
"status": true,
"bundleItems": [],
"categories": [
{
"id": "60aba6f53194f30008817374",
"name": "Lounge Chair",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "hidden",
"attributes": []
},
{
"id": "60aba6a33194f30008817362",
"name": "Furniture",
"attributes": []
},
{
"id": "60aba6b83194f30008817365",
"name": "Living",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Final Sale",
"description": "",
"type": "BOOLEAN",
"value": "true"
},
{
"name": "Dropship",
"description": null,
"type": "BOOLEAN",
"value": "true"
},
{
"name": "Vendor Id",
"description": "",
"type": "DECIMAL",
"value": "104"
},
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "Milo Baughman Design Classic Steel Chair"
},
{
"name": "Image 1",
"description": "",
"mapping": "image",
"type": "TEXT",
"value": "https://fabric-abc.imgix.net/products/1616735_chili_storm.jpg?w=700&q=60&auto=format&dpr=1"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
},
{
"sku": "item1",
"itemId": 26,
"children": [],
"type": "ITEM",
"status": true,
"bundleItems": [],
"categories": [
{
"id": "60acf75737d4df0008185284",
"name": "AB",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "MASTER",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "item1"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
},
{
"sku": "PricingTest123",
"itemId": 68,
"children": [
{
"sku": "var1",
"attributes": [
{
"name": "This attribute",
"description": "",
"type": "TEXT",
"value": "1"
},
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "var1"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
},
{
"sku": "var2",
"attributes": [
{
"name": "This attribute",
"description": "",
"type": "TEXT",
"value": "2"
},
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "var2"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
}
],
"type": "ITEM",
"status": true,
"bundleItems": [],
"categories": [
{
"id": "60c10ad09572f1000875291a",
"name": "Base 1",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "MASTER",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "Pricing Test 123"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
},
{
"sku": "1538910",
"itemId": 30,
"children": [],
"type": "ITEM",
"status": true,
"bundleItems": [],
"categories": [
{
"id": "60ab860c9e69ae00080042e7",
"name": "Sheets + Pillowcases",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "MASTER",
"attributes": []
},
{
"id": "60ab85a19e69ae00080042e1",
"name": "Bedding",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "Luminous Pillow"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
},
{
"sku": "testDemo",
"itemId": 31,
"children": [],
"type": "ITEM",
"status": true,
"bundleItems": [],
"categories": [
{
"id": "60aba6bd3194f30008817368",
"name": "Dinning",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "MASTER",
"attributes": []
},
{
"id": "60aba6a33194f30008817362",
"name": "Furniture",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "demo 1"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
},
{
"sku": "testiing item for reverse 21",
"itemId": 33,
"children": [],
"type": "ITEM",
"status": true,
"bundleItems": [],
"categories": [
{
"id": "60acf75737d4df0008185284",
"name": "AB",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "MASTER",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "testing reverse121111 2 22kj"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
},
{
"sku": "test1",
"itemId": 39,
"children": [
{
"sku": "testc2",
"attributes": [
{
"name": "Option Code",
"description": "",
"type": "TEXT",
"value": "t1123"
},
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "Test C1"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
},
{
"sku": "testc3",
"attributes": [
{
"name": "Option Code",
"description": "",
"type": "TEXT",
"value": "test c3 code"
},
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "Test C3"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
}
],
"type": "ITEM",
"status": true,
"bundleItems": [],
"categories": [
{
"id": "60b896d2e723930008f3d432",
"name": "Drafting Tables",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "MASTER",
"attributes": []
},
{
"id": "60b89690e723930008f3d42f",
"name": "Tables",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Option Code",
"description": "",
"type": "TEXT",
"value": "1234"
},
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "Test 1"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
},
{
"sku": "capio-parent",
"itemId": 66,
"children": [
{
"sku": "capio-child",
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "capio-child"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
}
],
"type": "ITEM",
"status": true,
"bundleItems": [],
"categories": [
{
"id": "60acf75737d4df0008185284",
"name": "AB",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "MASTER",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "capio-parent"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
}
]
}

2. Sample request for products, by itemIds.

GET https://{baseurl}/api-product/v1/product?itemIds=[30, 31]

Response Code: 200

Message: OK

Description: You will see this response when the products are successfully retrieved based on the query parameter 'item IDs'.

{
"pageSize": 2,
"totalSize": 2,
"pages": 1,
"products": [
{
"sku": "1538910",
"itemId": 30,
"children": [],
"type": "ITEM",
"status": true,
"bundleItems": [],
"categories": [
{
"id": "60ab860c9e69ae00080042e7",
"name": "Sheets + Pillowcases",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "MASTER",
"attributes": []
},
{
"id": "60ab85a19e69ae00080042e1",
"name": "Bedding",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "Luminous Pillow"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
},
{
"sku": "testDemo",
"itemId": 31,
"children": [],
"type": "ITEM",
"status": true,
"bundleItems": [],
"categories": [
{
"id": "60aba6bd3194f30008817368",
"name": "Dinning",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "MASTER",
"attributes": []
},
{
"id": "60aba6a33194f30008817362",
"name": "Furniture",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "demo 1"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
}
]
}

3. Sample request for inactive products, in a paginated response.

GET https://{baseurl}/api-product/v1/product?size=10&page=1&status=INACTIVE

Sample Response

Response Code: 200

Message: OK

Description: You will see this message when the API returns a paginated response of inactive products based on the query parameters size, page, and status (status = inactive).

{
"pageSize": 5,
"totalSize": 5,
"pages": 1,
"products": [
{
"sku": "1609745-config",
"itemId": 19,
"children": [],
"type": "ITEM",
"status": false,
"bundleItems": [],
"categories": [
{
"id": "60aba6e13194f30008817371",
"name": "Sectional",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "hidden",
"attributes": []
},
{
"id": "60aba6a33194f30008817362",
"name": "Furniture",
"attributes": []
},
{
"id": "60aba6b83194f30008817365",
"name": "Living",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "Alex Sectional"
},
{
"name": "Image 1",
"description": "",
"mapping": "image",
"type": "TEXT",
"value": "https://fabric-abc.imgix.net/products/1609745_soho_froth.jpg?w=700&q=60&auto=format&dpr=1"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "false"
}
]
},
{
"sku": "16157051-config",
"itemId": 22,
"children": [
{
"sku": "16157271-config",
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "Simple Linen Duvet Cover Sky"
},
{
"name": "Image 1",
"description": "",
"mapping": "image",
"type": "TEXT",
"value": "https://fabric-abc.imgix.net/products/1615727_4829.jpg?w=700&q=60&auto=format&dpr=1"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "false"
}
]
}
],
"type": "ITEM",
"status": false,
"bundleItems": [],
"categories": [
{
"id": "60ab860c9e69ae00080042e7",
"name": "Sheets + Pillowcases",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "MASTER",
"attributes": []
},
{
"id": "60ab85a19e69ae00080042e1",
"name": "Bedding",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "Simple Linen Duvet White"
},
{
"name": "Image 1",
"description": "",
"mapping": "image",
"type": "TEXT",
"value": "https://fabric-abc.imgix.net/products/1615705_4919.jpg?w=700&q=60&auto=format&dpr=1"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "false"
}
]
},
{
"sku": "16157391-config",
"itemId": 23,
"children": [
{
"sku": "test",
"attributes": [
{
"name": "Image 1",
"description": "",
"mapping": "image",
"type": "TEXT",
"value": "https://fabric-abc.imgix.net/products/1615739_4991.jpg?w=700&q=60&auto=format&dpr=1"
}
]
},
{
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "ergtgrew"
}
]
},
{
"attributes": []
}
],
"type": "ITEM",
"status": false,
"bundleItems": [],
"categories": [
{
"id": "60ab860c9e69ae00080042e7",
"name": "Sheets + Pillowcases",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "MASTER",
"attributes": []
},
{
"id": "60ab85a19e69ae00080042e1",
"name": "Bedding",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "Simple Linen Queen Duvet Cover Black"
},
{
"name": "Image 1",
"description": "",
"mapping": "image",
"type": "TEXT",
"value": "https://fabric-abc.imgix.net/products/1615739_4991.jpg?w=700&q=60&auto=format&dpr=1"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "false"
}
]
},
{
"sku": "fls1",
"itemId": 36,
"children": [],
"type": "ITEM",
"status": false,
"bundleItems": [],
"categories": [
{
"id": "60aba6dc3194f3000881736e",
"name": "Sofas",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "MASTER",
"attributes": []
},
{
"id": "60aba6a33194f30008817362",
"name": "Furniture",
"attributes": []
},
{
"id": "60aba6b83194f30008817365",
"name": "Living",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "fls1"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "false"
}
]
},
{
"sku": "item409",
"itemId": 37,
"children": [],
"type": "ITEM",
"status": false,
"bundleItems": [],
"categories": [
{
"id": "60acf75737d4df0008185284",
"name": "AB",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "MASTER",
"attributes": []
}
],
"attributes": []
}
],
"attributes": [
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "oye"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "false"
}
]
}
]
}

4. Sample request for products, by SKUs.

GET https://{baseurl}/api-product/v1/product?skus=["P113328"]

Sample Response

Response Code: 200

Message: OK

Description: You will see this response when products are successfully retrieved based on the query parameter 'SKUs.'

{
"pageSize": 1,
"totalSize": 1,
"pages": 1,
"products": [
{
"sku": "P113328",
"itemId": 43,
"children": [
{
"sku": "269233",
"attributes": [
{
"name": "Brand",
"description": "",
"type": "TEXT",
"value": "OCH"
},
{
"name": "Deluxe Delivery",
"description": "",
"type": "DECIMAL",
"value": "20"
},
{
"name": "Basic Delivery",
"description": "",
"type": "DECIMAL",
"value": "10"
},
{
"name": "description",
"description": "",
"type": "TEXT",
"value": "Adjustable tilt tension control assures the right reclining tension. Tilt lock and upright locking position let you adjust seat back angle. Pneumatic lift gives instant seat height adjustment."
},
{
"name": "Option Code",
"description": "",
"type": "TEXT",
"value": "2342145"
},
{
"name": "Best Seller",
"description": "",
"type": "BOOLEAN",
"value": "true"
},
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "Black Vinyl Mid Back Executive Chair"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
}
],
"type": "ITEM",
"status": true,
"bundleItems": [],
"categories": [
{
"id": "60b9e58752967300082fc990",
"name": "Computer Chairs",
"breadcrumbs": [
{
"id": "60a417f5c4b80d0008461e87",
"name": "MASTER",
"attributes": []
},
{
"id": "60b89623e723930008f3d42c",
"name": "Chairs",
"attributes": [
{
"name": "Product ID",
"description": "",
"type": "DECIMAL",
"value": "60485"
},
{
"name": "Tax Code",
"description": "",
"type": "TEXT",
"value": "P000000"
},
{
"name": "Weight",
"description": "",
"type": "DECIMAL",
"value": "23"
}
]
},
{
"id": "60b9e57a52967300082fc98d",
"name": "Task Chairs",
"attributes": []
}
],
"attributes": [
{
"name": "Color",
"description": "",
"type": "TEXT",
"value": "Black"
},
{
"name": "Tax Code",
"description": "",
"type": "TEXT",
"value": "P000000"
},
{
"name": "Weight",
"description": "",
"type": "DECIMAL",
"value": "35"
}
]
}
],
"attributes": [
{
"name": "Brand",
"description": "",
"type": "TEXT",
"value": "OCH"
},
{
"name": "Best Seller",
"description": "",
"type": "BOOLEAN",
"value": "true"
},
{
"name": "Deluxe Delivery",
"description": "",
"type": "DECIMAL",
"value": "20"
},
{
"name": "Basic Delivery",
"description": "",
"type": "DECIMAL",
"value": "10"
},
{
"name": "description",
"description": "",
"type": "TEXT",
"value": "Adjustable tilt tension control assures the right reclining tension. Tilt lock and upright locking position let you adjust seat back angle. Pneumatic lift gives instant seat height adjustment."
},
{
"name": "Option Code",
"description": "",
"type": "TEXT",
"value": "2342145"
},
{
"name": "Display Name",
"description": "",
"mapping": "title",
"type": "TEXT",
"value": "Black Vinyl Mid Back Executive Chair"
},
{
"name": "Active",
"description": "",
"mapping": "active",
"type": "BOOLEAN",
"value": "true"
}
]
}
]
}

Change Log

  • June - 2021 First Updated

‚Äč