HubSpot · JSON Structure

Commerce Payments Api Batch Error Structure

An error from a batch operation

Type: object Properties: 8 Required: 2

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

BatchError is a JSON Structure definition published by HubSpot, describing 8 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

status id category message errors context links subCategory

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/commerce-payments-api-batch-error-structure.json",
  "name": "BatchError",
  "description": "An error from a batch operation",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "example": "active"
    },
    "id": {
      "type": "string",
      "example": "500123"
    },
    "category": {
      "type": "string",
      "example": "standard"
    },
    "message": {
      "type": "string",
      "example": "This is an example description."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Detailed error information",
        "required": [
          "message"
        ],
        "properties": {
          "message": {
            "type": "string",
            "description": "The error message",
            "example": "This is an example description."
          },
          "code": {
            "type": "string",
            "description": "An error code",
            "example": "example-value"
          },
          "in": {
            "type": "string",
            "description": "The location of the error",
            "example": "example-value"
          },
          "subCategory": {
            "type": "string",
            "description": "A specific error subcategory",
            "example": "standard"
          },
          "context": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": {
              "key": "value"
            }
          }
        }
      },
      "example": [
        {
          "message": "This is an example description.",
          "code": "example-value",
          "in": "example-value",
          "subCategory": "standard",
          "context": {
            "key": "value"
          }
        }
      ]
    },
    "context": {
      "type": "object",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "example": {
        "key": "value"
      }
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "key": "value"
      }
    },
    "subCategory": {
      "type": "string",
      "example": "standard"
    }
  },
  "required": [
    "category",
    "message"
  ]
}