Check Connection Options Response Payload

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bigcommerce/main/json-schema/bigcommerce-check-connection-options-response-payload-schema.json",
  "title": "Check Connection Options Response Payload",
  "description": "The response received back from the Shipping Provider connection check. This allows the store to understand whether the connection was successful.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bigcommerce-shipping-provider-api-openapi.yml#/components/schemas/CheckConnectionOptionsResponsePayload",
  "type": "object",
  "properties": {
    "valid": {
      "type": "boolean",
      "description": "Indicates whether or not the connection options are valid."
    },
    "messages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "minLength": 1,
            "maxLength": 500
          },
          "type": {
            "type": "string",
            "enum": [
              "INFO",
              "WARNING",
              "ERROR"
            ]
          }
        },
        "required": [
          "text",
          "type"
        ],
        "title": "Message",
        "description": "A simple string/type response for returning information."
      }
    }
  },
  "x-internal": false
}