BlueCart · Schema

CatalogList

A paginated list of catalogs.

RestaurantProcurementWholesaleOrderingFood DistributionHospitalityeCommerce

Properties

Name Type Description
catalogs array
nextToken string
View JSON Schema on GitHub

JSON Schema

bluecart-catalog-list-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CatalogList",
  "description": "A paginated list of catalogs.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bluecart/refs/heads/main/json-schema/bluecart-catalog-list-schema.json",
  "type": "object",
  "properties": {
    "catalogs": {
      "type": "array",
      "items": {
        "title": "Catalog",
        "type": "object",
        "description": "A catalog of products and pricing assigned to clients.",
        "x-schema-source": "documentation",
        "x-source-url": "https://docs.bluecart.com/endpoints",
        "properties": {
          "catalogId": {
            "type": "integer",
            "format": "int64",
            "example": 700
          },
          "catalogName": {
            "type": "string",
            "example": "Premium Wines"
          },
          "enabled": {
            "type": "boolean",
            "example": true
          },
          "products": {
            "type": "array",
            "description": "Products in the catalog with pricing and discounts.",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          },
          "clients": {
            "type": "array",
            "description": "Clients the catalog is assigned to.",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          }
        }
      }
    },
    "nextToken": {
      "type": "string",
      "example": "eyJsYXN0SWQiOjcwMH0="
    }
  }
}