Get order
Retrieves order details by searching by order ID or sequence number.
⚠️ Throttling: Each VTEX account can make up to 6000 requests per minute.
You can only access information from orders created in the last two years, and that same period is valid for customers through My Account.
Check the 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.
Permissions
Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:
| Product | Category | Resource |
|---|---|---|
| OMS | OMS access | View order |
| Checkout | CheckoutResources | Orders Full Access |
You can create a custom role with that resource or use one of the following predefined roles:
| Role | Resource |
|---|---|
| OMS - Full access | View order |
| Checkout Admin | View order |
| IntegrationProfile - Fulfillment Oms | View order |
| OMS - Full access | Orders Full Access |
| Checkout Admin | Orders Full Access |
| IntegrationProfile - Fulfillment Oms | Orders Full Access |
❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys. To learn more about machine authentication at VTEX, see Authentication overview.
Path parameters
Order ID is a unique code that identifies an order. Instead of using orderId, you can also make the request using the sequence, a six-digit string that follows the order ID. For example, in order 1268540501456-01 (501456), the sequence is 501456. To use this parameter, replace the value between { } keys in seq{sequence-number} with the sequence. For example: seq501456.
Headers
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Type of the content being sent.
Response
OK