The VTEX Orders API PII variant supports VTEX stores using the PII data architecture where sensitive customer data is stored encrypted. It provides the same order management capabilities as the standard Orders API but with PII-compliant data handling for GDPR and LGPD requirements.
openapi: 3.0.0
info:
title: VTex Orders API - PII data architecture
description: "\r\n\r\n>⚠️ The **Orders API - PII data architecture** is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.\r\n>\r\n> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).\r\n\r\nStores using the [PII data architecture](https://developers.vtex.com/docs/guides/pii-data-architecture-specifications) from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus) must use this adapted version of the Orders API.\r\n\r\nLearn more about the modified behavior at [Changes in VTEX features behavior to handle PII data](https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data).\r\n## Index\r\n\r\n### Orders\r\n\r\n- `GET` [Get order](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#get-/api/orders/pvt/document/-orderId-)\r\n- `POST` [List orders](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/extendsearch/orders)\r\n- `POST` [Start handling order](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/actions/start-handling)\r\n- `POST` [Cancel order](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/cancel)\r\n\r\n### Invoice\r\n\r\n- `POST` [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/invoices)\r\n\r\n### Payment\r\n\r\n- `POST` [Send payment notification](https://developers.vtex.com/docs/api-reference/orders-api-pii-version#post-/api/orders/pvt/document/-orderId-/payment/-paymentId-/notify-payment)"
contact: {}
version: '1.0'
servers:
- url: https://{accountName}.{environment}.com.br
description: VTEX server URL.
variables:
accountName:
description: Name of the VTEX account. Used as part of the URL.
default: apiexamples
environment:
description: Environment to use. Used as part of the URL.
enum:
- vtexcommercestable
default: vtexcommercestable
paths:
/api/orders/pvt/document/{orderId}:
get:
tags:
- Orders
summary: VTex Get order
description: "Retrieves order details by searching a specific order ID.\n\r\n\r>If you wish to retrieve unmasked data, use the `reason` parameter.\n\r\n\r> The `View order` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#).\n\r\n\r> Check the new [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview). 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.\n\r\n\r> Throttling: Each account can make up to 5000 requests per minute.\n\r\n\r## Request object has the following properties:\r\n\r\n| Attribute | Type | Description |\r\n| --------------- |:---------:| --------------------------------------:|\r\n| `orderId` | string | Order Id |\r\n\r\n\r\n## Response object has the following properties:\r\n\r\n\r\n| Attribute | Type | Description |\r\n| --------------- |:---------:| --------------------------------------:|\r\n| `affiliateId` | string | Seller Name who was responsible for the order |\r\n| `allowCancellation` | boolean | If Cancellation is allowed |\r\n| `allowEdition` | boolean | If Order Edition is allowed |\r\n| `approvedBy` | string | User who approved the order |\r\n| `authorizedDate` | string | Authorized Order Date |\r\n| `callCenterOperatorData` | string | Call Center Operator responsible for the order |\r\n| `cancelReason` | string | Cancel Reason |\r\n| `cancelledBy` | string | User who Cancelled the order |\r\n| `changesAttachment` | object | Change details object |\r\n| `changesData` | object | Array with each change |\r\n| `discountValue` | integer | Change Discount Value |\r\n| `incrementValue` | integer | Change Increment Value |\r\n| `itemsAdded` | object | Added items details |\r\n| `itemsRemoved` | object | Removed items details |\r\n| `id` | integer | Changed SKU ID |\r\n| `name` | string | Changed SKU Name |\r\n| `price` | integer | Changed SKU Price |\r\n| `quantity` | integer | Changed SKU Quantity |\r\n| `unitMultiplier` | integer | Changed SKU Unit Multiplier |\r\n| `reason` | string | Change Reason |\r\n| `receipt` | object | Change receipt details object |\r\n| `date` | string | Change receipt date |\r\n| `orderId` | string | Change receipt order Id |\r\n| `receipt` | object | Change receipt ID |\r\n| `id` | string | Object Id, expect value \"changeAttachment\" |\r\n| `clientProfileData` | object | Object with all Cliente Profile Data |\r\n| `corporateDocument` | string | Client Corporate Document |\r\n| `corporateName` | string | Client Corporate Name |\r\n| `corporatePhone` | string | Cliente Corporate Telephone |\r\n| `customerClass` | string | Customer class |\r\n| `document` | string | Client Document |\r\n| `documentType` | string | Client Document Type |\r\n| `email` | string | Client e-mail |\r\n| `firstName` | string | Client First Name |\r\n| `id` | string | Object ID, expected value \"clientProfileData\" |\r\n| `isCorporate` | string | If the Client is a Corporate Client |\r\n| `lastName` | string | Client Last Name|\r\n| `phone` | string | Client Telephone |\r\n| `stateInscription` | string | Client Corporate Inscription |\r\n| `tradeName` | string | Client Corporate Trade Name |\r\n| `userProfileId` | string | Client User Profile ID |\r\n| `commercialConditionData` | object | Commercial condition information, including `\"Id\"`, `\"parentOrderId\"`, and `\"reason\"` |\r\n| `creationDate` | string | Order Creation Date |\r\n| `customData` | object | Custom Data Object |\r\n| `customApps` | object | Custom apps details object |\r\n| `fields` | object | Custom app fields |\r\n| `id` | string | Custom App ID |\r\n| `major` | integer | Major |\r\n| `emailTracked` | string | Client Conversation Tracker email |\r\n| `followUpEmail`
| string | Responsible store e-mail |\r\n| `giftRegistryData` | object | Gift registry list information, including `\"addressId\"` (object), `\"description\"` (string), and `\"giftRegistryId\"` (string) |\r\n| `hostname` | string | Account hostname registered in License Manager |\r\n| `invoiceData` | object | Information pertinent to the order's invoice |\r\n| `invoicedDate` | string | Invoice Date |\r\n| `isCheckedIn` | boolean | True if order is from inStore |\r\n| `isCompleted` | boolean | True if the order is completed |\r\n| `items` | object | Order items object |\r\n| `additionalInfo` | string | Order item additional info |\r\n| `brandId` | string | Brand ID |\r\n| `brandName` | string | Brand name |\r\n| `categoriesIds` | string | Item category ID |\r\n| `commercialConditionId` | string | Invoice date |\r\n| `dimension` | object | Item dimension object |\r\n| `cubicweight` | number | Item cubic weight |\r\n| `height` | number | Item height |\r\n| `length` | number | Item length |\r\n| `weight` | number | Item weight |\r\n| `width` | number | Item width |\r\n| `offeringInfo` | string | Extra information on offering |\r\n| `offeringType` | string | Offering type |\r\n| `offeringTypeId` | string | ID of offering type |\r\n| `productClusterId` | string | All releated product clusters |\r\n| `attachments` | object | Attachents Array |\r\n| `content` | object | Attachment Content Custom Field |\r\n| `name` | string | Attachment Name |\r\n| `bundleItems` | object | Invoice date |\r\n| `commission` | string | Comission value registered to Seller |\r\n| `components` | object | If item is a kit, contains components information |\r\n| `detailUrl` | string | Product Slug URL |\r\n| `ean` | string | SKU EAN |\r\n| `freightCommission` | integer | Comission value registered to seller |\r\n| `id` | string | SKU Id |\r\n| `imageUrl` | string | SKU Image URL |\r\n| `isGift` | string | If this item is a gift in order context |\r\n| `itemAttachment` | object | Attachment Object |\r\n| `content` | object | Attachment Content Array |\r\n| `name` | string | Attachment Name |\r\n| `listPrice` | integer | Item List Price |\r\n| `lockId` | string | Reservation ID |\r\n| `manualPrice` | string | Manually inserted price, if there is one. |\r\n| `measurementUnit` | string | Item measurement unit |\r\n| `name` | string | Item name |\r\n| `offerings` | object | Offerings information |\r\n| `params` | object | \"ContextParameter\" hashset with `\"name\"` and `\"value\"` |\r\n| `preSaleDate` | string | Item pre sale date |\r\n| `price` | integer | Item Price |\r\n| `items[].priceDefinition` | Object | Price information for all units of a specific item. |\r\n| `items[].priceDefinition.total` | Integer | Total value for all units of the item in cents. |\r\n| `items[].priceDefinition.calculatedSellingPrice` | Integer | Item's calculated unitary selling price in cents. |\r\n| `items[].priceDefinition.sellingPrices` | Array | Array of objects, each containing `value` (in cents) and `quantity` for the different rounding instances that can be combined to form the correctly rounded `total`. |\r\n| `priceTags` | object | Object with all price modifiers |\r\n| `identifier` | string | Price Tag ID |\r\n| `isPercentual` | boolean | Indicates whether the price tag is a percentual modifier |\r\n| `name` | string | Price tag name |\r\n| `rawValue` | string | Price tag raw value |\r\n| `value` | string | Price tag value |\r\n| `priceValidUntil` | string | Price expiration date |\r\n| `productId` | string | Item product ID |\r\n| `quantity` | integer | Item quantity |\r\n| `refId` | string | Item reference ID |\r\n| `rewardValue` | integer | Item reward value |\r\n\
| `seller` | string | Item seller |\r\n| `sellerSku` | string | Invoice Date |\r\n| `sellingPrice` | integer | Item selling price. For more accurate information, see the `priceDefinition` field |\r\n| `shippingPrice` | string | Item Shipping Price |\r\n| `tax` | integer | Item Tax |\r\n| `taxCode` | string | Item Tax Code |\r\n| `uniqueId` | string | Item Order Unique ID |\r\n| `unitMultiplier` | integer | Item Unit Multipler |\r\n| `lastChange` | string | Order Last Change Date |\r\n| `lastMessage` | string | initial excerpt from last message sent to the customer |\r\n| `marketingData` | string | Marketing Data Object |\r\n| `coupon` | string | Order Disccount Coupon |\r\n| `id` | string | Object ID, expected value \"marketingData\" |\r\n| `marketingTags` | object | Marketing Tags Array |\r\n| `utmCampaign` | string | UTM Campaign Parameters |\r\n| `utmMedium` | string | UTM Medium Parameters |\r\n| `utmPartner` | string | UTM Source Parameters |\r\n| `utmSource` | string | UTM Source Parameters|\r\n| `utmiCampaign` | string | UTMI Campaign Internal Parameters |\r\n| `utmiPart` | string | UTMI Part Internal Parameters |\r\n| `utmipage` | string | UTMI Page Internal Parameters |\r\n| `marketplace` | object | Marketplace Details Object |\r\n| `baseURL` | string | Marketplace Base URL |\r\n| `isCertified` | string | If is a Certified Marketplace |\r\n| `name` | string | Marketplace Name |\r\n| `marketplaceItems` | object | Marketplace Details Object |\r\n| `marketplaceOrderId` | string | Marketplace Order Id |\r\n| `marketplaceServicesEndpoint` | string | Marketplace Services Endpoint |\r\n| `merchantName` | string | Merchant Name |\r\n| `openTextField` | object | Open Text Field Object |\r\n| `value` | string | Open Text Field Value |\r\n| `orderFormId` | string | Order Form Id |\r\n| `orderGroup` | string | Order Group Id |\r\n| `orderId` | string | Order Id |\r\n| `origin` | string | Order Origin: \"Marketplace\", \"Fulfillment\", or \"Chain\" (for the third level in a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4?&utm_source=autocomplete#) purchase). |\r\n| `packageAttachment` | object | Package Object |\r\n| `packages` | object | Packages Details Object, populated after order invoiced |\r\n| `cfop` | string | Fiscal code for operations and installments |\r\n| `courier` | string | Package selected Courier |\r\n| `courierStatus` | string | Package Tracking Status |\r\n| `data` | object | Package Tracking Timeline |\r\n| `finished` | string | If the delivery are finished |\r\n| `status` | string | Courier Status |\r\n| `embeddedInvoice` | string | XML of the invoice |\r\n| `invoiceKey` | string | Invoice Credencial Key |\r\n| `invoiceNumber` | string | Package Invoice Number |\r\n| `invoiceUrl` | string | Package Invoice URL |\r\n| `invoiceValue` | string | Package Invoice Value |\r\n| `issuanceDate` | string | Package Issuance Date |\r\n| `items` | string | Items Package Array |\r\n| `description` | string | Item Desciprtion |\r\n| `itemIndex` | string | Item Index |\r\n| `price` | string | Item Price |\r\n| `quantity` | string | Item Quantity |\r\n| `unitMultiplier` | string | Unit Multiplier |\r\n| `trackingNumber` | string | Package Tracking Number |\r\n| `trackingUrl` | string | Tracking Order URL |\r\n| `type` | string | Invoice Type, expected values \"Output\" and \"Input\" |\r\n| `paymentData` | object | Payment Object |\r\n| `transactions` | object | Transactions Object |\r\n| `isActive` | boolean | If the payment is Active |\r\n| `merchantName` | string | Merchant Name|\r\n| `payments` | object | Payment Object |\r\n| `cardHolder` | string | Payment Card Holder |\r\n| `connectorResponses` | object | Connector Responses Object |\r\n| `billingAddress` | object | Billing Address information |\r\n| `Message` | string | Connector Responses Message |\r\n| `ReturnCode` | string | Connector Return Code |\r\n| `Tid` | string | Connector Transaction ID |\r\n| `acquirer` | string | Connector acquirer |\r\n| `authId` | string | Connector
authorization ID |\r\n| `dueDate` | string | Payment due date |\r\n| `firstDigits` | string | Payment card first digits |\r\n| `giftCardCaption` | string | Gift card caption |\r\n| `giftCardId` | string | Gift card ID |\r\n| `giftCardName` | string | Gift card name |\r\n| `group` | string | Payment group |\r\n| `id` | string | Payment ID |\r\n| `installments` | string | Payment installments quantity |\r\n| `lastDigits` | string | Payment card last digits |\r\n| `paymentSystem` | string | Payment system type ID |\r\n| `paymentSystemName` | string | Payment system name |\r\n| `redemptionCode` | string | Gift card redemption code |\r\n| `referenceValue` | string | Payment reference value |\r\n| `tid` | string | Payment transaction ID |\r\n| `url` | string | Payment URL |\r\n| `value` | string | Payment value with interest if it applies |\r\n| `transactionId` | string | Transaction Id |\r\n| `ratesAndBenefitsData` | string | Rates and Benefits Data Object |\r\n| `id` | string | Object ID, expected value \"ratesAndBenefitsData\" |\r\n| `rateAndBenefitsIdentifiers` | object | Rates and Benefits Details Object |\r\n| `additionalInfo` | string | Rates and Benefits Additional Info |\r\n| `description` | string | Rates and Benefits Description |\r\n| `featured` | string | If is allowed to acumulate the Rates and Benefits |\r\n| `matchedParameters` | object | March Parameters Array |\r\n| `name` | string | Rates and Benefits Name |\r\n| `roundingError` | integer | Rounding Error Total Amount |\r\n| `salesChannel` | string | Order Sales Channel Id |\r\n| `sellerOrderId` | string | Order Seller Id |\r\n| `sellers` | object | Sellers Array |\r\n| `id` | string | Seller Id |\r\n| `logo` | string | URL Seller Logo |\r\n| `name` | string | Seller Name |\r\n| `sequence` | string | Order Sequence ID |\r\n| `shippingData` | object | Shipping Data Object |\r\n| `address` | object | Shipping Address |\r\n| `addressId` | string | Shipping Address Id |\r\n| `addressType` | string | Shipping Address Type |\r\n| `city` | string | Shipping City |\r\n| `complement` | string | Shipping Complement |\r\n| `country` | string | Shipping Country in ISO 3166 ALPHA-3 abbreviation |\r\n| `geoCoordinates` | object | Shipping Geo Coordinates Array |\r\n| `neighborhood` | string | Shipping Neighborhood |\r\n| `number` | string | Shipping Number |\r\n| `postalCode` | string | Shipping Postal Code |\r\n| `receiverName` | string | Shipping Receiver Name |\r\n| `reference` | string | Shipping Reference |\r\n| `state` | string | Shipping State |\r\n| `street` | string | Shipping Street |\r\n| `id` | string | Object ID, expected value \"shippingData\"|\r\n| `logisticsInfo` | object | Logistics Info Object |\r\n| `addressId` | string | Adress Id |\r\n| `deliveryChannel` | string | Delivery Channel, allowed values \"delivery\" or \"pickup-in-point\" |\r\n| `deliveryCompany` | string | Courier Company Name |\r\n| `deliveryIds` | object | Delivery Ids Object |\r\n| `courierId` | string | Courier Id |\r\n| `courierName` | string | Courier Name |\r\n| `dockId` | string | Releated Dock Id |\r\n| `quantity` | integer | Items Quantity |\r\n| `warehouseId` | string | Releated Warehouse Id |\r\n| `deliveryWindow` | object | Delivery Window Object |\r\n| `endDateUtc` | string | Delivery Date End in UTC |\r\n| `price` | string | Delivery Window Cost |\r\n| `startDateUtc` | string | Delivery Date Starts in UTC |\r\n| `itemIndex` | integer | Logistic Info Item Index |\r\n| `listPrice` | integer | Logistic Info Item List Price |\r\n| `lockTTL` | string | Stock reservation waiting period |\r\n| `pickupStoreInfo` | object | Pickup Store Info Object |\r\n| `additionalInfo` | string | Pickup Store Additional Info |\r\n| `address` | string | Pickup Store Address |\r\n| `dockId` | string | Pickup Store Releated Dock Id |\r\n| `friendlyName` | string | Pickup Store Friendly Name |\r\n| `isPickupStore` | boolean | If is a Pickup Store |\r\n| `polygonName` | string | Releated Polygom Name |\r\n| `price` | integer | Logistic Info Item Price |\r\n| `selectedSla` | string | Selected
SLA |\r\n| `sellingPrice` | integer | Logistic Info Item Selling Price |\r\n| `shippingEstimate` | string | Estimate Shipping Duration |\r\n| `shippingEstimateDate` | string | Estimate Shipping Date |\r\n| `shipsTo` | object | Shipping Country in ISO 3166 ALPHA-3 abbreviation |\r\n| `slas` | object | SLAs Object |\r\n| `deliveryChannel` | string | Delivery Channel, allowed values \"delivery\" or \"pickup-in-point\" |\r\n| `deliveryWindow` | object | Delivery Window Object |\r\n| `endDateUtc` | string | Delivery Date End in UTC |\r\n| `price` | string | Delivery Window Cost |\r\n| `startDateUtc` | string | Delivery Date Starts in UTC |\r\n| `id` | string | SLA Id |\r\n| `pickupStoreInfo` | object | Pickup Store Details Object |\r\n| `additionalInfo` | string | Pickup Store Additional Info |\r\n| `address` | string | Pickup Store Address |\r\n| `dockId` | string | Pickup Store releated Dock Id |\r\n| `friendlyName` | string | Pickup Store Friendly Name |\r\n| `isPickupStore` | boolean | If is a Pickup Store |\r\n| `polygonName` | string | Releated Polygon Name |\r\n| `price` | integer | SLA Price |\r\n| `shippingEstimate` | string | SLA Shipping Estimate |\r\n| `selectedAddresses` | object | Selected Address Details Object |\r\n| `addressId` | string | Shipping Address Id |\r\n| `addressType` | string | Shipping Address Type |\r\n| `city` | string | Shipping City |\r\n| `complement` | string | Shipping Complement |\r\n| `country` | string | Shipping Country in ISO 3166 ALPHA-3 abbreviation |\r\n| `geoCoordinates` | object | Shipping Geo Coordinates Array |\r\n| `neighborhood` | string | Shipping Neighborhood |\r\n| `number` | string | Shipping Number |\r\n| `postalCode` | string | Shipping Postal Code |\r\n| `receiverName` | string | Shipping Receiver Name |\r\n| `reference` | string | Shipping Reference |\r\n| `state` | string | Shipping State |\r\n| `street` | string | Shipping Street |\r\n| `trackingHints` | array | Array of tracking hint objects, containing `\"courierName\"`, `\"trackingId\"`, `\"trackingLabel\"`, and `\"trackingUrl\"` |\r\n| `status` | string | Order Status |\r\n| `statusDescription` | string | Status Description |\r\n| `storePreferencesData` | object | Store Preferences Data Object |\r\n| `countryCode` | string | Country Code in ISO 3166 ALPHA-3 abbreviation |\r\n| `currencyCode` | string | Currency Code in ISO 4217 |\r\n| `currencyFormatInfo` | object | Currency Format Info Object |\r\n| `CurrencyDecimalDigits` | integer | Currency Decimal Digits |\r\n| `CurrencyDecimalSeparator` | string | Currency Decimal Separator |\r\n| `CurrencyGroupSeparator` | string | Currency Group Separator |\r\n| `CurrencyGroupSize` | integer | Currency Group Size |\r\n| `StartsWithCurrencySymbol` | boolean | If Starts With Currency Symbol |\r\n| `currencyLocale` | integer | LCID Decimal |\r\n| `currencySymbol` | string | Currency Symbol |\r\n| `timeZone` | string | Order Time Zone |\r\n| `totals` | object | Totals Object |\r\n| `id` | string | Totals Ids, expected values: \"Items\", \"Discounts\", \"Shipping\" and \"Tax\" |\r\n| `name` | string | Totals ID Description |\r\n| `value` | integer | Totals Value |\r\n| `value` | integer | Order Value |\r\n"
operationId: GetOrder2
parameters:
- $ref: '#/components/parameters/Content-Type'
- $ref: '#/components/parameters/Accept'
- $ref: '#/components/parameters/orderId'
- $ref: '#/components/parameters/reason'
responses:
'200':
description: OK
content:
application/json:
schema:
title: ''
type: object
properties:
emailTracked:
type: string
description: Email tracked.
example: [email protected]
approvedBy:
type: string
description: User that approved the order, in case of manual approval.
example: [email protected]
cancelledBy:
type: string
description: User that canceled the order.
example: [email protected]
cancelReason:
type: string
description: Reason for cancelation.
example: Stock shortage.
orderId:
type: string
description: Order ID.
example: v5195004lux-01
sequence:
type: string
description: Sequence number.
example: '502556'
marketplaceOrderId:
type: string
description: ID of the order in the marketplace.
example: ABC-v5195004lux-01
marketplaceServicesEndpoint:
type: string
description: Marketplace endpoint for post purchase communication.
example: http://oms.vtexinternal.com.br/api/oms?an=luxstore
sellerOrderId:
type: string
description: Seller order ID.
example: 00-v5195004lux-01
origin:
type: string
description: Origin.
example: Marketplace
affiliateId:
type: string
description: Three letter code identifying the marketplace where the order was placed.
example: ABC
salesChannel:
type: string
description: Sales channel.
example: '1'
merchantName:
type: string
description: Merchant name.
example: luxstore
status:
type: string
description: Status in the order workflow.
example: invoiced
statusDescription:
type: string
description: Status description which is displayed on the Admin panel.
example: Faturado
value:
type: integer
format: int32
description: Value in cents.
example: 2499
creationDate:
type: string
description: Creation date.
example: '2019-01-28T20:09:43+00:00'
lastChange:
type: string
description: Date of last change.
example: '2019-02-06T20:46:11.7010747+00:00'
orderGroup:
type: string
description: Order group.
example: '00'
totals:
type: array
description: Information on each of the order's totals.
items:
type: object
properties:
id:
type: string
description: Order's total ID.
example: Discounts
name:
type: string
description: Order's total name.
example: Discount total.
value:
type: integer
format: int32
description: Order's total value.
example: 199
items:
type: array
description: Information on each item in the order.
items:
type: object
properties:
uniqueId:
type: string
description: Order's item unique ID.
id:
type: string
description: ID.
productId:
type: string
description: Product ID.
productRefId:
type: string
description: Product Ref ID.
refId:
type: string
description: Ref ID.
ean:
type: string
description: European Article Number.
name:
type: string
description: Name.
skuName:
type: string
description: SKU name.
modalType:
type: string
description: Modal type.
parentItemIndex:
type: integer
description: Parent item index.
parentAssemblyBinding:
type: string
description: Parent assembly binding.
priceValidUntil:
type: string
description: Price expiration date and time.
tax:
type: integer
description: Tax value in cents.
price:
type: integer
description: Price in cents.
listPrice:
type: integer
description: List price in cents.
manualPrice:
type: integer
description: Manual price in cents.
manualPriceAppliedBy:
type: string
description: User that applied the manual price, if that is the case.
sellingPrice:
type: integer
description: Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
rewardValue:
type: integer
description: Reward value in cents.
isGift:
type: boolean
description: Indicates whether item is a gift.
additionalInfo:
type: object
description: Additional information.
properties:
dimension:
type: string
description: Dimension.
brandName:
type: string
description: Brand name.
brandId:
type: string
description: Brand ID.
offeringInfo:
type: string
description: Offering information.
offeringType:
type: string
description: Offering type.
offeringTypeId:
type: string
description: Offering type ID.
preSaleDate:
type: string
description: Presale date.
productCategoryIds:
type: string
description: Product category IDs.
productCategories:
type: object
description: Object, where each field is an ID from `productCategoryIds.
properties:
'{ID}':
type: string
description: Product category corresponding to the ID in the field key.
quantity:
type: integer
description: Quantity.
seller:
type: string
description: Seller.
sellerChain:
type: array
description: Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/pt/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
items:
type: string
description: Seller.
imageUrl:
type: string
description: Image URL.
detailUrl:
type: string
description: Detail URL.
bundleItems:
# --- truncated at 32 KB (197 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/openapi/vtex-orders-pii-openapi-original.yml