BigCommerce · Schema

errorMultiStatus

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
status integer The [HTTP status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) of the failure or partial success.
title string A summary of the failure or partial success.
type string A BigCommerce-defined error signifier.
errors object
View JSON Schema on GitHub

JSON Schema

bigcommerce-errormultistatus-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/errorMultiStatus",
  "title": "errorMultiStatus",
  "type": "object",
  "properties": {
    "status": {
      "type": "integer",
      "minLength": 3,
      "maxLength": 3,
      "description": "The [HTTP status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) of the failure or partial success."
    },
    "title": {
      "type": "string",
      "description": "A summary of the failure or partial success."
    },
    "type": {
      "type": "string",
      "description": "A BigCommerce-defined error signifier."
    },
    "errors": {
      "$ref": "#/components/schemas/DetailedErrors"
    }
  }
}