BigCommerce · Schema

Error Response

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

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

JSON Schema

bigcommerce-generalerrorwitherrors-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GeneralErrorWithErrors",
  "title": "Error Response",
  "required": [
    "status",
    "title",
    "type",
    "errors"
  ],
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "description": "The HTTP status code."
    },
    "title": {
      "type": "string",
      "description": "The error title describes the particular error."
    },
    "type": {
      "type": "string"
    },
    "errors": {
      "title": "Detailed Errors",
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  }
}