created_atstring date-time required
updated_atstring date-time required
deleted_atstring date-time nullable required
When the product was soft-deleted, or null if it has not been deleted.
store_idstring required
ID of the store this product belongs to.
department_idstring required
ID of the store department this product belongs to.
brandstring nullable required
descriptionstring nullable required
Short description, intended for character-limited use cases (e.g., printed receipts).
activeboolean required
Whether the product is active.
namestring required
Human-readable product name.
target_marginstring nullable required
Target gross margin for pricing decisions, as a whole-number percentage (35 means 35%).
case_sizeinteger nullable required
Number of sellable units in a vendor case.
pack_sizeinteger nullable required
Number of units in a retail pack.
print_physical_tagboolean required
Whether a physical shelf tag should be printed for this product.
esl_enabledboolean required
Whether electronic shelf labels are enabled for this product.
label_last_printed_atstring date-time nullable required
When a shelf tag was last printed for this product.
wicableinteger nullable required
WIC eligibility indicator.
min_customer_ageinteger nullable required
Minimum customer age, in years, required to purchase.
wic_enabledboolean required
Whether the product is eligible for WIC payment.
snap_enabledboolean required
Whether the product is eligible for SNAP payment.
ebt_enabledboolean required
Whether the product is eligible for EBT/SNAP payment.
ecommerce_enabledboolean required
Whether the product is available for e-commerce.
variable_sale_priceboolean required
Whether the sale price is entered at the register instead of fixed.
sold_by_weightboolean required
Whether the product is sold by weight rather than by unit.
prompt_for_quantityboolean required
Whether the register prompts for a quantity when the product is scanned.
manual_itemboolean required
Whether the product is entered manually at the register rather than scanned.
is_tippableboolean required
Whether purchases of this product can include a tip.
is_blackhawk_gift_cardboolean required
Whether the product is a Blackhawk gift card.
is_reloadable_blackhawk_gift_cardboolean required
Whether the product is a reloadable Blackhawk gift card.
snap_incentive_earnableboolean required
Whether purchases of this product earn SNAP incentives.
snap_incentive_redeemableboolean required
Whether SNAP incentives can be redeemed against this product.
discount_restrictionsDiscountRestriction[] nullable required
Discount types that may not be applied to this product.
loyalty_points_per_dollarstring nullable required
Loyalty points earned per dollar spent. Null defaults to one point per dollar.
unit_volume_quantitystring nullable required
Net content quantity, in the unit given by unit_volume_uom_name.
unit_volume_uom_namestring nullable required
Unit of measure for unit_volume_quantity.
unit_pricestring nullable required
Retail price per unit of measure, in dollars.
retail_pricestring positive-monetary nullable required
Current shelf/retail price in dollars.
minimum_retail_pricestring positive-monetary nullable required
Lower bound for the retail price, in dollars.
maximum_retail_pricestring positive-monetary nullable required
Upper bound for the retail price, in dollars.
retail_price_effective_atstring date-time nullable required
When the current retail price took effect.
disable_pos_syncboolean required
Whether synchronization of this product to the point-of-sale is disabled.
primary_vendor_configuration'LATEST_COST' | 'SELECTED_BY_USER' required
country_of_originstring nullable required
ISO 3166-1 alpha-3 country code of origin.
sync_to_deli_scalesboolean required
Whether the product is synchronized to deli scales.