Order logs

Connectors should present the logs that follow, considering their status:

Status Description
Success Occurs when the exchange of messages between VTEX, connector and marketplace flow successfully.
Error Occurs when the exchange of messages between VTEX, connector and marketplace present errors due to communication (500) or business errors (400). Recommendations: for 500 errors, it is highly recommended to use the contingency flow through the reprocessing queue with at least 10 attempts. After the attempt number is exceeded, we recommend using a DEADLETTER queue for infinite retrials.
Alert Occurs when the exchange of messages between VTEX, connector and marketplace are able to process, but with a needed action from one of the systems involved.
Pending Occurs when the exchange of messages between VTEX, connector and marketplace are in progress. Ex. SKUs are still in the connector’s processing queue, or waiting an async response from the marketplace.

Content of the messages

The messages contained in logs should follow the standard defined below, allowing the user who operates VTEX platform and catalog to understand the situation:

  1. Operation ID (id): allows to identify the unique log in any sort of operation.
  2. Operation: identifies if an operation is a Catalog change, Offer creation, Price update, Inventory update, Order status update, Invoice sending, Tracking code sending.
  3. Direction: allows to identify the origin and destination of the information. Ex. VTEX to Marketplace.
  4. Content Source: payload sent by the origin solution. Ex. Order’s json, connected from the marketplace, allowing to identify the original message sent by the origin app.
  5. Content Translated: message generated by the connector with transformations, filers and enrichments needed, allowing sellers to understand the actions executed.
  6. Content destination: original payload sent by the destination software after processing trial.
  7. Business message: in case of errors, message explaining the error under the business contexto, with guidance on how to solve the problem.
  8. Status: should include the statuses of success, error, warning and pending.

Log messages

Each step of the catalog integration requires a specific set of Log messages. The table describes all messages, for each scenario within the integration.

Code Event User message Error status Response
A When integrating the order successfully in VTEX The order {{marketplaceOrderId}} was created in VTEX successfully under the ID {{vtexOrderId}}. Link to the order within VTEX. Success 201
B When sending the SKU register to the marketplace The standard rule with 0-100% manual approval was created successfully. To view or change this rule click [here] (https://accountname.myvtex.com/admin/order-auth) Success 201
C When sending the cancel order request The order {vtexOrderId} has been cancelled successfully. Success 201
D When using the Fulfillment simulation API, the SKU is not retrieved in the `items` object. Oops, we couldn’t obtain the information of SKU {{skuId}}. Please check if the items below are configured correctly in the VTEX platform.
  1. In product registration, check if it is associated with the trade policy.
  2. In fulfillment simulation, check if the carrier attending the SKU exists.
  3. In price configuration, check if there’s a price associated with the trade policy.
Warning 400
E When trying to send the Cancel Order request and receiving failure for multiple requests Oops, we could not cancel the order right now, due to the high volume of requests we’re receiving. We’ll try again later. If you prefer, you can cancel the order directly in VTEX. Alert 400
F When checking if the SKU is inactive \ \ Oops, the SKU is inactive in VTEX. We recommend that you check:
  1. In Catalog, identify the SKU and check if the field “Activate SKU” is checked.
  2. In Catalog, check if the image is uploaded.
  3. In fulfillment simulation, check if the carrier attending the SKU exists.
  4. On price configuration, check if there’s a price associated with the trade policy.
Warning 400
G When trying to cancel an order that has already been manually cancelled in VTEX The order {vtexOrderId} has already been cancelled in VTEX. Error 500
H When receiving an error about divergences Oops, we couldn’t find the values needed for order placement, with standard values accepted by the marketplace. {{list containing FIELD and VALUE attributed}} Warning 200
I When transforming Order data to the format demanded by the marketplace. Oops, we couldn't prepare the SKU registration in the marketplace due to {{list all errors occurred during data transformation, and in case any data infringes marketplace rules}}.

(Connectors should list all errors at once, so the user knows all actions needed to send the SKU).

Error 400
J Error when trying to create price divergence standard rule Oops, we were not able to create the standard price divergence rule. Please try again later. Error 400
K When trying to cancel an order with invalid credentials Oops, we were not able to communicate with VTEX to cancel the Order. Please check if your integration’s settings are correct.
L When trying to communicate with the marketplace API used to register the product Oops, the product registration in the {name} marketplace is unavailable right now. Don’t worry - we’ll try again in a few minutes. In case the problem persists, get in touch with the marketplace. Error 500
M When trying to cancel an order that has not been integrated in VTEX Oops, the order {vtexOrderId} has not been integrated in VTEX yet. We’ll try again later.
N When sending the product registration to the marketplace, and obtaining failure for sending incorrect data. Oops, we couldn't prepare the SKU registration in the marketplace due to {list all errors occurred during data transformation, and in case any data infringes marketplace rules}.

(Connectors should list all errors at once, so the user knows all actions needed to send the SKU).

Error 400
O When trying to collect the category or attribute mapping from the VTEX Mapper. Oops, we couldn’t find the category {name of the category} mapping of the {SKU name + ID} SKU in the marketplace. Please access the link below to perform this mapping. {Link indicating the store’s mapper}. Error 400
P When trying to communicate with the mapping API from the mapper. Oops, the VTEX category mapping is unavailable right now. Don’t worry - we’ll try again in a few minutes. In case the problem persists, get in touch with support. Error 500
Q When trying to reprocess an order that is already canceled in the marketplace due to inventory error Oops, we couldn’t reprocess the order {{orderId}} of the {{marketplaceName}}, since this order was cancelled manually in the marketplace. Error 400

Did this page help you?