{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/UpdateSellerRequest",
"title": "UpdateSellerRequest",
"type": "object",
"required": [
"SellerId",
"Name",
"Email",
"Description",
"ExchangeReturnPolicy",
"DeliveryPolicy",
"UseHybridPaymentOptions",
"UserName",
"Password",
"SecutityPrivacyPolicy",
"CNPJ",
"CSCIdentification",
"ArchiveId",
"UrlLogo",
"ProductCommissionPercentage",
"FreightCommissionPercentage",
"FulfillmentEndpoint",
"CatalogSystemEndpoint",
"IsActive",
"FulfillmentSellerId",
"SellerType",
"IsBetterScope"
],
"properties": {
"SellerId": {
"type": "string",
"description": "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.",
"example": "pedrostore"
},
"Name": {
"type": "string",
"description": "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.",
"example": "My pedrostore"
},
"Email": {
"type": "string",
"description": "Email of the admin responsible for the seller.",
"example": "[email protected]"
},
"Description": {
"type": "string",
"description": "Text describing the seller with a marketing tone. You can display this text in the marketplace window display by [customizing the CMS](https://help.vtex.com/en/tutorial/list-of-controls-for-templates--tutorials_563).",
"example": "Brief description"
},
"ExchangeReturnPolicy": {
"type": "string",
"description": "Text describing the exchange and return policy previously agreed between the marketplace and the seller.",
"example": "Exchange return policy text"
},
"DeliveryPolicy": {
"type": "string",
"description": "Text describing the delivery policy previously agreed between the marketplace and the seller.",
"example": "Delivery policy text"
},
"UseHybridPaymentOptions": {
"type": "boolean",
"description": "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.",
"example": false
},
"UserName": {
"type": "string",
"description": "Seller username.",
"example": "myseller"
},
"Password": {
"type": "string",
"description": "Seller password.",
"example": "passoword"
},
"SecutityPrivacyPolicy": {
"type": "string",
"description": "Text describing the security policy previously agreed between the marketplace and the seller.",
"example": "Secutity privacy policy text"
},
"CNPJ": {
"type": "string",
"description": "Company registration number.",
"example": "12035072751"
},
"CSCIdentification": {
"type": "string",
"description": "CSC identification.",
"example": "pedrostore"
},
"ArchiveId": {
"type": "integer",
"description": "Seller archive ID.",
"example": 1
},
"UrlLogo": {
"type": "string",
"description": "Seller URL logo.",
"example": "/myseller"
},
"ProductCommissionPercentage": {
"type": "number",
"description": "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`.",
"example": 0.0
},
"FreightCommissionPercentage": {
"type": "number",
"description": "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`.",
"example": 0.0
},
"CategoryCommissionPercentage": {
"type": "string",
"description": "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`.",
"example": "[{\"CategoryId\":14,\"ProductCommission\":15.0,\"FreightCommission\":0.0}]"
},
"FulfillmentEndpoint": {
"type": "string",
"description": "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.",
"example": "http://pedrostore.vtexcommercestable.com.br/api/fulfillment?affiliateid=LDB&sc=1"
},
"CatalogSystemEndpoint": {
"type": "string",
"description": "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/`.",
"example": "http://pedrostore.vtexcommercestable.com.br/api/catalog_system/"
},
"IsActive": {
"type": "boolean",
"description": "If the selle is active (`true`) or not (`false`).",
"example": true
},
"MerchantName": {
"type": "string",
"description": "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](https://help.vtex.com/en/tutorial/split-payment--6k5JidhYRUxileNolY2VLx) article to know more.",
"example": "pedrostore"
},
"FulfillmentSellerId": {
"type": "integer",
"description": "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.",
"example": 1
},
"SellerType": {
"type": "integer",
"description": "Seller type.",
"example": 1
},
"IsBetterScope": {
"type": "boolean",
"description": "Indicates whether it is a [comprehensive seller](https://help.vtex.com/en/tutorial/comprehensive-seller--5Qn4O2GpjUIzWTPpvLUfkI).",
"example": false
},
"TrustPolicy": {
"type": "string",
"description": "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'`.",
"example": "Default"
}
}
}