{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/GetOrder",
"title": "GetOrder",
"required": [
"emailTracked",
"approvedBy",
"cancelledBy",
"cancelReason",
"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"
],
"type": "object",
"properties": {
"emailTracked": {
"type": "string"
},
"approvedBy": {
"type": "string",
"nullable": true
},
"cancelledBy": {
"type": "string",
"description": "User that canceled the order.",
"nullable": true
},
"cancelReason": {
"type": "string",
"nullable": true,
"description": "Explanation for cancellation."
},
"orderId": {
"type": "string"
},
"sequence": {
"type": "string"
},
"marketplaceOrderId": {
"type": "string"
},
"marketplaceServicesEndpoint": {
"type": "string"
},
"sellerOrderId": {
"type": "string"
},
"origin": {
"type": "string"
},
"affiliateId": {
"type": "string"
},
"salesChannel": {
"type": "string"
},
"merchantName": {
"type": "string",
"nullable": true
},
"status": {
"type": "string"
},
"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"
},
"creationDate": {
"type": "string"
},
"lastChange": {
"type": "string"
},
"orderGroup": {
"type": "string",
"nullable": true
},
"totals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Total"
},
"description": "Array containing totals' information."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Item"
},
"description": "Array containing items' information."
},
"marketplaceItems": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array containing marketplace items information."
},
"clientProfileData": {
"$ref": "#/components/schemas/ClientProfileData"
},
"giftRegistryData": {
"type": "string",
"nullable": true
},
"marketingData": {
"type": "string",
"nullable": true
},
"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": "Array containing sellers information."
},
"callCenterOperatorData": {
"type": "string",
"nullable": true
},
"followUpEmail": {
"type": "string"
},
"lastMessage": {
"type": "string",
"nullable": true
},
"hostname": {
"type": "string"
},
"invoiceData": {
"type": "object",
"description": "Information pertinent to the order's invoice.",
"nullable": true
},
"changesAttachment": {
"$ref": "#/components/schemas/ChangesAttachment"
},
"openTextField": {
"type": "string",
"description": "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"
},
"orderFormId": {
"type": "string"
},
"commercialConditionData": {
"type": "string",
"nullable": true
},
"isCompleted": {
"type": "boolean"
},
"customData": {
"type": "string",
"nullable": true
},
"storePreferencesData": {
"$ref": "#/components/schemas/StorePreferencesData"
},
"allowCancellation": {
"type": "boolean"
},
"allowEdition": {
"type": "boolean"
},
"isCheckedIn": {
"type": "boolean"
},
"marketplace": {
"$ref": "#/components/schemas/Marketplace"
},
"authorizedDate": {
"type": "string"
},
"invoicedDate": {
"type": "string",
"nullable": true
}
},
"example": {
"emailTracked": "[email protected]",
"approvedBy": "Person's name",
"cancelledBy": "Person's name",
"cancelReason": "Explanation for cancellation",
"orderId": "v5195004lux-01",
"sequence": "502556",
"marketplaceOrderId": "",
"marketplaceServicesEndpoint": "http://oms.vtexinternal.com.br/api/oms?an=luxstore",
"sellerOrderId": "00-v5195004lux-01",
"origin": "Marketplace",
"affiliateId": "",
"salesChannel": "1",
"merchantName": null,
"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": null,
"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-v5195004lux-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": "VTEX",
"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": "marketing data",
"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": "300",
"neighborhood": "Botafogo",
"complement": "3",
"reference": null,
"geoCoordinates": []
},
"logisticsInfo": [
{
"itemIndex": 1,
"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": "region196",
"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": "region196",
"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": "region196",
"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
},
{
"id": "pickup-in-point",
"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": "region46",
"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",
"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": "Loja do Suporte",
"logo": "https://sellersLogo/images.png",
"fulfillmentEndpoint": "http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName"
}
],
"callCenterOperatorData": null,
"followUpEmail": "[email protected]",
"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": "v5195004lux-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": false,
"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
}
}