Skip to main content

Caper attributes

Use the following columns to configure the Caper Cart experience.

ColumnTypeDescription
available_for_cartbooleanRequired by Caper. Determines whether the item can be purchased using a Caper Cart.
baked_good_baggablebooleanDetermines whether a loose bakery item can be mixed with other bakery items in a single bag or box without needing to be weighed as an individual unit. Not intended for items that can be purchased in predefined packs, such as half-dozen donut boxes.
in_store_pricefloatRequired by Caper. The item's per-unit or per-weight-unit price with no markup.
quantity_requiredbooleanThis column/value is required by Caper. Determines whether a quantity must be entered when adding PLU items to the cart. This typically applies to produce items that are sold per unit.
restriction_forced_verificationbooleanDetermines whether the item causes the cart to require verification by a store associate before the customer can check out. Can be used as a virtual security tag.
restriction_security_tagbooleanDetermines whether the item has a physical EAS (electronic article surveillance) tag that needs to be inspected or removed at checkout.
restriction_minimum_ageintegerThe minimum age required to purchase the item. Used in the management and display of age-verification workflows in the UI. This attribute provides flexibility in configuring age restrictions outside of standard categories, such as alcoholic beverages.
tare_weightfloatFor items sold by weight, this is the amount to be subtracted from the weight used to calculate the price. This is typically the weight of a container or other packaging.
tare_packagingJSONDetails about the types of containers that customers can use to purchase certain sold-by-weight items. During the shopping flow, the customer taps to select their container from the list of options.

JSON

tare_container

Each object in the tare_container array can have the following fields.

FieldData typeRequiredDescriptionExample
weight_codeintegerYesAlphanumeric identifier"weight_code":6
weight_valuefloatYesThe weight of the container. This amount is subtracted from the weight used to calculate the price. Uses the same unit of measure as the item being purchased."weight_value":0.06
namestringYesThe name of the container. This value is displayed to the customer."name":"Small Hot Bar"
image_URLstringYesThe path to the container image file. This image is displayed to the customer."image_url":"https://example.com/ctr_img_12.jpg"

Example

The following is an example of the tare_packaging array:

{
"tare_packaging": [
{
"weight_code": 6,
"weight_value": 0.06,
"name": "Small Hot Bar",
"image_url": "https://example.com/ctr_img_12.jpg"
},
{
"weight_code": 16,
"weight_value": 0.16,
"name": "Large Hot Bar",
"image_url": "https://example.com/ctr_img_19.jpg"
}
]
}