VTEX · Example Payload

Vtex Postcancelservice Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Postcancelservice 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": "PostCancelservice",
  "method": "POST",
  "path": "/cancel/{carrierId}/{serviceId}",
  "summary": "VTex Cancel ongoing service",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "comment": "The delivery address was changed",
        "type": "END_CLIENT_CANCELED"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json; charset=utf-8",
      "example": {
        "message": "Service canceled successfully",
        "data": {
          "comment": "The delivery address was changed",
          "type": "END_CLIENT_CANCELED"
        }
      }
    },
    {
      "status": "401",
      "contentType": "application/json; charset=utf-8",
      "example": {
        "message": "Unauthorized",
        "requestId": "c482e112-aa73-4dfb-a31c-1586978dfead"
      }
    },
    {
      "status": "403",
      "contentType": "application/json",
      "example": {
        "message": "Authentication token expired",
        "requestId": "8c0bbb1b-8486-4d94-8136-8586c0ea2efe"
      }
    },
    {
      "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": "b39a0833-629f-429e-8955-f448165502ac",
        "date": "2024-03-15T06:22:50.518Z",
        "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&_78c83922-d658-48bf-89d5-0658a6a94e27'"
      }
    }
  ]
}