Products

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

ProductStatus

object

A product status.

activeOne Of

Information whether or not the product is active (not exposed).

ProductActiveobject

Information whether or not a product is active.

Show Child Parameters
descriptionstring

Status description text.

distribution_centerarray[object]

The pex status of the product.

Show Child Parameters
idstringrequired

Status identifier (no relation to active field).

Can be one of these values: available, not-available, currently-not-available, liquidation, deleted.

Allowed values:availablenot-availablecurrently-not-availableliquidationdeleted

offline_datestring(date-time)

Date which marks by when a product should not be displayed online anymore.

online_approvalboolean

Is field available online

online_datestring(date-time)

Date which marks by when a product should be displayed online.

pim_statusstringrequired

The pim status of the product.

price_band_categorystring

Price band category type.

price_levelOne Of

Information about the price_level (tiefpreis/normalpreis)

PriceLevelobject
Show Child Parameters
season_yearinteger

Additional information for seasonal products to identify for which year this product is.

seasonalboolean

Seasonal flag.

seasonal_type_codestring

Product’s seasonality type code.
Possible values:

  • ‘0010’: Default
  • ‘P’: Permanent
  • ‘F’: Spring
  • ‘FW’: Spring periodic
  • ‘H’: Fall
  • ‘HW’: Fall periodic
  • ‘S’: Summer
  • ‘SW’: Summer periodic
  • ‘W’: Winter
  • ‘WW’: Winter periodic

Allowed values:0010PFFWHHWSSWWWW

Example