VTEX · Schema

CancelServiceResponse

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
message string Message of successful cancelation.
data object Object containing service information.
View JSON Schema on GitHub

JSON Schema

vtex-cancelserviceresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CancelServiceResponse",
  "title": "CancelServiceResponse",
  "type": "object",
  "required": [
    "message",
    "data"
  ],
  "properties": {
    "message": {
      "type": "string",
      "example": "Service executed successfully",
      "description": "Message of successful cancelation."
    },
    "data": {
      "type": "object",
      "description": "Object containing service information.",
      "required": [
        "serviceId",
        "carrierId",
        "reason"
      ],
      "properties": {
        "serviceId": {
          "type": "string",
          "description": "Service ID.",
          "example": "apknieot924892jaf-1231"
        },
        "carrierId": {
          "type": "string",
          "description": "Carrier ID.",
          "example": "servientrega9234jaf"
        },
        "reason": {
          "type": "string",
          "example": "En el lugar de residencia no hay quien reciba el paquete",
          "description": "Reason for the cancelation."
        }
      }
    }
  }
}