Sign in

v1

latestOpenAPI 3.0.02026-07-141525155.4 KB
External Marketplace

VTEX Mapper Registration

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 register the external marketplace integration in VTEX Mapper.

In case VTEX Mapper detects an error and the call fails, the connector should check if mandatory information was sent correctly. Ex. are URLs correctly registered in the properties categoryTreeEndPoint and mappingEndPoint?

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/connector/register

Query parameters

anstring required
Example:accountName

Name of the VTEX account. Used as part of the URL.

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

CategoryTreeProcessingNotificationEndpointstring

The CategoryTreeProcessingNotificationEndpoint is optional, and should be an endpoint from the external marketplace, that will be notified after the marketplace's category tree is successfully processed or not.

categoryTreeEndPointstring required

Endpoint that returns categories and attributes according to VTEX Mapper specifications.

displayNamestring required

Marketplace Name, that will be displayed in VTEX Mapper.

mappingEndPointstring required

Secure endpoint that will receive the category mapping sent by VTEX Mapper.

propertiesobject required

Refers to the allowsRemap property.

Example request

{
  "CategoryTreeProcessingNotificationEndpoint": "https://CategoryTreeProcessingNotificationEndpoint.com/api",
  "categoryTreeEndPoint": "http://api.vtexinternal.com.br/api/{{marketplaceName}}/mapper/categories",
  "displayName": "Marketplace A",
  "mappingEndPoint": "http://api.vtexinternal.com.br/api/{{marketplaceName}}/mapper/mapping"
}

Response

OK