The store product object

{
  "id": "<string>",
  "active": true,
  "barcode": "<string>",
  "brand": "<string>",
  "country_of_origin": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "department_id": "<string>",
  "description": "<string>",
  "ebt_enabled": true,
  "ecommerce_enabled": true,
  "food_modifier_categories": [
    {
      "id": "<string>",
      "max_selection": 123,
      "min_selection": 123,
      "modifiers": [
        {
          "id": "<string>",
          "item_modifier": {
            "id": "<string>",
            "name": "<string>",
            "value": "199.99"
          },
          "priority": 123
        }
      ],
      "name": "<string>",
      "priority": 123
    }
  ],
  "images": [
    {
      "id": "<string>",
      "is_primary": true,
      "thumbnail_url": "<string>",
      "url": "<string>"
    }
  ],
  "is_blackhawk_gift_card": true,
  "is_prepackaged": true,
  "is_reloadable_blackhawk_gift_card": true,
  "is_tippable": true,
  "item_modifiers": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": "199.99"
    }
  ],
  "loyalty_points_per_dollar": "199.99",
  "manual_item": true,
  "maximum_retail_price": "199.99",
  "min_customer_age": 123,
  "minimum_retail_price": "199.99",
  "name": "<string>",
  "prompt_for_quantity": true,
  "retail_price": "199.99",
  "sold_by_weight": true,
  "store_id": "<string>",
  "sync_to_deli_scales": false,
  "target_margin": "199.99",
  "tax_rates": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": "8.25"
    }
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "variable_sale_price": true,
  "variable_weights": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": "199.99"
    }
  ],
  "wic_enabled": true,
  "store_vendor_products": [
    {
      "id": "<string>",
      "barcode": "<string>",
      "brand_name": "<string>",
      "case_cost": "199.99",
      "case_cost_start_time": "2023-11-07T05:31:56Z",
      "case_size": "199.99",
      "case_weight_lb": "199.99",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "each_cost": "199.99",
      "each_cost_start_time": "2023-11-07T05:31:56Z",
      "inner_pack_size": "199.99",
      "is_order_primary": true,
      "item_code": "<string>",
      "lb_cost": "199.99",
      "lb_cost_start_time": "2023-11-07T05:31:56Z",
      "mutation_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "store_id": "<string>",
      "store_product": {
        "id": "<string>",
        "barcode": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "store_product_id": "<string>",
      "store_vendor": {
        "id": "<string>",
        "code": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "unit_volume": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

A product as it is sold at a single store, carrying its price, barcodes, department, and inventory settings.

string

required

Unique identifier for the record.

active

boolean

required

Whether the product is active.

barcode

string

required

Primary barcode.

brand

string | null

required

Brand name.

country_of_origin

string | null

required

ISO 3166-1 alpha-3 country code of origin.

Required string length: 3

created_at

string<date-time>

required

When the record was created.

department_id

string

required

ID of the store department this product belongs to.

Pattern: ^[0-9]+$

description

string | null

required

Short description, intended for character-limited use cases (e.g., printed receipts).

ebt_enabled

boolean

required

Whether the product is eligible for EBT/SNAP payment.

ecommerce_enabled

boolean

required

Whether the product is available for e-commerce.

food_modifier_categories

object[]

required

Food modifier categories, and their modifiers, available for this product, ordered by category priority.

Show child attributes

images

object[]

required

Photos of this product.

Show child attributes

is_blackhawk_gift_card

boolean

required

Whether the product is a Blackhawk gift card.

is_prepackaged

boolean | null

required

Whether the product is sold as a fixed pre-packaged unit rather than weighed or portioned at sale. Null when the store has not reviewed it.

is_reloadable_blackhawk_gift_card

boolean

required

Whether the product is a reloadable Blackhawk gift card.

is_tippable

boolean

required

Whether purchases of this product can include a tip.

item_modifiers

object[]

required

Item modifiers available for this product.

Show child attributes

loyalty_points_per_dollar

string | null

required

Loyalty points earned per dollar spent. Null defaults to one point per dollar.

Pattern: ^[0-9]+(\.[0-9]+)?$

Example:

"199.99"

manual_item

boolean

required

Whether the product is entered manually at the register rather than scanned.

maximum_retail_price

string<positive-monetary> | null

required

Upper bound for the retail price, in dollars. This is typically only used for variable-priced gift cards.

Pattern: ^[0-9]+(\.[0-9]+)?$

Example:

"199.99"

min_customer_age

integer | null

required

Minimum customer age, in years, required to purchase.

minimum_retail_price

string<positive-monetary> | null

required

Lower bound for the retail price, in dollars. This is typically only used for variable-priced gift cards.

Pattern: ^[0-9]+(\.[0-9]+)?$

Example:

"199.99"

name

string

required

Human-readable product name.

prompt_for_quantity

boolean

required

Whether the register prompts for a quantity when the product is scanned.

retail_price

string<positive-monetary> | null

required

Current shelf/retail price in dollars.

Pattern: ^[0-9]+(\.[0-9]+)?$

Example:

"199.99"

sold_by_weight

boolean

required

Whether the product is sold by weight rather than by unit.

store_id

string

required

ID of the store this product belongs to.

Pattern: ^[0-9]+$

sync_to_deli_scales

boolean

default:false

required

Whether the product is synchronized to deli scales.

target_margin

string | null

required

Target gross margin for pricing decisions, as a whole-number percentage (35 means 35%).

Pattern: ^-?[0-9]+(\.[0-9]+)?$

Example:

"199.99"

tax_rates

object[]

required

Tax rates applied to this product at the register.

Show child attributes

updated_at

string<date-time>

required

When the record was last changed.

variable_sale_price

boolean

required

Whether the sale price is entered at the register instead of fixed.

variable_weights

object[]

required

Preset weights for products sold by weight.

Show child attributes

wic_enabled

boolean

required

Whether the product is eligible for WIC payment.

active_vendor

object

The vendor currently supplying this product.

Show child attributes

active_vendor_product

object

The vendor catalog entry currently supplying this product.

Show child attributes

inventory

object

Current inventory levels. Included when requested via include=inventory.

Show child attributes

store_vendor_products

object[]

Vendor catalog entries for this product.

Show child attributes

API

AI tools