{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account SKU Bindings API", "version": "1.0" }, "items": [ { "info": { "name": "SKU Bindings", "type": "folder" }, "items": [ { "info": { "name": "VTex Get SKU Bindings by SKU ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/catalog/pvt/skusellers/:skuId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "skuId", "value": "", "type": "path", "description": "SKU's unique identifier in the marketplace." } ] }, "docs": "Retrieves SKU Bindings details by SKU ID.\r\n\r\n## Response body example\r\n\r\n```json\r\n[\r\n {\r\n \"Id\": 48,\r\n \"SellerId\": \"cosmetics1\",\r\n \"StockKeepingUnitId\": 1,\r\n \"SellerSkuId\": \"42\",\r\n \"IsActive\": true,\r\n \"LastUpdateDate\": \"2020-10-21T19:13:00.657\",\r\n \"SalesPolicy\": 0\r\n }\r\n]\r\n```" }, { "info": { "name": "VTex Get SKU Bindings information", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/sku-binding/pvt/skuseller/admin", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "sellerId", "value": "", "type": "query", "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID." }, { "name": "skuId", "value": "", "type": "query", "description": "SKU's unique identifier in the marketplace." }, { "name": "sellerSkuId", "value": "", "type": "query", "description": "SKU ID in the seller's store." }, { "name": "isActive", "value": "", "type": "query", "description": "Defines if the SKU binding is active." }, { "name": "size", "value": "", "type": "query", "description": "Amount of results." } ] }, "docs": "Retrieves SKU Bindings administrative information using optional query params `sellerId`, `skuId`, `sellerSkuId` and `IsActive` to filter results and `size` to restrict the amount of results. \r\n\r\n > ℹ This path is an updated version of `/api/catalog_system/pvt/skuseller/admin`.\r\n\r\n## Response body example\r\n\r\n```json\r\n[\r\n {\r\n \"IsPersisted\": true,\r\n \"IsRemoved\": false,\r\n \"SkuSellerId\": 1,\r\n \"UpdateDate\": \"2019-12-04T01:56:00.673Z\",\r\n \"RequestedUpdateDate\": nul" }, { "info": { "name": "VTex Get details of a seller's SKU", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/sku-binding/pvt/skuseller/:sellerId/:sellerSkuId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "sellerId", "value": "", "type": "path", "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID." }, { "name": "sellerSkuId", "value": "", "type": "path", "description": "SKU ID in the seller's store." } ] }, "docs": "Retrieves the details of a seller's SKU given a seller ID and the SKU ID in the seller's store. \r\n\r\n > ℹ This path is an updated version of `/api/catalog_system/pvt/skuseller/{sellerId}/{sellerSkuId}`.\r\n\r\n## Response body example\r\n\r\n```json\r\n{\r\n \"IsPersisted\": true,\r\n \"IsRemoved\": false,\r\n \"SkuSellerId\": 102,\r\n \"UpdateDate\": \"2021-04-12T20:06:59.413Z\",\r\n \"RequestedUpdateDate\": null,\r\n \"SellerStockKeepingUnitId\": \"71\",\r\n \"SellerId\": \"vtxkfj7352\",\r\n \"StockKeepingUnitId\": 1," }, { "info": { "name": "VTex Bind a seller's SKU to another SKU", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/sku-binding/pvt/skuseller/:sellerId/:sellerSkuId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "sellerId", "value": "", "type": "path", "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID." }, { "name": "sellerSkuId", "value": "", "type": "path", "description": "SKU ID in the seller's store." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associates a seller's SKU to another marketplace SKU.\r\n\r\n > ℹ This path is an updated version of `/api/catalog_system/pvt/skuseller/{sellerId}/{sellerSkuId}`.\r\n\r\n## Request body example\r\n\r\n```json\r\n{\r\n \"StockKeepingUnitId\": 1\r\n}\r\n```" }, { "info": { "name": "VTex Get all SKU Bindings by Seller ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/sku-binding/pvt/skuseller/list/bysellerId/:sellerId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "sellerId", "value": "", "type": "path", "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID." } ] }, "docs": "Retrieves a list of SKU Bindings given a specific Seller ID. \r\n\r\n > ℹ This path is an updated version of `/api/catalog_system/pvt/skuseller/list/bysellerId/{sellerId}`.\r\n\r\n## Response body example\r\n\r\n```json\r\n[\r\n {\r\n \"SellerStockKeepingUnitId\": \"24\",\r\n \"FreightCommissionPercentage\": null,\r\n \"ProductCommissionPercentage\": null,\r\n \"SellerId\": \"vtxkfj7352\",\r\n \"StockKeepingUnitId\": 121,\r\n \"IsActive\": true\r\n }\r\n]\r\n```" }, { "info": { "name": "VTex Get paged SKU Bindings by Seller ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/sku-binding/pvt/skuseller/paged/sellerid/:sellerId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number." }, { "name": "size", "value": "", "type": "query", "description": "Amount of results per page." }, { "name": "sellerId", "value": "", "type": "path", "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID." } ] }, "docs": "Retrieves a paged list of SKU Bindings given a specific Seller ID. \r\n\r\n > ℹ This path is an updated version of `/api/catalog_system/pvt/skuseller/paged/sellerid/{sellerId}`.\r\n\r\n## Response body example\r\n\r\n```json\r\n[\r\n {\r\n \"SellerId\": \"vtxkfj7352\",\r\n \"StockKeepingUnitId\": 121,\r\n \"SellerStockKeepingUnitId\": \"24\",\r\n \"IsActive\": true,\r\n \"FreightCommissionPercentage\": null,\r\n \"ProductCommissionPercentage\": null\r\n },\r\n {\r\n \"SellerId\": \"vtxkfj73" }, { "info": { "name": "VTex Change Notification with SKU ID", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/sku-binding/pvt/skuseller/changenotification/:skuId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "skuId", "value": "", "type": "path", "description": "A string that identifies the SKU in the marketplace. This is the ID that the marketplace will use to look for the SKU whose change the seller wants to inform. If the marketplace finds this ID, it responds with status code `200`. Otherwise, it responds with status code `404`." } ] }, "docs": "The seller is responsible for suggesting new SKUs to be sold in the VTEX marketplace and also for informing the marketplace about changes in their SKUs that already exist in the marketplace. Both actions start with a catalog notification, which is made by this request.\n\nWith this notification, the seller is telling the marketplace that something has changed about a specific SKU, like price or inventory, or that this is a new SKU that the seller would like to offer to the marketplace.\n\nThe body o" }, { "info": { "name": "VTex Change Notification with Seller ID and Seller SKU ID", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/sku-binding/pvt/skuseller/changenotification/:sellerId/:sellerSkuId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "sellerId", "value": "", "type": "path", "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID." }, { "name": "sellerSkuId", "value": "", "type": "path", "description": "ID of the binding of the seller with the SKU." } ] }, "docs": "The seller is responsible for suggesting new SKUs to be sold in the VTEX marketplace and also for informing the marketplace about changes in their SKUs that already exist in the marketplace. Both actions start with a catalog notification, which is made by this request.\n\nWith this notification, the seller is telling the marketplace that something has changed about a specific SKU, like price or inventory, or that this is a new SKU that the seller would like to offer to the marketplace.\n\nThere are " }, { "info": { "name": "VTex Insert SKU Binding", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/sku-binding/pvt/skuseller/insertion", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an SKU Binding, associating a seller's SKU with a marketplace's SKU.\r\n\r\n > ℹ This path is an updated version of `/api/catalog_system/pvt/skuseller/insertion`." }, { "info": { "name": "VTex Activate SKU Binding", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/sku-binding/pvt/skuseller/activate/:sellerId/:skuSellerId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "sellerId", "value": "", "type": "path", "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID." }, { "name": "skuSellerId", "value": "", "type": "path", "description": "SKU ID in the seller's store." } ] }, "docs": "Changes the status of an SKU Binding to active, setting `isActive` to `true`.\r\n\r\n > ℹ This path is an updated version of `/api/catalog_system/pvt/skuseller/activate/{sellerId}/{skuSellerId}`." }, { "info": { "name": "VTex Deactivate SKU Binding", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/sku-binding/pvt/skuseller/inactivate/:sellerId/:skuSellerId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "sellerId", "value": "", "type": "path", "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID." }, { "name": "skuSellerId", "value": "", "type": "path", "description": "SKU ID in the seller's store." } ] }, "docs": "Changes the status of an SKU Binding to inactive, setting `isActive` to `false`.\r\n\r\n > ℹ This path is an updated version of `/api/catalog_system/pvt/skuseller/inactivate/{sellerId}/{skuSellerId}`." }, { "info": { "name": "VTex Remove a seller's SKU Binding", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/sku-binding/pvt/skuseller/remove/:sellerId/:sellerSkuId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "sellerId", "value": "", "type": "path", "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID." }, { "name": "sellerSkuId", "value": "", "type": "path", "description": "SKU ID in the seller's store." } ] }, "docs": "Remove a seller's SKU binding, given the Seller ID and the SKU ID in the seller's store.\r\n\r\n > ℹ This path is an updated version of `/api/catalog_system/pvt/skuseller/remove/{sellerId}/{sellerSkuId}`." } ] } ], "bundled": true }