{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Prices and Fixed Prices API", "version": "1.0" }, "items": [ { "info": { "name": "Prices and Fixed Prices", "type": "folder" }, "items": [ { "info": { "name": "VTex Get price by SKU ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/pricing/prices/:itemId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "itemId", "value": "", "type": "path", "description": "SKU ID." } ] }, "docs": "Retrieves price data given a specific SKU ID. Within the `fixedPrices` object, there might be a list of prices for specific Trade Policies and Minimium Quantities of the SKU. Fixed Prices may also be scheduled.\r\n\r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6eu" }, { "info": { "name": "VTex Create or update base price or fixed prices", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/pricing/prices/:itemId", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "itemId", "value": "", "type": "path", "description": "SKU unique identifier number." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates an SKU Base Price or Fixed Prices. The **base price** is the basic selling price of a product, it comprises the cost price and the markup wanted in the sale of the product. The **fixed price** is an optional price of the SKU for a specific trade policy with a specific minimum quantity to be activated.\r\n\r\nYou may optionally set a list price. Additionally, you may set either a cost price or a markup value. By defining either one of them, the other will be calculated to conform t" }, { "info": { "name": "VTex Delete price all base and fixed prices of an SKU", "type": "http" }, "http": { "method": "DELETE", "url": "https://{providerApiEndpoint}/pricing/prices/:itemId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "itemId", "value": "", "type": "path", "description": "SKU ID." } ] }, "docs": "Deletes the Base Price and all available Fixed Prices for an SKU in all trade policies.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicabl" }, { "info": { "name": "VTex Get fixed prices", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/pricing/prices/:itemId/fixed", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "itemId", "value": "", "type": "path", "description": "SKU ID." } ] }, "docs": "The **fixed price** is an optional price of the SKU for a specific trade policy with a specific minimum quantity to be activated. This method retrieves an array of Fixed Prices for an SKU in a Trade Policy with Minimum Quantities.\r\n\r\nThe default value for a Minimum Quantity is `1`. This means a Fixed Price will be valid for a SKU in a Trade Policy for orders containing the specified number of Minimum Quantity or above, unless a higher Minimum Quantity is specified.\r\n\r\nFixed prices may, optionall" }, { "info": { "name": "VTex Get fixed prices on a price table or trade policy", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/pricing/prices/:itemId/fixed/:priceTableId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "itemId", "value": "", "type": "path", "description": "SKU ID." }, { "name": "priceTableId", "value": "", "type": "path", "description": "Price Table Name" } ] }, "docs": "Retrieves all Fixed Prices on a price table or trade policy. \r\n\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this end" }, { "info": { "name": "VTex Create or update fixed prices on a price table or trade policy", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/pricing/prices/:itemId/fixed/:priceTableId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "itemId", "value": "", "type": "path", "description": "SKU ID." }, { "name": "priceTableId", "value": "", "type": "path", "description": "SKU **price table** name or **trade policy** ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates the fixed prices of an SKU for a specific price table or trade policy. You can add one or multiple fixed prices per SKU.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receiv" }, { "info": { "name": "VTex Delete fixed prices on a price table or trade policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://{providerApiEndpoint}/pricing/prices/:itemId/fixed/:priceTableId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "itemId", "value": "", "type": "path", "description": "SKU ID." }, { "name": "priceTableId", "value": "", "type": "path", "description": "Price Table or Trade Policy Name." } ] }, "docs": "Deletes all Fixed Prices of an SKU in a specific Price Table or Trade Policy.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resource" }, { "info": { "name": "VTex Get computed price by price table or trade policy", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/pricing/prices/:itemId/computed/:priceTableId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "categoryIds", "value": "", "type": "query", "description": "Category ID." }, { "name": "brandId", "value": "", "type": "query", "description": "Brand ID." }, { "name": "quantity", "value": "", "type": "query", "description": "SKU quantity." }, { "name": "itemId", "value": "", "type": "path", "description": "SKU ID." }, { "name": "priceTableId", "value": "", "type": "path", "description": "SKU Price Table Name." } ] }, "docs": "Gets the Computed Price, which is the price after all the steps in the Pricing pipeline, for an SKU in a specific price table or trade policy. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will re" } ] } ], "bundled": true }