{"note":"OpenAPI conversion -- returning structured metadata","name":"vtex-local-pricing-api","description":"Pricing API","version":"1.0","base_url":"https://api.vtex.com/apiexamples","endpoints":17,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Pricing API\n@base https://api.vtex.com/apiexamples\n@version 1.0\n@auth ApiKey X-VTEX-API-AppKey in header | ApiKey X-VTEX-API-AppToken in header | ApiKey VtexIdclientAutCookie in header\n@common_fields {Content-Type: str # Type of the content being sent., Accept: str # HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.}\n@endpoints 17\n@toc pricing(17)\n\n@endpoint GET /pricing/prices/{itemId}\n@desc Get price by SKU ID\n@required {itemId: int # SKU ID.}\n@returns(200) {itemId: str, listPrice: int(int32), costPrice: int(int32), markup: int(int32), basePrice: int(int32), fixedPrices: [map]} # OK\n\n@endpoint DELETE /pricing/prices/{itemId}\n@desc Delete price all base and fixed prices of an SKU\n@required {itemId: int # SKU ID.}\n@returns(200) OK\n\n@endpoint PUT /pricing/prices/{itemId}\n@desc Create or update base price or fixed price\n@required {itemId: int # SKU unique identifier number.}\n@optional {markup: int # The profit percentage that is to be obtained from the sale of that SKU. If you decide to fill the `markup` item, you must also fill the `costPrice`. The `basePrice` will be automatically generated based on both values., listPrice: num # SKU's suggested selling price., basePrice: num # SKU selling base price. If you decide to fill only the `basePrice` item, the `markup` and `costPrice` will be automatically generated to adapt to the number inserted in `basePrice`., costPrice: num # SKU selling cost price. If you decide to fill the `costPrice` item, you must also fill the `markup` and `basePrice` will be automatically generated based on both values., fixedPrices: [map{tradePolicyId!: str, value!: num, listPrice: num, minQuantity!: int, dateRange: map}] # Information  about the SKU's fixed prices.}\n@returns(200) OK\n@example_request {\"markup\":30,\"listPrice\":50,\"costPrice\":35,\"fixedPrices\":[{\"tradePolicyId\":\"1\",\"value\":50.5,\"listPrice\":50.5,\"minQuantity\":2,\"dateRange\":{\"from\":\"2021-12-30T22:00:00-03:00\",\"to\":\"2021-12-30T23:00:00-03:00\"}}]}\n\n@endpoint GET /pricing/prices/{itemId}/fixed\n@desc Get fixed prices\n@required {itemId: int # SKU ID.}\n@returns(200) OK\n\n@endpoint PATCH /pricing/prices/{itemId}/fixed\n@desc Create or update base price or fixed price\n@required {itemId: int # SKU unique identifier number.}\n@returns(200) OK\n@example_request [{\"tradePolicyId\":\"1\",\"value\":50.5,\"listPrice\":50.5,\"minQuantity\":2,\"dateRange\":{\"from\":\"2021-12-30T22:00:00-03:00\",\"to\":\"2021-12-30T22:00:00-03:00\"}}]\n\n@endpoint POST /pricing/prices/{itemId}/fixed/{priceTableId}\n@desc Create or update fixed prices on a price table or trade policy\n@required {itemId: int # SKU ID., priceTableId: str # SKU **price table** name or **trade policy** ID.}\n@returns(200) OK\n\n@endpoint GET /pricing/prices/{itemId}/fixed/{priceTableId}\n@desc Get fixed prices on a price table or trade policy\n@required {itemId: int # SKU ID., priceTableId: str # Price Table Name}\n@returns(200) OK\n\n@endpoint DELETE /pricing/prices/{itemId}/fixed/{priceTableId}\n@desc Delete fixed prices on a price table or trade policy\n@required {itemId: int # SKU ID., priceTableId: str # Price Table or Trade Policy Name.}\n@returns(200) OK\n\n@endpoint GET /pricing/prices/{itemId}/computed\n@desc Get computed prices for all price tables\n@required {itemId: int # SKU ID.}\n@optional {categoryIds: int # Category ID., brandId: int # Brand ID., quantity: int # SKU quantity.}\n@returns(200) OK\n\n@endpoint GET /pricing/prices/{itemId}/computed/{priceTableId}\n@desc Get computed price by price table or trade policy\n@required {itemId: int # SKU ID., priceTableId: str # SKU Price Table Name.}\n@optional {categoryIds: int # Category ID., brandId: int # Brand ID., quantity: int # SKU quantity.}\n@returns(200) OK\n\n@endpoint GET /pricing/config\n@desc Get pricing configuration\n@returns(200) OK\n\n@endpoint GET /pricing/migration\n@desc Get pricing v2 status\n@returns(200) OK\n\n@endpoint GET /pricing/pipeline/catalog/{priceTableId}\n@desc Get rules for a price table\n@required {priceTableId: str # Price Table Name.}\n@returns(200) {tradePolicyId: str, rules: [map], percentualModifier: int} # OK\n@errors {401: Unauthorized, 403: Forbidden, 429: Too many requests}\n\n@endpoint PUT /pricing/pipeline/catalog/{priceTableId}\n@desc Update rules for a price table\n@required {priceTableId: str # Price Table Name., rules: [map{id!: int, context!: map, percentualModifier!: num}] # Array of rules for the price table.}\n@returns(201) Created\n\n@endpoint PUT /pricing/tables/{priceTableId}\n@desc Create price table\n@required {priceTableId: str # Price Table Name.}\n@returns(200) OK\n\n@endpoint GET /pricing/pipeline/catalog\n@desc Get all price tables and their rules\n@returns(200) OK\n\n@endpoint GET /pricing/tables\n@desc List price tables\n@returns(200) OK\n\n@end\n"}