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
Orders overview
Order details page
Order details page
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.

The order details page allows you to view all the information of an order and manage it in a single place. To access it, in the VTEX Admin, go to Orders > All orders, and click the desired order.

You can also 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

On the order details page, you can:

  • Check in which stage of the order flow the order is (order status).
  • View the entire change history of the order.
  • View the payment method used.
  • Check the promotions applied to the order (if any).
  • Send and track emails sent to the customer.
  • Send the order invoice.
  • Change items in the order.
  • Manage package returns.
  • Cancel the order.

The order details page is divided into blocks that group information or features together. See below the sections of the page and their respective functions.

To learn more about order flow and status, please check out the article Order flow and status.

You will find below a list of all possible sections for the Order details page, but please note that only the sections that apply to the order in question will be visible.

Top bar

{"base64":"  ","img":{"width":3254,"height":603,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":297504,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Orders/Orders%20overview/order-details-page_1.jpg"}}

The top bar contains the following information and actions:

  • Order number: Numerical identification of the order.
  • Order status: The status of the order is in the order flow. For more information, read the article Order flow and status.
  • Actions: Menu that allows you to access quick actions for the order.
    • Print order: Allows you to print the order information.
    • Cancel order: this button allows you to cancel an order which is not in Invoiced status.
    • Invoice: this button allows you to invoice an order. This option applies to orders that have not yet been invoiced.
  • Navigation between orders: You can quickly navigate between orders using the arrows and .

General information

{"base64":"  ","img":{"width":2430,"height":937,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":319232,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Orders/Orders%20overview/order-details-page_2.jpg"}}

General order information is displayed at the top of the page, just below the top bar, and includes:

  • Date and time: Date and time when the order was placed.
  • Sold by: Name of seller responsible for the sale.
  • Customer: Personal information of the customer, including:
    • Name
    • Taxpayer registration number
    • Contact details (mobile number and email)
  • Delivery/Pickup: address details and recipient name for shipping by carrier or for pickup by customer.

Click on the icon to enlarge the block.

Order status

This block shows the current status of the order in the VTEX order flow. Here you can see history, viewing all order activity and interactions that took place within the order.

To learn more about the order flow and when to handle an order, read the article Order flow and status.

Items to invoice

{"base64":"  ","img":{"width":2514,"height":1246,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":384045,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Orders/Orders%20overview/order-details-page_3.png"}}

The block Items to Invoice contains packages with items for which payment has been approved but not yet invoiced, i.e. their invoices have not been uploaded to the platform.

The package is the wrapping or box that contains the items of a delivery. Please note that a single order may include more than one package if it consists of items from different sellers or different warehouses. For more information about package split, check out the article Order split and delivery split.

In the top left corner, the following actions are available:

  • Change: you can change the items in an order. Please note that changing items is different from replacing orders. When replacing an order, the customer requests changes to the order, and when changing items, the store modifies the order.
  • Invoice: you can generate the order invoice. Learn more about sending invoices in the article How invoice an order.

Invoices

{"base64":"  ","img":{"width":1938,"height":1110,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":232465,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Orders/Orders%20overview/order-details-page_4.png"}}

This block displays the invoiced items with their respective invoices and the packages that make up the deliveries.

In this block, the retailer can:

  • Return items: By clicking on Return items, a new page with the return information is displayed. For more information, read the article How to return items from an order.
  • Track order delivery: By clicking on View tracking, a new page will display the delivery details.
  • Confirm delivery: Confirm that the order has been delivered to the recipient. To confirm the delivery, click Actions and select Confirm delivery. The delivery confirmation does not change the order status or order flow. The information is used only to indicate to the store and the customer that the delivery has been completed.
  • Changing tracking data: Enter and edit tracking information for store and customer use.

Returned items

{"base64":"  ","img":{"width":2648,"height":1130,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":297300,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Orders/Orders%20overview/order-details-page_5.png"}}

The block Returned Items is displayed when order items are returned. See the information and actions available in this block:

  • Confirm delivery: Confirm that the returned package has been received. For more information about returning items, read the article How to return items from an order.
  • Package information: Information about the package containing returned items.
    • Incoming invoice: Invoice number of the arrival to the inventory, after the return.
    • Issue date: issue date of the incoming invoice, when the return occurred.
    • Amount: Invoice amount.
  • Returned items: A list of returned items with SKU information, unit price, number of items, additional transaction costs (if any), and total amount.
  • Total refunded: The total amount refunded to the customer for the returned items.

History of changed items

{"base64":"  ","img":{"width":2420,"height":999,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":153224,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Orders/Orders%20overview/order-details-page_6.png"}}

This block is displayed when changes are made to order items. The History of changed items displays the details of the changes made, such as which items were added or removed, the date the change occurred, and the prices of the products (the price of the returned item, the price of the added item, and the difference between the two).

If there are changes in the final amount of the order, the difference will be displayed in the item Cost of changes at the bottom of the section.

Order history

{"base64":"  ","img":{"width":2024,"height":1673,"type":"jpg","mime":"image/jpeg","wUnits":"px","hUnits":"px","length":446925,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Orders/Orders%20overview/order-details-page_7.jpg"}}

This block displays all the order activity and interactions that took place within the order, with date and time information.

By clicking on See interactions, you can see the communication with VTEX systems and external systems, such as ERP, and payment gateways.

In Order history, you can start preparing the order by clicking on Start Handling (if available). By clicking on Start handling, the order status is changed. This way, you indicate that the items are ready for shipping. A modal will appear on screen asking you to confirm this action. To proceed, select the checkboxes and click Proceed with status.

For more information on when to handle an order, read the article Order flow and status.

You can also view details of notifications emailed to the customer by clicking on the arrow. You can resend any of the emails by clicking the Resend email button.

Comments

{"base64":"  ","img":{"width":1987,"height":518,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":67734,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Orders/Orders%20overview/order-details-page_8.png"}}

This section allows you to add internal comments with remarks about the order. To do this, you can type in the text box and click on Send.

Comments are recorded on the order details page with the date, time, and email address of the user. They are not visible to customers, only to VTEX Admin users with access to the All Orders page in your store.

Financial details

{"base64":"  ","img":{"width":1358,"height":2217,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":388192,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Orders/Orders%20overview/order-details-page_9.png"}}

On the right side of the page, you can view the financial details of the order. This information is updated automatically as the order progresses.

  • Total cost of the order: The total amount charged for the order, i.e., the total cost of the items, shipping, and additional services, if any.

    • Change final cost: Allows you to modify the total amount charged.
    • Promos and partnerships: Promotions applied to the order, if any. They are divided into:
      • Promotions: A gift card or promotional code applied at checkout.
      • Marketing: Marketing campaign promotions.
  • Payment: The payment method used for the purchase. This information depends on how the payment was made, and can be:

    • Credit card: Information on the credit card used for the purchase (transaction ID, gateway, installments, transaction code, authorization date, and seller).
    • Boleto bancário: The boleto bancário (Brazilian payment method) file. To view the boleto, click on View boleto bancário.
    • Gift card: Details of the gift card used.

    To see more details about the transaction, click on the button See details .

    If the order has the status Pending payment, you can manually approve the payment by clicking on Approve payment.

Learn more

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