BigCommerce · Schema

Collection Meta

Additional data about the response.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name	Type	Description
total	integer	Total number of items in the result set.
success	integer	Total number of items that were successfully deleted.
failed	integer	Total number of items that failed to be deleted.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WriteCollectionSuccessMeta",
  "title": "Collection Meta",
  "type": "object",
  "description": "Additional data about the response.",
  "properties": {
    "total": {
      "type": "integer",
      "description": "Total number of items in the result set.\n",
      "example": 3
    },
    "success": {
      "type": "integer",
      "description": "Total number of items that were successfully deleted.\n",
      "example": 3
    },
    "failed": {
      "type": "integer",
      "description": "Total number of items that failed to be deleted.\n",
      "example": 0
    }
  },
  "x-internal": false
}