List orders

Retrieves a list of orders according to the filters described below.

This endpoint returns masked order data.

This should not be used for integrations. Use the orders Feed or hook for this purpose.

This endpoint returns only orders that already have been indexed, which takes aproximately four minutes. Because of this, the data retrieved may present inconsistencies. To get live up to date information and build order integrations use the orders Feed or hook.

Check the new Orders onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey.

Do not use request for integrations

This endpoint returns only orders that already have been indexed, which takes aproximately four minutes. Because of this, the data retrieved may present inconsistencies or become unavailable in periods of peak order volume. In other words, order integrations built with the List orders endpoint are not reliable and will not be supported. To get live up to date information and build order integrations use the orders Feed or hook.

Throtling

Each account can make up to 5000 requests per minute.

Request parameters allowed

Sorting Examples

CreationDate:

`/api/oms/pvt/orders?orderBy=creationDate,desc`

OrderID:

`/api/oms/pvt/orders?orderBy=orderId,desc`

Items:

`/api/oms/pvt/orders?orderBy=items,asc`

TotalValue:

`/api/oms/pvt/orders?orderBy=totalValue,desc`

Origin:

`/api/oms/pvt/orders?orderBy=origin,asc`

Pagination Examples:

`/api/oms/pvt/orders?page=3`

Quantity per Page Examples:

`/api/oms/pvt/orders?per_page=15`

<div class="alert alert-info">Pagination Limit: The limit of pages that can be requested is 30. </div>

Time zone query

Time Zone Example:

`/api/oms/pvt/orders?utc=-0200`

Request filters

Fulltext

The + caracter isn't allowed in Fulltext Search

Fulltext filter Examples:

OrderID:

`/api/oms/pvt/orders?q=v212333lux-02`

Email:

`/api/oms/pvt/orders?q=rodrigo.cunha@vtex.com`

Document:

`/api/oms/pvt/orders?q=21133355524`

ClientName:

`/api/oms/pvt/orders?q=Cunha`

Shipping Estimate

Shipping Estimate filter Examples:

Next 7 days:

`/api/oms/pvt/orders?f_shippingEstimate=7.days`

Tomorrow:

`/api/oms/pvt/orders?f_shippingEstimate=1.days`

Today:

`/api/oms/pvt/orders?f_shippingEstimate=0.days`

Late:

`/api/oms/pvt/orders?f_shippingEstimate=-1.days`

Invoiced Date

Invoiced Date filter Examples:

1 Day:

`/api/oms/pvt/orders?f_invoicedDate=invoicedDate:[2017-01-01T02:00:00.000Z TO 2017-01-02T01:59:59.999Z]`

1 Month:

`/api/oms/pvt/orders?f_invoicedDate=invoicedDate:[2017-01-01T02:00:00.000Z TO 2017-02-01T01:59:59.999Z]`

1 Year:

`/api/oms/pvt/orders?f_invoicedDate=invoicedDate:[2016-01-01T02:00:00.000Z TO 2017-01-01T01:59:59.999Z]`

Order Date

Order Date filter Examples:

1 Day:

`/api/oms/pvt/orders?f_creationDate=creationDate:[2017-01-01T02:00:00.000Z TO 2017-01-02T01:59:59.999Z]`

1 Month:

`/api/oms/pvt/orders?f_creationDate=creationDate:[2017-01-01T02:00:00.000Z TO 2017-02-01T01:59:59.999Z]`

1 Year:

`/api/oms/pvt/orders?f_creationDate=creationDate:[2016-01-01T02:00:00.000Z TO 2017-01-01T01:59:59.999Z]`

Authorized Date

Authorized Date filter Examples:

1 Day:

`/api/oms/pvt/orders?f_authorizedDate=authorizedDate:[2017-01-01T02:00:00.000Z TO 2017-01-02T01:59:59.999Z]`

1 Month:

`/api/oms/pvt/orders?f_authorizedDate=authorizedDate:[2017-01-01T02:00:00.000Z TO 2017-02-01T01:59:59.999Z]`

1 Year:

`/api/oms/pvt/orders?f_authorizedDate=authorizedDate:[2016-01-01T02:00:00.000Z TO 2017-01-01T01:59:59.999Z]`

UTMs

Channels filter Examples:

`/api/oms/pvt/orders?f_UtmSource=buscape_campaign`

Seller

Seller filter Examples:

`/api/oms/pvt/orders?f_sellerNames=Fast+Shop`

Call Center Operator

Call Center Operator filter Examples:

`/api/oms/pvt/orders?f_callCenterOperatorName=Operator%20Name`

Sales Channel Name

Sales Channel Name filter Examples:

`/api/oms/pvt/orders?f_salesChannel=Main`

Sales Channel ID

Sales Channel ID filter Examples:

`/api/oms/pvt/orders?salesChannelId=1`

Affiliate ID

Affiliate ID filter Examples:

`/api/oms/pvt/orders?f_affiliateId=WLM`

Order Status

Order Status filter Examples:

`/api/oms/pvt/orders?f_status=ready-for-handling`

Order Status Description

Order Status Description filter Examples:

`/api/oms/pvt/orders?f_statusDescription=Pronto+para+o+manuseio`

Order Situation

know more about Incomplete Orders in VTEX Help

Order Situation filter Examples:

`/api/oms/pvt/orders?incompleteOrders=true`

Error Situation

Error Situation filter Examples:

`/api/oms/pvt/orders?filterError=all`

Payment Type Name

Payment Type Name filter Examples:

`/api/oms/pvt/orders?f_paymentNames=Visa`

Rates and Benefits Name

Rates and Benefits filter Examples:

`/api/oms/pvt/orders?f_RnB="Free+Shipping"`

Search Field

Search Field filter Examples:

SKU ID:

`/api/oms/pvt/orders?searchField=sku_Ids&sku_Ids=11223`

Gift List ID:

`/api/oms/pvt/orders?searchField=listId&listId=11223`

Transaction ID (TID):

`/api/oms/pvt/orders?searchField=tid&tid=54546300238810034995829230012`

PCI Connector's Transaction ID (TID):

`/api/oms/pvt/orders?searchField=pci_tid&pci_tid=7032909234899834298423209`

Payment ID (PID):

`/api/oms/pvt/orders?searchField=paymentId&paymentId=2`

Connector's NSU:

`/api/oms/pvt/orders?searchField=nsu&nsu=2437281`

\n\r\n\r## Response objects\n\r\n\r, Response object has the following properties:

{
  "f_creationDate": "creationDate:[2021-11-01T00:00:00.000Z TO 2022-11-10T02:00:00.000Z]",
  "page": 1,
  "per_page": 15,
  "q": "Postman Test"
}