BlueCart · Schema

ProductList

A paginated list of products.

RestaurantProcurementWholesaleOrderingFood DistributionHospitalityeCommerce

Properties

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

JSON Schema

bluecart-product-list-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ProductList",
  "description": "A paginated list of products.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bluecart/refs/heads/main/json-schema/bluecart-product-list-schema.json",
  "type": "object",
  "properties": {
    "products": {
      "type": "array",
      "items": {
        "title": "Product",
        "type": "object",
        "description": "A product available for wholesale ordering.",
        "x-schema-source": "documentation",
        "x-source-url": "https://docs.bluecart.com/endpoints",
        "properties": {
          "productId": {
            "type": "integer",
            "format": "int64",
            "description": "Unique product identifier.",
            "example": 90210
          },
          "productName": {
            "type": "string",
            "description": "Product name.",
            "example": "Cabernet Sauvignon 750ml"
          },
          "sku": {
            "type": "string",
            "description": "Stock keeping unit.",
            "example": "WINE-CAB-750"
          },
          "description": {
            "type": "string",
            "description": "Product description.",
            "example": "Estate-bottled Cabernet Sauvignon, vintage 2022."
          },
          "uom": {
            "type": "string",
            "description": "Unit of measure.",
            "example": "Bottle"
          },
          "price": {
            "type": "number",
            "format": "float",
            "description": "Unit price.",
            "example": 18.5
          },
          "pack": {
            "type": "integer",
            "description": "Number of units per pack.",
            "example": 12
          },
          "tags": {
            "type": "array",
            "description": "Tags associated with the product.",
            "items": {
              "type": "string"
            },
            "example": [
              "Wine",
              "Red"
            ]
          },
          "inventory": {
            "type": "object",
            "description": "Inventory management details.",
            "additionalProperties": true
          },
          "discounts": {
            "type": "object",
            "description": "Discount configuration for the product.",
            "additionalProperties": true
          },
          "creationDateTime": {
            "type": "string",
            "format": "date-time",
            "example": "2026-06-02T14:30:00Z"
          },
          "lastUpdateDateTime": {
            "type": "string",
            "format": "date-time",
            "example": "2026-06-02T15:00:00Z"
          }
        }
      }
    },
    "nextToken": {
      "type": "string",
      "example": "eyJsYXN0SWQiOjkwMjEwfQ=="
    }
  }
}