Skip to content

Read product

Reads one product with its offers and access, its body too when asked.

Needs the read scope.

Call

  • Tool: get_product
  • Scope: read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
product object Yes
coupon string No A discount’s code, or its id as an affiliate link carries it, priced into the offers.
preview string No A token a seller made for the product’s page, which opens it unpublished with its staged body, or for one of its entries, which opens it unpublished as it is live.
include array of "body" No What else the read answers: body reads the body whole, as readBody does, and fails the read where readBody would.
{
  "type": "object",
  "properties": {
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "coupon": {
      "description": "A discount's code, or its id as an affiliate link carries it, priced into the offers.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "preview": {
      "description": "A token a seller made for the product's page, which opens it unpublished with its staged body, or for one of its entries, which opens it unpublished as it is live.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "include": {
      "description": "What else the read answers: `body` reads the body whole, as `readBody` does, and fails the read where `readBody` would.",
      "type": "array",
      "items": {
        "type": "string",
        "const": "body"
      },
      "maxItems": 1
    }
  },
  "required": [
    "product"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
files object Yes
maps array of object Yes The maps the body’s map blocks show, matched to a block by latitude and longitude; none while the body is kept from the reader.
entries array of object Yes
body object or null Yes
attachments array of object Yes
tiers array of object Yes
can_review boolean Yes Whether the caller may write their review of it now: their scopes allow it, and a grant of theirs started and ended by nothing but a lapse, on a published product that takes reviews.
calendar_events array of object Yes The events a booking product’s page offers to pick from, unlisted and discontinued ones too; empty for any other product.
event object or null Yes An event product’s format, place, schedule and how it takes guests; null for any other product.
questions array of object Yes What checkout asks each buyer before payment, in order; empty for a product that asks nothing.
description string or null Yes The page’s long description, in the rich text format as stored.
what_you_get string or null Yes What a buyer gets, in the rich text format as stored.
settings object Yes
coupon object or null Yes
category object or null Yes
access string Yes
mcp object Yes
offers array of object Yes
owned object or null Yes
request object or null Yes The caller’s latest request for it: waiting for the seller’s approval, on the waitlist, or decided; null for none or a visitor.
poster object or null Yes
stats object Yes
release object or null Yes
rating object Yes
id string Yes
slug string Yes
path string Yes The storefront path.
url string or null Yes The absolute URL on the store’s verified hostname, or null before it has one.
title string Yes
subtitle string or null Yes The short line shown under the title.
listing string Yes
priority number Yes
published_at string or null Yes
discontinued_at string or null Yes
unlisted_at string or null Yes
feed_url string or null Yes The public feed’s absolute URL, for a blog or a podcast that is published (discontinued too), listed and on a verified hostname; else null.
created_at string or null Yes
updated_at string or null Yes

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close