Skip to main content
GET
Retrieve a variable weight

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Pattern: ^[0-9]+$

Response

The weight of a tare container a product is sold in, such as a produce bag. It is subtracted from the scale reading so the shopper pays for the contents rather than the packaging.

id
string
required

Unique identifier for the record.

created_at
string<date-time>
required

When the record was created.

name
string
required

Human-readable name for the tare container, such as "Produce bag".

store_id
string
required

ID of the store the variable weight belongs to. Variable weights are not shared between stores.

Pattern: ^[0-9]+$
unit_of_measure
enum<string>
required

Unit of measure the weight is expressed in, limited to the units the point of sale can weigh in.

Available options:
LBS,
OZ
updated_at
string<date-time>
required

When the record was last changed.

value
string
required

Weight of the tare container, as a decimal string in the unit of measure.

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

"199.99"