--- title: "Configure seller account" method: POST path: "/seller-register/pvt/sellers" tags: ["Sellers"] --- # Configure seller account `POST /seller-register/pvt/sellers` This endpoint is used by marketplace operators to configure the accounts of sellers that have already accepted the invitation to join their marketplaces. For marketplaces to [add sellers](https://help.vtex.com/en/tutorial/adding-a-seller--tutorials_392) without the [Seller Invite](https://help.vtex.com/en/tutorial/marketplace-invited-sellers--6rb2FkcslmDueJ689Ulb9A) feature, call this endpoint directly. This call includes all the information a seller needs to activate their account. ## Permissions Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint: | **Product** | **Category** | **Resource** | | --------------- | ----------------- | ----------------- | | Seller Register | Seller Administration | **Save Seller** | You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy): | **Role** | **Resource** | | --------------- | ----------------- | | Seller manager | Save Seller | >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). ## Path parameters - `accountName` string, required - `environment` string, required ## Headers - `Accept` string, required - `Content-Type` string, required ## Request body - UpsertSellerRequest — Request to configure or update a seller account. This includes all necessary details for setting up the seller's account, such as ID, name, status, fulfillment settings, payment options, tax information, contact details, commission configuration, policies, and authentication information. - `id` string, required — Seller ID assigned by the marketplace. We recommend filling it in with the seller's account name. - `name` string, required — Name of the seller's store, configured in the seller's environment. - `isActive` boolean, required — Whether the seller is active on the marketplace or not. - `fulfillmentEndpoint` string, required — URL of the endpoint for fulfillment of seller's orders, which the marketplace will use to communicate with the seller. For **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. For **VTEX Stores**, the field format will be as follows: `https://{SellerName}.vtexcommercestable.com.br/api/fulfillment?&sc={TradePolicyID}`. The value `SellerName` corresponds to the store name if the seller is a VTEX store. The 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. The 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. To 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}}`. - `allowHybridPayments` boolean, required — Indicates if customers can use gift cards from the seller to buy their products on the marketplace (`true`) or not (`false`). If true, it identifies purchases made with a gift card so that only the final price (with discounts applied) is paid to the seller. - `taxCode` string, required — Identity number of the legal entity, which is linked to information in its base country. - `email` string, required — Email of the administrative user responsible for the seller. - `description` string, required — Description of the seller. - `sellerCommissionConfiguration` object, required — Details of the seller's commission configuration, including the product commission percentage, freight commission percentage, and categories commission configuration. - `isBetterScope` boolean, required — 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` integer, required — Type of seller, including: `1`: Regular seller `2`: White label seller. - `availableSalesChannels` AvailableSalesChannel[], required — Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) available. - `isSelected` boolean, required — Defines if the sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) is selected or not. - `id` integer, required — Trade policy ID. - `name` string, required — Name of the trade policy. - `CSCIdentification` string, required — SKU Seller Identification. - `account` string, required — Seller's account name. - `channel` string, required — Channel's name. - `salesChannel` string, required — 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. - `isVtex` boolean, required — Indicates whether the seller configured is a VTEX store or not. - `exchangeReturnPolicy` string, required — Text describing the exchange and return policy previously agreed between the marketplace and the seller. - `deliveryPolicy` string, required — Text describing the delivery policy previously agreed between the marketplace and the seller. - `securityPrivacyPolicy` string, nullable, required — Text describing the security policy previously agreed between the marketplace and the seller. - `fulfillmentSellerId` string, nullable, required — 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` Groups[] — Array of groups attached to the seller. Groups are defined by keywords that group sellers into categories defined by the marketplace when adding a new seller through the [Configure Seller Account](https://developers.vtex.com/docs/api-reference/marketplace-apis?endpoint=post-/seller-register/pvt/sellers) endpoint. It is possible to filter sellers by group in the Seller Management page in your VTEX Admin. Learn more about groups through our [Seller Management](https://help.vtex.com/en/tutorial/seller-management--6eEiOISwxuAWJ8w6MtK7iv#groups) documentation. - `id` string — Group's unique identifier code. - `name` string — Name of the tag chosen to identify the group. - `user` string, nullable, required — Username, if you are using a hub to integrate with the external seller. - `password` string, nullable, required — User password, if you are using a hub to integrate with the external seller. - `catalogSystemEndpoint` string, required — 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, required — Specifies the trust policy agreed between the marketplace and the seller, such as permissions related to data sharing. - `score` number, required — Score attributed to this seller. ## Response `200` OK --- [API](https://skmtc.net/vtex/apis/marketplace-api.md) · [All operations](https://skmtc.net/vtex/apis/marketplace-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/marketplace-api/revisions/27e83b4cc9ac/schema)