API Reference

Integration Guides
Back office integration guide (ERP/PIM/WMS)
Set up order processing

In this step, you will send order updates from your ERP or WMS to VTEX.

Before you start

When an order is processed in an external fulfillment platform such as an ERP or WMS, it's not enough to set up order integration. VTEX should also receive order updates when applicable.

During handling an order can be changed, cancelled or invoiced. These events should be notified as illustrated in the diagram below.

{"base64":"  ","img":{"width":477,"height":745,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":54842,"url":""}}

If your freight carrier is integrated with VTEX, all you need to do is inform its identifier and tracking number when invoicing the order and order tracking information will be set up. Otherwise you should add the order tracking updates you want customers to see separately, as seen in the diagram below.

{"base64":"  ","img":{"width":383,"height":416,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":36461,"url":""}}

Change order

Changing items is a feature that allows your store to modify the items or prices of an order. With this feature, the store can handle eventual changes in orders motivated by customer mistakes, product unavailability, and the inclusion of discounts, among other things. Learn more about how it works and its restrictions in the article Changing items from a completed order.

Check this Change order guide to learn how you can implement this feature to your integration.

Change seller

If your store is a marketplace, your integration must also be prepared to change which seller is assigned to fulfill a given order. Learn more about the circumstances and limitations of this type of process in the article How to use the Change Seller feature.

To learn how to implement this in your integration, check the Change seller integration guide.

Cancel order

The Cancel order endpoint in the Orders API allows you to cancel an order. Optionally, you can add more information by creating a note in the order timeline using the Create note endpoint in the VTEX DO API.

The order cancellation can be confirmed through the orders feed.

Keep in mind that the OMS order flow does not allow an order to be cancelled after it has been invoiced and that order cancellations cannot be reversed.

Invoice order

The Order Invoice Notification endpoint in the Orders API allows you to notify VTEX that you are ready to ship the order and add invoice information to the order.

Note that invoice information includes tracking number and URL. However this is not required to send the invoice to VTEX. It may be added later.

Order tracking

Order tracking information is directly related to an order's invoice. An order's tracking number and URL may be sent to VTEX when first invoicing an order, or later, with the Update order's partial invoice API request.

Tracking messages

Once an order was invoiced and has their tracking number and URL, if the designated carrier is integrated with VTEX, VTEX can log tracking messages and send them to your customers. If your freight carrier is not integrated with VTEX, you should add the tracking messages using the Update order tracking status endpoint of the Orders API.

Wrapping up

If you have done things correctly, you should have set up order processing. This includes sending notifications to VTEX when orders are changed, cancelled or invoiced, as well as when tracking updates are available from non-integrated freight carriers.

Photo of the contributor
+ 1 contributors
Was this helpful?
Suggest edits (Github)
Photo of the contributor
+ 1 contributors
On this page