{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Legacy Subcollection API", "version": "1.0" }, "items": [ { "info": { "name": "Legacy Subcollection", "type": "folder" }, "items": [ { "info": { "name": "VTex Add SKU to subcollection", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/catalog/pvt/subcollection/:subCollectionId/stockkeepingunit", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "subCollectionId", "value": "", "type": "path", "description": "Subcollection'''s unique numerical identifier, which can be obtained by placing a request to [Get subcollection by collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid)." } ], "body": { "type": "json", "data": "{}" } }, "docs": " >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L).\n\nAssociates a single SKU to a Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection.\r\n\r\n## Permissions\r\n\r\nAny user or [ap" }, { "info": { "name": "VTex Delete SKU from subcollection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{providerApiEndpoint}/api/catalog/pvt/subcollection/:subCollectionId/stockkeepingunit/:skuId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "subCollectionId", "value": "", "type": "path", "description": "Subcollection'''s unique numerical identifier, which can be obtained by placing a request to [Get subcollection by collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid)." }, { "name": "skuId", "value": "", "type": "path", "description": "SKU's unique numerical identifier." } ] }, "docs": " >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L).\n\nDeletes an SKU from a Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection.\r\n\r\n## Permissions\r\n\r\nAny user or [applicati" }, { "info": { "name": "VTex Associate category to subcollection", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/catalog/pvt/subcollection/:subCollectionId/category", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "subCollectionId", "value": "", "type": "path", "description": "Subcollection's unique numerical identifier, which can be obtained by placing a request to [Get subcollection by collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid)." } ], "body": { "type": "json", "data": "{}" } }, "docs": " >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L).\n\nAssociates a single category to a Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection.\r\n\r\n## Permissions\r\n\r\nAny user o" }, { "info": { "name": "VTex Delete category from Subcollection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{providerApiEndpoint}/api/catalog/pvt/subcollection/:subCollectionId/brand/:categoryId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "subCollectionId", "value": "", "type": "path", "description": "Subcollection's unique numerical identifier, which can be obtained by placing a request to [Get subcollection by dollection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid)." }, { "name": "categoryId", "value": "", "type": "path", "description": "Category's unique numerical identifier." } ] }, "docs": " >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L).\n\nDeletes a category from a subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection.\r\n\r\n## Permissions\r\n\r\nAny user or [appli" }, { "info": { "name": "VTex Associate brand to subcollection", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/catalog/pvt/subcollection/:subCollectionId/brand", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "subCollectionId", "value": "", "type": "path", "description": "Subcollection's unique numerical identifier, which can be obtained by placing a request to [Get subcollection by collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid)." } ], "body": { "type": "json", "data": "{}" } }, "docs": " >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L).\n\nAssociates a single brand to a Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection.\r\n\r\n## Permissions\r\n\r\nAny user or [" }, { "info": { "name": "VTex Delete brand from subcollection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{providerApiEndpoint}/api/catalog/pvt/subcollection/:subCollectionId/brand/:brandId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "subCollectionId", "value": "", "type": "path", "description": "Subcollection's unique numerical identifier, which can be obtained by placing a request to [Get subcollection by collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid)." }, { "name": "brandId", "value": "", "type": "path", "description": "Brand's unique numerical identifier." } ] }, "docs": " >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L).\n\nDeletes a brand from a Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection.\r\n\r\n## Permissions\r\n\r\nAny user or [applicati" }, { "info": { "name": "VTex Get subcollection by collection ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog/pvt/collection/:collectionId/subcollection", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "Collection's unique numerical identifier." } ] }, "docs": " >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L).\n\nRetrieves all subcollections given a collection ID. A subcollection is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a collection.\r\n\r\n## Permissions\r\n" }, { "info": { "name": "VTex Get subcollection by subcollection ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog/pvt/subcollection/:subCollectionId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "subCollectionId", "value": "", "type": "path", "description": "Subcollection's unique numerical identifier, which can be obtained by placing a request to [Get subcollection by collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid)." } ] }, "docs": " >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L).\n\nRetrieves information about a subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a collection.\r\n\r\n## Permissions\r\n\r\nAny user or [ap" }, { "info": { "name": "VTex Update subcollection", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/catalog/pvt/subcollection/:subCollectionId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "subCollectionId", "value": "", "type": "path", "description": "Subcollection's unique numerical identifier, which can be obtained by placing a request to [Get subcollection by collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid)." } ], "body": { "type": "json", "data": "{}" } }, "docs": " >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L).\n\nUpdates a previously created subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a collection.\r\n\r\n## Permissions\r\n\r\nAny user or [app" }, { "info": { "name": "VTex Delete subcollection", "type": "http" }, "http": { "method": "DELETE", "url": "https://{providerApiEndpoint}/api/catalog/pvt/subcollection/:subCollectionId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "subCollectionId", "value": "", "type": "path", "description": "Subcollection's unique numerical identifier, which can be obtained by placing a request to [Get subcollection by collection ID](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-subcollection-collectionid)." } ] }, "docs": " >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L).\n\nDeletes a previously created subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a collection.\r\n\r\n## Permissions\r\n\r\nAny user or [app" }, { "info": { "name": "VTex Create subcollection", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/catalog/pvt/subcollection", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": " >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L).\n\nCreates a new subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a collection. A subcollection can be either “Exclusive” (all the p" }, { "info": { "name": "VTex Reposition SKU on the subcollection", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/catalog/pvt/collection/:collectionId/position", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "Collection's unique numerical identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": " >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L).\n\nEdits the position of an SKU that already exists in the subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a collection.\r\n\r\n## Per" } ] } ], "bundled": true }