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
code	integer	The custom code of the error.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GeneralError",
  "title": "Error Response",
  "required": [
    "status",
    "title",
    "type"
  ],
  "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"
    },
    "code": {
      "type": "integer",
      "description": "The custom code of the error."
    }
  }
}