Skip to main content

Tare packaging specifications

Use the tare_packaging array to provide container options for items sold by weight. During the shopping flow, the customer selects a container from the list you provide.

Parameters

Each object in the tare_packaging array accepts the following parameters.

FieldTypeRequiredDescription
weight_codeintegeryesThe identifier for the container.
weight_valuefloatyesThe weight of the container. This amount is subtracted from the total weight when calculating the price. Uses the same unit of measure as the item.
namestringyesThe name of the container, displayed to the customer.
image_urlstringyesThe URL of the container image, displayed to the customer.

Example

{
"lookup_code": "1234567890",
"store_identifier": "1234",
"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"
}
]
}