VTvtex
Promotions and taxes

Seller opt-in or opt-out

Changed on

Adds or removes one or more sellers to or from a specified promotion.

⚠️ When the first seller opts in to an inactive promotion, it's activated, and when the last seller opts out, it's deactivated.

Permissions

Any user or application 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 401 error. These are the applicable resources for this endpoint

ProductCategoryResource
Rates and BenefitsManage external seller promosExternal_Seller_Promotions
post/api/rnb/pvt/calculatorconfiguration/{promotionId}/seller-opt

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/rnb/pvt/calculatorconfiguration/{promotionId}/seller-opt
  • 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:d8a10358-cbb7-42ae-b020-91e104d997e7

The ID of the promotion.

Query parameters

anstring required
Example:mystore

The VTEX account name that owns the promotion.

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.

if-Matchstring required
Example:2025-05-27T14:05:41.7706903Z

Must match the current lastModified value of the promotion.

Request body

sellerIdsstring[] required

List of seller IDs that opted in or out to the promotion.

operation'OptIn' | 'OptOut' required

Operation to perform: OptIn or OptOut.

Example request

{
  "sellerIds": [
    "seller-id-1"
  ],
  "operation": "OptIn"
}

Response

Opt-in or opt-out executed successfully.

lastModifiedstring

Timestamp of the promotion's last modification (UTC).

Changes