Products Related

ProductPackage

object

Represents the package information.

average_maxnumber(float)
average_max_unit_codestring

The unit code of the average max. (mostly kg).

average_minnumber(float)
average_min_unit_codestring

The unit code of the average min. (mostly kg).

brutto_volumenumber(float)

Volume of the product including the package.

brutto_volume_unit_codestring

The unit code of the brutto volume.

Potential values: cdm, dm3 (cubic decimeter), ccm (cubic centimeter),
m3 (cubicmeter), hl (hectoliter), gll (US gallon), oza (US fluid ounce),
in3 (cubic inches)

brutto_weightnumber(float)

Weight of the product including the package.

brutto_weight_unit_codestring

The unit code of the brutto weight.

Potential values: kg, g

contentnumber(float)

Size of the content.

For example:
Cola bottle - 1000 (ml)
M-Budget Glace Box - 2500 (ml)

content_unitstring

The unit value of the content.

content_unit_codestring

The unit code of the content. (l, kg).

heightnumber(float)
height_unit_codestring
lengthnumber(float)
length_unit_codestring
net_weightnumber(float)

Net weight. Weight of the content, without package.

Example values:
Cola bottle - 1.012 (kg)
M-Budget Glace Box - 1.15 (kg)

net_weight_unitstring

The unit value of the net weight.

net_weight_unit_codestring

The unit code of the net weight. (mostly kg).

portions_per_packagestring

The number of portion in a package unit.

precisionstring

How precise the portions information is. Either “exact” or “approximate”.

price_comparison_contentnumber(float)

Size of the content for price comparison.

sizestring

The size of the package as a string.

typestring

The type of the package.

unit_dimensionstringDEPRECATED
widthnumber(float)
width_unit_codestring
Example

ProductPackageInformation

object
brutto_volumenumber(float)

Volume of the product including the package.

brutto_volume_unit_codestring

The unit code of the brutto volume.

Potential values: cdm, dm3 (cubic decimeter), ccm (cubic centimeter),
m3 (cubicmeter), hl (hectoliter), gll (US gallon), oza (US fluid ounce),
in3 (cubic inches)

brutto_weightnumber(float)

Weight of the product including the package.

brutto_weight_unit_codestring

The unit code of the brutto weight.

Potential values are kg, g, etc.

dimension_unit_codestringDEPRECATED

Unit code used for height, length and width.

Potential values are m, cm, etc.

gtinsarray[string]

Gtins specific to this packaging.

Note that the customer unit (CU) gtins (and only those) are also copied
to the gtins field directly on the product.

heightnumber(float)
height_unit_codestring
lengthnumber(float)
length_unit_codestring
number_of_base_unitsinteger

Number of products the package contains (integer until v8, float from v9 on).

widthnumber(float)
width_unit_codestring
Example

ProductPreSupplier

object
idstringrequired
namestring
Example

ProductPrice

object

Singular combined price information including discount if present.

currencystring
estimated_piece_pricenumber(float)

The estimated price of a piece.

Some products that are usually sold by weight (fruit, vegetables, meat). But aMigos
needs to know the estimated price based on the average weight of one piece as it
is added to the cart by number and not by weight.

estimated_piece_weightnumber(float)

The estimated weight of a piece (in grams).

The average weight that the estimated piece price is calculated on.

itemOne Of
PriceQuantityUnitobject

Represents the current price and quantity (within a region).

Show Child Parameters
no_price_hintstring

The price hint if no price is set.

sourcestring
valid_fromstring(date)required
valid_tostring(date)required
baseOne Of
PriceQuantityUnitobject

Represents the current price and quantity (within a region).

Show Child Parameters
discountOne Of
BaseDiscountobject

Represents the Discount information.

Show Child Parameters
discount_hintstring
estimated_piece_original_pricenumber(float)

The estimated original price of a piece, without discount.

Example

ProductPriceComparison

object
comparison_pricinginteger
content_unit_pricingOne Of
ContentUnitPricingobject
Show Child Parameters
net_pricinginteger
Example