v50

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

Sellers

Update seller by seller ID

This endpoint allows marketplace operators to update the information of sellers connected to their account. You can replace a path's value with another value in order to update that single information. There is no need to fill all the body params available, only the one you wish to update.

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

You can create a custom role with that resource or use one of the following predefined roles:

Role	Resource
Seller manager	Save Seller

❗ 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.

patch/seller-register/pvt/sellers/{sellerId}

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

operationstring required

Action being performed, which should always be replace.

pathstring required

Path in which the value is being updated. It follows the standardized format /{field}, where {field} is the path's name.

valueboolean required

Value that is being updated. Notice that the type will depend on the path that is being updated.

Example request

[
  {
    "operation": "replace",
    "path": "/field"
  }
]

v50