vtex.local – Catalog-API-Seller-Portal

OpenAPI apis-guru

With the Catalog API for Seller Portal, you will be able to create, edit and consult products and their variations, brands, and categories.

This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Index

Product

GET PUT GET PUT GET POST

SKU

GET GET

Brand

GET POST GET PUT

Tools (18)

Extracted live via the executor SDK.

brand.getBrand
📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Retrieves general information about a brand by its ID.
Response body example
json
{ "id": "863", "name": "Zwilling", "isActive": false, "createdAt": "2021-01-18T14:41:45.696488+00:00", "updatedAt": "2021-01-18T14:41:45.696488+00:00"}

brand.listBrand

📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Retrieves general information about all brands of the store. It is mandatory to use at least one query parameter.

Response body example

json

{    "data": [        {            "id": "7",            "name": "All For Paws",            "isActive": true,            "createdAt": "2022-01-17T19:43:14.18678Z",            "updatedAt": "2022-01-17T19:43:14.18678Z"        },        {            "id": "1",            "name": "AOC",            "isActive": true,            "createdAt": "2021-08-16T21:13:40.55189Z",            "updatedAt": "2021-08-16T21:13:40.55189Z"        }    ],    "_metadata": {        "total": 18,        "from": 1,        "to": 2,        "orderBy": "name,asc"    }}

{    "data": [        {            "id": "7",            "name": "All For Paws",            "isActive": true,            "createdAt": "2022-01-17T19:43:14.18678Z",            "updatedAt": "2022-01-17T19:43:14.18678Z"        },        {            "id": "1",            "name": "AOC",            "isActive": true,            "createdAt": "2021-08-16T21:13:40.55189Z",            "updatedAt": "2021-08-16T21:13:40.55189Z"        }    ],    "_metadata": {        "total": 18,        "from": 1,        "to": 2,        "orderBy": "name,asc"    }}

brand.postBrand
📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Creates a new brand.
Request body example
json
{ "name": "Zwilling", "isActive": true}
Response body example
json
{ "id": "20", "name": "Zwilling", "isActive": true, "createdAt": "2021-05-17T15:20:36.077253+00:00", "updatedAt": "2021-01-18T14:41:45.696488+00:00"}
```
{  "name": "Zwilling",  "isActive": true}
```
```
{  "id": "20",  "name": "Zwilling",  "isActive": true,  "createdAt": "2021-05-17T15:20:36.077253+00:00",  "updatedAt": "2021-01-18T14:41:45.696488+00:00"}
```
brand.putBrand
📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Updates an existing brand.
Request body example
json
{ "id": "20", "name": "Zwilling", "isActive": true}
category.createCategory
📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Creates a new category.
Request body example
json
{ "parentId": "567", "Name": "Beauty"}
Response body example
json
{ "value": { "id": "1", "name": "Beauty", "isActive": false }, "children": [ { "value": { "id": "2", "name": "Perfumes", "isActive": false } } ]}
```
{  "parentId": "567",  "Name": "Beauty"}
```
```
{  "value": {    "id": "1",    "name": "Beauty",    "isActive": false  },  "children": [    {      "value": {        "id": "2",        "name": "Perfumes",        "isActive": false      }    }  ]}
```
category.getbyid
📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Retrieves general information about a category by its ID.
Response body example
json
{ "value": { "id": "1", "name": "sandboxintegracao", "isActive": false }, "children": [ { "value": { "id": "2", "name": "Perfumes", "isActive": false } } ]}
```
{  "value": {    "id": "1",    "name": "sandboxintegracao",    "isActive": false  },  "children": [    {      "value": {        "id": "2",        "name": "Perfumes",        "isActive": false      }    }  ]}
```

category.getCategoryTree

📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Retrieves general information about the category tree from the store.

Response body example

json

{    "roots": [        {            "value": {                "id": "2",                "name": "Departamento Artesanato",                "isActive": true            },            "children": [                {                    "value": {                        "id": "3",                        "name": "Artesanato de Barro",                        "isActive": false                    },                    "children": [                        {                            "value": {                                "id": "4",                                "name": "Artesanato de Barro Vermelho",                                "isActive": false                            },                            "children": []                        }                    ]                }            ]        },        {            "value": {                "id": "5",                "name": "Perfumes",                "isActive": false            },            "children": [                {                    "value": {                        "id": "6",                        "name": "Perfume Feminino",                        "isActive": false                    },                    "children": []                },                {                    "value": {                        "id": "7",                        "name": "Perfume Masculino",                        "isActive": false,                        "displayOnMenu": false,                        "score": 0,                        "filterByBrand": false,                        "isClickable": false                    },                    "children": []                }            ]        }    ],    "createdAt": "2021-08-16T20:57:13.070813Z",    "updatedAt": "2022-07-07T14:24:56.416337Z"}

