API Reference

Integration Guides
External Marketplace
Product and Category Mappings

This section of the integration guide goes over which mappings are necessary to maintain the connection between the VTEX platform and the marketplace. It includes mappings for Catalog and mappings for Orders.

Product Mapping

Usually marketplaces offer a unique ID that identifies an SKU within its storefront. This ID enables SKU consultation, updates, blocking and exclusion operations.

When this ID differs from the code that identifies the SKU within VTEX, the connector must offer a mechanism/repository that allows the mapping of these IDs.

It is important to implement a routine that allows the cleaning of this mapping in case the SKU is blocked or excluded in VTEX.

In case the marketplace’s ID is the same used in VTEX, this action is not necessary.

Category Mapping

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.

VTEX Mapper

To use the category mapping service, follow the steps below, that will be further explored in the items that follow:

API Reference

Register the connector in VTEX Mapper

After obtaining the access keys to operate a VTEX account, the diagram below illustrates the necessary steps to register the connector in VTEX Mapper.

{"base64":"  ","img":{"width":5262,"height":2267,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":238113,"url":""}}

  1. Use the Mapper Registration endpoint.
  2. In case the registration is successful, VTEX Mapper returns a unique ID and endpoint to the connector.
  3. Store the ID returned, to be later used in the category tree update action, in VTEX Matcher.

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?

Send category tree to VTEX Mapper

To send the marketplace’s category tree to VTEX Mapper, follow the steps illustrated in this diagram:

{"base64":"  ","img":{"width":5262,"height":1442,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":213559,"url":""}}

  1. Collect marketplace category tree.
  2. Check if the category tree doesn’t already exist in its repository. a. If it is not mapped, store the category tree and the last update’s date. b. If it is mapped, check if the category tree has updates. If there are updates, send the full tree to the mapper (step 3). If there are no updates, update the tree’s date, and log informing the tree is updated.
  3. Assemble the full category tree schema, following the JSON example below.
  4. Send the category tree through the Send Category Mapping to VTEX Mapper endpoint. Connectors should send the payload compacted in .gzip format.
  5. If VTEX Mapper receives the category tree successfully, the call’s response will be a 204. Connectors should log the response offered by the Mapper.

Category tree processing is asynchronous. Once processing is complete, the Mapper will send the connector the confirmation of creation through the endpoint defined in the property connectorEndpoint during the integration’s registration in VTEX Mapper.

Receive the category mapping in VTEX Mapper

VTEX Mapper will send the updated category mapping through the endpoint defined in the property mappingEndpoint during the Mapper app’s registration.

Once receiving the category tree, the connector should store it. This data will be used during the catalog integration flow. Once receiving a notification from VTEX to integrate a product, connectors verify if the VTEX category ID sent from the catalog exists in the mapping sent by the mapper.

Use the category mapping in the product registration flow

When receiving a VTEX notification to register an SKU in the marketplace, connectors should:

  1. Get SKU information through the {stockKeepUnit/skuId} property.
  2. Collect value of categoryId property, from the call’s response.
  3. Verify if the ID exists in the mapping previously sent by VTEX Mapper. a. If the ID exists, collect the corresponding value in the marketplace. b. If the ID does not exist, generate a log informing the seller that they should perform the category mapping in VTEX.
  4. With the corresponding ID, register the SKU in the marketplace, following the steps described in the How to get a new product to offer in the marketplace section.
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 3 contributors
Was this helpful?
Suggest edits (Github)
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 3 contributors
On this page