v50

latestOpenAPI 3.0.0raw.githubusercontent.com2025-09-22312710.8 KB
Prices (Legacy - v1)

Get price by context

Get price by context.

If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 API

If you are still using Pricing v1, please check if your store is able to migrate to take advantage of many more features

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
Rates and BenefitsPromotionsManage benefits and rates

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.

post/price-sheet/context

Query parameters

anstring required
Example:{{accountName}}

VTEX account name.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

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

Request body

idinteger required

Price ID.

itemIdinteger required

Item ID.

salesChannelinteger required

Sales channel.

sellerIdstring required

Seller ID.

validFromstring required

Valid from.

validTostring required

Valid to.

Example request

{
  "id": 6324,
  "itemId": 2390148,
  "salesChannel": 1,
  "sellerId": "1",
  "validFrom": "2000-01-01T00:00:00",
  "validTo": "2000-02-01T00:00:00"
}

Response

OK