BigCommerce · Schema

error_Base

Error payload for the BigCommerce API.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
status	integer	The HTTP status code.
title	string	The error title describing the particular error.
type	string
instance	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/error_Base",
  "title": "error_Base",
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "description": "The HTTP status code.\n"
    },
    "title": {
      "type": "string",
      "description": "The error title describing the particular error.\n"
    },
    "type": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  },
  "description": "Error payload for the BigCommerce API.\n",
  "x-internal": false
}