Sign in

v1

latestOpenAPI 3.0.02026-07-141525155.4 KB
External Marketplace

Send Category Mapping to VTEX Mapper

Mapping categories guarantees that the VTEX category tree has a correct association with the marketplace’s category tree.

To perform this association, VTEX made VTEX Mapper available. It is a tool integrated to the VTEX platform that allows the user to relate categories created in VTEX to categories from the marketplace.

This endpoint allows connectors to send the marketplace's category tree mapped in the integration.

Connectors should send the payload compacted in .gzip format.

For a detailed explanation of the steps required to develop a custom connector to become an external marketplace for VTEX sellers, check out our complete External Marketplace Integration Guide.

post/portal.vtexcommercestable.com.br/api/mkp-category-mapper/categories/marketplace/{id}

Path parameters

idstring required

Code identifying returned in the VTEX Mapper Registration endpoint.

Headers

Content-Typestring required

Describes the type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

Example request

{
  "categories": [
    {
      "children": [
        {
          "specifications": [
            {
              "attributeName": "Color",
              "attributeValues": [
                {
                  "valueName": "Red"
                }
              ],
              "required": true
            }
          ]
        }
      ]
    }
  ]
}

Response

OK