XM

Retrieve Product Attributes

Path:

GET https://{baseurl}/api-product/v1/product/attribute?itemId=5

Retrieves product attributes, by item ID or SKU.

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 item ID to retrieve the product attributes. Alternatively, SKU may be specified instead of item ID.

Required: true

Sample Request

GET https://{baseurl}/api-product/v1/product/attribute?itemId=5

Sample Response

Response Code: 200

Message: OK

Description: You will see this response when the product attributes are successfully retrieved based on the query parameter 'itemId.' When there are no product attributes available, a blank array of attributes is returned.

{
"totalSize": 4,
"pageSize": 4,
"pages": 1,
"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"
}
]
}

Change Log

  • June - 2021 First Updated

‚Äč