Vtex Addshippingaddress 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": "AddShippingAddress",
"method": "POST",
"path": "/api/checkout/pub/orderForm/{orderFormId}/attachments/shippingData",
"summary": "VTex Add shipping address and select delivery option",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"orderFormId": "2f586e50342a4f87b7e0654c56299e88",
"salesChannel": "1",
"loggedIn": false,
"isCheckedIn": false,
"storeId": "1",
"checkedInPickupPointId": "21",
"allowManualPrice": false,
"canEditData": true,
"userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
"userType": "User type",
"ignoreProfileData": false,
"value": 0,
"messages": [],
"items": [],
"selectableGifts": [],
"totalizers": [],
"shippingData": {
"address": {
"addressType": "residential",
"receiverName": "Clark Kent",
"addressId": "c3701fc4c61b4d1b91f67e81415db44d",
"isDisposable": true,
"postalCode": "12345000",
"city": "Rio de Janeiro",
"state": "ST",
"country": "BRA",
"street": "My street",
"number": "1091",
"neighborhood": "My neighborhood",
"complement": null,
"reference": null,
"geoCoordinates": []
},
"logisticsInfo": [
{
"itemIndex": 0,
"selectedSla": "Normal",
"selectedDeliveryChannel": "delivery",
"addressId": "f239ad30f8c948a382543ab2c739b967",
"slas": [
{
"id": "Retirada (VTEXSP)",
"deliveryChannel": "pickup-in-point",
"name": "Retirada (VTEXSP)",
"deliveryIds": [
{
"courierId": "1ee17c2",
"warehouseId": "1_1",
"dockId": "1",
"courierName": "Retira em Loja",
"quantity": 2,
"kitItemDetails": []
}
],
"shippingEstimate": "3bd",
"shippingEstimateDate": null,
"lockTTL": null,
"availableDeliveryWindows": {
"startDateUtc": "2017-03-27T00:00:00+00:00",
"endDateUtc": "2017-03-27T00:00:00+00:00",
"price": 0,
"lisPrice": 0,
"tax": 0
},
"deliveryWindow": {
"startDateUtc": "2014-04-21T09:00:00+00:00",
"endDateUtc": "2014-04-21T12:00:00+00:00",
"price": 0,
"listprice": 1000,
"tax": 0
},
"price": 250,
"listPrice": 250,
"tax": 0,
"pickupStoreInfo": {
"isPickupStore": true,
"friendlyName": "VTEX SP",
"address": {
"addressType": "pickup",
"receiverName": "Clark Kent",
"addressId": "VTEXSP",
"isDisposable": true,
"postalCode": "04538-132",
"city": "S\u00e3o Paulo",
"state": "SP",
"country": "BRA",
"street": "Avenida Brigadeiro Faria Lima",
"number": "4440",
"neighborhood": "Itaim Bibi",
"complement": "Apto 101",
"reference": null,
"geoCoordinates": [
-47.924747467041016,
-15.832582473754883
]
},
"additionalInfo": "Additional info",
"dockId": "1"
},
"pickupPointId": "1_VTEXSP",
"pickupDistance": 15,
"polygonName": null,
"transitTime": "3bd"
}
],
"shipsTo": [
"BRA",
"COL",
"USA"
],
"itemId": "2",
"deliveryChannels": [
{
"id": "pickup-in-point"
},
{
"id": "delivery"
}
]
}
],
"selectedAddresses": [
{
"addressType": "residential",
"receiverName": "Clark Kent",
"addressId": "c3701fc4c61b4d1b91f67e81415db44d",
"isDisposable": true,
"postalCode": "12345000",
"city": "Rio de Janeiro",
"state": "ST",
"country": "BRA",
"street": "My street",
"number": "1091",
"neighborhood": "My neighborhood",
"complement": null,
"reference": null,
"geoCoordinates": []
}
],
"availableAddresses": [
{
"addressType": "residential",
"receiverName": "Clark Kent",
"addressId": "ae3173b32bf64663a81fc42b057be211",
"isDisposable": true,
"postalCode": "70386060",
"city": "Bras\u00edlia",
"state": "DF",
"country": "BRA",
"street": "Quadra SQS 116 Bloco F",
"number": "101",
"neighborhood": "Asa Sul",
"complement": null,
"reference": null,
"geoCoordinates": [
-47.92592239379883,
-15.832707405090332
]
},
{
"addressType": "residential",
"receiverName": "Clark Kent",
"addressId": "449dcbe11c5844098fb4545a49cf6e07",
"isDisposable": true,
"postalCode": "00076555",
"city": "Bras\u00edlia",
"state": "DF",
"country": "BRA",
"street": "My street",
"number": "101",
"neighborhood": "Asa sul",
"complement": null,
"reference": null,
"geoCoordinates": []
},
{
"addressType": "residential",
"receiverName": "Clark Kent",
"addressId": "c3701fc4c61b4d1b91f67e81415db44d",
"isDisposable": true,
"postalCode": "12345000",
"city": "Rio de Janeiro",
"state": "ST",
"country": "BRA",
"street": "My street",
"number": "1091",
"neighborhood": "My neighborhood",
"complement": null,
"reference": null,
"geoCoordinates": []
}
],
"pickupPoints": []
},
"clientProfileData": {
"email": "clark.kent@example.com",
"firstName": "Clark",
"lastName": "Kent",
"document": "12345678900",
"documentType": "cpf",
"phone": "+5521998765432",
"corporateName": "company-name",
"tradeName": "trade-name",
"corporateDocument": "12345678000100",
"stateInscription": "12345678",
"corporatePhone": "551100988887777",
"isCorporate": false,
"profileCompleteOnLoading": false,
"profileErrorOnLoading": false,
"customerClass": null
},
"paymentData": {
"updateStatus": "updated",
"installmentOptions": [],
"paymentSystems": [],
"payments": [
{
"paymentSystem": 6,
"bin": null,
"accountId": "12",
"tokenId": null,
"value": 34390,
"referenceValue": 34390,
"giftCardRedemptionCode": null,
"giftCardProvider": null,
"giftCardId": null
}
],
"giftCards": [],
"giftCardMessages": [],
"availableAccounts": [],
"availableTokens": []
},
"marketingData": null,
"sellers": [],
"clientPreferencesData": {
"locale": "pt-BR",
"optinNewsLetter": false
},
"commercialConditionData": null,
"storePreferencesData": {
"countryCode": "BRA",
"saveUserData": true,
"timeZone": "E. South America Standard Time",
"currencyCode": "BRL",
"currencyLocale": 1046,
"currencySymbol": "R$",
"currencyFormatInfo": {
"currencyDecimalDigits": 2,
"currencyDecimalSeparator": ",",
"currencyGroupSeparator": ".",
"currencyGroupSize": 3,
"startsWithCurrencySymbol": true
}
},
"giftRegistryData": null,
"openTextField": null,
"invoiceData": null,
"customData": null,
"itemMetadata": {
"items": [
{
"id": "1",
"seller": "1",
"name": "Ra\u00e7\u00e3o Royal Canin Feline Urinary 500g",
"skuName": "Ra\u00e7\u00e3o Royal Canin Feline Urinary 500g",
"productId": "1",
"refId": "0001",
"ean": "123456789",
"imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
"detailUrl": "/racao-royal-canin-feline-urinary/p",
"assemblyOptions": []
}
]
},
"hooksData": null,
"ratesAndBenefitsData": {
"rateAndBenefitsIdentifiers": [],
"teaser": []
},
"subscriptionData": null,
"itemsOrdination": {
"criteria": "NAME",
"ascending": true
}
}
}
]
}