{    "roots": [        {            "value": {                "id": "2",                "name": "Departamento Artesanato",                "isActive": true            },            "children": [                {                    "value": {                        "id": "3",                        "name": "Artesanato de Barro",                        "isActive": false                    },                    "children": [                        {                            "value": {                                "id": "4",                                "name": "Artesanato de Barro Vermelho",                                "isActive": false                            },                            "children": []                        }                    ]                }            ]        },        {            "value": {                "id": "5",                "name": "Perfumes",                "isActive": false            },            "children": [                {                    "value": {                        "id": "6",                        "name": "Perfume Feminino",                        "isActive": false                    },                    "children": []                },                {                    "value": {                        "id": "7",                        "name": "Perfume Masculino",                        "isActive": false,                        "displayOnMenu": false,                        "score": 0,                        "filterByBrand": false,                        "isClickable": false                    },                    "children": []                }            ]        }    ],    "createdAt": "2021-08-16T20:57:13.070813Z",    "updatedAt": "2022-07-07T14:24:56.416337Z"}

category.updateCategoryTree

📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Updates the existing categories in the category tree.

Request body example

json

{  "roots": [    {      "value": {        "id": "2",        "name": "Departamento Artesanato",        "isActive": true      },      "children": [        {          "value": {            "id": "3",            "name": "Artesanato de Barro",            "isActive": false          },          "children": [            {              "value": {                "id": "4",                "name": "Artesanato de Barro Vermelho",                "isActive": false              },              "children": []            }          ]        }      ]    },    {      "value": {        "id": "5",        "name": "Perfumes",        "isActive": false      },      "children": [        {          "value": {            "id": "6",            "name": "Perfume Feminino",            "isActive": false          },          "children": []        },        {          "value": {            "id": "7",            "name": "Perfume Masculino",            "isActive": false,            "displayOnMenu": false,            "score": 0,            "filterByBrand": false,            "isClickable": false          },          "children": []        }      ]    }  ]}

{  "roots": [    {      "value": {        "id": "2",        "name": "Departamento Artesanato",        "isActive": true      },      "children": [        {          "value": {            "id": "3",            "name": "Artesanato de Barro",            "isActive": false          },          "children": [            {              "value": {                "id": "4",                "name": "Artesanato de Barro Vermelho",                "isActive": false              },              "children": []            }          ]        }      ]    },    {      "value": {        "id": "5",        "name": "Perfumes",        "isActive": false      },      "children": [        {          "value": {            "id": "6",            "name": "Perfume Feminino",            "isActive": false          },          "children": []        },        {          "value": {            "id": "7",            "name": "Perfume Masculino",            "isActive": false,            "displayOnMenu": false,            "score": 0,            "filterByBrand": false,            "isClickable": false          },          "children": []        }      ]    }  ]}

product.getProduct

📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Retrieves general information about a product by its ID. The response also has information about the product's SKUs.

Response body example

json

