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.

Request body can have one of the following properties:

Attribute

Type

Description

id

string

Seller ID assigned by the marketplace.

name

string

Name of the seller's store, configured in the seller's environment.

isActive

boolean

Whether the seller is active on the marketplace or not.

fulfillmentEndpoint

string

URL of the endpoint for fulfillment of seller's orders, which the marketplace will use to communicate with the seller.

allowHybridPayments

boolean

Flag that allows customers to use gift cards from the seller to buy their products on the marketplace. It identifies purchases made with a gift card so that only the final price (with discounts applied) is paid to the seller.

taxCode

string

This code is the Identity Number for the legal entity and is linked to information in its base country.

email

string

Email of the admin responsible for the seller.

description

string

String describing the seller.

isBetterScope

boolean

Flag used by the VTEX Checkout to simmulate shopping carts, products and shipping only in sellers with the boolean set as true, avoiding performance issues.

sellerType

int32

Type of seller, including:

1: regular seller

2: whitelabel seller

availableSalesChannels

array of objects

Sales channel (or trade policy) available.

CSCIdentification

string

SKU Seller Identification.

account

string

Seller's account name.

channel

string

Channel's name.

salesChannel

string

Sales channel (or trade policy) associated to the seller account created.

isVtex

boolean

Flag determining whether the seller configured is a VTEX store or not.

exchangeReturnPolicy

string

Text describing the exchange and return policy previously agreed between the marketplace and the seller.

deliveryPolicy

string

Text describing the delivery policy previously agreed between the marketplace and the seller.

securityPrivacyPolicy

string

Text describing the security policy previously agreed between the marketplace and the seller.

fulfillmentSellerId

string

Identification code of the seller responsible for fulfilling the order. This is an optional field used when a seller sells SKUs from another seller. If the seller sells their own SKUs, it must be nulled.

groups

array of objects

Array of groups attached to the seller. Groups are defined by key-words that group sellers into categories defined by the marketplace when adding a new seller through the Configure Seller Account endpoint.

user

string

Username, if you are using a hub to integrate with the external seller.

password

string

User password, if you are using a hub to integrate with the external seller.

catalogSystemEndpoint

string

URL of the endpoint of the seller's catalog. This field will only be displayed if the seller type is VTEX Store. The field format will be as follows: https://{sellerName}.vtexcommercestable.com.br/api/catalog_system/.

trustPolicy

string

The marketplace must first allow VTEX to share clients’ email addresses with the seller. To do so, it is necessary to set 'AllowEmailSharing' as the value for the TrustPolicy field.

integration

string

If the integration is made by VTEX (internal-default), or an external hub.

score

number

Score attributed to this seller.

offers

object

Offers sent by external sellers that are still waiting the marketplace's approval through the Match Received SKUs endpoint.

Request body examples:

[
    {
        "operation": "replace",
        "path": "/isBetterScope",
        "value": true
    }
]
[
    {
        "operation": "replace",
        "path": "/availableSalesChannels",
        "value": [
            {
                "id": 1
            },
            {
                "id": 2
            }
        ]
    }
]
Language
Authentication
Click Try It! to start a request and see the response here!