BigCommerce · Schema

Error

Error response payload for the BigCommerce API.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
status integer The HTTP status code for the error.
title string The error title.
type string The error type.
errors object
View JSON Schema on GitHub

JSON Schema

bigcommerce-error-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Error",
  "title": "Error",
  "type": "object",
  "description": "Error response payload for the BigCommerce API.\n",
  "properties": {
    "status": {
      "type": "integer",
      "description": "The HTTP status code for the error.\n",
      "example": 422
    },
    "title": {
      "type": "string",
      "description": "The error title.\n",
      "example": "Bulk operation has failed"
    },
    "type": {
      "type": "string",
      "description": "The error type.\n",
      "example": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes"
    },
    "errors": {
      "$ref": "#/components/schemas/ErrorDetail"
    }
  }
}