{    "id": "189371",    "status": "active",    "name": "VTEX 10 Shirt",    "brandId": "1",    "brandName": "AOC",    "categoryIds": [        "732"    ],    "categoryNames": [        "/sandboxintegracao/Acessórios/"    ],    "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": 300,            "dimensions": {                "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"}

{    "id": "189371",    "status": "active",    "name": "VTEX 10 Shirt",    "brandId": "1",    "brandName": "AOC",    "categoryIds": [        "732"    ],    "categoryNames": [        "/sandboxintegracao/Acessórios/"    ],    "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": 300,            "dimensions": {                "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"}

product.getProductDescription
📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Retrieves the description of a product given a Product ID.
Response body example
json
{ "productId": "61", "description": "Beautifully handmade laptop case/sleeve made in the Nepal Himalaya. It can be slipped inside your backpack or carried alone with space for all your work bits and pieces!", "createdAt": "2022-10-10T19:18:45.612317Z", "updatedAt": "2022-10-11T18:12:58.825544Z"}

product.getProductQuery

📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Retrieves general information about a product by its external ID, SKU ID, SKU external ID or product slug. The response also has information about the product's SKUs.

Response body example

json

{    "id": "189371",    "status": "active",    "name": "VTEX 10 Shirt",    "brandId": "1",    "brandName": "AOC",    "categoryIds": [        "732"    ],    "categoryNames": [        "/sandboxintegracao/Acessórios/"    ],    "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",            "name": "VTEX Shirt Black Size S",            "externalId": "1909621862",            "manufacturerCode": "1234567",            "isActive": true,            "weight": 300,            "dimensions": {                "width": 1.5,                "height": 2.1,                "length": 1.6            },            "specs": [                {                    "name": "Color",                    "value": "Black"                },                {                    "name": "Size",                    "value": "S"                }            ],            "images": [                "vtex_logo.jpg"            ]        },        {            "id": "182908",            "name": "VTEX Shirt White Size L",            "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-31T16:28:25.578067Z"}

{    "id": "189371",    "status": "active",    "name": "VTEX 10 Shirt",    "brandId": "1",    "brandName": "AOC",    "categoryIds": [        "732"    ],    "categoryNames": [        "/sandboxintegracao/Acessórios/"    ],    "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",            "name": "VTEX Shirt Black Size S",            "externalId": "1909621862",            "manufacturerCode": "1234567",            "isActive": true,            "weight": 300,            "dimensions": {                "width": 1.5,                "height": 2.1,                "length": 1.6            },            "specs": [                {                    "name": "Color",                    "value": "Black"                },                {                    "name": "Size",                    "value": "S"                }            ],            "images": [                "vtex_logo.jpg"            ]        },        {            "id": "182908",            "name": "VTEX Shirt White Size L",            "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-31T16:28:25.578067Z"}

product.postProduct

📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Creates a new product and its SKUs.

Request body example

json

{    "status": "active",    "name": "VTEX 10 Shirt",    "description": "Shirt number 10 by VTEX.",    "brandId": "1",    "categoryIds": [        "732"    ],    "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": [        {            "name": "VTEX Shirt Black Size S",            "externalId": "1909621862",            "manufacturerCode": "1234567",            "isActive": true,            "weight": 300,            "dimensions": {                "width": 1.5,                "height": 2.1,                "length": 1.6            },            "specs": [                {                    "name": "Color",                    "value": "Black"                },                {                    "name": "Size",                    "value": "S"                }            ],            "images": [                "vtex_logo.jpg"            ]        },        {            "name": "VTEX Shirt White Size L",            "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"            ]        }    ],    "origin": "vtxleo7778",    "transportModal": "110",    "taxCode": "234"}

Response body example

json

{    "id": "189371",    "status": "active",    "name": "VTEX 10 Shirt",    "brandId": "1",    "brandName": "AOC",    "categoryIds": [        "732"    ],    "categoryNames": [        "/Men/Acessories/"    ],    "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",            "name": "VTEX Shirt Black Size S",            "externalId": "1909621862",            "manufacturerCode": "1234567",            "isActive": true,            "weight": 300,            "dimensions": {                "width": 1.5,                "height": 2.1,                "length": 1.6            },            "specs": [                {                    "name": "Color",                    "value": "Black"                },                {                    "name": "Size",                    "value": "S"                }            ],            "images": [                "vtex_logo.jpg"            ]        },        {            "id": "182908",            "name": "VTEX Shirt White Size L",            "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"            ]        }    ],    "origin": "vtxleo7778",    "transportModal": "110",    "taxCode": "234",    "createdAt": "2022-11-01T14:15:54.262702Z",    "updatedAt": "2022-11-01T14:15:54.262702Z"}

{    "status": "active",    "name": "VTEX 10 Shirt",    "description": "Shirt number 10 by VTEX.",    "brandId": "1",    "categoryIds": [        "732"    ],    "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": [        {            "name": "VTEX Shirt Black Size S",            "externalId": "1909621862",            "manufacturerCode": "1234567",            "isActive": true,            "weight": 300,            "dimensions": {                "width": 1.5,                "height": 2.1,                "length": 1.6            },            "specs": [                {                    "name": "Color",                    "value": "Black"                },                {                    "name": "Size",                    "value": "S"                }            ],            "images": [                "vtex_logo.jpg"            ]        },        {            "name": "VTEX Shirt White Size L",            "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"            ]        }    ],    "origin": "vtxleo7778",    "transportModal": "110",    "taxCode": "234"}

{    "id": "189371",    "status": "active",    "name": "VTEX 10 Shirt",    "brandId": "1",    "brandName": "AOC",    "categoryIds": [        "732"    ],    "categoryNames": [        "/Men/Acessories/"    ],    "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",            "name": "VTEX Shirt Black Size S",            "externalId": "1909621862",            "manufacturerCode": "1234567",            "isActive": true,            "weight": 300,            "dimensions": {                "width": 1.5,                "height": 2.1,                "length": 1.6            },            "specs": [                {                    "name": "Color",                    "value": "Black"                },                {                    "name": "Size",                    "value": "S"                }            ],            "images": [                "vtex_logo.jpg"            ]        },        {            "id": "182908",            "name": "VTEX Shirt White Size L",            "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"            ]        }    ],    "origin": "vtxleo7778",    "transportModal": "110",    "taxCode": "234",    "createdAt": "2022-11-01T14:15:54.262702Z",    "updatedAt": "2022-11-01T14:15:54.262702Z"}

