Item Resource
Use the Item resource to fetch a single item.
Resources:
Schema type
Use item to reference this resource in the template schema.
Querying
Filters nullable
-
id string
Square
Itemidof item to retrieve.{ "filters": { "id": "WUH4RMB3WUDBQJQAOMYN56WD" } } -
square_online_id boolean
Flag to identify the resource to be fetched using legacy
square_online_ids{ "filters": { "id": "2", "square_online_id": true } } -
location_id string
- Default: Catalog Shipping Location ID
idofLocationto scope an item to. The item data received will be based off of the item’s configuration at the given location. Must be used in conjunction withfilters.idorfilters.ids{ "filters": { "id": ["WUH4RMB3WUDBQJQAOMYN56WD"], "location_id": "location_id" } }
Optional
- optional boolean
- Default: false
A resource marked as optional will not cause the page to render a 404 view. Optional only applies to a single resource.
{ "filters": { "id": "some_id_that_does_not_exist" }, "optional": true }
Output
{
"__SO_RESOURCE_TYPE__": "item", // internally used resource property. do not modify.
"id": "WUH4RMB3WUDBQJQAOMYN56WD",
"square_online_id": "12",
"resource_type": "ITEM",
"name": "Turtle T-shirt",
"description": "The best t-shirt.",
"description_html": "<p>The best t-shirt.</p>",
"visibility": "VISIBLE",
"item_type": "REGULAR",
"available": true,
"is_alcoholic": false,
"price": {
"high": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"high_with_modifiers": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"high_with_subscriptions": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"low": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"low_with_modifiers": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"low_with_subscriptions": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"regular_high": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"regular_high_with_modifiers": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"regular_high_with_subscriptions": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"regular_low": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"regular_low_with_modifiers": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"regular_low_with_subscriptions": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
},
"images": [
{
"absolute_url": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_p12_i1_w679.jpeg",
"width": 679,
"height": 690,
"format": "jpeg",
"absolute_urls": {
"80": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_p12_i1_w679.jpeg?width=80",
"160": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_p12_i1_w679.jpeg?width=160",
"320": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_p12_i1_w679.jpeg?width=320",
"640": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_p12_i1_w679.jpeg?width=640"
}
}
],
"item_options": [
{
"choices": [
"Black",
"Blue",
"Green",
"Yellow",
"Pink",
"White"
],
"colors": [
"#000000",
"#5174D1",
"#036E30",
"#F7C03E",
"#EF476F",
"#FFFFFF"
],
"id": "U5R73HPO2AFZMKNCD6UARS5W",
"name": "Colors FROM SQ",
"ordinal": 0,
"renderer": "color"
},
{
"choices": [
"Small",
"Medium",
"Large"
],
"id": "546RS5FESPR54V37TZMEMLSN",
"name": "Size",
"ordinal": 1,
"renderer": "radio"
}
],
"modifier_lists": [
{
"id": "U5R73HPO2AFZMKNCD6UAR7W",
"name": "T-shirt Text",
"square_online_item_id": "12",
"type": "text",
"min_selected_modifiers": 0,
"max_selected_modifiers": 150
},
{
"id": "6WVGAE3PKEHRWZHF54KR2PIN",
"name": "Pin",
"square_online_item_id": "12",
"type": "CHOICE",
"min_selected_modifiers": 0,
"max_selected_modifiers": 0,
"modifiers": [
{
"id": "E3MWZ3PJ3VZDQWGW4G3KFZGW",
"name": "Dinosaur",
"price_money": {
"amount": 1000,
"currency": "USD",
"formatted": "$10.00"
},
"ordinal": 0,
"sold_out": false,
"hidden": false,
"selected_by_default": false,
"image": {
"absolute_url": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566d01c4982eba0b1f057ad4_i11ee4cd2b81db111afdd089e019fd17a_w724.jpeg",
"width": 724,
"height": 695,
"absolute_urls": {
"80": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566d01c4982eba0b1f057ad4_i11ee4cd2b81db111afdd089e019fd17a_w724.jpeg?width=80",
"160": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566d01c4982eba0b1f057ad4_i11ee4cd2b81db111afdd089e019fd17a_w724.jpeg?width=160",
"320": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566d01c4982eba0b1f057ad4_i11ee4cd2b81db111afdd089e019fd17a_w724.jpeg?width=320",
"640": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566d01c4982eba0b1f057ad4_i11ee4cd2b81db111afdd089e019fd17a_w724.jpeg?width=640"
},
"format": "jpeg"
}
},
{
"id": "GKCUYTB7ARN25J7BTRTOSVHO",
"name": "Lion",
"price_money": {
"amount": 1000,
"currency": "USD",
"formatted": "$10.00"
},
"ordinal": 1,
"sold_out": false,
"hidden": false,
"selected_by_default": false,
"image": {
"absolute_url": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566dcdacb277ba0b1f057ad4_i11ee3ae89f8cefd59fa9089e019fd17a_w1134.jpeg",
"width": 1134,
"height": 1500,
"absolute_urls": {
"80": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566dcdacb277ba0b1f057ad4_i11ee3ae89f8cefd59fa9089e019fd17a_w1134.jpeg?width=80",
"160": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566dcdacb277ba0b1f057ad4_i11ee3ae89f8cefd59fa9089e019fd17a_w1134.jpeg?width=160",
"320": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566dcdacb277ba0b1f057ad4_i11ee3ae89f8cefd59fa9089e019fd17a_w1134.jpeg?width=320",
"640": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566dcdacb277ba0b1f057ad4_i11ee3ae89f8cefd59fa9089e019fd17a_w1134.jpeg?width=640"
},
"format": "jpeg"
}
},
{
"id": "EYYJYQQ65VFKH7M554DNR7CL",
"name": "Elephant",
"price_money": {
"amount": 1000,
"currency": "USD",
"formatted": "$10.00"
},
"ordinal": 2,
"sold_out": false,
"hidden": false,
"selected_by_default": false,
"image": {
"absolute_url": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566e0bdc8bb9ba0b1f057ad4_i11ee3ae89ed209799fa9089e019fd17a_w1455.jpeg",
"width": 1455,
"height": 1500,
"absolute_urls": {
"80": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566e0bdc8bb9ba0b1f057ad4_i11ee3ae89ed209799fa9089e019fd17a_w1455.jpeg?width=80",
"160": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566e0bdc8bb9ba0b1f057ad4_i11ee3ae89ed209799fa9089e019fd17a_w1455.jpeg?width=160",
"320": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566e0bdc8bb9ba0b1f057ad4_i11ee3ae89ed209799fa9089e019fd17a_w1455.jpeg?width=320",
"640": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566e0bdc8bb9ba0b1f057ad4_i11ee3ae89ed209799fa9089e019fd17a_w1455.jpeg?width=640",
"1280": "https://769244280274161852.staging.weebly.net/uploads/1/2/1/7/121778831/s604497668748833845_mc11ee2b33566e0bdc8bb9ba0b1f057ad4_i11ee3ae89ed209799fa9089e019fd17a_w1455.jpeg?width=1280"
},
"format": "jpeg"
}
}
]
}
],
"variations": [
{
"id": "U5R73HPO2AFZMKNCD6UARS5W",
"square_online_item_id": "12",
"square_online_id": "18",
"name": null,
"item_option_values": [
{
"name": "Colors",
"choice": "White",
"color": "#FFFFFF"
},
{
"name": "Size",
"choice": "Large"
}
],
"ordinal": 18,
"price": {
"current": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"regular": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"sale": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"high": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
},
"pricing_type": "FIXED_PRICING",
"sold_out": false,
"inventory": 0
}
],
"badges": {
"low_stock": false,
"out_of_stock": false,
"on_sale": false
},
"seo": {
"page_description": null,
"page_title": null
},
"open_graph": {
"title": null,
"description": null
},
"avg_rating": null,
"avg_rating_all": null,
"inventory": {
"total": 0,
"lowest": null,
"enabled": false,
"all_variations_sold_out": false,
"some_variations_sold_out": false
},
"measurement_units": {
"multiple_units": false,
"abbreviation": null,
"precision": null
},
"fulfillment": {
"methods": {
"SHIPMENT": true,
"PICKUP": true,
"DELIVERY": false,
"DINE_IN": false,
"MANUAL": false,
"DIGITAL": false
},
"methods_at_any_location": {
"SHIPMENT": true,
"PICKUP": false,
"DELIVERY": false,
"DINE_IN": false,
"MANUAL": false,
"DIGITAL": false
}
},
"fulfillment_availability": {
"PICKUP": [],
"SHIPMENT": [],
"DELIVERY": []
},
"categories": [],
"discounts": [
{
"id": "X6P5OQ3GBC6CNHTLQIN7QP3C",
"name": "schedulealways",
"discount_type": "FIXED_PERCENTAGE",
"percentage": 1.0,
"display_strings": {
"discount_formatted": "1%",
"summary_text": "Buy 2, get 1% off each",
"badge_text": "Buy 2, get 1% off each",
"excluded_summary_text": "",
"excluded_badge_text": "",
"details": [
"Buy 2, get 1% off each",
"Automatically applied in cart to qualifying orders. If multiple discounts are available on an item, the highest-value discount is applied."
],
"recurring_details": [
"Monday from 12:00 AM - 11:59 PM",
"Tuesday from 12:00 AM - 11:59 PM",
"Thursday from 12:00 AM - 11:59 PM",
"Friday from 12:00 AM - 11:59 PM",
"Saturday from 12:00 AM - 11:59 PM"
]
},
"match_item_ids": [],
"exclude_item_ids": [],
"all_items": true,
"present_at_all_locations": true,
"absent_at_location_ids": [],
"present_at_location_ids": [],
"valid_from_date": null,
"valid_until_date": null,
"time_periods": [
"BEGIN:VEVENT\nDURATION:PT23H59M\nRRULE:FREQ=WEEKLY;BYDAY=MO\nDTSTART:20170102T000000\nEND:VEVENT\n",
"BEGIN:VEVENT\nDURATION:PT23H59M\nRRULE:FREQ=WEEKLY;BYDAY=TU\nDTSTART:20170103T000000\nEND:VEVENT\n",
"BEGIN:VEVENT\nDURATION:PT23H59M\nRRULE:FREQ=WEEKLY;BYDAY=TH\nDTSTART:20170105T000000\nEND:VEVENT\n",
"BEGIN:VEVENT\nDURATION:PT23H59M\nRRULE:FREQ=WEEKLY;BYDAY=FR\nDTSTART:20170106T000000\nEND:VEVENT\n",
"BEGIN:VEVENT\nDURATION:PT23H59M\nRRULE:FREQ=WEEKLY;BYDAY=SA\nDTSTART:20170107T000000\nEND:VEVENT\n"
],
"discount_tags": [
"quantity_exact",
"time_period"
],
"excluded_quantity": null,
"included_quantity": null,
"exact_quantity": 2,
"min_quantity": null,
"min_value": "$0",
"max_value": "$0"
}
],
"preordering": {
"PICKUP": false,
"DELIVERY": false,
"SHIPMENT": false,
"DINE_IN": false,
"MANUAL": false,
"DIGITAL": false
},
"prep_time_duration": {
"in_minutes": 30,
"rfc3339_interval": "PT30M"
},
"is_advanced_notice": false,
"reviews": [
{
"reviewer_name": "Andrew Y.",
"rating": 5,
"content": "Good product",
"status": "approved",
"verified_purchase": true,
"published_replies": [],
"images": [
{
"absolute_url": "https://769244280274161852.staging.weebly.net/uploads/b/cdfd8173bb4497a4cc9a37c03725153f621a2165e584ab66a4bfe314351724d0/5d13d6a0-a665-4a31-a2a2-ee24693c5b04.jpeg",
"width": null,
"height": null,
"format": "jpeg",
"absolute_urls": {
"80": "https://769244280274161852.staging.weebly.net/uploads/b/cdfd8173bb4497a4cc9a37c03725153f621a2165e584ab66a4bfe314351724d0/5d13d6a0-a665-4a31-a2a2-ee24693c5b04.jpeg?width=80",
"160": "https://769244280274161852.staging.weebly.net/uploads/b/cdfd8173bb4497a4cc9a37c03725153f621a2165e584ab66a4bfe314351724d0/5d13d6a0-a665-4a31-a2a2-ee24693c5b04.jpeg?width=160",
"320": "https://769244280274161852.staging.weebly.net/uploads/b/cdfd8173bb4497a4cc9a37c03725153f621a2165e584ab66a4bfe314351724d0/5d13d6a0-a665-4a31-a2a2-ee24693c5b04.jpeg?width=320",
"640": "https://769244280274161852.staging.weebly.net/uploads/b/cdfd8173bb4497a4cc9a37c03725153f621a2165e584ab66a4bfe314351724d0/5d13d6a0-a665-4a31-a2a2-ee24693c5b04.jpeg?width=640",
"1280": "https://769244280274161852.staging.weebly.net/uploads/b/cdfd8173bb4497a4cc9a37c03725153f621a2165e584ab66a4bfe314351724d0/5d13d6a0-a665-4a31-a2a2-ee24693c5b04.jpeg?width=1280"
}
}
],
"updated_at": "2023-05-17T22:27:49+00:00"
}
],
"review_meta": {
"avg_rating": 5,
"rating_breakdown": {
"1": 0,
"2": 0,
"3": 0,
"4": 0,
"5": 1,
"total": 1
}
},
"subscriptions": [
{
"id": "M35RH6VYGATAHIP5FKO6JVBM",
"type": "SUBSCRIPTION_PLAN",
"version": 1690496928533,
"present_at_all_locations": true,
"subscription_plan_data": {
"name": "monthly",
"subscription_plan_variations": [
{
"type": "SUBSCRIPTION_PLAN_VARIATION",
"id": "SV4O2HJUHLZS3LCDNAYNN6UP",
"present_at_all_locations": true,
"subscription_plan_variation_data": {
"name": "monthly",
"subscription_plan_id": "M35RH6VYGATAHIP5FKO6JVBM",
"monthly_billing_anchor_date": 17,
"configuration": {
"buyer_allow_indefinite_pausing": true,
"buyer_max_cycles_to_skip": 0
},
"phases": [
{
"id": "VHFPVNBPIH3H464VBTUQPZ53",
"cadence": "MONTHLY",
"ordinal": 0,
"pricing": {
"type": "RELATIVE",
"discounts": [
{
"id": "RPN6QHKOWOIB74HB6ITOKTL5",
"discount_type": "FIXED_AMOUNT",
"percentage": 0,
"amount": {
"amount": 200,
"currency": "USD",
"formatted": "$2.00"
}
}
],
"regular_high": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"regular_high_subscription": {
"amount": 1710,
"currency": "USD",
"formatted": "$17.10"
},
"regular_low": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"regular_low_subscription": {
"amount": 1710,
"currency": "USD",
"formatted": "$17.10"
},
"high": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"high_subscription": {
"amount": 1710,
"currency": "USD",
"formatted": "$17.10"
},
"low": {
"amount": 1800,
"currency": "USD",
"formatted": "$18.00"
},
"low_subscription": {
"amount": 1710,
"currency": "USD",
"formatted": "$17.10"
}
}
}
]
}
}
],
"eligible_item_ids": [
"A56GLJN57UQWINMKYA6SXNHJ",
"34ZTBGU2KOTMFXIF5EEJRAZX"
]
}
}
]
}
Item resources
Item
An item in the site catalog.
| Field | Type | Description |
|---|---|---|
available | Boolean | If the item is available on Square Online. |
avg_rating_all | Number | The average rating including PUBLISHED & UNPUBLISHED reviews of this item, for example 4.1. |
avg_rating | Number | The average rating for PUBLISHED reviews of this item, for example 3.2. Can be null if this item has no reviews. |
badges | Badges | A list of visual badges that may or may not be applied to a item. |
categories | Category[] | The category details. An item can belong to multiple categories. |
created_at | String | Date at which the item was created. |
description_html | String | HTML-formatted description of the item. |
description | String | Text description of the item with all formatting removed. |
discounts | Discount[] | Any discounts applicable to this item. |
fulfillment_availability | FulfillmentAvailability | A map of fulfillment availability windows on when the item can be fulfilled in the future by fulfillment type. |
fulfillment | Fulfillment | Fulfillment options. |
id | String | ID of the item in Square. |
images | Image[] | The item’s images. |
inventory | Inventory | Inventory information for items where inventory tracking is enabled. |
is_alcoholic | Boolean | Whether or the seller has marked the item as alcoholic. |
locations | Location[] | Store locations where this item is available. Abbreviated details. |
measurement_units | MeasurementUnits | Details about the item’s measurement units. |
media_files | Image[] | Other media files associated with the item. |
item_options | ItemOption[] | The item options that make up the variations. Only included if there are multiple options. |
modifier_lists | ModifierList[] | The available modifiers for the item. |
name | String | This item’s name or title. |
open_graph | OpenGraph | Details for the Open Graph protocol. |
per_order_max | Number | The max number of times this item can be added to a single order. NULL indicates no max. |
allow_order_item_quantities | Boolean | Whether the per_order_max field should be used in order calculations. |
pickup | Pickup | Pickup fulfillment details. |
preordering | Preordering | Preordering enablement by fulfillment type. |
price | Price | The different prices for this item. An item that has multiple SKUs and / or item modifiers can sell for a variety of prices. |
prep_time_duration | Duration | Details about prep time duration. |
is_advanced_notice | Boolean | True if prep time duration is in calendar days. |
item_type_details | ItemTypeDetails | Item type details. |
item_type | String | The type of item. |
resource_type | String | The resource type identifier. |
review_meta | ReviewMeta | Aggregated data for the item’s reviews (e.g. average rating). |
reviews | Review[] | Reviews for the item. |
seo | Seo | The search engine optimization settings. |
square_online_id | String | ID of the item in Square Online. |
square_online_type | String | The Square Online type. Valid values: PHYSICAL, SERVICE, DIGITAL, FOOD, EVENT, MEMBERSHIP, GIFTCARD, DONATION, SIMPLE_DIGITAL. |
subscriptions | Subscription[] | Subscription details if this item is part of any subscriptions. |
only_subscribable | [Boolean] | Whether or not the item is only available for subscriptions. |
variations | Variation[] | Information about the item variations available (e.g. size, color). |
visibility | String | Whether or not this item should be visible. |
AvailabilityWindow
An availability window that defines fulfillment availability.
| Field | Type | Description |
|---|---|---|
availability_cutoff_at | String | UNIX timestamp of when a order needs to be placed by to fit into the fulfillment availability window |
end_at | String | UNIX timestamp of when the fulfillment availability window ends |
start_at | String | UNIX timestamp of when the fulfillment availability window starts |
Badges
Visual badges that can be applied to an item.
| Field | Type | Description |
|---|---|---|
has_discounts | Boolean | Display a badge showing this item has applicable discounts |
low_stock | Boolean | Display a badge advertising this item as low on stock. |
on_sale | Boolean | Display a badge showing this item is currently on sale |
out_of_stock | Boolean | Display a badge showing that this item is currently out of stock |
Configuration
Configuration details for a subscription plan variation.
| Field | Type | Description |
|---|---|---|
buyer_allow_indefinite_pausing | Boolean | Whether the buyer can pause this subscription indefinitely |
buyer_max_cycles_to_skip | Number | Max number of subscription cycles the buyer can skip |
Duration
Duration.
| Field | Type | Description |
|---|---|---|
in_minutes | Number | Duration in minutes. |
rfc3339_interval | String | Duration in RFC3339 format. |
Fulfillment
Fulfillment options for an item.
| Field | Type | Description |
|---|---|---|
methods_at_any_location | Methods | Fulfillment methods for ANY location |
methods | Methods | Fulfillment methods for THIS location |
FulfillmentAvailability
Represents when an item can be fulfilled by a given fulfillment type.
| Field | Type | Description |
|---|---|---|
PICKUP | AvailabilityWindow[] | Array of availability windows on when the item can be fulfilled in the future. |
SHIPMENT | AvailabilityWindow[] | Array of availability windows on when the item can be fulfilled in the future. |
Image
An image for an item.
| Field | Type | Description |
|---|---|---|
absolute_url | String | Absolute url for primary image |
absolute_urls | AbsoluteUrls | Dictionary of absolute urls for various sizes. The key is the image width in pixels, the value is the URL |
format | String | The format of the media file, if applicable. For example, gif. |
height | Number | Height of the primary image |
width | Number | Width of the primary image |
Inventory
Inventory details for an item that has inventory tracking enabled.
| Field | Type | Description |
|---|---|---|
all_variations_sold_out | Boolean | Whether or not all SKUs are sold out, or if this item is marked as sold out |
enabled | Boolean | Whether or not inventory tracking is enabled for this item |
lowest | Number | Number under which we should not allow sales anymore |
some_variations_sold_out | Boolean | Whether or not any SKU is sold out, or if any SKU is marked as sold out |
total | Number | Number still in stock |
Location
Abbreviated details about a store location where an item is available.
| Field | Type | Description |
|---|---|---|
name | String | Location name |
id | String | Store location ID |
square_online_id | String | Store location ID in Square Online |
MeasurementUnits
An item’s measurement units.
| Field | Type | Description |
|---|---|---|
abbreviation | String | The measurement unit the item is sold in |
multiple_units | Boolean | Whether or not this item has multiple measurement units. |
precision | Number | the measurement precision for the item |
Methods
Available fulfillment methods.
| Field | Type | Description |
|---|---|---|
DELIVERY | Boolean | Can be delivered |
DIGITAL | Boolean | Can be downloaded |
DINE_IN | Boolean | Can be served in a dine in location |
MANUAL | Boolean | Can be manually fulfilled by the merchant |
PICKUP | Boolean | Can be picked up from store location(s) |
SHIPMENT | Boolean | Can be shipped |
ModifierList
Available modifiers on the item.
| Field | Type | Description |
|---|---|---|
id | String | ID of the modifier list. |
name | String | Name of the modifier list. |
display_order | Number | Display order for the modifier list. |
max_selected_modifiers | Number | The maximum number of selected modifiers for the modifier list. If it’s a text based modifier this is the number of characters, otherwise number of choices. |
min_selected_modifiers | Number | The minimum number of selected modifiers for the modifier list. If it’s a text based modifier this is the number of characters, otherwise number of choices. |
allow_quantities | Boolean | Whether quantities are allowed on the modifier list. |
modifiers | Modifier | Can be manually fulfilled by the merchant |
square_online_item_id | String | ID of the item in Square Online. |
type | String | Type of the modifier list. Can either be choice based (GIFT_WRAP or CHOICE) or text based (GIFT_MESSAGE or TEXT) |
Modifier
Available modifier choices for a choice based modifier.
| Field | Type | Description |
|---|---|---|
hidden | Boolean | Whether or not the modifier choice was configured to be hidden. |
id | String | ID of the modifier choice. |
image | Image | The image for the modifier choice. |
name | String | Name of the modifier choice. |
ordinal | Number | The ordinal for the modifier choice. |
price_money | Money | The amount of money for the modifier choice. |
selected_by_default | Boolean | Whether or not the modifier choice was configured to be selected by default. |
sold_out | Boolean | Whehter or not the modifier choice is sold out. |
Money
Information about monetary amounts.
| Field | Type | Description |
|---|---|---|
amount | Number | Amount in the smallest subunit of the given currency |
currency | String | The ISO 4217 three-letter currency code |
formatted | String | Amount formatted with the symbol of the given currency. Formatted according to the site’s locale |
OpenGraph
Details for the Open Graph protocol.
| Field | Type | Description |
|---|---|---|
description | String | OpenGraph description |
title | String | OpenGraph title |
Phase
A phase in a subscription plan variation.
| Field | Type | Description |
|---|---|---|
cadence | String | The billing cadence of the phase. For example, weekly or monthly |
id | String | Subscription phase ID |
ordinal | Number | The position this phase appears in the sequence of phases defined for the plan, indexed from 0 |
pricing | SubscriptionPricing | The subscription pricing |
Preordering
Preordering enablement by fulfillment type.
| Field | Type | Description |
|---|---|---|
DELIVERY | Boolean | Preordering enabled for delivery |
DIGITAL | Boolean | Preordering enabled for digital downloads |
DINE_IN | Boolean | Preordering enabled for dine_in |
MANUAL | Boolean | Preordering enabled for manual |
PICKUP | Boolean | Preordering enabled for pickup |
SHIPMENT | Boolean | Preordering enabled for shipping |
Price
The different prices for an item.
| Field | Type | Description |
|---|---|---|
currency | String | Currency the item is sold in |
high_with_modifiers | Money | The max you could pay for this when the default modifiers are applied |
high_with_subscriptions | Money | The max you could pay for this item as part of a subscription |
high | Money | The highest price you can pay for this item (with the exception of any modifiers) |
low_with_modifiers | Money | The least you could pay, if default modifiers are applied |
low_with_subscriptions | Money | The least you could pay, if part of a subscription |
low | Money | The least you could pay for this item |
regular_high_with_modifiers | Money | Non sale price, modifiers included |
regular_high_with_subscriptions | Money | Non sale price of a subscription of this item |
regular_high | Money | The price when this item is NOT ON SALE |
regular_low_with_modifiers | Money | Non sale low price, modifiers included |
regular_low_with_subscriptions | Money | Non sale low price of a subscription of this item |
regular_low | Money | Non sale low price |
SubscriptionPricing
Details about the subscription pricing.
| Field | Type | Description |
|---|---|---|
discounts | SubscriptionDiscount | The discounts that are applicable for this subscription plan variation phase |
type | String | Pricing type. RELATIVE or STATIC |
high | Money | The highest price you can pay for this item (with the exception of any modifiers) without a subscription |
high_subscription | Money | The max you could pay for this item with the subscription phase |
low | Money | The least you could pay for this item without a subscription |
low_subscription | Money | The least you could pay with the subscription phase |
regular_high | Money | The price when this item is NOT ON SALE without a subscription |
regular_high_subscription | Money | The price when this item is NOT ON SALE with the subscription phase |
regular_low | Money | Non sale low price without a subscription |
regular_low_subscription | Money | Non sale low price with the subscription phase |
SubscriptionDiscount
Details about the discount for a subscription plan variation phase
| Field | Type | Description |
|---|---|---|
id | String | ID of the discount |
discount_type | String | The discount type. Either FIXED_AMOUNT or FIXED_PERCENTAGE |
percentage | Number | The discount percentage (e.g. 50) if the discount type is FIXED_PERCENTAGE |
amount_money | Money | The discount monetary amount if the discount type is FIXED_AMOUNT |
ItemTypeDetails
Details about a item type.
| Field | Type | Description |
|---|---|---|
calorie_count | String | Calorie count |
dietary_preferences_tl | String[] | Dietary preferences translated |
dietary_preferences | String[] | Dietary preferences |
ingredients_tl | String[] | Food ingredients translated |
ingredients | String[] | Food ingredients |
ItemOption
Details about an option that makes up a variation.
| Field | Type | Description |
|---|---|---|
choices | String[] | The choices available for this option |
colors | String[] | If it’s a color renderer, these are the colors that match up to the choices |
id | String | ID of the item option |
name | String | Name of the item option |
ordinal | String | The configured order for this item option |
renderer | String | The renderer type, can be color, radio, or dropdown |
ItemOptionValues
The ItemOptions that make up a specific variation.
| Field | Type | Description |
|---|---|---|
[itemOptionId] | ItemOptionValue | The itemOptionId key is the id of the ItemOption |
ItemOptionValue
An ItemOption that makes up a specific variation.
| Field | Type | Description |
|---|---|---|
name | String | Name of the ItemOption |
choice | String | The selected choice from the ItemOption choices |
color | String | The selected color from the ItemOption colors if the ItemOption rendere is color |
PublishedReply
A reply from the owner to a review.
| Field | Type | Description |
|---|---|---|
content | String | The reply content. |
updated_at | Number | When the reply was last updated, as a Unix timestamp. |
RatingBreakdown
Breakdown of a review rating.
| Field | Type | Description |
|---|---|---|
1 | Number | Number of 1-star reviews |
2 | Number | Number of 2-star reviews |
3 | Number | Number of 3-star reviews |
4 | Number | Number of 4-star reviews |
5 | Number | Number of 5-star reviews |
total | Number | Total number of reviews |
Review
A review for an item.
| Field | Type | Description |
|---|---|---|
content | String | Text content of the review |
images | Image[] | Any images included with the review |
published_replies | PublishedReply[] | Any replies to the review from the site owner |
rating | Number | Number of stars out of 5 the reviewer gave |
reviewer_name | String | Name of the reviewer |
status | String | Review status |
updated_at | String | When the review was last updated |
verified_purchase | Boolean | Whether this review was from a customer with a verified purchase of the item |
ReviewMeta
Aggregated data of an item’s reviews.
| Field | Type | Description |
|---|---|---|
avg_rating | Number | The average rating for PUBLISHED reviews of this item. Can be null if this item has no reviews |
rating_breakdown | RatingBreakdown | Review rating breakdown, broken down by star rating from 1 - 5 |
Seo
Search engine optimization settings.
| Field | Type | Description |
|---|---|---|
page_description | String | SEO text entered by the site owner |
page_title | String | The page title as it should appear on search engines |
Subscription
Subscription details for an item that is part of a subscription.
| Field | Type | Description |
|---|---|---|
id | String | Subscription ID |
present_at_all_locations | Boolean | Whether this subscription is available at all store locations |
subscription_plan_data | SubscriptionPlanData | Subscription plan details |
version | Number | Subscription version |
SubscriptionPlanData
Details about a subscription plan.
| Field | Type | Description |
|---|---|---|
eligible_item_ids | String[] | The list of Item IDs that are eligible for subscription by this SubscriptionPlan’s variations |
name | String | The name of the plan |
subscription_plan_variations | SubscriptionPlanVariation[] | The list of subscription plan variations available for this item |
SubscriptionPlanVariation
A subscription plan variation.
| Field | Type | Description |
|---|---|---|
id | String | Variation ID |
present_at_all_locations | Boolean | If true, this variation is present at all locations (including future locations). If False, it is only available at certain locations |
subscription_plan_variation_data | SubscriptionPlanVariationData | Details for this subscription variation |
SubscriptionPlanVariationData
Details about a subscription plan variation.
| Field | Type | Description |
|---|---|---|
configuration | Configuration | Subscription plan variation configuration |
monthly_billing_anchor_date | Number | The day of the month the billing period starts. Min of 1 and Max of 31 |
name | String | The name of the plan variation |
phases | Phase[] | A list containing each Subscription phase for this plan variation |
subscription_plan_id | String | The ID of the subscription plan, if there is one |
Variation
An item variation.
| Field | Type | Description |
|---|---|---|
created_at | String | Timestamp when the variation was created |
id | String | Item Variation ID |
image | Image | Image for this variation, if one exists |
inventory | Number | Number of units available in this variation |
item_id | String | Parent Item ID |
name | String | Variation name |
ordinal | Number | The display order of the variation |
price | VariationPrice | Price information |
pricing_type | String | The pricing type for the variation. Enum: VARIABLE_PRICING or FIXED_PRICING |
sold_out | Boolean | Whether this variation is sold out |
square_online_id | String | Variation ID in Square Online |
square_online_item_id | String | Parent Item ID in Square Online |
item_option_values | ItemOptionValues | The item options that make up this variation. Note this is only included for variations with multiple options |
item_option_name | String | The variation option name. Note this is only included for flat variations |
color | String | The color for this variation. Note this is only included for flat variations using a color renderer |
renderer | String | The renderer to use for this variation. Note this is only included for flat variations with a configured renderer |
VariationPrice
The price of an item variation.