Menu
Feedback
Start here
Tutorials
Developer portal

Known Issues
Support Rules
Troubleshooting

Frequently Asked Questions
Announcements
News
Announcements
The 'items' field will be removed from the List Orders API
Photo of the author
PedroAntunesCosta
Published on 10/4/2018
Last update on 12/31/2019

On October 12, we will remove the items field from the List Orders API.

List Orders API request: http://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders

If your store uses the List Orders API and your integration mapping is expected to receive the items field, your development team needs to remove it from the integration mapping.

The items field of the List Orders API has already been stale for quite some time. It does not have any use today, and so your store should not consider it in your integrations. To get order items, you should be using the Feed API .

It is important to remember that the List Orders API remains working normally. Only the items field will be deleted.

Why are we doing this?

Removing this field will greatly increase the stability and performance of the orders indexer.

That is why it's crucial to remove it from integration.

Attention: This change only impacts integrations that depend on the delivery of the items field through the List Orders API.

This change does not affect the Get Orders API. In it, the items field continues to exist and keeps being normally updated.

Get Order API request: http://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/{{orderId}}


  • What will happen: We will remove the items field from the List Orders API.
  • When: October 12, 2018.
  • Why: To improve the stability and performance of order indexing.
  • What you need to do: If your store depends on the items field returned by the List Orders API (and in such case only), your development team needs to remove the items field from the integration mapping.
Was this helpful?
Yes
No
Suggest Edits (GitHub)
On this page
Still got questions?
Ask the community
Find solutions and share ideas in the VTEX community.
Join our community
Request support from VTEX
For personalized assistance, contact our experts.
Open a support ticket
GithubDeveloper portalCommunityFeedback