Catalog API
> Check the new [Catalog onboarding guide](https://developers.vtex.com/docs/guides/catalog-overview). We created this guide to improve the onboarding…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
> Check the new Catalog onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey.
Methods for collecting product/SKU catalog data, categories, brands and other information. All content that comes between {{}} keys must be replaced with the correct data before performing the request.
Index
- Product - Here you can consult, create, or update a Product. For more information, check this article.
- Product Specification - You can consult, create, or update additional information of a Product. For more information, check this article.
- SKU - Here you can consult, create, or update an SKU. For more information, check this article.
- SKU Complement - You can consult, create, or update an SKU Complement. An SKU Complement is a new SKU that has a Parent SKU.
- SKU EAN - Here you can consult, create, or update an SKU unique identification code (barcode).
- SKU Attachment - You can consult, create, or update an SKU Attachment. An attachment is used to add custom information about the item. For more information, check this article.
- SKU File - Here you can consult, create, or update an SKU File. An SKU File is an image associated with an SKU.
- SKU Kit - You can consult, create, or update an SKU Kit. A kit is an SKU composed of one or more SKUs. For more information, check this article.
- SKU Seller - Here you can consult and delete an SKU Seller. An SKU Seller is a seller associated with an SKU. For more information, check this article.
- SKU Service - You can create, update, or delete an SKU Service. A service is an item that may come with a product, optionally, and with a cost. For more information, check this article.
- SKU Service Attachment - Here you can associate or disassociate an Attachment to an SKU Service.
- SKU Service Type - You can create, update, or delete an SKU Service Type. A service type is the behavior configuration of a service.
- SKU Service Value - Here you can create, update, or delete an SKU Service Value. Service value is how much the customer will be charged for the service.
- SKU Specification - You can consult, create, or delete an SKU Specification. SKU Specification is used to create site browsing filters and to differentiate SKUs within the product page. For more information, check this article.
- Legacy Subcollection - Here you…
Endpoints 162
SKU Service
- POSTAssociate SKU Service
/api/catalog/pvt/skuserviceAssociates an SKU Service to an SKU. - GETGet SKU Service
/api/catalog/pvt/skuservice/:skuServiceIdRetrieves an SKU Service. Response body example { "Id": 1, "SkuServiceTypeId": 1, "SkuServiceValueId": 1, "SkuId": 1, "Name": "name", "Text": "text",… - PUTUpdate SKU Service
/api/catalog/pvt/skuservice/:skuServiceIdUpdates an SKU Service. Request body example { "Name": "name", "Text": "text", "IsActive": false } Response body example { "Id": 1, "SkuServiceTypeId": 1,… - DELETEDissociate SKU Service
/api/catalog/pvt/skuservice/:skuServiceIdDissociates an SKU Service from an SKU.
SKU Service Attachment
- POSTAssociate SKU Service Attachment
/api/catalog/pvt/skuservicetypeattachmentAssociates an Attachment for an existing SKU Service Type. Request body example { "AttachmentId": 1, "SkuServiceTypeId": 1 } Response body example { "Id": 1,… - DELETEDissociate Attachment by Attachment ID or SKU Service Type ID
/api/catalog/pvt/skuservicetypeattachment?attachmentId=1&skuServiceTypeId=1Dissociates an Attachment by its Attachment ID or SKU Service Type ID from an SKU Service Type. - DELETEDissociate Attachment from SKU Service Type
/api/catalog/pvt/skuservicetypeattachment/:skuServiceTypeAttachmentIdDissociates an Attachment from an SKU Service Type
SKU Service Value
- POSTCreate SKU Service Value
/api/catalog/pvt/skuservicevalueCreates an SKU Service Value for an existing SKU Service Type. Request body example { "SkuServiceTypeId": 2, "Name": "Test ServiceValue API", "Value": 10.5,… - GETGet SKU Service Value
/api/catalog/pvt/skuservicevalue/:skuServiceValueIdRetrieves an existing SKU Service Value. Response body example { "Id": 2, "SkuServiceTypeId": 2, "Name": "Test ServiceValue API", "Value": 10.5, "Cost": 10.5 } - PUTUpdate SKU Service Value
/api/catalog/pvt/skuservicevalue/:skuServiceValueIdUpdates an existing SKU Service Value. Request body example { "SkuServiceTypeId": 2, "Name": "Test ServiceValue API", "Value": 10.5, "Cost": 10.5 } Response… - DELETEDelete SKU Service Value
/api/catalog/pvt/skuservicevalue/:skuServiceValueIdDeletes an existing SKU Service Value.
SKU Service Type
- POSTCreate SKU Service Type
/api/catalog/pvt/skuservicetypeCreates a new SKU Service Type. Request body example { "Name": "Test API Sku Services", "IsActive": true, "ShowOnProductFront": true, "ShowOnCartFront": true,… - GETGet SKU Service Type
/api/catalog/pvt/skuservicetype/:skuServiceTypeIdRetrieves information about an existing SKU Service Type. Response body example: { "Id": 2, "Name": "Test API SKU Services", "IsActive": true,… - PUTUpdate SKU Service Type
/api/catalog/pvt/skuservicetype/:skuServiceTypeIdUpdates an existing SKU Service Type. Request body example { "Name": "Test API Sku Services", "IsActive": true, "ShowOnProductFront": true, "ShowOnCartFront":… - DELETEDelete SKU Service Type
/api/catalog/pvt/skuservicetype/:skuServiceTypeIdDeletes an existing SKU Service Type.
Category
- POSTCreate Category
/api/catalog/pvt/categoryCreates a new Category. If there is a need to create a new category with a specific custom ID, specify the Id (integer) in the request. Otherwise, VTEX will… - GETGet Category by ID
/api/catalog/pvt/category/:categoryIdRetrieves general information about a Category. Response body example { "Id": 1, "Name": "Home Appliances", "FatherCategoryId": null, "Title": "Home… - PUTUpdate Category
/api/catalog/pvt/category/:categoryIdUpdates a previously existing Category. Request body example { "Name": "Home Appliances", "FatherCategoryId": null, "Title": "Home Appliances", "Description":… - GETGet Category Tree
/api/catalog_system/pub/category/tree/:categoryLevelsRetrieves the Category Tree of your store. Get all the category levels registered in the Catalog or define the level up to which you want to get. > 📘…
Brand
- POSTCreate Brand
/api/catalog/pvt/brandCreates a new Brand. Request and response body example { "Id": 2000013, "Name": "Orma Carbon", "Text": "Orma Carbon", "Keywords": "orma", "SiteTitle": "Orma… - GETGet Brand and context
/api/catalog/pvt/brand/:brandIdRetrieves information about a specific Brand and its context. Response body example { "Id": 2000013, "Name": "Orma Carbon", "Text": "Orma Carbon", "Keywords":… - PUTUpdate Brand
/api/catalog/pvt/brand/:brandIdUpdates a previously existing Brand. Request and response body example { "Id": 2000013, "Name": "Orma Carbon", "Text": "Orma Carbon", "Keywords": "orma",… - DELETEDelete Brand
/api/catalog/pvt/brand/:brandIdDeletes an existing Brand. - GETGet Brand List
/api/catalog_system/pvt/brand/listRetrieves all Brands registered in the store's Catalog. >⚠️ This route's response is limited to 20k results. If you need to obtain more results, please use… - GETGet Brand List Per Page
/api/catalog_system/pvt/brand/pagedlist?pageSize=5&page=1Retrieves all Brands registered in the store's Catalog by page number. Response body example { "items": [ { "id": 2000000, "name": "Farm", "isActive": true,… - GETGet Brand
/api/catalog_system/pvt/brand/:brandIdRetrieves a specific Brand by its ID. Response body example { "id": 7000000, "name": "Pedigree", "isActive": true, "title": "Pedigree", "metaTagDescription":…
Attachment
- POSTCreate attachment
/api/catalog/pvt/attachmentCreates a new SKU attachment. >⚠️ To understand the specific syntax for Assembly Options attachments, read the Assembly Options documentation. Request body… - GETGet attachment
/api/catalog/pvt/attachment/:attachmentidGets information about a registered attachment. >⚠️ To understand the specific syntax for Assembly Options attachments, read the Assembly Options… - PUTUpdate attachment
/api/catalog/pvt/attachment/:attachmentidUpdates a previously existing SKU attachment with new information. >⚠️ To understand the specific syntax for Assembly Options attachments, read the Assembly… - DELETEDelete attachment
/api/catalog/pvt/attachment/:attachmentidDeletes a previously existing SKU attachment. - GETGet all attachments
/api/catalog/pvt/attachmentsRetrieves information about all registered attachments. >⚠️ To understand the specific syntax for Assembly Options attachments, read the Assembly Options…
Product
- GETGet Product Review Rate by Product ID
/api/addon/pvt/review/GetProductRate/:productIdRetrieves the review rate of a product by this product's ID. - POSTCreate Product with Category and Brand
/api/catalog/pvt/productThis endpoint allows two types of request: Type 1: Creating a new Product as well as a new Category path (including subcategories) and a new Brand by using… - GETGet Product by ID
/api/catalog/pvt/product/:productIdRetrieves a specific Product by its ID. This information is exactly what is needed to create a new Product. > 📘 Onboarding guide > > Check the new Catalog… - PUTUpdate Product
/api/catalog/pvt/product/:productIdUpdates an existing Product. - GETGet Product's SKUs by Product ID
/api/catalog_system/pub/products/variations/:productIdRetrieves data about the product and all SKUs related to it by the product's ID. Response body example { "productId": 9, "name": "Camisa Masculina",… - GETGet Product and SKU IDs
/api/catalog_system/pvt/products/GetProductAndSkuIds?categoryId=1&_from=1&_to=10Retrieves the IDs of products and SKUs. > 📘 Onboarding guide > > Check the new Catalog onboarding guide. We created this guide to improve the onboarding… - GETGet Product and its general context
/api/catalog_system/pvt/products/productget/:productIdRetrieves a specific product's general information as name, description and the trade policies that it is included. - GETGet Product by RefId
/api/catalog_system/pvt/products/productgetbyrefid/:refIdRetrieves a specific product by its Reference ID.
Product Specification
- GETGet Product Specification and its information by Product ID
/api/catalog/pvt/product/:productId/specificationRetrieves information of all specifications of a product by the product's ID. Response body example [ { "Id": 227, "ProductId": 1, "FieldId": 33,… - POSTAssociate Product Specification
/api/catalog/pvt/product/:productId/specificationAssociates a previously defined Specification to a Product. Request body example { "FieldId": 19, "FieldValueId": 1, "Text": "test" } Response body example {… - DELETEDelete all Product Specifications by Product ID
/api/catalog/pvt/product/:productId/specificationDeletes all Product Specifications given a specific Product ID. - DELETEDelete a specific Product Specification
/api/catalog/pvt/product/:productId/specification/:specificationIdDeletes a specific Product Specification given a Product ID and a Specification ID. - PUTAssociate product specification using specification name and group name
/api/catalog/pvt/product/:productId/specificationvalueAssociates a specification to a product using specification name and group name. Automatically creates the informed group, specification and values if they… - GETGet Product Specification by Product ID
/api/catalog_system/pvt/products/:productId/specificationRetrieves all specifications of a product by the product's ID. > 📘 Onboarding guide > > Check the new Catalog onboarding guide. We created this guide to… - POSTUpdate Product Specification by Product ID
/api/catalog_system/pvt/products/:productId/specificationUpdates the value of a product specification by the product's ID. The ID or name can be used to identify what product specification will be updated.…
Trade Policy
- GETGet Trade Policies by Product ID
/api/catalog/pvt/product/:productId/salespolicyRetrieves a list of Trade Policies associated to a Product based on the Product's ID. Response body example [ { "ProductId": 1, "StoreId": 1 }, { "ProductId":… - POSTAssociate Product with Trade Policy
/api/catalog/pvt/product/:productId/salespolicy/:tradepolicyIdAssociates an existing Trade Policy with a Product. - DELETERemove Product from Trade Policy
/api/catalog/pvt/product/:productId/salespolicy/:tradepolicyIdDisassociates a Trade Policy of a Product. - GETList all SKUs of a Trade Policy
/api/catalog_system/pvt/sku/stockkeepingunitidsbysaleschannel?sc=1&page=1&pageSize=1&onlyAssigned=trueRetrieves a list of SKU IDs of a Trade Policy. Response body example [ 405380, 405381, 405382, 405383, 405384, 405385, 405386, 405387, 405388, 405389, 405390,…
Similar Category
- GETGet Similar Categories
/api/catalog/pvt/product/:productId/similarcategory/Retrieves Similar Categories from a Product. Response body example [ { "ProductId": 1, "CategoryId": 1 }, { "ProductId": 1, "CategoryId": 20 } ] - POSTAdd Similar Category
/api/catalog/pvt/product/:productId/similarcategory/:categoryIdAdds a Similar Category to a Product. Response body example { "ProductId": 1, "StoreId": 1 } - DELETEDelete Similar Category
/api/catalog/pvt/product/:productId/similarcategory/:categoryIdDeletes a Similar Category from a Product.
SKU
- GETGet SKU by RefId
/api/catalog/pvt/stockkeepingunit?refId=1Retrieves information about a specific SKU by its RefId. Response body example { "Id": 1, "ProductId": 1, "IsActive": true, "Name": "Royal Canin Feline… - POSTCreate SKU
/api/catalog/pvt/stockkeepingunitCreates a new SKU. If there is a need to create a new SKU with a specific custom ID, specify the Id (integer) in the request. Otherwise, VTEX will generate… - GETGet SKU
/api/catalog/pvt/stockkeepingunit/:skuIdRetrieves a specific SKU by its ID. Response body example { "Id": 1, "ProductId": 1, "IsActive": true, "ActivateIfPossible": true, "Name": "Ração Royal Canin… - PUTUpdate SKU
/api/catalog/pvt/stockkeepingunit/:skuIdUpdates an existing SKU. Request body example { "Id": 310118448, "ProductId": 310117069, "IsActive": true, "ActivateIfPossible": true, "Name": "sku test",… - POSTRetrieve SKU ID list by Reference ID list
/api/catalog_system/pub/sku/stockkeepingunitidsbyrefidsReceives a list of Reference IDs and returns a list with the corresponding SKU IDs. >⚠️ The list of Reference IDs in the request body cannot have repeated… - GETGet SKU list by Product ID
/api/catalog_system/pvt/sku/stockkeepingunitByProductId/:productIdRetrieves a list with the SKUs related to a product by the product's ID. Response body example [ { "IsPersisted": true, "IsRemoved": false, "Id": 2000035,… - GETGet SKU by Alternate ID
/api/catalog_system/pvt/sku/stockkeepingunitbyalternateId/:alternateIdRetrieves an SKU by its Alternate ID. Response body example { "Id": 310118450, "ProductId": 2, "NameComplete": "Caixa de Areia Azul Petmate sku test",… - GETGet SKU and context
/api/catalog_system/pvt/sku/stockkeepingunitbyid/:skuId?sc=1Retrieves context of an SKU. > 📘 Onboarding guide > > Check the new Catalog onboarding guide. We created this guide to improve the onboarding experience for… - GETGet SKU ID by Reference ID
/api/catalog_system/pvt/sku/stockkeepingunitidbyrefid/:refIdRetrieves an SKU ID by the SKU's Reference ID. Response body example "310118450" - GETList all SKU IDs
/api/catalog_system/pvt/sku/stockkeepingunitids?page=1&pagesize=25Retrieves the IDs of all SKUs in your store. Presents the results with page size and pagination. > 📘 Onboarding guide > > Check the new Catalog onboarding…
SKU EAN
- GETGet EAN by SKU ID
/api/catalog/pvt/stockkeepingunit/:skuId/eanRetrieves the EAN of the SKU. Response body example [ "1234567890123" ] - DELETEDelete all SKU EAN values
/api/catalog/pvt/stockkeepingunit/:skuId/eanDeletes all EAN values of an SKU. - POSTCreate SKU EAN
/api/catalog/pvt/stockkeepingunit/:skuId/ean/:eanCreates or updates the EAN value of an SKU. - DELETEDelete SKU EAN
/api/catalog/pvt/stockkeepingunit/:skuId/ean/:eanDeletes the EAN value of an SKU. - GETGet SKU by EAN
/api/catalog_system/pvt/sku/stockkeepingunitbyean/:eanRetrieves an SKU by its EAN ID. Response body example { "Id": 2001773, "ProductId": 2001426, "NameComplete": "Tabela de Basquete", "ProductName": "Tabela de…
SKU File
- PUTCopy Files from an SKU to another SKU
/api/catalog/pvt/stockkeepingunit/copy/:skuIdfrom/:skuIdto/file/Copy all existing files from an SKU to another SKU. Response body example [ { "Id": 1964, "ArchiveId": 155404, "SkuId": 1, "IsMain": true, "Label": "" }, {… - DELETEDisassociate SKU File
/api/catalog/pvt/stockkeepingunit/disassociate/:skuId/file/:skuFileIdDisassociates an SKU File from an SKU. - GETGet SKU Files
/api/catalog/pvt/stockkeepingunit/:skuId/fileGets general information about all Files in the SKU. Response body example [ { "Id": 549, "ArchiveId": 155485, "SkuId": 310118490, "Name":… - POSTCreate SKU File
/api/catalog/pvt/stockkeepingunit/:skuId/fileCreates a new Image for an SKU based on its URL or on a form-data request body. Request body example { "IsMain": true, "Label": "", "Name":… - DELETEDelete All SKU Files
/api/catalog/pvt/stockkeepingunit/:skuId/fileDeletes all SKU Image Files. - PUTUpdate SKU File
/api/catalog/pvt/stockkeepingunit/:skuId/file/:skuFileIdUpdates a new Image on an SKU based on its URL or on a form-data request body. Request body example { "IsMain": true, "Label": null, "Name": "toilet-paper",… - DELETEDelete SKU Image File
/api/catalog/pvt/stockkeepingunit/:skuId/file/:skuFileIdDeletes a specific SKU Image File.
SKU Kit
- GETGet SKU Kit by SKU ID or Parent SKU ID
/api/catalog/pvt/stockkeepingunitkit?skuId=1&parentSkuId=1Retrieves general information about the components of an SKU Kit by SKU ID or Parent SKU ID. Response body example { "Id": 7, "StockKeepingUnitParent": 7,… - POSTCreate SKU Kit
/api/catalog/pvt/stockkeepingunitkitAdds a component to a specific Kit. Request body example { "StockKeepingUnitParent": 7, "StockKeepingUnitId": 1, "Quantity": 1, "UnitPrice": 50.0000 }… - DELETEDelete SKU Kit by SKU ID or Parent SKU ID
/api/catalog/pvt/stockkeepingunitkit?skuId=1&parentSkuId=1Deletes all Kit’s components based on the Parent SKU ID or deletes a specific Kit’s component based on the SKU ID. - GETGet SKU Kit
/api/catalog/pvt/stockkeepingunitkit/:kitIdRetrieves general information about a component of a Kit. - DELETEDelete SKU Kit by KitId
/api/catalog/pvt/stockkeepingunitkit/:kitIdDeletes a specific Kit’s component based on its Kit ID.
SKU Specification
- GETGet SKU Specifications
/api/catalog/pvt/stockkeepingunit/:skuId/specificationRetrieves information about an SKU's Specifications. Response body example [ { "Id": 427, "SkuId": 7, "FieldId": 32, "FieldValueId": 131, "Text": "500g" }, {… - PUTUpdate SKU Specification
/api/catalog/pvt/stockkeepingunit/:skuId/specificationUpdates an existing Specification on an existing SKU. This endpoint only updates the FieldValueId. Request body example { "Id": 65, "SkuId": 21, "FieldId":… - POSTAssociate SKU Specification
/api/catalog/pvt/stockkeepingunit/:skuId/specificationAssociates a previously created Specification to an SKU. Request body example { "FieldId": 65, "FieldValueId": 138 } Response body example { "Id": 730,… - DELETEDelete all SKU Specifications
/api/catalog/pvt/stockkeepingunit/:skuId/specificationDeletes all SKU Specifications. - DELETEDelete SKU Specification
/api/catalog/pvt/stockkeepingunit/:skuId/specification/:specificationIdDeletes a specific SKU Specification. - PUTAssociate SKU specification using specification name and group name
/api/catalog/pvt/stockkeepingunit/:skuId/specificationvalueAssociates a specification to an SKU using specification name and group name. Automatically creates the informed group, specification and values if they had…
SKU Attachment
- POSTAssociate SKU Attachment
/api/catalog/pvt/skuattachmentAssociates an existing SKU to an existing Attachment. Request body example { "AttachmentId": 1, "SkuId": 7 } Response body example { "Id": 31, "AttachmentId":… - DELETEDissociate attachments and SKUs
/api/catalog/pvt/skuattachment?skuId=1&attachmentId=1Dissociates attachments and SKUs based on an SKU ID or an attachment ID. - DELETEDelete SKU Attachment by Attachment Association ID
/api/catalog/pvt/skuattachment/:skuAttachmentAssociationIdDeletes the association of an SKU to an Attachment. - GETGet SKU Attachments by SKU ID
/api/catalog/pvt/stockkeepingunit/:skuId/attachmentRetrieves existing SKU Attachments by SKU ID. Response body example [ { "Id": 97, "AttachmentId": 1, "SkuId": 1 } ] - POSTAssociate attachments to an SKU
/api/catalog_system/pvt/sku/associateattachmentsAssociates attachments to an SKU based on a given SKU ID and attachment names. This request removes existing SKU attachment associations and recreates the…
SKU Complement
- POSTCreate SKU Complement
/api/catalog/pvt/skucomplementCreates a new SKU Complement on a Parent SKU. Request body example { "SkuId": 2, "ParentSkuId": 1, "ComplementTypeId": 2 } Response body example { "Id": 62,… - GETGet SKU Complement by SKU Complement ID
/api/catalog/pvt/skucomplement/:skuComplementIdRetrieves an existing SKU Complement by its SKU Complement ID. Response body example { "Id": 62, "SkuId": 2, "ParentSkuId": 1, "ComplementTypeId": 2 } - DELETEDelete SKU Complement by SKU Complement ID
/api/catalog/pvt/skucomplement/:skuComplementIdDeletes a previously existing SKU Complement by SKU Complement ID. - GETGet SKU Complement by SKU ID
/api/catalog/pvt/stockkeepingunit/:skuId/complementRetrieves an existing SKU Complement by its SKU ID. Response body example [ { "Id": 61, "SkuId": 7, "ParentSkuId": 1, "ComplementTypeId": 1 } ] - GETGet SKU Complements by Complement Type ID
/api/catalog/pvt/stockkeepingunit/:skuId/complement/:complementTypeIdRetrieves all the existing SKU Complements with the same Complement Type ID of a specific SKU. Response body example [ { "Id": 61, "SkuId": 7, "ParentSkuId":… - GETGet SKU complements by type
/api/catalog_system/pvt/sku/complements/:parentSkuId/:typeRetrieves all the existing SKU complements with the same complement type ID of a specific SKU. Response body example { "ParentSkuId": 1, "ComplementSkuIds": […
Non Structured Specification
- GETGet Non Structured Specification by SKU ID
/api/catalog/pvt/specification/nonstructured?skuId=1Gets general information about unmapped Specifications of a Seller's SKU in a Marketplace by SKU ID. Response body example [ { "Id": 1010, "SkuId": 310119072,… - DELETEDelete Non Structured Specification by SKU ID
/api/catalog/pvt/specification/nonstructured?skuId=1Deletes unmapped Specifications of a Seller'S SKU in a Marketplace by SKU ID. - GETGet Non Structured Specification by ID
/api/catalog/pvt/specification/nonstructured/:IdRetrieves general information about unmapped Specifications of a Seller's SKU in a Marketplace. Response body example { "Id": 1010, "SkuId": 310119072,… - DELETEDelete Non Structured Specification
/api/catalog/pvt/specification/nonstructured/:IdDeletes unmapped Specifications of a Seller'S SKU in a Marketplace by its unique ID.
Specification Field
- GETGet Specification Field
/api/catalog_system/pub/specification/fieldGet/:fieldIdRetrieves details from a specification field by this field's ID. >⚠️ This is a legacy endpoint. We recommend using Get Specification instead. Response body… - PUTUpdate Specification Field
/api/catalog_system/pvt/specification/fieldUpdates a specification field in a category. >⚠️ This is a legacy endpoint. We recommend using Update Specification instead. Request body example { "FieldId":… - POSTCreate Specification Field
/api/catalog_system/pvt/specification/fieldCreates a specification field in a category. >⚠️ This is a legacy endpoint. We recommend using Create Specification instead. Request body example { "Name":…
Specification Group
- POSTCreate Specification Group
/api/catalog/pvt/specificationgroupCreate a specification group. >⚠️ It is also possible to create a Specification Group by using an alternative legacy route:… - PUTUpdate Specification Group
/api/catalog/pvt/specificationgroup/:groupIdUpdate a specification group. >⚠️ It is also possible to update a Specification Group by using an alternative legacy route:… - GETGet Specification Group
/api/catalog_system/pub/specification/groupGet/:groupIdRetrieves details from a specification group by the ID of the group. Response body example { "CategoryId": 1, "Id": 6, "Name": "Sizes", "Position": 3 } - GETList Specification Group by Category
/api/catalog_system/pvt/specification/groupbycategory/:categoryIdRetrieves a list of specification groups by the category ID. Response body example [ { "CategoryId": 1, "Id": 5, "Name": "Materials", "Position": 2 }, {…
Specification Value
- POSTCreate Specification Value
/api/catalog/pvt/specificationvalueCreates a new Specification Value for a Category. Request body example { "FieldId": 193, "Name": "Metal", "IsActive": true, "Position": 1 } Response body… - GETGet Specification Value
/api/catalog/pvt/specificationvalue/:specificationValueIdRetrieves general information about a Specification Value. Response body example { "FieldValueId": 143, "FieldId": 34, "Name": "Cotton", "Text": "Cotton… - PUTUpdate Specification Value
/api/catalog/pvt/specificationvalue/:specificationValueIdUpdates a new Specification Value for a Category. Request body example { "FieldId": 193, "Name": "Metal", "Text": null, "IsActive": true, "Position": 1 }…
Specification Field Value
- GETGet Specification Values By Field ID
/api/catalog_system/pub/specification/fieldvalue/:fieldIdGets a list of all specification values from a Specification Field by this field's ID. Response body example [ { "FieldValueId": 52, "Value": "0 a 6 meses",… - PUTUpdate Specification Field Value
/api/catalog_system/pvt/specification/fieldValueUpdates a specification field value by the specification field's ID. >⚠️ This is a legacy endpoint. We recommend using Update Specification Field Value… - POSTCreate Specification Field Value
/api/catalog_system/pvt/specification/fieldValueCreates a specification field value by the specification field's ID. >⚠️ This is a legacy endpoint. We recommend using Create Specification Value instead.… - GETGet Specification Field Value
/api/catalog_system/pvt/specification/fieldValue/:fieldValueIdRetrieves details from a specification field's value by this value's ID. >⚠️ This is a legacy endpoint. We recommend using Get Specification Value instead.…
Category Specification
- GETGet Specifications By Category ID
/api/catalog_system/pub/specification/field/listByCategoryId/:categoryIdRetrieves all specifications from a category by its ID. Response body example [ { "Name": "Specification A", "CategoryId": 1, "FieldId": 33, "IsActive": true,… - GETGet Specifications Tree By Category ID
/api/catalog_system/pub/specification/field/listTreeByCategoryId/:categoryIdLists all specifications including the current category and the level zero specifications from a category by its ID. Response body example [ { "Name":…
Specification
- POSTCreate Specification
/api/catalog/pvt/specificationCreates a new Product or SKU Specification. Request body example { "FieldTypeId": 1, "CategoryId": 4, "FieldGroupId": 20, "Name": "Material", "Description":… - GETGet Specification
/api/catalog/pvt/specification/:specificationIdRetrieves information of a Product or SKU Specification. Response body example { "Id": 88, "FieldTypeId": 1, "CategoryId": 4, "FieldGroupId": 20, "Name":… - PUTUpdate Specification
/api/catalog/pvt/specification/:specificationIdUpdates a Product or SKU Specification. Request body example { "FieldTypeId": 1, "CategoryId": 4, "FieldGroupId": 20, "Name": "Material", "Description":…
Legacy Collection
- POSTCreate Collection
/api/catalog/pvt/collection>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections… - GETGet Collection
/api/catalog/pvt/collection/:collectionId>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections… - PUTUpdate Collection
/api/catalog/pvt/collection/:collectionId>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections… - DELETEDelete Collection
/api/catalog/pvt/collection/:collectionId>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections…
Legacy Subcollection
- POSTReposition SKU on the Subcollection
/api/catalog/pvt/collection/:collectionId/position>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections… - GETGet Subcollection by Collection ID
/api/catalog/pvt/collection/:collectionId/subcollection>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections… - POSTCreate Subcollection
/api/catalog/pvt/subcollection>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections… - GETGet Subcollection
/api/catalog/pvt/subcollection/:subCollectionId>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections… - PUTUpdate Subcollection
/api/catalog/pvt/subcollection/:subCollectionId>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections… - DELETEDelete Subcollection
/api/catalog/pvt/subcollection/:subCollectionId>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections… - POSTAssociate Brand to Subcollection
/api/catalog/pvt/subcollection/:subCollectionId/brand>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections… - DELETEDelete Brand from Subcollection
/api/catalog/pvt/subcollection/:subCollectionId/brand/:brandId>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections… - DELETEDelete Category from Subcollection
/api/catalog/pvt/subcollection/:subCollectionId/brand/:categoryId>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections… - POSTAssociate Category to Subcollection
/api/catalog/pvt/subcollection/:subCollectionId/category>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections… - POSTAdd SKU to Subcollection
/api/catalog/pvt/subcollection/:subCollectionId/stockkeepingunit>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections… - DELETEDelete SKU from Subcollection
/api/catalog/pvt/subcollection/:subCollectionId/stockkeepingunit/:skuId>⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections…
Collection Beta
- POSTCreate Collection
/api/catalog/pvt/collection/Creates a new collection. - GETGet All Inactive Collections
/api/catalog/pvt/collection/inactiveRetrieves a list of Collection IDs of the inactive Collections. - GETImport Collection file example
/api/catalog/pvt/collection/stockkeepingunit/importfileexampleImports a sample of the imported XLS file. You need to save the response file to your device. - GETGet products from a collection
/api/catalog/pvt/collection/:collectionId/products?page=2&pageSize=15&Filter=Pre launch&Active=true&Visible=true&CategoryId=12&BrandId=3&SupplierId=1&SalesChannelId=1&ReleaseFrom=2069-11-26T15:23:00&ReleaseTo=2069-11-26T15:23:00&SpecificationProduct=M&SpecificationFieldId=40Retrieves information about the products from a collection. - POSTRemove products from Collection by imported file
/api/catalog/pvt/collection/:collectionId/stockkeepingunit/importexcludeRemoves products from a collection from the request body file. The file must be an imported template. - POSTAdd products to Collection by imported file
/api/catalog/pvt/collection/:collectionId/stockkeepingunit/importinsertAdds products to a collection from the request body file. The file must be an imported template. - GETGet All Collections
/api/catalog_system/pvt/collection/search?page=2&pageSize=15&orderByAsc=trueRetrieves a list of all collections matching a filter. - GETGet Collections by search terms
/api/catalog_system/pvt/collection/search/:searchTerms?page=2&pageSize=15&orderByAsc=trueRetrieves a list of collections matching a filter.
Supplier
- POSTCreate Supplier
/api/catalog/pvt/supplierCreates a new Supplier. Request body example { "Name": "Supplier", "CorporateName": "TopStore", "StateInscription": "", "Cnpj": "33304981001272", "Phone":… - PUTUpdate Supplier
/api/catalog/pvt/supplier/:supplierIdUpdates general information of an existing Supplier. Request body example { "Name": "Supplier", "CorporateName": "TopStore", "StateInscription": "", "Cnpj":… - DELETEDelete Supplier
/api/catalog/pvt/supplier/:supplierIdDeletes an existing Supplier.
Sales Channel
- GETGet Sales Channel by ID
/api/catalog_system/pub/saleschannel/:salesChannelIdRetrieves a specific sales channel by its ID. Response body example { "Id": 1, "Name": "Loja Principal", "IsActive": true, "ProductClusterId": null,… - GETGet Sales Channel List
/api/catalog_system/pvt/saleschannel/listRetrieves a list with details about the store's sales channels. Response body example [ { "Id": 1, "Name": "Loja Principal", "IsActive": true,…
Seller
- PUTUpdate Seller
/api/catalog_system/pvt/sellerUpdates a seller. - POSTCreate Seller
/api/catalog_system/pvt/sellerCreates a new seller. - GETGet Seller List
/api/catalog_system/pvt/seller/list?sc=1&sellerType=1&isBetterScope=falseRetrieves the seller's details by its ID. - GETGet Seller by ID
/api/catalog_system/pvt/seller/:sellerIdRetrieves the seller's details by its ID. - GETGet Seller by ID
/api/catalog_system/pvt/sellers/:sellerIdRetrieves the seller's details by its ID.
SKU Seller
- POSTChange Notification with Seller ID and Seller SKU ID
/api/catalog_system/pvt/skuseller/changenotification/:sellerId/:sellerSkuId> ⚠️ Check out the updated version of the SKU Seller endpoints in our SKU Bindings API documentation. If you are doing this integration for the first time, we… - POSTChange Notification with SKU ID
/api/catalog_system/pvt/skuseller/changenotification/:skuId> ⚠️ Check out the updated version of the SKU Seller endpoints in our SKU Bindings API documentation. If you are doing this integration for the first time, we… - POSTRemove a seller's SKU binding
/api/catalog_system/pvt/skuseller/remove/:sellerId/:sellerSkuId> ⚠️ Check out the updated version of the SKU Seller endpoints in our SKU Bindings API documentation. If you are doing this integration for the first time, we… - GETGet details of a seller's SKU
/api/catalog_system/pvt/skuseller/:sellerId/:sellerSkuId> ⚠️ Check out the updated version of the SKU Seller endpoints in our SKU Bindings API documentation. If you are doing this integration for the first time, we…
Product Indexing
- GETGet Product Indexed Information
/api/catalog_system/pvt/products/GetIndexedInfo/:productIdRetrieve details of a Product's Indexed Information in XML format. Response body example " <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <response>\n <lst…
Commercial Conditions
- GETGet all commercial conditions
/api/catalog_system/pvt/commercialcondition/listLists all commercial conditions on the store. Response body example [ { "Id": 1, "Name": "Padrão", "IsDefault": true }, { "Id": 2, "Name": "Teste Fast",… - GETGet commercial condition
/api/catalog_system/pvt/commercialcondition/:commercialConditionIdRetrieves information of a commercial condition by its ID. Response body example { "Id": 1, "Name": "Padrão", "IsDefault": true }
Gift List
- GETGet Gift List
/api/addon/pvt/giftlist/get/:listIdRetrieves information about a Gift List by its ID.
API details
- Base URL
https://vtex.localhttps://{accountName}.{environment}.com.br- Authentication
- An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header - Operations
- 162 operations on 117 pathsGET 69POST 40DELETE 31PUT 22
- Main resources
- Legacy Subcollection 12SKU 10Collection Beta 8Product 8Brand 7Product Specification 7SKU File 7SKU Complement 6SKU Specification 6Attachment 5
- Response formats
application/jsontext/plainxml- Description format
- OpenAPI 3.0.0, API version
1.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Catalog API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Catalog API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Associate SKU Service” (POST /api/catalog/pvt/skuservice), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Catalog API?
> Check the new [Catalog onboarding guide](https://developers.vtex.com/docs/guides/catalog-overview). We created this guide to improve the onboarding… It is listed under Other and has 162 endpoints.
Who publishes the Catalog API?
It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Catalog API?
Its description lists 2 base URLs: https://vtex.local, https://{accountName}.{environment}.com.br. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Catalog API?
It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.
How many endpoints does the Catalog API have?
162 operations on 117 paths (69 GET, 40 POST, 31 DELETE, 22 PUT). The largest groups are Legacy Subcollection, SKU, Collection Beta, Product.
Is forking the Catalog API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.