product.putProduct

📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Updates an existing product and its SKUs.

Request body example

json

{    "id": "189371",    "status": "active",    "name": "VTEX 10 Shirt",    "description": "Shirt number 10 by VTEX.",    "brandId": "1",    "categoryIds": [        "732"    ],    "specs": [        {            "name": "Color",            "values": [                "Black",                "White"            ]        },        {            "name": "Size",            "values": [                "S",                "M",                "L"            ]        }    ],    "attributes": [        {            "name": "Fabric",            "value": "Cotton"        },        {            "name": "Gender",            "value": "Feminine"        }    ],    "slug": "/vtex-shirt",    "transportModal": null,    "taxCode": null,    "images": [        {            "id": "vtex_logo.jpg",            "url": "https://vtxleo7778.vtexassets.com/assets/vtex.catalog-images/products/vtex_logo.jpg",            "alt": "VTEX"        }    ],    "skus": [        {            "name": "VTEX Shirt Black Size S",            "externalId": "1909621862",            "manufacturerCode": "1234567",            "isActive": true,            "weight": 300,            "dimensions": {                "width": 1.5,                "height": 2.1,                "length": 1.6            },            "specs": [                {                    "name": "Color",                    "value": "Black"                },                {                    "name": "Size",                    "value": "S"                }            ],            "images": [                "vtex_logo.jpg"            ]        },        {            "name": "VTEX Shirt White Size L",            "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"            ]        }    ],    "origin": "vtxleo7778"}

{    "id": "189371",    "status": "active",    "name": "VTEX 10 Shirt",    "description": "Shirt number 10 by VTEX.",    "brandId": "1",    "categoryIds": [        "732"    ],    "specs": [        {            "name": "Color",            "values": [                "Black",                "White"            ]        },        {            "name": "Size",            "values": [                "S",                "M",                "L"            ]        }    ],    "attributes": [        {            "name": "Fabric",            "value": "Cotton"        },        {            "name": "Gender",            "value": "Feminine"        }    ],    "slug": "/vtex-shirt",    "transportModal": null,    "taxCode": null,    "images": [        {            "id": "vtex_logo.jpg",            "url": "https://vtxleo7778.vtexassets.com/assets/vtex.catalog-images/products/vtex_logo.jpg",            "alt": "VTEX"        }    ],    "skus": [        {            "name": "VTEX Shirt Black Size S",            "externalId": "1909621862",            "manufacturerCode": "1234567",            "isActive": true,            "weight": 300,            "dimensions": {                "width": 1.5,                "height": 2.1,                "length": 1.6            },            "specs": [                {                    "name": "Color",                    "value": "Black"                },                {                    "name": "Size",                    "value": "S"                }            ],            "images": [                "vtex_logo.jpg"            ]        },        {            "name": "VTEX Shirt White Size L",            "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"            ]        }    ],    "origin": "vtxleo7778"}

product.putProductDescription
📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Updates the description of a product given a Product ID.
Request body example
json
{ "productId": "71", "description": "White shirt."}
sku.listSku
📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Retrieves general information about all SKUs.
Response body example
json
{ "data": [ "1", "10", "11", "12", "13", "14", "15", "16", "19", "2", "20", "21", "22", "23", "24" ], "_metadata": { "total": 65, "from": 1, "to": 15 }}
```
{    "data": [        "1",        "10",        "11",        "12",        "13",        "14",        "15",        "16",        "19",        "2",        "20",        "21",        "22",        "23",        "24"    ],    "_metadata": {        "total": 65,        "from": 1,        "to": 15    }}
```
sku.searchSku
📘 This API is part of the . This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact .

Retrieves general information about an SKU taking into consideration the defined search criteria. It is mandatory to use at least one query parameter.
Response body example
json
{ "data": [ { "id": "2", "productId": "2", "externalId": "1909621862" } ], "_metadata": { "total": 1, "from": 1, "to": 15 }}
```
{  "data": [    {      "id": "2",      "productId": "2",      "externalId": "1909621862"    }  ],  "_metadata": {    "total": 1,    "from": 1,    "to": 15  }}
```
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools