Which methods can be used on VTEX API to integrate on our WMS?


I am reaching out from Logiwa, a WMS software company located in the US.

I am trying to analyze VTEX API in order to learn if it complies with our requirements for our customers using VTEX software. I have read the documents located at developer documents section of the help. But there are some confusions I still have and would like to make sure we can integrate smoothly.

The services we require are:

  • Getting sales orders from VTEX
  • Confirming shipments of sales orders to VTEX
  • Stock adjustments sent to VTEX

Are these all possible with VTEX API, and could you please direct me to those methods, at least to their names.

Thanks in advance.

Toda documenta├ž├úo necess├írio se encontra aqui, tanto para o m├│dulo de log├şstica quanto para o fluxo de um pedido:


Hi @Egemen Sava┼č T├╝fek├žilerÔÇő

  • Getting sales orders from VTEX

In order to get details from a specific order, you should use Get Order (https://documenter.getpostman.com/view/487146/vtex-orders-api/6tjSKqi#43524211-bbed-4f80-9a9b-d96b32347f0a). In case you need to retrieve a list of orders, you may use this one: List Orders https://documenter.getpostman.com/view/487146/vtex-orders-api/6tjSKqi#209cb0dd-4877-4db8-a372-95173f49be07

  • Confirming shipments of sales orders to VTEX

These information will also be available within the same methods described above. Inside the Order JSON, there'll be a specific section for shipping information, which you can use to extract this information. Note that it's posible to use a filter "By Status and Situations" in the List Orders. That means you can look for only the orders that have reached a certain status. The last one is Invoiced, by this time the shippment has already been processed. Note that the method Invoice has logistics info as well: https://documenter.getpostman.com/view/487146/vtex-orders-api/6tjSKqi#102391a1-346d-4fa8-91fe-b11706922a77. That means, when creating an invoice, the seller also sends this information, such as an UPS tracking code, for example.

  • Stock adjustments sent to VTEX

The method used to update inventory information is this: https://documenter.getpostman.com/view/3848/vtex-logistics-api/Hs42#2e41254e-0d48-fcb0-c849-4a76c6ebf390. These other GET methods can be used to retrieve actual data: https://i.imgur.com/Crjfe08.png

If you have further questions, please let us know.