--- title: "Retrieve user order details" method: GET path: "/api/oms/user/orders/{orderId}" tags: ["User orders"] --- # Retrieve user order details `GET /api/oms/user/orders/{orderId}` Lists all details from an order, through the perspective of the customer who placed the order. > You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh). ## B2B Buyer Portal orders You can use this endpoint to list orders by filtering with the following fields: - Text: texts in existing order fields, [custom fields](https://developers.vtex.com/docs/guides/custom-fields-integration), and [contact information fields](https://developers.vtex.com/docs/api-reference/b2b-contact-information-api#post-/api/dataentities/contact_information/documents). - Status: the current status of the orders you wish to list. - Creation date: the date the order was created. - The purchase agent ID: ID of the purchase agent that made the order. - Pending approval: You can also filter by orders which are pending approval (`true`) or orders which are not pending approval (`false`). >⚠️ When using the `text` field to filter by contact information, you must use the exact value of the field in the contact information. Partial matches are not supported. For example: If the user's first name is set to `John Henry`, you must write `John Henry` in the `text` field. Searching for `John` will return orders made by `John`, and not `John Henry`. > Note that this request should be made by an [user](https://developers.vtex.com/docs/guides/user-authentication-and-login) or [an appKey / appToken pair](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) that is associated with the [Call center operator](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy#call-center-operator) role. Otherwise, it will return only orders from the same email informed in the `clientEmail` query parameter. ## Permissions Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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** | | --------------- | ----------------- | ----------------- | | View My Contract Orders | My Account / OMS | **ViewMyContractOrders** | | View My Org Unit Orders | My Account / OMS | **ViewMyOrgUnitOrders** | | OMS | OMS access | **View order** | You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy): | **Role** | **Resource** | | --------------- | ----------------- | | Call center operator | View order | | OMS - Read only | View order | >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or API keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication). ## Path parameters - `orderId` string, required ## Query parameters - `clientEmail` string - `text` string - `status` string - `creation_date` string - `purchase_agent_id` string - `my_pending_approvals` boolean ## Headers - `Content-Type` string, required - `Accept` string, required ## Response `200` OK - Userorderdetails - `orderId` string, required — Order ID is a unique code that identifies an order. - `sequence` string, required — Sequence is a six-digit string that follows the order ID. For example, in order `1268540501456-01 (501456)`, the sequence is `501456`. - `marketplaceOrderId` string, required — Marketplace order ID. - `marketplaceServicesEndpoint` string, required — Marketplace services endpoint. - `sellerOrderId` string, required — ID of the seller related to the order. It can be a VTEX seller or an external seller. - `origin` string, required — Order's [origin in the order flow](https://developers.vtex.com/docs/guides/orders-overview#understanding-order-flow-types), which can be `Marketplace`, `Fulfillment` or `Chain`. - `affiliateId` string, required — Corresponds to the three-digit [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) identification code of the seller responsible for the order. - `salesChannel` string, required — Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order. - `merchantName` string, required — Name of the merchant. - `status` string, required — Order [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). - `statusDescription` string, required — `Deprecated`. Status description which is displayed on the Admin panel. This field is obsolete and may not return any value. - `value` integer, required — Order's total amount. - `creationDate` string, required — Order's creation date. - `lastChange` string, required — Order's last change date. - `orderGroup` string, required — Order's group ID. - `totals` Total[], required — List with details about orders' totals. - `id` string, required — Code that identifies if the information is about `Items`, `Discounts`, `Shipping`, `Tax` or `Change`. - `name` string, required — Name of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`. - `value` integer, required — Total amount of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`. - `items` Item[], required — Information about order's items. - `uniqueId` string, required — Unique ID is an alphanumeric sequence that identifies an SKU in a given order. - `id` string, required — Item's SKU ID, which is a unique numerical identifier. - `productId` string, required — ID of the Product associated with the item. - `ean` string, nullable, required — EAN of the SKU. - `lockId` string, required — Reservation ID. - `itemAttachment` ItemAttachment, required — Information about attachments, if it applies. - `content` object, required — Attachment's custom field for content. - `name` string, nullable, required — Attachment's name. - `attachments` string[], required — Array containing information on attachments. - `quantity` integer, required — Quantity of items. - `seller` string, required — Seller related to the order. - `name` string, required — Item's name. - `refId` string, required — Product referencial code associated with the item. - `price` integer, required — Item's price. - `listPrice` integer, required — Item's list price. - `manualPrice` string, nullable, required — Item's manual price. - `priceTags` string[], required — List of objects with item's price modifiers. - `imageUrl` string, required — Item's SKU image URL. - `detailUrl` string, required — URL slug of the item. - `components` string[], required — Item's components. - `bundleItems` string[], required — This field groups offerings (services) related to the item and displays their ID and quantity. A gift package is an example of an offering. - `params` string[], required — Information about params. - `offerings` string[], required — Item's offerings, which are services related to the item. For example, guarantee or installation. - `attachmentOfferings` object[], nullable, required — List of attachments details. - `name` string, nullable, required — Name of the attachment. - `required` boolean, nullable, required — If the attachment is required (`true`) or not (`false`). - `schema` object, nullable, required — Schema of the content declared in the field `attachmentOfferings`. - `sellerSku` string, required — SKU ID from the seller perspective. - `priceValidUntil` string, nullable, required — Date until when the price is going to be valid if there is a promotion. - `commission` integer, required — Commission value registered for the seller. - `tax` integer, required — Item's tax. - `preSaleDate` string, nullable, required — Item's pre sale date. - `additionalInfo` AdditionalInfo, required — Additional information about the item. - `brandName` string, required — Item's brand name. - `brandId` string, required — Item's brand ID. - `categoriesIds` string, required — Item's category ID. - `productClusterId` string, required — All product clusters related to the item. - `commercialConditionId` string, required — Commercial conditions ID. - `dimension` Dimension, required — Item dimensions. - `cubicweight` number, required — Item cubic weight. - `height` number, required — Item height. - `length` number, required — Item length. - `weight` number, required — Item weight. - `width` number, required — Item width. - `offeringInfo` string, nullable, required — Information about services related to the item. For example: guarantee or installation. - `offeringType` string, nullable, required — Offering type. - `offeringTypeId` string, nullable, required — Offering type ID. - `measurementUnit` string, required — Item's measurement unit. - `unitMultiplier` integer, required — Item's unit multiplier. - `sellingPrice` integer, required — Item's selling price. - `isGift` boolean, required — This field is `true` when the item is a gift in order context and `false` when it is not. - `shippingPrice` string, nullable, required — Item's shipping price. - `rewardValue` integer, required — Item's reward value. - `freightCommission` integer, required — Value of the freight commission. - `priceDefinitions` object, required — Item's price information. - `sellingPrices` object[], required — Details on item's selling price. - `value` integer, required — Total value of items in cents. - `quantity` integer, required — Quantity of items. - `calculatedSellingPrice` integer, required — Item's calculated unitary selling price in cents. - `total` integer, required — Total value of all item's units in cents. - `taxCode` string, nullable, required — Item's tax code. - `parentItemIndex` string, nullable, required — Parent item index. - `parentAssemblyBinding` string, nullable, required — Parent assembly binding. - `callCenterOperator` string, nullable, required — Call center operator responsible for the order. - `serialNumbers` string, nullable, required — This field identifies the order in the `handling` status in the workflow, and it was used for VTEX internal control. - `assemblies` string[], nullable, required — Retrieves information about orders item's customizations. - `costPrice` integer, required — Item's cost price. - `marketplaceItems` string[], required — Marketplace details object. - `clientProfileData` ClientProfileData, required — Object with information on the client's profile. - `id` string, required — Object ID, the expected value is `clientProfileData`. - `email` string, required — Customer's email. - `firstName` string, required — Customer's first name. - `lastName` string, required — Customer's last name. - `documentType` string, required — Type of the document informed by the customer. - `document` string, required — Document identification code informed by the customer. - `phone` string, required — Customers's phone number. - `corporateName` string, nullable, required — If the customer is a legal entity, here goes the corporate name. - `tradeName` string, nullable, required — If the customer is a legal entity, here goes the trade name. - `corporateDocument` string, nullable, required — If the customer is a legal entity, here goes the corporate document. - `stateInscription` string, nullable, required — If the customer is a legal entity, here goes the state inscription. - `corporatePhone` string, nullable, required — If the customer is a legal entity, here goes the corpany's phone number. - `isCorporate` boolean, required — The value is `true` when the customer is a legal entity and `false` when not. - `userProfileId` string, required — Customer user profile ID. - `customerClass` string, nullable, required — Identification of the class the customer belongs to. - `giftRegistryData` string, nullable, required — Information about gift list, when it applies. - `marketingData` object, required — Information about promotions and marketing. For example, coupon tracking information and internal or external UTMs. - `id` string, required — Object ID which expected value is `marketingData`. - `utmSource` string, required — Value of the `utm_source` parameter of the URL that led to the request. - `utmPartner` string, required — UTM Source Parameters. - `utmMedium` string, required — Value of the `utm_medium` parameter of the URL that led to the request. - `utmCampaign` string, required — Value of the `utm_campaign` parameter of the URL that led to the request. - `coupon` string, required — Coupon's code information. - `utmiCampaign` string, required — Internal UTM value `utmi_cp`. - `utmipage` string, required — Internal UTM value `utmi_p`. - `utmiPart` string, required — Internal UTM value `utmi_pc`. - `marketingTags` string[], required — Marketing tags information. This field can be used to register campaign data or informative tags regarding promotions. - `ratesAndBenefitsData` RatesAndBenefitsData, required — Information on promotions and taxes that apply to the order. - `id` string, required — ID of the rate or benefit. - `rateAndBenefitsIdentifiers` string[], required — Information about order's promotions and taxes identifiers. - `shippingData` ShippingData, required — Object containing shipping data. - `id` string, required — Object ID, the expected value is `shippingData`. - `address` Address, required — Shipping address details. - `addressType` string, required — Type of address. For example, `Residential` or `Pickup`, among others. - `receiverName` string, required — Name of the person who is going to receive the order. - `addressId` string, required — Shipping address ID. - `versionId` string, nullable, required — Shipping address version ID. - `entityId` string, nullable, required — Shipping address entity ID. - `postalCode` string, required — Postal code of the shipping address. - `city` string, required — City of the shipping address. - `state` string, required — State of the shipping address. - `country` string, required — Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3). - `street` string, required — Street of the shipping address. - `number` string, required — Number of the building, house or apartment in the shipping address. - `neighborhood` string, required — Neighborhood of the shipping address. - `complement` string, required — Complement to the shipping address when it applies. - `reference` string, nullable, required — Complement to help locate the shipping address, in case of delivery. - `geoCoordinates` number[], required — Array with two numbers with geocoordinates, first longitude then latitude. - `logisticsInfo` LogisticsInfo[], required — Array of objects containing item's logistics information. - `itemIndex` integer, required — Index of the item starting from 0. - `selectedSla` string, required — Selected shipping option. - `lockTTL` string, required — Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time. - `price` integer, required — Shipping price for the item in cents. Does not account for the whole order's shipping price. - `listPrice` integer, required — SKU's optional price for a specific trade policy. - `sellingPrice` integer, required — Item's selling price. - `deliveryWindow` string, nullable, required — [Scheduled delivery](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) window information, if it applies to the item. - `deliveryCompany` string, required — [Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE) company's name. - `shippingEstimate` string, required — Total shipping estimate time in days. For instance, three business days is represented `3bd`. - `shippingEstimateDate` string, required — Shipping estimate date. It is defined only after the confirmation of the order. - `slas` Sla[], required — Information on Service Level Agreement (SLA), corresponding to [shipping policies](https://help.vtex.com/tutorial/shipping-policy--tutorials_140). - `id` string, required — ID of the shipping method used in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140). - `name` string, required — Name of the shipping policy. - `shippingEstimate` string, required — Total shipping estimate time in days. For instance, three business days is represented `3bd`. - `deliveryWindow` string, nullable, required — [Scheduled delivery window](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, if it applies to the item. - `price` integer, required — Shipping price for the item in cents. Does not account for the whole order's shipping price. - `deliveryChannel` string, required — If the delivery channel is `delivery` or `pickup-in-point`. - `pickupStoreInfo` PickupStoreInfo, required — Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R). - `additionalInfo` string, nullable, required — Additional information about the pickup point. - `address` string, nullable, required — Pickup point's address. - `dockId` string, nullable, required — ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj) related to the delivery or the pickup point. - `friendlyName` string, nullable, required — Name of the pickup point displayed at checkout. - `isPickupStore` boolean, required — If this field is set `true`, it means the type of shipping is pickup, and if set as `false`, it is not. - `polygonName` string, nullable, required — Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy. - `lockTTL` string, required — Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. - `pickupPointId` string, required — [Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID related to the SLA. - `transitTime` string, required — Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`. - `pickupDistance` number, required — Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line. - `shipsTo` string[], required — Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3). - `deliveryIds` DeliveryId[], required — Information about delivery IDs. - `courierId` string, required — [Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE)'s ID. - `courierName` string, required — Carrier's name. - `dockId` string, required — ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj). - `quantity` integer, required — Quantity of items. - `warehouseId` string, required — ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb). - `accountCarrierName` string, required — Name of the account's [carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE). - `kitItemDetails` string[], nullable, required — Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), if there are any. - `deliveryChannels` object[], required — List of delivery channels associated with the trade policy. - `id` string, required — Delivery channel's shipping type, which can be `delivery` or `pickup-in-point`. - `stockBalance` integer, required — Stock check for an SKU availability. - `deliveryChannel` string, required — If the delivery channel is `delivery` or `pickup-in-point`. - `pickupStoreInfo` PickupStoreInfo, required — Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R). - `additionalInfo` string, nullable, required — Additional information about the pickup point. - `address` string, nullable, required — Pickup point's address. - `dockId` string, nullable, required — ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj) related to the delivery or the pickup point. - `friendlyName` string, nullable, required — Name of the pickup point displayed at checkout. - `isPickupStore` boolean, required — If this field is set `true`, it means the type of shipping is pickup, and if set as `false`, it is not. - `addressId` string, required — Address ID. - `versionId` string, nullable, required — Shipping address version ID. - `entityId` string, required — Shipping address entity ID. - `polygonName` string, nullable, required — Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy. - `pickupPointId` string, required — [Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R)'s ID. - `transitTime` string, required — Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`. - `trackingHints` string, nullable, required — List containing order shipping label information. - `selectedAddresses` SelectedAddress[], required — Information about selected adresses. - `addressId` string, required — Selected address ID. - `versionId` string, nullable, required — Shipping address version ID of the selected address. - `entityId` string, nullable, required — Shipping address entity ID of the selected address. - `addressType` string, required — Selected adress's shipping type, which can be `pickup`, `residential`, `invoice`, `search`, `inStore`, `commercial` or `giftRegistry`. - `receiverName` string, required — Name of the person who is going to receive the order in the selected address. - `street` string, required — Street of the selected address. - `number` string, required — Number of the building, house or apartment of the selected address. - `complement` string, required — Complement to the selected address if it applies. - `neighborhood` string, required — Neighborhood of the selected address. - `postalCode` string, required — Postal code of the selected address. - `city` string, required — City of the selected address. - `state` string, required — State of the selected address. - `country` string, required — Three letters ISO code of the country of the selected address (ISO 3166 ALPHA-3). - `reference` string, nullable, required — Complement to help locate the selected address. - `geoCoordinates` number[], required — Array with two numbers with the selected address's geocoordinates, first longitude then latitude. - `paymentData` PaymentData, required — Object with information about the payment. - `giftCards` string[] — Array with information about Gift Cards. - `transactions` Transaction[], required — Information about financial transactions. - `isActive` boolean, required — When this field is set as `true`, the payment is active, and when it is `false`, the payment is inactive. - `transactionId` string, required — ID of the transaction. - `merchantName` string, required — Name of the merchant that will receive the payment. - `payments` Payment[], required — Detailed information about payment. - `id` string, required — VTEX payment ID that can be used as unique identifier. - `paymentSystem` string, required — Payment system's ID. - `paymentSystemName` string, required — Payment system's name. - `value` integer, required — Payment's final amount in cents. - `installments` integer, required — Number of payment installments. - `referenceValue` integer, required — Payment's reference value in cents. - `cardHolder` string, nullable, required — Name of the person who owns the card. - `cardNumber` string, nullable, required — Numeric sequence of the card used in the transaction. - `firstDigits` string, nullable, required — Fist digits of the card used in the transaction. - `lastDigits` string, nullable, required — Last digits of the card used in the transaction. - `cvv2` string, nullable, required — Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions. - `expireMonth` string, nullable, required — Expire month of the card used in the transaction (2-digits). - `expireYear` string, nullable, required — Expire year of the card used in the transaction (4-digits). - `url` string, required — Payment's URL. - `giftCardId` string, nullable, required — Gift Card's ID. - `giftCardName` string, nullable, required — Gift Card's name. - `giftCardCaption` string, nullable, required — Gift Card's caption. - `redemptionCode` string, nullable, required — Code for the customer to use the Gift Card. - `group` string, required — Name of the collection the Gift Card belongs to. - `tid` string, nullable, required — Provider's unique identifier for the transaction. - `dueDate` string, required — Payment due date, with the format `yyyy-mm-dd`. - `connectorResponses` object, required — Information about the connector responses. - `Tid` string, required — Provider's unique identifier for the transaction. - `ReturnCode` string, required — Provider's operation/error code to be logged. - `Message` string, required — Provider's operation/error message to be logged. - `authId` string, required — Connector's authorization ID. - `giftCardProvider` string, required — Gift Card provider's ID. - `giftCardAsDiscount` boolean, required — When this field is set as `true`, the Gift Card is a discount over the price, and when set as `false`, it is not a discount. - `koinUrl` string, required — Payment's account ID. - `accountId` string, required — Payment's account ID. - `parentAccountId` string, required — This field retrieves the main account if the payment was made in a subaccount. - `bankIssuedInvoiceIdentificationNumber` string, required — Numeric sequence that identifies the bank issued invoice. - `bankIssuedInvoiceIdentificationNumberFormatted` string, required — Bank issued invoice ID formatted. - `bankIssuedInvoiceBarCodeNumber` string, required — Number of the bank issued invoice bar code. - `bankIssuedInvoiceBarCodeType` string, required — Type of the bank issued invoice bar code. - `billingAddress` object, required — Billing address information. - `packageAttachment` PackageAttachment, required — Package object populated after order invoiced. - `packages` string[], required — Packages details. - `sellers` Seller[], required — List of all sellers associated with the order. - `id` string, required — Seller ID that identifies the seller. - `name` string, required — Seller's name. - `logo` string, required — URL of the seller's logo. - `fulfillmentEndpoint` string, required — URL of the endpoint for fulfillment of seller's orders. - `callCenterOperatorData` string, nullable, required — Call center operator responsible for the order. - `followUpEmail` string, required — Email of the store's employee responsible for managing the order. - `lastMessage` string, nullable, required — Last sent transactional message. - `hostname` string, required — Account Hostname registered in License Manager. - `invoiceData` object, nullable, required — Information pertinent to the order's invoice. - `changesAttachment` ChangesAttachment, required — Information about changes in the order. - `id` string, required — Object ID, the expect value is `changeAttachment`. - `changesData` ChangesDatum[], required — Order change details. - `reason` string, required — Text explaining why there was a change in the order. This information may be shown to the customer in the UI or transactional emails. - `discountValue` integer, required — Order change discount value. - `incrementValue` integer, required — Order change increment value. - `itemsAdded` string[], required — List of items added to the order. - `itemsRemoved` ItemsRemoved[], required — List of items removed from the order. - `id` string, required — SKU ID of the item removed from the order. - `name` string, required — Name of the item removed from the order. - `quantity` integer, required — Quantity of items removed from the order. - `price` integer, required — Total amount of items removed from the order. - `unitMultiplier` string, nullable, required — Unit multiplier of the item removed from the order. - `receipt` Receipt, required — Information about the receipt for modified orders. - `date` string, required — Date when the receipt was created. - `orderId` string, required — ID of the order. - `receipt` string, required — Receipt's unique identifier code. - `openTextField` string, nullable, required — Optional field with order's additional information. This field must be filled in using the following format: ``` { "fieldExample": "ValueExample" } ``` . - `roundingError` integer, required — Rounding error total amount, if it applies. For example, in orders with a discount over non-integer multiplier items, the rounding price is performed per item, not after the sum of all items. That can cause a difference in the total discount amount, which is informed in this field. - `orderFormId` string, required — [Order form](https://developers.vtex.com/docs/guides/orderform-fields) ID. - `commercialConditionData` string, nullable, required — Information about commercial conditions. - `isCompleted` boolean, required — When set as `true`, the order's payment has been settled, and when set as `false`, it has not been settled yet. - `customData` string, nullable, required — Custom information in the order. This field is useful for storing data not included in other fields, for example, a message for a gift or a name to be printed in a shirt. - `storePreferencesData` StorePreferencesData, required — Object with data from the store's configuration - stored in VTEX's License Manager. - `countryCode` string, required — Three letters ISO code of the country (ISO 3166 ALPHA-3). - `currencyCode` string, required — Currency code in ISO 4217. For example, `BRL`. - `currencyFormatInfo` CurrencyFormatInfo, required — Object with currency format details. - `CurrencyDecimalDigits` integer, required — Quantity of currency decimal digits. - `CurrencyDecimalSeparator` string, required — Defines what currency decimal separator will be applied. - `CurrencyGroupSeparator` string, required — Defines what currency group separator will be applied. - `CurrencyGroupSize` integer, required — Defines how many characters will be grouped. - `StartsWithCurrencySymbol` boolean, required — Defines if all prices will be initiated with the currency symbol (`true`) or not (`false`). - `currencyLocale` integer, required — Currency Locale Code in LCID in decimal. - `currencySymbol` string, required — Currency symbol. - `timeZone` string, required — Time zone from where the order was made. - `allowCancellation` boolean, required — When set as `true`, the order can be canceled, and when set as `false`, it is no longer possible to cancel the order. - `allowEdition` boolean, required — When set as `true`, the order can be edited, and when set as `false`, it is no longer possible to edit the order. - `isCheckedIn` boolean, required — This field is set `true` when the order was made via inStore and `false` when it was not. - `marketplace` Marketplace, required — Details about the marketplace related to the order. - `baseURL` string, required — Marketplace base URL. - `isCertified` string, nullable, required — If is a certified marketplace. - `name` string, required — Name of the marketplace. - `authorizedDate` string, required — Authorized order date. - `invoicedDate` string, nullable, required — Order's invoice date. - `cancelReason` string, nullable, required — Reason for order cancellation. - `itemMetadata` object, required — Metadata information about the order's items. - `Items` object[], required — Metadata items. - `Id` string, required — Item's SKU ID, which is a unique numerical identifier. - `Seller` string, required — Seller ID that identifies the seller the item belongs to. - `Name` string, required — Name of the item as displayed to customers in the storefront. - `SkuName` string, required — Name of the SKU corresponding to the item. - `ProductId` string, required — ID of the Product associated with the item. - `RefId` string, required — Item's reference ID. - `Ean` string, required — EAN of the item. - `ImageUrl` string, required — Item's SKU image URL. - `DetailUrl` string, required — URL slug of the item. - `AssemblyOptions` object[], required — Displays information about [assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) related to the item, if there are any. - `Id` string, required — ID of the attachment related to the order. - `Name` string, required — Name of the attachment related to the order. - `Required` boolean, required — If this field is set as `true`, when the customer purchases the item sending the attachment is required, and when set as `false`, sending the attachment is optional. - `InputValues` object, nullable, required — Displays the attachment's content. - `Composition` object, nullable, required — Displays the attachment's composition. - `subscriptionData` object, nullable, required — Information about [subscriptions](https://help.vtex.com/tutorial/how-subscriptions-work--frequentlyAskedQuestions_4453). - `SubscriptionGroupId` string, required — ID of the subscription's group. If this field returns `null` and the `executionCount` is `0`, the order is the first one with subscriptions. - `Subscriptions` object[], nullable, required — List with subscriptions and their details. - `ExecutionCount` integer, required — Position of the order in the subscription cycle. The first order will have the value `0`, the second will have the value `1`, and so on. - `PriceAtSubscriptionDate` number, required — Price of the order when the customer signed up for subscriptions. Subscriptions created from Admin UI or APIs do not have an original order, so the field returns `0.0`. This field was valid only for Subscriptions v2 and is deprecated in Subscriptions v3. - `ItemIndex` integer, required — Each item in the subscriptions' order is identified by an index. The position starts in`0`, followed by `1`, `2`, and so on. - `Plan` object, required — Information about the subscription's validility and frequency. - `type` string, required — Type of plan. - `frequency` object, required — Information about subscriptions' recurrence. - `periodicity` string, required — Defines the subscriptions recurrence period. The possible values are `DAILY`,`WEEKLY`, `MONTHLY` and `YEARLY`. - `interval` integer, required — Number of the time interval configured between subscription orders, which depends on the periodicity. For a `DAILY` periodicity, the field's value will correspond to days, for `MONTHLY` to months, and so on. - `validity` object, required — Information about the period during which the subscription will be valid. - `begin` string, required — Subscriptions' beginning date with the format `yyyy-mm-ddThh:mm:ss`. - `end` string, required — Subscriptions' ending date with the format `yyyy-mm-ddThh:mm:ss`. - `taxData` object, required — Order's tax information. - `areTaxesDesignatedByMarketplace` boolean, required — If the taxes were designated by the marketplace (`true`) or not (`false`). - `taxInfoCollection` object[], required — Array with taxes' details. - `itemIndex` integer, required — Item's indexing number. - `sku` string, required — Alphanumeric sequence that identifies an SKU. - `priceTags` object[], required — Price tag information. - `isPercentual` boolean, required — If the tax is a percentage (`true`) or note (`false`). - `name` string, required — Name that identifies the tax. - `rawValue` string, required — The amount that corresponds to the tax. - `checkedInPickupPointId` string, required — If the field `isCheckedIn` is set as `true`, the `checkedInPickupPointId` will retrieve the ID of the physical store where the order was made. - `cancellationData` object, required — Information about order cancellation, when it applies. - `RequestedByUser` boolean, required — If the order cancellation was requested by the costumer (`true`) or not (`false`). - `RequestedBySystem` boolean, required — If the order cancellation was made by the system (`true`) or not (`false`). This type of order cancellation happens in [incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294), for example. - `RequestedBySellerNotification` boolean, required — If the order cancellation was requested by the seller (`true`) or not (`false`). - `RequestedByPaymentNotification` boolean, required — If the order cancellation was requested by the payment gateway (`true`) or not (`false`). - `Reason` string, required — The reason why the order was cancelled. - `CancellationDate` string, required — The date when the order was cancelled. - `clientPreferencesData` object, required — Information about customer's preferences. - `locale` string, required — Customer's prefered language while accessing the store. - `optinNewsLetter` boolean, required — When set as `true`, this field indicates customers opted to receive the newsletters, and when set as `false`, it means they did not. ## Changes > 62 revisions in range; 1 could not be searched. - **2026-02-10** `4be2d9ba0a4e` — 1 info - the `query` request parameter `clientEmail` became optional - **2026-02-02** `f6d7493fa46e` — 5 info - added the new optional `query` request parameter `creation_date` - added the new optional `query` request parameter `my_pending_approvals` - added the new optional `query` request parameter `purchase_agent_id` - added the new optional `query` request parameter `status` - …1 more [Change history](https://skmtc.dev/vtex/apis/orders-api/changes/api/oms/user/orders/:orderId/get.md) --- [API](https://skmtc.dev/vtex/apis/orders-api.md) · [All operations](https://skmtc.dev/vtex/apis/orders-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vtex/orders-api/revisions/cb5fa08e400c/schema)