Child pages
  • Products
Skip to end of metadata
Go to start of metadata

Products are the types of projects which can be created. They are maintained by MILK, and can be retrieved by the API user. Creating or changing products takes coordination with the physical production process, so these will be dealt with offline.

Requires:

Actions

URLVerbInformation
/productsGETLists all available product types

Fields

The following fields are returned about a Product

FieldData TypeRequiredInformation
IdIntegerYMay differ between Environments
GuidGuidYUniquely identifies the product, consistent between Environments
NameStringY 
PriceDecimalYPrice of purchasing one of the product
AddOnsList of AddOnNAny Add Ons available for the product
OptionGroupsList of AddOnOptionGroupNAny Add Ons available for the product, grouped by the Option

The following fields are returned about an Add On

FieldData TypeRequiredInformation
IdIntegerYMay differ between Environments
GuidGuidYUniquely identifies the add on, consistent between Environments
NameStringY 
PriceDecimalYPrice of purchasing one of the product
QuantityTypeQuantityTypeYHow the quantity of the add on relates to the quantity of the order line
OptionGroupStringNThe name of the Option Group the add on belongs to

The following options are available for QuantityType

ValueInformation
EachApplies the quantity of the add on to each quantity of the base line. For example: Line quantity of 2 with an add on of quantity 3 would result in a total of 6 add ons being charged.
LineOnly applies once per line, the quantity of the add on is independent of the quantity of the base line.
  • No labels