VTvtex
Promotions and taxes

Update multiple SKU promotion

Changed on

Updates information from a Multiple SKU promotion. This scenario allows the creation of a single promotion for multiple SKUs with the Percentage Effect.

⚠️ The limit of SKUs on a Multiple Effects promotion is 400.

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 BenefitsManage benefits and ratesGerenciarPromocoesETarifas

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.

put/api/rnb/pvt/import/calculatorConfiguration/{promotionId}

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/rnb/pvt/import/calculatorConfiguration/{promotionId}
  • 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

promotionIdstring required
Example:dc6b6f59-ec2b-4a13-8490-0d1e0c53ddf9

Promotion unique identifier.

Headers

Content-Typestring required
Example:text/csv

Type of the content being sent.

Acceptstring required

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

X-VTEX-calculator-namestring required
Example:Test

Promotion Name.

X-VTEX-cumulativeboolean

Defines if the Promotion is cumulative with other promotions.

X-VTEX-cluster-operatorstring
Example:any

This header allows implementing the Promotion in multiples client clusters. You can set the value as all - the Promotion will be valid to all the clusters - or any - the Promotion will be valid to any of the clusters.

X-VTEX-cluster-expressionstring
Example:cluster_name=true

Cluster that will be included in the Promotion. To add multiple clusters, create a header for each one of them.

X-VTEX-start-datestring required
Example:2020-08-18T16:00:00+3:00

Promotion start date.

X-VTEX-end-datestring required
Example:2020-08-18T16:30:00+3:00

Promotion end date.

X-VTEX-accumulate-with-manual-pricesboolean required

Condition that will accumulate the Promotion with manual prices or not.

Request body text/csv

string binary required

The file must contain the SKU ID and the percentage of the discount. The first line must have the headers sku and effect. The next lines must be the SKU ID and the percentage, without any spaces. For decimal values, use . as in 10.5. This should be sent as a raw text on the request body.

Example request

"sku,effect\r\n1,10.5"

Response

Accepted

Changes