VTEX · Schema

GetSellersApprovalSettings

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
sellerId string A string that identifies the seller in the marketplace.
accountId string Marketplace’s account ID.
accountName string Marketplace’s account name.
mapping object SKU Mapping Information and Product [Specifications](https://developers.vtex.com/docs/guides/catalog-overview#configuring-initial-settings-mandatory). The properties included within `mapping` can chan
matchFlux string This field determines the type of [approval configuration applied to SKUs received from a seller](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configura
View JSON Schema on GitHub

JSON Schema

vtex-responsegetsellersapprovalsettings-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/responseGetSellersApprovalSettings",
  "title": "GetSellersApprovalSettings",
  "type": "object",
  "properties": {
    "sellerId": {
      "type": "string",
      "description": "A string that identifies the seller in the marketplace.",
      "example": "sellerexample"
    },
    "accountId": {
      "type": "string",
      "description": "Marketplace\u2019s account ID.",
      "example": "d74daf1f-355a-4463-bdc7-ae8b045311c"
    },
    "accountName": {
      "type": "string",
      "description": "Marketplace\u2019s account name.",
      "example": "marketplaceexample"
    },
    "mapping": {
      "type": "object",
      "default": {},
      "description": "SKU Mapping Information and Product [Specifications](https://developers.vtex.com/docs/guides/catalog-overview#configuring-initial-settings-mandatory).\n\n The properties included within `mapping` can change according to the product type, the `color` specification and its variations described in this example are just one of the possibilities. The values received in this call's payload for those properties depend on the seller's catalog architecture, and are not default. \n\nSee some examples of specifications: \n\n- Voltage \n\n- Power \n\n- Size \n\n- Height \n\n- Width",
      "properties": {
        "defaultColor": {
          "type": "string",
          "description": "The field will indicate the default color predefined by the seller in cases where specific product colors are not defined. This field is neither mandatory nor default, it will depend on the architecture of the seller's catalog. ",
          "example": "white /black"
        },
        "searchColor": {
          "type": "string",
          "description": "Field that provides the available colors to filter searches. This field is neither mandatory nor default, it will depend on the architecture of the seller's catalog.",
          "example": "color1, color2"
        },
        "color1": {
          "type": "string",
          "description": "`color1` available for search filter. This field is neither mandatory nor default, it will depend on the architecture of the seller's catalog.",
          "example": "black"
        },
        "color2": {
          "type": "string",
          "description": "`color2` available for search filter. This field is neither mandatory nor default, it will depend on the architecture of the seller's catalog.",
          "example": "white"
        },
        "color": {
          "type": "string",
          "description": "Indicates the predominant or main color of the product. This field is neither mandatory nor default, it will depend on the architecture of the seller's catalog.",
          "example": "black"
        },
        "size": {
          "type": "string",
          "description": "Indicates the size of the product.This field is neither mandatory nor default, it will depend on the architecture of the seller's catalog.",
          "example": "EUR44"
        }
      }
    },
    "matchFlux": {
      "type": "string",
      "description": "This field determines the type of [approval configuration applied to SKUs received from a seller](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions#put-/suggestions/configuration/seller/-sellerId-). \n\nThe possible values include:  \n\n-`default`, where the Matcher reviews the SKU, and approves it based on its score. \n\n-`manual`, for manual approvals through the Received SKU UI and Match API. \n\n-`autoApprove`, for every SKU received from a given seller to be approved automatically, regardless of the Matcher Score.",
      "example": "default"
    }
  }
}