instacart · Schema

ShoppingListRequest

Properties

Name Type Description
title string The title displayed at the top of the shopping list page.
image_url string URL of an image to display on the shopping list page.
link_type string The type of product link to create.
expires_in integer The number of seconds until the generated link expires.
instructions string Additional instructions or notes to display on the page.
line_items array The list of products to include on the shopping list page.
landing_page_configuration object Configuration options for the landing page appearance and behavior.
View JSON Schema on GitHub

JSON Schema

instacart-shoppinglistrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ShoppingListRequest",
  "title": "ShoppingListRequest",
  "type": "object",
  "required": [
    "title",
    "line_items"
  ],
  "properties": {
    "title": {
      "type": "string",
      "description": "The title displayed at the top of the shopping list page."
    },
    "image_url": {
      "type": "string",
      "format": "uri",
      "description": "URL of an image to display on the shopping list page."
    },
    "link_type": {
      "type": "string",
      "description": "The type of product link to create."
    },
    "expires_in": {
      "type": "integer",
      "description": "The number of seconds until the generated link expires.",
      "minimum": 1
    },
    "instructions": {
      "type": "string",
      "description": "Additional instructions or notes to display on the page."
    },
    "line_items": {
      "type": "array",
      "description": "The list of products to include on the shopping list page.",
      "items": {
        "$ref": "#/components/schemas/LineItem"
      }
    },
    "landing_page_configuration": {
      "type": "object",
      "description": "Configuration options for the landing page appearance and behavior.",
      "properties": {
        "partner_linkback_url": {
          "type": "string",
          "format": "uri",
          "description": "URL to link back to the partner site from the landing page."
        }
      }
    }
  }
}