Vtex Userorderdetails Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "Userorderdetails",
"method": "GET",
"path": "/api/oms/user/orders/{orderId}",
"summary": "VTex Retrieve user order details",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"orderId": "1172452900788-01",
"sequence": "502556",
"marketplaceOrderId": "",
"marketplaceServicesEndpoint": "http://oms.vtexinternal.com.br/api/oms?an=luxstore",
"sellerOrderId": "00-v502556llux-01",
"origin": "Marketplace",
"affiliateId": "GHB",
"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": "3256873",
"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": "rodrigo.cunha@vtex.com.br",
"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 name",
"utmMedium": "utm medium name",
"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": "region196",
"lockTTL": "12d",
"pickupPointId": "1_VTEX-RJ",
"transitTime": "3d",
"pickupDistance": 0
},
{
"id": "Expressa",
"name": "Expressa",
"shippingEstimate": "5bd",
"deliveryWindow": null,
"price": 1160,
"deliveryChannel": "delivery",
"pickupStoreInfo": {
"additionalInfo": null,
"address": null,
"dockId": null,
"friendlyName": null,
"isPickupStore": false
},
"polygonName": null,
"lockTTL": "12d",
"pickupPointId": "1_VTEX-RJ",
"transitTime": "3d",
"pickupDistance": 0
},
{
"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": null,
"lockTTL": "12d",
"pickupPointId": "1_VTEX-RJ",
"transitTime": "3d",
"pickupDistance": 0
},
{
"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": null,
"lockTTL": "12d",
"pickupPointId": "1_VTEX-RJ",
"transitTime": "3d",
"pickupDistance": 0
}
],
"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": null,
"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": {
"giftCards": [],
"transactions": [
{
"isActive": true,
"transactionId": "418213DE29634837A63DD693A937A696",
"merchantName": "luxstore",
"payments": [
{
"id": "D3DEECAB3C6C4B9EAF8EF4C1FE062FF3",
"paymentSystem": "6",
"paymentSystemName": "Boleto Banc\u00e1rio",
"value": 4450,
"installments": 1,
"referenceValue": 4450,
"cardHolder": null,
"cardNumber": null,
"firstDigits": null,
"lastDigits": null,
"cvv2": null,
"expireMonth": null,
"expireYear": null,
"url": "https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}",
"giftCardId": null,
"giftCardName": null,
"giftCardCaption": null,
"redemptionCode": null,
"group": "bankInvoice",
"tid": null,
"dueDate": "2019-02-02",
"connectorResponses": {
"Tid": "94857956",
"ReturnCode": "200",
"Message": "logMessage",
"authId": "857956"
},
"giftCardProvider": "presentCard",
"giftCardAsDiscount": false,
"koinUrl": "koinURL",
"accountId": "5BC5C6B417FE432AB971B1D399F190C9",
"parentAccountId": "5BC5C6B417FE432AB971B1D399F190C9",
"bankIssuedInvoiceIdentificationNumber": "23797770100000019003099260100022107500729050",
"bankIssuedInvoiceIdentificationNumberFormatted": "32534.95739 75945.24534 54395.734214 5",
"bankIssuedInvoiceBarCodeNumber": "325349573975945245345439573421443986734065",
"bankIssuedInvoiceBarCodeType": "i25",
"billingAddress": {}
}
]
}
]
},
"packageAttachment": {
"packages": []
},
"sellers": [
{
"id": "1",
"name": "Lux Store",
"logo": "https://sellersLogo/images.png",
"fulfillmentEndpoint": "http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName"
}
],
"callCenterOperatorData": null,
"followUpEmail": "7bf3a59bbc56402c810bda9521ba449e@ct.vtex.com.br",
"lastMessage": null,
"hostname": "luxstore",
"invoiceData": null,
"changesAttachment": {
"id": "changeAttachment",
"changesData": [
{
"reason": "Blah",
"discountValue": 3290,
"incrementValue": 0,
"itemsAdded": [],
"itemsRemoved": [
{
"id": "1234568358",
"name": "Bay Max L",
"quantity": 1,
"price": 3290,
"unitMultiplier": null
}
],
"receipt": {
"date": "2019-02-06T20:46:04.4003606+00:00",
"orderId": "v502556llux-01",
"receipt": "029f9ab8-751a-4b1e-bf81-7dd25d14b49b"
}
}
]
},
"openTextField": null,
"roundingError": 0,
"orderFormId": "caae7471333e403f959fa5fd66951340",
"commercialConditionData": null,
"isCompleted": true,
"customData": null,
"storePreferencesData": {
"countryCode": "BRA",
"currencyCode": "BRL",
"currencyFormatInfo": {
"CurrencyDecimalDigits": 2,
"CurrencyDecimalSeparator": ",",
"CurrencyGroupSeparator": ".",
"CurrencyGroupSize": 3,
"StartsWithCurrencySymbol": true
},
"currencyLocale": 1046,
"currencySymbol": "R$",
"timeZone": "E. South America Standard Time"
},
"allowCancellation": true,
"allowEdition": false,
"isCheckedIn": false,
"marketplace": {
"baseURL": "http://oms.vtexinternal.com.br/api/oms?an=luxstore",
"isCertified": null,
"name": "luxstore"
},
"authorizedDate": "2019-01-28T20:33:04+00:00",
"invoicedDate": null,
"cancelReason": "The size was too big.",
"itemMetadata": {
"Items": [
{
"Id": "18",
"Seller": "1",
"Name": "Cat food",
"SkuName": "Cat food",
"ProductId": "6",
"RefId": "105",
"Ean": "43673557",
"ImageUrl": "http://store.vteximg.com.br/ids/155392-55-55/AlconKOI.jpg?v=635918402228600000",
"DetailUrl": "/catfood/p",
"AssemblyOptions": [
{
"Id": "vtex.subscription.plan-ana",
"Name": "vtex.subscription.plan-ana",
"Required": false,
"InputValues": {
"vtex.subscription.key.frequency": {
"MaximumNumberOfCharacters": 8,
"Domain": [
"4 month",
"1 month"
]
}
},
"Composition": {}
}
]
}
]
},
"subscriptionData": {
"SubscriptionGroupId": "A64AC73C0FB8693A7ADB4AC69CA4FD5F",
"Subscriptions": [
{
"ExecutionCount": 724,
"PriceAtSubscriptionDate": 100,
"ItemIndex": 0,
"Plan": {
"type": "RECURRING_PAYMENT",
"frequency": {
"periodicity": "DAILY",
"interval": 1
},
"validity": {
"begin": "2022-01-10T00:00:00.0000000+00:00",
"end": "2024-02-03T00:00:00.0000000+00:00"
}
}
}
]
},
"taxData": {
"areTaxesDesignatedByMarketplace": true,
"taxInfoCollection": [
{
"itemIndex": 0,
"sku": "COLOCAR_O_SKUID",
"priceTags": [
{
"isPercentual": false,
"name": "Taxes (Magazine Luisa)",
"rawValue": "COLOCAR_O_VALOR_SEM_DECIMAL"
}
]
}
]
},
"checkedInPickupPointId": "storeNameExample_901",
"cancellationData": {
"RequestedByUser": true,
"RequestedBySystem": false,
"RequestedBySellerNotification": false,
"RequestedByPaymentNotification": false,
"Reason": "Item was too big in the client.",
"CancellationDate": "2022-10--05T15:40:33"
},
"clientPreferencesData": {
"locale": "en-US",
"optinNewsLetter": false
}
}
}
]
}