Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-29208421.4 MB
Seller

Get seller by ID

Retrieves the seller details by its ID.

Permissions

This endpoint does not require permissions.

get/api/catalog_system/pvt/seller/{sellerId}

Path parameters

sellerIdstring required
Example:pedrostore

ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the Sellers management section in the Admin to get the correct ID.

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.

Response

OK

SellerIdstring

Code used to identify the seller. It is assigned by the marketplace. We recommend filling it in with the seller's account name.

Namestring

Name of the account in the seller's environment. You can find it on Account settings > Account > Account Name). Applicable only if the seller uses their own payment method.

Emailstring

Email of the admin responsible for the seller.

Descriptionstring

Text describing the seller with a marketing tone. You can display this text in the marketplace window display by customizing the CMS.

ExchangeReturnPolicystring

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

DeliveryPolicystring

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

UseHybridPaymentOptionsboolean

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.

UserNamestring nullable

Seller username.

Passwordstring nullable

Seller password.

SecutityPrivacyPolicystring

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

CNPJstring

Company registration number.

CSCIdentificationstring

CSC identification.

ArchiveIdinteger nullable

Seller archive ID.

UrlLogostring

Seller URL logo.

ProductCommissionPercentagenumber

The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: 0.00.

FreightCommissionPercentagenumber

The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: 0.00.

CategoryCommissionPercentagestring

The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: 0.00.

FulfillmentEndpointstring nullable

URL of the endpoint for fulfillment of seller's orders, which the marketplace will use to communicate with the seller. This field applies to all sellers, regardless of their type. However, for VTEX Stores, you don't need to fill it in because the system will do that automatically. You can edit this field once the seller has been successfully added.

CatalogSystemEndpointstring

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: http://{sellerName}.vtexcommercestable.com.br/api/catalog_system/.

IsActiveboolean

If the selle is active (true) or not (false).

MerchantNamestring

Name of the marketplace, used to guide payments. This field should be nulled if the marketplace is responsible for processing payments. Check out our Split Payment article to know more.

FulfillmentSellerIdinteger nullable

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 left blank.

SellerTypeinteger

Seller type.

IsBetterScopeboolean

Indicates whether it is a comprehensive seller.

TrustPolicystring

Seller trust policy. The default value is 'Default', but if your store is a B2B marketplace and you want to share the customers'emails with the sellers you need to set this field as 'AllowEmailSharing'.