{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Userorderdetails",
"title": "Userorderdetails",
"required": [
"orderId",
"sequence",
"marketplaceOrderId",
"marketplaceServicesEndpoint",
"sellerOrderId",
"origin",
"affiliateId",
"salesChannel",
"merchantName",
"status",
"statusDescription",
"value",
"creationDate",
"lastChange",
"orderGroup",
"totals",
"items",
"marketplaceItems",
"clientProfileData",
"giftRegistryData",
"marketingData",
"ratesAndBenefitsData",
"shippingData",
"paymentData",
"packageAttachment",
"sellers",
"callCenterOperatorData",
"followUpEmail",
"lastMessage",
"hostname",
"invoiceData",
"changesAttachment",
"openTextField",
"roundingError",
"orderFormId",
"commercialConditionData",
"isCompleted",
"customData",
"storePreferencesData",
"allowCancellation",
"allowEdition",
"isCheckedIn",
"marketplace",
"authorizedDate",
"invoicedDate",
"cancelReason",
"itemMetadata",
"subscriptionData",
"taxData",
"checkedInPickupPointId",
"cancellationData",
"clientPreferencesData"
],
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "Order ID is a unique code that identifies an order."
},
"sequence": {
"type": "string",
"description": "Sequence is a six-digit string that follows the order ID. For example, in order `1268540501456-01 (501456)`, the sequence is `501456`."
},
"marketplaceOrderId": {
"type": "string",
"description": "Marketplace order ID."
},
"marketplaceServicesEndpoint": {
"type": "string",
"description": "Marketplace services endpoint."
},
"sellerOrderId": {
"type": "string",
"description": "ID of the seller related to the order. It can be a VTEX seller or an external seller."
},
"origin": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order."
},
"merchantName": {
"type": "string",
"description": "Name of the merchant."
},
"status": {
"type": "string",
"description": "Order [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)."
},
"statusDescription": {
"type": "string",
"description": "`Deprecated`. Status description which is displayed on the Admin panel. This field is obsolete and may not return any value.",
"deprecated": true
},
"value": {
"type": "integer",
"description": "Order's total amount."
},
"creationDate": {
"type": "string",
"description": "Order's creation date."
},
"lastChange": {
"type": "string",
"description": "Order's last change date."
},
"orderGroup": {
"type": "string",
"description": "Order's group ID."
},
"totals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Total"
},
"description": "List with details about orders' totals."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item"
},
"description": "Information about order's items."
},
"marketplaceItems": {
"type": "array",
"items": {
"type": "string"
},
"description": "Marketplace details object."
},
"clientProfileData": {
"$ref": "#/components/schemas/ClientProfileData"
},
"giftRegistryData": {
"type": "string",
"nullable": true,
"description": "Information about gift list, when it applies."
},
"marketingData": {
"type": "object",
"description": "Information about promotions and marketing. For example, coupon tracking information and internal or external UTMs.",
"required": [
"id",
"utmSource",
"utmPartner",
"utmMedium",
"utmCampaign",
"coupon",
"utmiCampaign",
"utmipage",
"utmiPart",
"marketingTags"
],
"properties": {
"id": {
"type": "string",
"description": "Object ID which expected value is `marketingData`."
},
"utmSource": {
"type": "string",
"description": "Value of the `utm_source` parameter of the URL that led to the request."
},
"utmPartner": {
"type": "string",
"description": "UTM Source Parameters."
},
"utmMedium": {
"type": "string",
"description": "Value of the `utm_medium` parameter of the URL that led to the request."
},
"utmCampaign": {
"type": "string",
"description": "Value of the `utm_campaign` parameter of the URL that led to the request."
},
"coupon": {
"type": "string",
"description": "Coupon's code information."
},
"utmiCampaign": {
"type": "string",
"description": "Internal UTM value `utmi_cp`."
},
"utmipage": {
"type": "string",
"description": "Internal UTM value `utmi_p`."
},
"utmiPart": {
"type": "string",
"description": "Internal UTM value `utmi_pc`."
},
"marketingTags": {
"type": "array",
"description": "Marketing tags information. This field can be used to register campaign data or informative tags regarding promotions.",
"items": {
"type": "string"
}
}
}
},
"ratesAndBenefitsData": {
"$ref": "#/components/schemas/RatesAndBenefitsData"
},
"shippingData": {
"$ref": "#/components/schemas/ShippingData"
},
"paymentData": {
"$ref": "#/components/schemas/PaymentData"
},
"packageAttachment": {
"$ref": "#/components/schemas/PackageAttachment"
},
"sellers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Seller"
},
"description": "List of all sellers associated with the order."
},
"callCenterOperatorData": {
"type": "string",
"nullable": true,
"description": "Call center operator responsible for the order."
},
"followUpEmail": {
"type": "string",
"description": "Email of the store's employee responsible for managing the order."
},
"lastMessage": {
"type": "string",
"nullable": true,
"description": "Last sent transactional message."
},
"hostname": {
"type": "string",
"description": "Account Hostname registered in License Manager."
},
"invoiceData": {
"type": "object",
"description": "Information pertinent to the order's invoice.",
"nullable": true
},
"changesAttachment": {
"$ref": "#/components/schemas/ChangesAttachment"
},
"openTextField": {
"type": "string",
"description": "Optional field with order's additional information. This field must be filled in using the following format: \n\r```\n\r{\r\n \"fieldExample\": \"ValueExample\"\r\n }\n\r```\n\r.",
"nullable": true
},
"roundingError": {
"type": "integer",
"description": "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": {
"type": "string",
"description": "[Order form](https://developers.vtex.com/docs/guides/orderform-fields) ID."
},
"commercialConditionData": {
"type": "string",
"nullable": true,
"description": "Information about commercial conditions."
},
"isCompleted": {
"type": "boolean",
"description": "When set as `true`, the order's payment has been settled, and when set as `false`, it has not been settled yet."
},
"customData": {
"type": "string",
"nullable": true,
"description": "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": {
"$ref": "#/components/schemas/StorePreferencesData"
},
"allowCancellation": {
"type": "boolean",
"description": "When set as `true`, the order can be canceled, and when set as `false`, it is no longer possible to cancel the order."
},
"allowEdition": {
"type": "boolean",
"description": "When set as `true`, the order can be edited, and when set as `false`, it is no longer possible to edit the order."
},
"isCheckedIn": {
"type": "boolean",
"description": "This field is set `true` when the order was made via inStore and `false` when it was not."
},
"marketplace": {
"$ref": "#/components/schemas/Marketplace"
},
"authorizedDate": {
"type": "string",
"description": "Authorized order date."
},
"invoicedDate": {
"type": "string",
"nullable": true,
"description": "Order's invoice date."
},
"cancelReason": {
"type": "string",
"description": "Reason for order cancellation.",
"nullable": true
},
"itemMetadata": {
"type": "object",
"description": "Metadata information about the order's items.",
"required": [
"Items"
],
"properties": {
"Items": {
"type": "array",
"description": "Metadata items.",
"items": {
"type": "object",
"required": [
"Id",
"Seller",
"Name",
"SkuName",
"ProductId",
"RefId",
"Ean",
"ImageUrl",
"DetailUrl",
"AssemblyOptions"
],
"properties": {
"Id": {
"type": "string",
"description": "Item's SKU ID, which is a unique numerical identifier."
},
"Seller": {
"type": "string",
"description": "Seller ID that identifies the seller the item belongs to."
},
"Name": {
"type": "string",
"description": "Name of the item as displayed to customers in the storefront."
},
"SkuName": {
"type": "string",
"description": "Name of the SKU corresponding to the item."
},
"ProductId": {
"type": "string",
"description": "ID of the Product associated with the item."
},
"RefId": {
"type": "string",
"description": "Item's reference ID."
},
"Ean": {
"type": "string",
"description": "EAN of the item."
},
"ImageUrl": {
"type": "string",
"description": "Item's SKU image URL."
},
"DetailUrl": {
"type": "string",
"description": "URL slug of the item."
},
"AssemblyOptions": {
"type": "array",
"description": "Displays information about [assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) related to the item, if there are any.",
"items": {
"required": [
"Id",
"Name",
"Required",
"InputValues",
"Composition"
],
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "ID of the attachment related to the order."
},
"Name": {
"type": "string",
"description": "Name of the attachment related to the order."
},
"Required": {
"type": "boolean",
"description": "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": {
"type": "object",
"description": "Displays the attachment's content.",
"nullable": true
},
"Composition": {
"type": "object",
"description": "Displays the attachment's composition.",
"nullable": true
}
}
}
}
}
}
}
}
},
"subscriptionData": {
"type": "object",
"description": "Information about [subscriptions](https://help.vtex.com/tutorial/how-subscriptions-work--frequentlyAskedQuestions_4453).",
"nullable": true,
"required": [
"SubscriptionGroupId",
"Subscriptions"
],
"properties": {
"SubscriptionGroupId": {
"type": "string",
"description": "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": {
"type": "array",
"description": "List with subscriptions and their details.",
"nullable": true,
"items": {
"type": "object",
"required": [
"ExecutionCount",
"PriceAtSubscriptionDate",
"ItemIndex",
"Plan"
],
"properties": {
"ExecutionCount": {
"type": "integer",
"description": "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": {
"type": "number",
"description": "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.",
"deprecated": true
},
"ItemIndex": {
"type": "integer",
"description": "Each item in the subscriptions' order is identified by an index. The position starts in`0`, followed by `1`, `2`, and so on."
},
"Plan": {
"type": "object",
"description": "Information about the subscription's validility and frequency.",
"required": [
"type",
"frequency",
"validity"
],
"properties": {
"type": {
"type": "string",
"description": "Type of plan."
},
"frequency": {
"type": "object",
"description": "Information about subscriptions' recurrence.",
"required": [
"periodicity",
"interval"
],
"properties": {
"periodicity": {
"type": "string",
"description": "Defines the subscriptions recurrence period. The possible values are `DAILY`,`WEEKLY`, `MONTHLY` and `YEARLY`."
},
"interval": {
"type": "integer",
"description": "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": {
"type": "object",
"description": "Information about the period during which the subscription will be valid.",
"required": [
"begin",
"end"
],
"properties": {
"begin": {
"type": "string",
"description": "Subscriptions' beginning date with the format `yyyy-mm-ddThh:mm:ss`."
},
"end": {
"type": "string",
"description": "Subscriptions' ending date with the format `yyyy-mm-ddThh:mm:ss`."
}
}
}
}
}
}
}
}
}
},
"taxData": {
"type": "object",
"description": "Order's tax information.",
"required": [
"areTaxesDesignatedByMarketplace",
"taxInfoCollection"
],
"properties": {
"areTaxesDesignatedByMarketplace": {
"type": "boolean",
"description": "If the taxes were designated by the marketplace (`true`) or not (`false`)."
},
"taxInfoCollection": {
"type": "array",
"description": "Array with taxes' details.",
"items": {
"type": "object",
"required": [
"itemIndex",
"sku",
"priceTags"
],
"properties": {
"itemIndex": {
"type": "integer",
"description": "Item's indexing number."
},
"sku": {
"type": "string",
"description": "Alphanumeric sequence that identifies an SKU."
},
"priceTags": {
"type": "array",
"description": "Price tag information.",
"items": {
"type": "object",
"required": [
"isPercentual",
"name",
"rawValue"
],
"properties": {
"isPercentual": {
"type": "boolean",
"description": "If the tax is a percentage (`true`) or note (`false`)."
},
"name": {
"type": "string",
"description": "Name that identifies the tax."
},
"rawValue": {
"type": "string",
"description": "The amount that corresponds to the tax."
}
}
}
}
}
}
}
}
},
"checkedInPickupPointId": {
"type": "string",
"description": "If the field `isCheckedIn` is set as `true`, the `checkedInPickupPointId` will retrieve the ID of the physical store where the order was made."
},
"cancellationData": {
"type": "object",
"description": "Information about order cancellation, when it applies.",
"required": [
"RequestedByUser",
"RequestedBySystem",
"RequestedBySellerNotification",
"RequestedByPaymentNotification",
"Reason",
"CancellationDate"
],
"properties": {
"RequestedByUser": {
"type": "boolean",
"description": "If the order cancellation was requested by the costumer (`true`) or not (`false`)."
},
"RequestedBySystem": {
"type": "boolean",
"description": "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": {
"type": "boolean",
"description": "If the order cancellation was requested by the seller (`true`) or not (`false`)."
},
"RequestedByPaymentNotification": {
"type": "boolean",
"description": "If the order cancellation was requested by the payment gateway (`true`) or not (`false`)."
},
"Reason": {
"type": "string",
"description": "The reason why the order was cancelled."
},
"CancellationDate": {
"type": "string",
"description": "The date when the order was cancelled."
}
}
},
"clientPreferencesData": {
"type": "object",
"description": "Information about customer's preferences.",
"required": [
"locale",
"optinNewsLetter"
],
"properties": {
"locale": {
"type": "string",
"description": "Customer's prefered language while accessing the store."
},
"optinNewsLetter": {
"type": "boolean",
"description": "When set as `true`, this field indicates customers opted to receive the newsletters, and when set as `false`, it means they did not."
}
}
}
},
"example": {
"orderId": "v502556llux-01",
"sequence": "502556",
"marketplaceOrderId": "",
"marketplaceServicesEndpoint": "http://oms.vtexinternal.com.br/api/oms?an=luxstore",
"sellerOrderId": "00-v502556llux-01",
"origin": "Marketplace",
"affiliateId": "",
"salesChannel": "1",
"merchantName": "luxstore",
"status": "handling",
"statusDescription": "Preparando Entrega",
"value": 1160,
"creationDate": "2019-01-28T20:09:43.899958+00:00",
"lastChange": "2019-02-06T20:46:11.7010747+00:00",
"orderGroup": "v502556lspt",
"totals": [
{
"id": "Items",
"name": "Total dos Itens",
"value": 3290
},
{
"id": "Discounts",
"name": "Total dos Descontos",
"value": 0
},
{
"id": "Shipping",
"name": "Total do Frete",
"value": 1160
},
{
"id": "Tax",
"name": "Total da Taxa",
"value": 0
},
{
"id": "Change",
"name": "Total das mudan\u00e7as",
"value": -3290
}
],
"items": [
{
"uniqueId": "87F0945396994B349158C7D9C9941442",
"id": "1234568358",
"productId": "9429485",
"ean": null,
"lockId": "00-v502556llux-01",
"itemAttachment": {
"content": {},
"name": null
},
"attachments": [],
"quantity": 1,
"seller": "1",
"name": "Bay Max L",
"refId": "BIGHEROBML",
"price": 3290,
"listPrice": 3290,
"manualPrice": null,
"priceTags": [],
"imageUrl": "http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000",
"detailUrl": "/bay-max-9429485/p",
"components": [],
"bundleItems": [],
"params": [],
"offerings": [],
"attachmentOfferings": [
{
"name": "vtex.subscription.weekly",
"required": false,
"schema": {
"vtex.subscription.key.frequency": {
"MaximumNumberOfCharacters": 7,
"Domain": [
" 1 week",
" 2 week",
" 3 week",
" 4 week"
]
}
}
}
],
"sellerSku": "1234568358",
"priceValidUntil": null,
"commission": 0,
"tax": 0,
"preSaleDate": null,
"additionalInfo": {
"brandName": "VTEX",
"brandId": "2000023",
"categoriesIds": "/1/",
"productClusterId": "135,142",
"commercialConditionId": "5",
"dimension": {
"cubicweight": 0.7031,
"height": 15,
"length": 15,
"weight": 15,
"width": 15
},
"offeringInfo": null,
"offeringType": null,
"offeringTypeId": null
},
"measurementUnit": "un",
"unitMultiplier": 1,
"sellingPrice": 3290,
"isGift": false,
"shippingPrice": null,
"rewardValue": 0,
"freightCommission": 0,
"priceDefinitions": {
"sellingPrices": [
{
"value": 99,
"quantity": 1
}
],
"calculatedSellingPrice": 99,
"total": 99
},
"taxCode": null,
"parentItemIndex": null,
"parentAssemblyBinding": null,
"callCenterOperator": "callCenterOp5473869",
"serialNumbers": "3",
"assemblies": [],
"costPrice": 52
}
],
"marketplaceItems": [],
"clientProfileData": {
"id": "clientProfileData",
"email": "[email protected]",
"firstName": "Rodrigo",
"lastName": "Cunha",
"documentType": "cpf",
"document": "11047867702",
"phone": "+5521972321094",
"corporateName": null,
"tradeName": null,
"corporateDocument": null,
"stateInscription": null,
"corporatePhone": null,
"isCorporate": false,
"userProfileId": "5a3692de-358a-4bea-8885-044bce33bb93",
"customerClass": null
},
"giftRegistryData": null,
"marketingData": {
"id": "marketingData",
"utmSource": "fb",
"utmPartner": "utm partner",
"utmMedium": "utm medium",
"utmCampaign": "christmas",
"coupon": "sale",
"utmiCampaign": " ",
"utmipage": " ",
"utmiPart": " ",
"marketingTags": [
"vtex-subscription"
]
},
"ratesAndBenefitsData": {
"id": "ratesAndBenefitsData",
"rateAndBenefitsIdentifiers": []
},
"shippingData": {
"id": "shippingData",
"address": {
"addressType": "residential",
"receiverName": "Rodrigo Cunha",
"addressId": "-1425945657910",
"versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f",
"entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad",
"postalCode": "22250-040",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BRA",
"street": "Praia de Botafogo",
"number": "518",
"neighborhood": "Botafogo",
"complement": "10",
"reference": null,
"geoCoordinates": []
},
"logisticsInfo": [
{
"itemIndex": 0,
"selectedSla": "Normal",
"lockTTL": "10d",
"price": 1160,
"listPrice": 1160,
"sellingPrice": 1160,
"deliveryWindow": null,
"deliveryCompany": "Todos os CEPS",
"shippingEstimate": "5bd",
"shippingEstimateDate": "2019-02-04T20:33:46.4595004+00:00",
"slas": [
{
"id": "Normal",
"name": "Normal",
"shippingEstimate": "5bd",
"deliveryWindow": null,
"price": 1160,
"deliveryChannel": "delivery",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false
},
"polygonName": "region13",
"lockTTL": "12d",
"pickupPointId": "1_VTEX-RJ",
"transitTime": "0d",
"pickupDistance": 29.861602783203125
},
{
"id": "Expressa",
"name": "Expressa",
"shippingEstimate": "5bd",
"deliveryWindow": null,
"price": 1160,
"deliveryChannel": "delivery",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false
},
"polygonName": "region13",
"lockTTL": "12d",
"pickupPointId": "1_VTEX-RJ",
"transitTime": "0d",
"pickupDistance": 29.861602783203125
},
{
"id": "Quebra Kit",
"name": "Quebra Kit",
"shippingEstimate": "2bd",
"deliveryWindow": null,
"price": 1392,
"deliveryChannel": "delivery",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false
},
"polygonName": "region13",
"lockTTL": "12d",
"pickupPointId": "1_VTEX-RJ",
"transitTime": "0d",
"pickupDistance": 29.861602783203125
},
{
"id": "Sob Encomenda",
"name": "Sob Encomenda",
"shippingEstimate": "32bd",
"deliveryWindow": null,
"price": 1392,
"deliveryChannel": "delivery",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false
},
"polygonName": "region13",
"lockTTL": "12d",
"pickupPointId": "1_VTEX-RJ",
"transitTime": "0d",
"pickupDistance": 29.861602783203125
}
],
"shipsTo": [
"BRA"
],
"deliveryIds": [
{
"courierId": "197a56f",
"courierName": "Todos os CEPS",
"dockId": "1",
"quantity": 1,
"warehouseId": "1_1",
"accountCarrierName": "recorrenciaqa",
"kitItemDetails": []
}
],
"deliveryChannels": [
{
"id": "delivery",
"stockBalance": 0
}
],
"deliveryChannel": "delivery",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false
},
"addressId": "-1425945657910",
"versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f",
"entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad",
"polygonName": "region56",
"pickupPointId": "1_VTEX-RJ",
"transitTime": "3d"
}
],
"trackingHints": null,
"selectedAddresses": [
{
"addressId": "-1425945657910",
"versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f",
"entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad",
"addressType": "residential",
"receiverName": "Rodrigo Cunha",
"street": "Praia de Botafogo",
"number": "518",
"complement": "10",
"neighborhood": "Botafogo",
"postalCode": "22250-040",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BRA",
"reference": null,
"geoCoordinates": []
}
]
},
"paymentData": {
"transactions": [
{
"isActive": true,
"transactionId": "418213DE29634837A63DD693A937A696",
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/json-schema/vtex-userorderdetails-schema.json