Vtex Getproduct Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "GetProduct",
"method": "GET",
"path": "/api/catalog-seller-portal/products/{productId}",
"summary": "VTex Get Product by ID",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"id": "189371",
"status": "active",
"name": "VTEX 10 Shirt",
"brandId": "1",
"description": "Description data for product.",
"brandName": "AOC",
"categoryIds": [
"732"
],
"categoryNames": [
"/sandboxintegracao/Acess\u00f3rios/"
],
"specs": [
{
"name": "Color",
"values": [
"Black",
"White"
]
},
{
"name": "Size",
"values": [
"S",
"M",
"L"
]
}
],
"attributes": [
{
"name": "Fabric",
"value": "Cotton"
},
{
"name": "Gender",
"value": "Feminine"
}
],
"slug": "/vtex-shirt",
"images": [
{
"id": "vtex_logo.jpg",
"url": "https://vtxleo7778.vtexassets.com/assets/vtex.catalog-images/products/vtex_logo.jpg",
"alt": "VTEX"
}
],
"skus": [
{
"id": "182907",
"externalId": "1909621862",
"manufacturerCode": "1234567",
"isActive": true,
"weight": 12,
"dimensions": {
"width": 1.5,
"height": 2.1,
"length": 1.6
},
"RealWeight": 300,
"RealDimensions": {
"width": 1.5,
"height": 2.1,
"length": 1.6
},
"specs": [
{
"name": "Color",
"value": "Black"
},
{
"name": "Size",
"value": "S"
}
],
"images": [
"vtex_logo.jpg"
]
},
{
"id": "182908",
"externalId": "1909621862",
"manufacturerCode": "1234568",
"isActive": true,
"weight": 300,
"dimensions": {
"width": 1.5,
"height": 2.1,
"length": 1.6
},
"specs": [
{
"name": "Color",
"value": "White"
},
{
"name": "Size",
"value": "L"
}
],
"images": [
"vtex_logo.jpg"
]
}
],
"transportModal": "123",
"taxCode": "100",
"origin": "vtxleo7778",
"createdAt": "2022-10-31T16:28:25.578067Z",
"updatedAt": "2022-10-31T17:09:12.639088Z"
}
}
]
}