instacart · Schema

LineItem

Properties

Name	Type	Description
name	string	The name of the product.
quantity	number	The quantity of the product to add.
unit	string	The unit of measurement for the quantity.
display_text	string	Custom display text for the line item on the page.
product_ids	array	Instacart product identifiers to match specific products.
upcs	array	Universal Product Codes to match specific products.
line_item_measurements	object	Measurement details for the line item.
filters	object	Filters to narrow product matching.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LineItem",
  "title": "LineItem",
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the product."
    },
    "quantity": {
      "type": "number",
      "description": "The quantity of the product to add.",
      "minimum": 1
    },
    "unit": {
      "type": "string",
      "description": "The unit of measurement for the quantity."
    },
    "display_text": {
      "type": "string",
      "description": "Custom display text for the line item on the page."
    },
    "product_ids": {
      "type": "array",
      "description": "Instacart product identifiers to match specific products.",
      "items": {
        "type": "string"
      }
    },
    "upcs": {
      "type": "array",
      "description": "Universal Product Codes to match specific products.",
      "items": {
        "type": "string"
      }
    },
    "line_item_measurements": {
      "type": "object",
      "description": "Measurement details for the line item.",
      "properties": {
        "amount": {
          "type": "number",
          "description": "The measurement amount."
        },
        "unit": {
          "type": "string",
          "description": "The measurement unit."
        }
      }
    },
    "filters": {
      "type": "object",
      "description": "Filters to narrow product matching.",
      "properties": {
        "department": {
          "type": "string",
          "description": "The store department to filter products by."
        }
      }
    }
  }
}