VTvtex
Prices and Fixed Prices

Get computed price by price table or trade policy

Changed on

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.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
PricingPrice ListRead prices

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/pricing/prices/{itemId}/computed/{priceTableId}

Request

  • Base URL
    https://api.vtex.com/DefaultParameterValue/pricing
  • URL
    https://api.vtex.com/DefaultParameterValue/pricing/pricing/prices/{itemId}/computed/{priceTableId}
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Path parameters

itemIdinteger required
Example:1

SKU ID.

priceTableIdstring required
Example:gold

SKU Price Table Name.

Query parameters

categoryIdsinteger
Example:1

Category ID.

brandIdinteger
Example:3

Brand ID.

quantityinteger
Example:2

SKU quantity.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

Changes

  • bccf40ffc340Revision changes
    • info

      the query request parameter brandId became optional

    • info

      the query request parameter categoryIds became optional

    • info

      the query request parameter quantity became optional

    • info

      added the optional property to the response with the status

  • 49631b235d69Revision changes
    • info

      endpoint added