schema_commerce_products.json - Via automated deployment - Visit https://learn.lexer.io for more information.

lexer_docs_schema_commerce_products.json

{
  "type": "object",
  "properties": {
    "records": {
      "type": "array",
      "items": {
        "title": "Product",
        "type": "object",
        "description": "A product object. The field referenced in product_reference_type should be unique and used in purchase and return events.",
        "required": [
          "product_reference_type"
        ],
        "properties": {
          "product_id": {
            "title": "Product ID",
            "type": "string",
            "description": "Unique product_id. Required if used as the product identifier in product_reference_type.",
            "example": "b7c901..."
          },
          "sku": {
            "title": "SKU",
            "type": "string",
            "description": "Unique SKU. Required if used as a product identifier in product_reference_type.",
            "example": "ac6674..."
          },
          "upc": {
            "title": "UPC",
            "type": "string",
            "description": "Unique UPC. Required if used as a product identifier in product_reference_type.",
            "example": "ce6378..."
          },
          "product_reference_type": {
            "title": "Product Reference Type",
            "type": "string",
            "description": "Which field is used to identify the product entity. A value must be provided in the specified field.",
            "enum": [
              "product_id",
              "sku",
              "upc"
            ],
            "default": "product_id"
          },
          "name": {
            "title": "Product Name",
            "type": "string",
            "example": "Organic Sawyer Rib Crew Knit"
          },
          "description": {
            "title": "Description",
            "type": "string",
            "example": "Whether your look is clean and casual or sharp and sophisticated, Staple Superior has what you need to achieve that effortlessly cool style.\n"
          },
          "brand": {
            "title": "Brand Name",
            "type": "string",
            "example": "Sawyer"
          },
          "size": {
            "title": "Size",
            "type": "string",
            "example": "L"
          },
          "color": {
            "title": "Color",
            "type": "string",
            "example": "Navy"
          },
          "price": {
            "title": "Price",
            "type": "number",
            "example": 89
          },
          "options": {
            "title": "Categories",
            "type": "object",
            "description": "Key value pairs of options that define the product, such as departments, categories, styles, etc",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": {
              "department": [
                "menswear"
              ],
              "category": [
                "outerwear"
              ],
              "subcategory": [
                "knits",
                "wool"
              ]
            }
          },
          "url": {
            "title": "Product URL",
            "description": "A url to the product listed on the public internet - i.e. ecommerce link",
            "type": "string",
            "format": "uri",
            "example": "https://fake.com/menswear/sawyer-rib-crew-knit"
          },
          "images": {
            "title": "Image URLs",
            "description": "An array of Product Image URLs listed on the public internet",
            "type": "array",
            "items": {
              "type": "string",
              "format": "uri",
              "example": "https://fake.com/images/menswear/sawyer-rib-crew-knit.jpg"
            }
          }
        }
      },
      "minItems": 1,
      "maxItems": 100
    }
  }
}