Vtex Updateservice 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": "Updateservice",
"method": "PATCH",
"path": "/{carrierId}/{serviceId}",
"summary": "VTex Update service",
"requestExamples": [
{
"contentType": "application/json",
"example": {
"message": "Service updated successfully",
"data": {
"status": "PENDING",
"agent": {
"id": "27327489234",
"name": "Pedro",
"identification": "020323809",
"phone": "+57314855674",
"email": "pedro434234@gmailc.om",
"vehicle": "SCOOTER"
},
"trackingUrl": "https://localhost.com",
"totalDistanceTraveled": 2,
"rating": 5,
"shippingPrice": 150000,
"shippingEstimatedDate": "2024-04-27T20:25:45.067Z"
}
}
}
],
"responseExamples": [
{
"status": "200",
"contentType": "application/json; charset=utf-8",
"example": {
"message": "Service updated successfully",
"data": {
"status": "PENDING",
"agent": {
"id": "27327489234",
"name": "Pedro",
"identification": "020323809",
"phone": "+57314855674",
"email": "pedro434234@gmailc.om",
"vehicle": "SCOOTER"
},
"trackingUrl": "https://localhost.com",
"totalDistanceTraveled": 2,
"rating": 5,
"shippingPrice": 150000,
"shippingEstimatedDate": "2024-04-27T20:25:45.067Z"
}
}
},
{
"status": "401",
"contentType": "application/json; charset=utf-8",
"example": {
"message": "Unauthorized",
"requestId": "b5077045-e5ee-4eeb-8783-467c5454d03c"
}
},
{
"status": "403",
"contentType": "application/json",
"example": {
"message": "Authentication token expired",
"requestId": "6d5f5fa2-cf31-4878-9be5-7e094022a206"
}
},
{
"status": "404",
"contentType": "application/json; charset=utf-8",
"example": {
"type": "exception",
"code": "TRP0005E",
"data": {
"0": "1",
"carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50",
"serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27"
},
"requestId": "8ce83c17-d9c4-434f-94cd-f2016bb7be8a",
"date": "2024-03-15T05:59:30.114Z",
"message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&_78c83922-d658-48bf-89d5-0658a6a94e27'"
}
}
]
}