VTEX · Schema

UpsertMappingRequest

Request to upsert a mapping between a marketplace's sales channel and a seller's affiliate.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
marketplaceSalesChannel integer The sales channel of the marketplace to be associated with the seller's affiliate. It is linked to the seller's affiliate.
sellerChannel string The affiliate of the seller that will be associated with the marketplace's sales channel. Through the affiliate, the seller determines which of his sales channels will be used for the mapping.
View JSON Schema on GitHub

JSON Schema

vtex-upsertmappingrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpsertMappingRequest",
  "title": "UpsertMappingRequest",
  "description": "Request to upsert a mapping between a marketplace's sales channel and a seller's affiliate.",
  "required": [
    "marketplaceSalesChannel",
    "sellerChannel"
  ],
  "type": "object",
  "properties": {
    "marketplaceSalesChannel": {
      "type": "integer",
      "description": "The sales channel of the marketplace to be associated with the seller's affiliate. It is linked to the seller's affiliate.",
      "example": 1
    },
    "sellerChannel": {
      "type": "string",
      "description": "The affiliate of the seller that will be associated with the marketplace's sales channel. Through the affiliate, the seller determines which of his sales channels will be used for the mapping.",
      "example": "GCB"
    }
  },
  "example": {
    "marketplaceSalesChannel": 1,
    "sellerChannel": "GCB"
  }
}