Menu
Feedback
Start here
Tutorials
Developer portal

Known Issues
Support Rules
Troubleshooting

Frequently Asked Questions
Announcements
Tutorials
Tutorials
Explore in-depth tutorials for operating your VTEX store.
Tutorials
Orders
All orders
Filtering orders on All Orders
Filtering orders on All Orders
7 min read

You can only access information from orders created in the last two years, and that same period is valid for customers through My Account.

In the Orders module, the All Orders page allows you to access your store's orders, search and filter them, as shown in the image below:

{"base64":"  ","img":{"width":1258,"height":136,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":16824,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Orders/All%20orders/filtering-all-orders_1.png"}}

This article explains how to use these resources, and it is divided into:

Besides searching for orders in Orders > All Orders, you can search for orders from any page in the VTEX Admin using the global search bar at the top bar. By default, the search is configured as Pages. To search for an order, click on the bar, select Orders, and use one of the following criteria:

  • Order ID
  • Customer name
  • Customer email
  • Customer document

When applying multiple filters to different searches, the total number of orders viewed in the filtering window may differ from the total displayed on the All Orders page due to a platform limitation. However, that does not impact the validity of the results displayed after filtering.

To search using the search bar, type in the desired term and press the enter key. You can search by:

  • Customer name
  • Customer document
  • Customer email
  • Order ID
  • Sequence

Sequence is a six-digit string displayed in your VTEX Admin right after the order ID. For example, in order 1268540501456-01 (501456), the order ID is 1268540501456, the -01 indicates that a seller will handle fulfillment, and the sequence is 501456.

In addition to the list above, it is possible to activate other search criteria, as you will see in the Other section.

By default, the All orders page has the orders created Today filter activated. To search by other dates, use the filters available under Filters: Date or Created.

You can search on all orders or search by combining filters.

Search on all orders

Searching on All orders returns all orders related to the criteria used, regardless of their creation date. You can, for example, view a customer's full purchase history using the customer's name, email, or document.

Enter the desired term in the search bar to search on All orders. This will make Remove date limit option visible. Then, activate it to search.

{"base64":"  ","img":{"width":1243,"height":202,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":16377,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Orders/All%20orders/filtering-all-orders_2.png"}}

The search on All orders cannot be combined with other filters. So, once you remove the date limit from the search, any active filters become inactive. If the search term is removed or the Remove date limit is disabled, the previously configured filters become active again.

Search by combining filters

Searching by associated filters allows you to combine different filters, which are described in:

Filters

On the Orders > All Orders page, there is Filters option, as shown in the image below:

{"base64":"  ","img":{"width":1258,"height":136,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":16824,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Orders/All%20orders/filtering-all-orders_3.png"}}

When you click Filters, a modal is displayed with the following options:

Select the desired option and click 'Apply' to apply a filter to the search. To remove applied filters, click Clear Filters > Apply.

By default, the My time zone: GMT-3 option appears enabled for all filters. When disabled, the time zone reference changes to GMT-0 and, if re-enabled, becomes the time zone adopted by the user's browser.

If there is no match for the filter combination used in the search, the search won't provide any results.

Below, you will find a description of the filters available under Filters.

Filters: Date

You can use the filters under Date to sort by dates and periods, such as when an order will be delivered or approved. When you click Filters, by default, Date is already available as the option.

You can find the desired option using the search bar or by clicking the dropdown next to the options below:

  • Shipping estimate: The estimated order shipping period:
    • Next 7 days
    • Tomorrow
    • Today
    • Late
  • **Invoiced date: **The date on which the order was invoiced:
    • Today
    • Yesterday
    • Last 7 days
    • Current month
    • Last 30 days
    • Custom
  • Order date: The date the order was made:
    • Today
    • Yesterday
    • Last 7 days
    • Current month
    • Last 30 days
    • Custom
  • Authorized date: The date on which the payment operator/gateway approved the order:
    • Today
    • Yesterday
    • Last 7 days
    • Current month
    • Last 30 days
    • Custom

