Orders API

Each purchase a customer makes in your store generates an order on VTEX. With the Orders API, you can view orders statuses and manage multiple aspects involved in order fulfillment, such as financial transactions, invoicing, shipping, and subscriptions. You can also modify orders and make configurations to allow or forbid marketplaces and sellers to change or cancel orders.

Order integration

To automate actions related to order processing, you can integrate orders with systems like ERP (Enterprise Resource Planning) and WMS (Warehouse Management System) using Feed and Hook.

Orders API Index

Orders

• GET Get order
• GET Get orders by order group ID
• GET List orders
• POST Start handling order
• POST Cancel order
• POST Register modifications on order

Order modifications

• PATCH Create order modifications
• POST Preview order modifications
• GETGet order modifications details
• GETGet order modifications history
• GET Get order modifications summary
• POST Retry order modifications
• POSTCancel order modifications
• PUTUpdate Order modifications settings
• GET Get Order modifications settings

Invoice

• POST Order invoice notification
• PATCH Update order's partial invoice (send tracking number)

Tracking

• PUT Update order tracking status

Conversation

• GET Retrieve order conversation

Payment

• GET Retrieve payment transaction
• POST Send payment notification

Feed v2 (deprecated)

• GET Get feed order status

Feed v3

• GET Get feed configuration
• POST Create or update feed configuration
• DELETE Delete feed configuration
• GET Retrieve feed items
• POST Commit feed items
• POST Test JSONata expression

Order hook

• GET Get hook configuration
• POST Create or update hook configuration
• DELETE Delete hook configuration

User orders

• GET Retrieve user's orders
• GET Retrieve user order details

Change seller

• GET Get window to change seller
• POST Update window to change seller

Common parameters

Parameter name	Description	Type
{{accountName}}	Name of the VTEX account. Used as part of the URL.	Server variable.
{{environment}}	Environment to use. Used as part of the URL. The default value is vtexcommercestable.	Server variable.
X-VTEX-API-AppKey	Unique identifier of the API key.	Authentication header. Must be used together with X-VTEX-API-AppToken. Not necessary when using VtexIdclientAutCookie.
X-VTEX-API-AppToken	Secret token of the API key.	Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using VtexIdclientAutCookie.
VtexIdclientAutCookie	User token, valid for 24 hours.	Authentication header. Not necessary when using X-VTEX-API-AppKey and X-VTEX-API-AppToken.