XM
Members
Retrieve Product Attributes
This documentation is now outdated, please find the latest docs for this endpoint here
Path:
1
GET https://{baseurl}/api-product/v1/product/attribute?itemId=5
Copied!
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

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

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.
1
{
2
"totalSize": 4,
3
"pageSize": 4,
4
"pages": 1,
5
"attributes": [
6
{
7
"name": "Display Name",
8
"description": "",
9
"mapping": "title",
10
"type": "TEXT",
11
"value": "Simple Linen Queen Duvet Mustard"
12
},
13
{
14
"name": "Image 1",
15
"description": "",
16
"mapping": "image",
17
"type": "TEXT",
18
"value": "https://fabric-abc.imgix.net/products/1615717_4811.jpg?w=700&q=60&auto=format&dpr=1"
19
},
20
{
21
"name": "Active",
22
"description": "",
23
"mapping": "active",
24
"type": "BOOLEAN",
25
"value": "true"
26
},
27
{
28
"name": "Vendor Id",
29
"description": "",
30
"type": "DECIMAL",
31
"value": "101"
32
}
33
]
34
}
Copied!

Change Log

  • June - 2021 First Updated
Last modified 1mo ago
Copy link
Contents
Change Log