v50

latestOpenAPI 3.0.0raw.githubusercontent.com2025-08-282624202.6 KB

Seller Commissions

Upsert seller commissions in bulk

This endpoint is used by marketplace operators to define comissions for multiple categories, sending an array with multiple objects in the same call.

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:

Product	Category	Resource
Seller Register	Seller administration	Save Seller

Role	Resource
Seller manager	Save Seller
You can create a custom role with this feature or use one of the predefined roles from the list above.

❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys. To learn more about machine authentication at VTEX, see Authentication overview.

put/seller-register/pvt/sellers/{sellerId}/commissions

Path parameters

accountNamestring required

Example:apiexamples

Name of the VTEX account that belongs to the marketplace. The notification will be posted into this account.

environmentstring required

Environment to use. Used as part of the URL.

sellerIdstring required

Example:seller123

A string that identifies the seller in the marketplace. This ID must be created by the marketplace and informed to the seller before the integration is built.

Headers

Acceptstring required

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

Content-Typestring required

Type of the content being sent.

Request body

categoryIdstring required

Marketplace's Category ID that the product belongs to, configured in the Catalog.

categoryFullPathstring nullable required

Full path to the SKU's category. It should be written as {department}/{category}. For example: if the department is Appliances and the category is Oven, the full path should be 'Appliances/Oven'.

productCommissionPercentagenumber required

Percentage of the comission applied to the product in decimals.

freightCommissionPercentagenumber required

Percentage of the comission applied to the freight in decimals.

Example request

[
  {
    "categoryId": "6",
    "categoryFullPath": null,
    "productCommissionPercentage": 9.85,
    "freightCommissionPercentage": 2.43
  }
]

Response

No Content