After selecting the desired filters, click Apply.

Filters: Channel

You can use the filters under Channel to sort by sales channels and other aspects of the order. Click Filters to use them and select Channel. Depending on your store settings, some options listed may not appear in your VTEX Admin.

You can find the desired filter option by using the search bar or by clicking the dropdown next to the following options:

  • Seller: Displays the seller ID in your store and filters by the seller fulfilling the order.
  • Trade policy: Displays your store's trade policies and filters by the one used in the order.
  • Campaign: Displays your store's campaign target audiences and filters by a promotion's target audience.
  • Call center operator: Displays your store's call center operators.
  • UTM source: Displays UTM source options configured in your store. UTM (Urchin Tracking Modules) are URL parameters commonly used in marketing and promotional contexts to track traffic to a website.

After selecting the desired filters, click Apply.

Filters: Status

You can use the filters under Status to sort by order status at the time of the search related to the order flow or errors. Click Filters to use them and select Status. You can find the desired option using the search bar or by clicking the dropdown next to the options below:

  • Order status: Order step in the order flow. The options that appear correspond to the status of orders in your store. For example, if there are no canceled orders among your orders, this option will not be visible. These are some examples of order status filters:
    • Payment approved
    • Payment pending
    • Awaiting fulfillment
    • Ready for handling
    • Waiting for seller change
  • Completed status: Whether an order has all the necessary information to be completed on the platform or if it is incomplete:
    • Incomplete
  • Error status: Displays the errors:
    • Permanent error
    • Temporary error
    • Any error

After selecting the desired filters, click Apply.

Filters: Other

You can use the filters under Other for different topics, some of which will vary depending on your store settings. Therefore, some of the options listed below may not be available in your VTEX Admin.

Click Filters to use these filters and select Other. You can find the option you want using the search bar or by clicking the dropdown next to the following options:

  • Other fields: Fields that can be used to filter results. After selecting the field, you need to type the value in the search bar Search in Other.
    • Order ID
    • SKU ID
    • Gift list ID
    • Transaction ID (TID)
    • PCI connector transaction ID (TID)
    • Payment ID (PID)
    • Connector NSU (Brazil)
  • Payment type: Displays the payment methods configured in your store.
  • Promotions: Displays the promotions added to your store.
  • Currency: Displays the currencies configured in the trade policy and that have been used in orders.
  • Hostname: Displays your account name, which is your company ID in the VTEX system.
  • B2B: Select true to filter by orders from B2B stores or false for orders from other business models.
  • inStore: Select true to filter by orders made using inStore or false for non-inStore orders.
  • Delivery channel: Displays the type of order delivery, whether it will be delivered or picked up at a pickup point. The pickup option appears only for stores that have configured this feature.
  • Country: Displays the country where the order was made.
  • Has return invoice: Identifies whether the orders have a return invoice - true - or not - false.
  • Has invoice: Identifies whether the orders are invoiced - true - or not - false.

Filter by Status

On the Orders > All Orders page, there is the Filter by Status option, as shown in the image below:

{"base64":"  ","img":{"width":1258,"height":136,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":16824,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Orders/All%20orders/filtering-all-orders_4.png"}}

When clicking Filter by Status , your store's order status options are displayed. For example, if among all your orders, there are no canceled ones, this option will not be visible.

For more status filter options, go to the section Filters: Status. If you want to check all existing order status, read the article Order flow and status.

Created

On the Orders > All Orders page, there is the option Created: Today , as shown in the image below:

{"base64":"  ","img":{"width":1258,"height":136,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":16824,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Orders/All%20orders/filtering-all-orders_5.png"}}

This filter has the Today date enabled by default, but by clicking it, the following options are displayed:

  • Today
  • Yesterday
  • Last 7 days
  • Current month
  • Last 30 days

By default, the My time zone: GMT-3 option is enabled. When disabled, the time zone reference changes to GMT-0 and, if re-enabled, becomes the time zone used in the user's browser.

For more date and period filter options, visit the Filters: Date section.

Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
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