Get Seller by ID

Retrieves the seller's details by its ID.

🚧

New version of Sellers API

Check out the updated version of the Sellers' endpoints in our Marketplace API documentation. If you are doing this integration for the first time, we recommend that you follow the updated documentation.

Response object has the following properties:

AttributeTypeDescription
SellerIdintegerSeller ID
NamestringSeller Name
EmailstringE-mail from Seller Administrator
DescriptionstringSeller Description
ExchangeReturnPolicystringDetails about Seller Exchange Return Policy
DeliveryPolicystringDetails about Seller Delivery Policy
UseHybridPaymentOptionsbooleanIf will uses Hybrid Payment between Seller and Marketplace
UserNamestringUserName in case the integration isn't between VTEX stores
PasswordstringPassword in case the integration isn't between VTEX stores
SecutityPrivacyPolicystringDetails about Seller Security Privacy Policy
CNPJstringSeller Company Register Document
CSCIdentificationstringSeller Identification
ArchiveIdintegerImage ID
UrlLogostringSeller URL logo
CategorystringProduct Category
ProductCommissionPercentagedecimalProduct Comission Percentage
FreightCommissionPercentagedecimalFreight Comission Percentage
CategoryCommissionPercentagedecimalCategory Comission Percentage
FulfillmentEndpointstringURL of the endpoint for fulfillment of seller's orders, which the marketplace will use to communicate with the seller
CatalogSystemEndpointdecimalURL of the endpoint of the seller's catalog. This field will only be displayed if the seller type is VTEX Store
IsActivebooleanCondition if the seller is active or not
MerchantNamestring
FulfillmentSellerIdstringIdentification code of the seller responsible for fulfilling the order
SellerTypeintegerSeller type. Add 1 to a normal seller or 2 to a seller whitelabel
IsBetterScopebooleanField used by the Checkout to simulate items. Only sellers white label can have this field as true

Response body example:

{
    "SellerId": "externalseller",
    "Name": "External Seller",
    "Email": "[email protected]",
    "Description": "",
    "ExchangeReturnPolicy": "",
    "DeliveryPolicy": "",
    "UseHybridPaymentOptions": false,
    "UserName": "",
    "Password": "",
    "SecutityPrivacyPolicy": "",
    "CNPJ": "",
    "CSCIdentification": "",
    "ArchiveId": null,
    "UrlLogo": "",
    "ProductCommissionPercentage": 30.00,
    "FreightCommissionPercentage": 10.00,
    "CategoryCommissionPercentage": null,
    "FulfillmentEndpoint": "https://sellerendpoint.com/",
    "CatalogSystemEndpoint": null,
    "IsActive": true,
    "MerchantName": "",
    "FulfillmentSellerId": "",
    "SellerType": 1,
    "IsBetterScope": false
}
Language
Authentication
URL
Click Try It! to start a request and see the response here!