Model Definitions

Product Definition

Attribute	Type	Description
id	int	Product ID. Read only.
manufacturer	string	The name of the manufacturer. Must be 100 or fewer characters in length.
brand	string	The name of the brand. Must be 100 or fewer characters in length.
name	string	The name of the product. Must be 100 or fewer characters in length.
customData	string	Container for customer specified extra data. Must be 30 or fewer characters in length.
size	float	The size of the product. Must be greater than or equal to zero.
unitsForSize	string	The units for the size, such as oz or pack. Must be 10 or fewer characters in length.
container	string	An enum that describes the products container. See the enum definition for accepted options.
upc	string	The product's UPC. Must be 50 or fewer characters in length.
productImage	string	A link to the uploaded product image. Must be 100 or fewer characters in length.
nutritionImage	string	A link to the uploaded image of the product's nutritional facts. Must be 100 or fewer characters in length.
cost	decimal	The product's cost to the vendor. Must be greater than or equal to zero.
defaultPrice	decimal	The customer's price for the product unless overridden elsewhere (such as selection). Must be greater than or equal to zero.
isACommonProduct	bool	Indicates if a product is commonly used. Products that are marked as commonly used are easier to locate when using the Client UI.
calories	int	The number of calories per serving. Must be greater than or equal to zero.
vendSize	string	An enum that indicates the products general size. See the enum definition for accepted options.
organizationId	int	The ID of the organization this product belongs to. Must be greater than zero. Read only.
productGroup	string	An additional label for groups of products, such as "soda". Must be 50 or fewer characters in length.
number	string	The product number. Must be 50 or fewer characters in length.
customField1	string	User defined custom data. Must be 50 or fewer characters in length.
customField2	string	User defined custom data. Must be 50 or fewer characters in length.
customField3	string	User defined custom data. Must be 50 or fewer characters in length.
customField4	string	User defined custom data. Must be 50 or fewer characters in length.
customField5	string	User defined custom data. Must be 50 or fewer characters in length.
customField6	string	User defined custom data. Must be 50 or fewer characters in length.
customField7	string	User defined custom data. Must be 50 or fewer characters in length.
customField8	string	User defined custom data. Must be 50 or fewer characters in length.
customField9	string	User defined custom data. Must be 50 or fewer characters in length.
customField10	string	User defined custom data. Must be 50 or fewer characters in length.
customField11	string	User defined custom data. Must be 50 or fewer characters in length.
customField12	string	User defined custom data. Must be 50 or fewer characters in length.
customField13	string	User defined custom data. Must be 50 or fewer characters in length.
customField14	string	User defined custom data. Must be 50 or fewer characters in length.
customField15	string	User defined custom data. Must be 50 or fewer characters in length.
isDeleted	bool	Indicates if product is considered active in the system. Deleted products will not be shown by default on the website UI.

Product Enumerations

Container

Default value is unknown.

Name	Meaning
unknown	Invalid data or unspecified.
all	None (tells the machine to vend as both bottle and can).
can	Product is canned.
bottle	Product is bottled.

VendSize

Default value is unknown.

Name	Meaning
unknown	Invalid data or unspecified.
small	Product size is small.
medium	Product size is medium.
bottle	Product size is large.