VTEX · Schema

PauseResumeServiceRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
serviceId	string	Service ID.
carrierId	string	Carrier ID.
pause	boolean	Condition that the service is paused (`false`) or not (`true`).
settings	array	Array of custom fields.
reason	string	Reason for the pause or resume.
metaData	object	Object containing service metadata.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PauseResumeServiceRequest",
  "title": "PauseResumeServiceRequest",
  "type": "object",
  "required": [
    "serviceId",
    "carrierId",
    "settings",
    "reason",
    "metaData"
  ],
  "properties": {
    "serviceId": {
      "type": "string",
      "example": "apknieot924892jaf-1231",
      "description": "Service ID."
    },
    "carrierId": {
      "type": "string",
      "example": "servientrega9234jaf",
      "description": "Carrier ID."
    },
    "pause": {
      "type": "boolean",
      "description": "Condition that the service is paused (`false`) or not (`true`).",
      "example": false
    },
    "settings": {
      "type": "array",
      "description": "Array of custom fields.",
      "items": {
        "type": "object",
        "required": [
          "label",
          "key",
          "value"
        ],
        "properties": {
          "label": {
            "type": "string",
            "example": "Cliente ID",
            "description": "Custom label."
          },
          "key": {
            "type": "string",
            "example": "clientId",
            "description": "Custom key."
          },
          "value": {
            "type": "string",
            "example": "HUR123",
            "description": "Custom value."
          }
        }
      }
    },
    "reason": {
      "type": "string",
      "example": "La direcci\u00f3n de entrega esta mal registrada",
      "description": "Reason for the pause or resume."
    },
    "metaData": {
      "type": "object",
      "description": "Object containing service metadata.",
      "properties": {
        "myFieldCustom": {
          "type": "string",
          "example": "custom value",
          "description": "Custom value."
        }
      }
    }
  }
}