BigCommerce · Schema

ResponseErrorBrief

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
View JSON Schema on GitHub

JSON Schema

bigcommerce-responseerrorbrief-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ResponseErrorBrief",
  "title": "ResponseErrorBrief",
  "type": "object",
  "description": "Error payload for the BigCommerce API.\n",
  "properties": {
    "status": {
      "description": "The HTTP status code.\n",
      "type": "integer"
    },
    "title": {
      "description": "The error title describing the particular error.\n",
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "status"
  ]
}