{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/UpsertSellerRequest",
"title": "Configure Seller Account",
"required": [
"id",
"name",
"isActive",
"fulfillmentEndpoint",
"allowHybridPayments",
"taxCode",
"email",
"description",
"sellerCommissionConfiguration",
"isBetterScope",
"sellerType",
"availableSalesChannels",
"CSCIdentification",
"account",
"channel",
"salesChannel",
"isVtex",
"score",
"exchangeReturnPolicy",
"deliveryPolicy",
"securityPrivacyPolicy",
"fulfillmentSellerId",
"user",
"password",
"catalogSystemEndpoint",
"trustPolicy"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Seller ID assigned by the marketplace. We recommend filling it in with the seller's account name.",
"default": "seller123"
},
"name": {
"type": "string",
"description": "Name of the seller's store, configured in the seller's environment.",
"default": "Seller Name"
},
"isActive": {
"type": "boolean",
"description": "Whether the seller is active on the marketplace or not.",
"default": true
},
"fulfillmentEndpoint": {
"type": "string",
"description": "URL of the endpoint for fulfillment of seller's orders, which the marketplace will use to communicate with the seller. \n\nFor **external sellers**, please include the URL of the seller's endpoint. External sellers have different endpoint standards. The seller must inform this endpoint to the marketplace so that the marketplace can complete the configuration process. \n\nFor **VTEX Stores**, the field format will be as follows: `https://{SellerName}.vtexcommercestable.com.br/api/fulfillment?&sc={TradePolicyID}`. \n\nThe value `SellerName` corresponds to the store name if the seller is a VTEX store. \n\nThe value `TradePolicyID` corresponds to the [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV#master-data) created by the seller in their own VTEX environment. The seller must inform this ID to the marketplace so that the marketplace can complete the configuration process. \n\nThe value `AffiliateID` corresponds to the 3-digit affiliate identification code created by the seller. The seller must inform this ID to the marketplace so that the marketplace can complete the configuration process. \n\nTo configure the [Multilevel Omnichannel Inventory](https://developers.vtex.com/vtex-rest-api/docs/multilevel-omnichannel-inventory) feature, fill in this field with the checkout endpoint following this example: `https://{{sellerAccount}}.vtexcommercestable.com.br/api/checkout?affiliateid={{affiliateId}}&sc={{salesChannel`",
"default": "http://{SellerName}.vtexcommercestable.com.br/api/fulfillment?&sc={TradePolicyID}"
},
"allowHybridPayments": {
"type": "boolean",
"description": "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.",
"default": false
},
"taxCode": {
"type": "string",
"description": "This code is the Identity Number for the legal entity and is linked to information in its base country.",
"default": "34444"
},
"email": {
"type": "string",
"description": "email of the admin responsible for the seller.",
"default": "[email protected]"
},
"description": {
"type": "string",
"description": "String describing the seller",
"default": "Seller A, from the B industry."
},
"sellerCommissionConfiguration": {
"type": "object",
"items": {
"$ref": "#/components/schemas/SellerCommissionConfiguration"
}
},
"isBetterScope": {
"type": "boolean",
"description": "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.",
"default": true
},
"sellerType": {
"type": "integer",
"description": "Type of seller, including: \n\n`1`: regular seller \n\n`2`: whitelabel seller",
"default": 1
},
"availableSalesChannels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableSalesChannel"
},
"description": "Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV#master-data)) available.",
"default": []
},
"CSCIdentification": {
"type": "string",
"description": "SKU Seller Identification",
"default": "cscidentification 123"
},
"account": {
"type": "string",
"description": "Seller's account name",
"default": "partner01"
},
"channel": {
"type": "string",
"description": "Channel's name.",
"default": "channel name"
},
"salesChannel": {
"type": "string",
"description": "Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated to the seller account created. If no value is specified, the system will automatically use the sales channel configured in the seller's [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) ID.",
"default": "1"
},
"isVtex": {
"type": "boolean",
"description": "Flag determining whether the seller configured is a VTEX store or not.",
"default": true
},
"exchangeReturnPolicy": {
"type": "string",
"description": "Text describing the exchange and return policy previously agreed between the marketplace and the seller.",
"default": "Describe exchange and returns policy"
},
"deliveryPolicy": {
"type": "string",
"description": "Text describing the delivery policy previously agreed between the marketplace and the seller.",
"default": "Describe delivery policy"
},
"securityPrivacyPolicy": {
"type": "string",
"nullable": true,
"description": " Text describing the security policy previously agreed between the marketplace and the seller.",
"default": "Describe privacy and security policy"
},
"fulfillmentSellerId": {
"type": "string",
"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 nulled.",
"default": "seller1"
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Groups"
},
"description": "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](https://developers.vtex.com/vtex-rest-api/reference/sellers#putupsertseller) endpoint. It is possible to filter sellers by group in the Seller Management page in your VTEX Admin. Know more about groups through our [Seller Management](https://help.vtex.com/en/tutorial/gerenciamento-de-sellers-beta--6eEiOISwxuAWJ8w6MtK7iv#groups) documentation."
},
"user": {
"type": "string",
"title": "user",
"description": "Username, if you are using a hub to integrate with the external seller.",
"default": "integrationHubUserName",
"nullable": true
},
"password": {
"type": "string",
"title": "password",
"description": "User password, if you are using a hub to integrate with the external seller.",
"default": "integrationHubPassword",
"nullable": true
},
"catalogSystemEndpoint": {
"type": "string",
"title": "Catalog System Endpoint schema",
"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: `https://{sellerName}.vtexcommercestable.com.br/api/catalog_system/.`",
"default": "https://pedrostore.vtexcommercestable.com.br/api/catalog_system/"
},
"trustPolicy": {
"type": "string",
"title": "Trust Policy",
"description": " the marketplace must first allow VTEX to share clients\u2019 email addresses with the seller. To do so, it is necessary to set 'AllowEmailSharing' as the value for the TrustPolicy field",
"default": "AllowEmailSharing"
},
"score": {
"type": "number",
"title": "Score",
"description": "Score attributed to this seller.",
"default": 0
}
},
"example": {
"id": "testeMARCUS123",
"name": "qamarketplace",
"isActive": true,
"fulfillmentEndpoint": "http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=parceiro01",
"allowHybridPayments": false,
"trustPolicy": "AllowEmailSharing",
"user": "integrationHubUserName",
"password": "integrationHubPassword",
"taxCode": "34444",
"email": "[email protected]",
"description": "Seller A, from the B industry.",
"sellerCommissionConfiguration": {
"productCommissionPercentage": 3,
"freightCommissionPercentage": 4,
"categoriesCommissionConfiguration": []
},
"isBetterScope": false,
"sellerType": 1,
"availableSalesChannels": [
{
"isSelected": true,
"id": 1,
"name": "Loja Principal"
},
{
"isSelected": true,
"id": 2,
"name": "Terceira"
},
{
"isSelected": true,
"id": 3,
"name": "Marketplaces"
}
],
"CSCIdentification": "SampleCSCIdentification123",
"account": "parceiro01",
"channel": "SampleChannel",
"salesChannel": "SampleSalesChannel",
"isVtex": true,
"score": 0,
"exchangeReturnPolicy": "1",
"deliveryPolicy": "3",
"securityPrivacyPolicy": null,
"catalogSystemEndpoint": "https://pedrostore.vtexcommercestable.com.br/api/catalog_system/",
"fulfillmentSellerId": "seller1",
"groups": [
{
"groups": [
{
"id": "8d845239bf1448dc8bc3ed3121837511",
"name": "long tail"
},
{
"id": "b9bcd348ab9c4cec8285ff9485c27a72",
"name": "franchise accounts"
}
]
}
]
}
}