Vtex Createservice 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": "Createservice",
"method": "POST",
"path": "/create-service",
"summary": "VTex Create service",
"requestExamples": [
{
"contentType": "application/json",
"example": {
"orderId": "SLR-29384924-01",
"carrierId": "servientrega-50461c9f3335",
"seller": "qaolimpica",
"sender": {
"name": "Tabitha Sears",
"phone": "+57 2305781612",
"email": "tabitha_sears@fortean.brother",
"city": "Jenkinsville",
"state": "Northern Mariana Islands",
"country": "US",
"address": "77 Sullivan Place, Jenkinsville, Northern Mariana Islands",
"addressComplement": "Flat 45",
"number": "1029",
"reference": "3",
"location": {
"latitude": -75.269008,
"longitude": 137.499833
},
"pickupDate": "2024-04-25T18:06:41.202Z"
},
"receiver": {
"name": "Pansy Graves",
"phone": "+57 4240807147",
"email": "pansy_graves@zentime.moda",
"city": "Valle",
"state": "Marshall Islands",
"country": "Iceland",
"neighborhood": "Billings",
"number": "9840",
"reference": "63 Billings Place, Valle, Marshall Islands",
"addressComplement": "Flat 45",
"location": {
"latitude": -33.249891,
"longitude": -135.052901
},
"identification": "9541933267",
"deliveryDate": "2024-04-16T20:49:36.117Z",
"contactName": "Savannah Porter",
"deliveryWindow": {
"name": "consectetur",
"initialDate": "2024-04-25T22:50:41.209Z",
"finalDate": "2024-05-05T21:50:41.210Z"
}
},
"packages": [
{
"id": "6266df719ac55224b793ad36",
"orderId": "SLR-1221800709659-01",
"envelope": "Large",
"description": "Delicate package",
"categories": [
"Cellphone",
"Technology"
],
"dimensions": {
"width": "68",
"height": "43",
"length": "13"
},
"weight": "19",
"totalValue": 5616.01,
"items": [
{
"id": "6266df71a19ebe35637e1f42",
"name": "Tomatos",
"ean": "473390795673",
"refId": "6266",
"image": "https://static9.depositphotos.com/1628352/1107/i/600/depositphotos_11071361-stock-photo-tomato.jpg",
"type": "Food",
"price": 774230.01,
"weight": "4 kg",
"quantity": 4
},
{
"id": "6266df71803601c3bc4e2d99",
"name": "Tomatos",
"ean": "329949764612",
"refId": "6266",
"image": "https://static9.depositphotos.com/1628352/1107/i/600/depositphotos_11071361-stock-photo-cellphone.jpg",
"type": "Foods",
"price": 23162,
"weight": "14 kg",
"quantity": 9
}
]
}
],
"type": "PICKUP_DELIVERY",
"carrierServiceType": "OTHERS",
"comments": "Delivery comments.",
"paymentMethod": "CASH_ON_DELIVERY",
"orderValue": 8000,
"settings": [
{
"label": "Key secret",
"value": "keysecret-0122",
"key": "secrekey"
}
],
"timezone": {
"offset": 300,
"value": "America/Bogota"
}
}
}
],
"responseExamples": []
}