shop.type.getInfo

Returns information about a product type.

Parameters

  • id GET

    Product type ID.

  • format GET Optional

    Sets response format. Available options: json (default), xml.

Return value

Product type data array with the following keys:

  • id int Product type ID.
  • count int Number of products belonging to this type.
  • icon string Product type icon name.
  • name string Product type name.
  • cross_selling string Value of the Cross-selling setting for this products type.
  • upselling int Flag (0 or 1) denoting the status of the Upselling & Similar products setting for this product type.
  • base_unit_id int Base quantity unit ID.
  • base_unit_fixed int Availability of editing the base quantity unit (0 — can be edited in product properties, 1 — cannot be edited in product properties, 2 — disabled).
  • stock_unit_id int Stock quantity unit ID.
  • stock_unit_fixed int Availability of editing the base quantity unit (0 — can be edited in product properties, 1 — cannot be edited in product properties, 2 — disabled).
  • count_denominator int Available precision for stock quantities. Acceptable values: 1 (whole pieces), 10 (precision to tenths), 100 (precision to hundredths), 1000 (precision to thousandths).
  • count_denominator_fixed int Availability of editing the available precision for stock quantities (0 — can be edited in product properties, 1 — cannot be edited in product properties, 2 — disabled).
  • order_count_min float Minimal orderable product quantity.
  • order_count_min_fixed int Availability of editing the minimal orderable product quantity (0 — can be edited in product properties, 1 — cannot be edited in product properties, 2 — disabled).
  • order_count_step float Value of product quantity adjustment with “+/-” buttons.
  • order_count_step_fixed int Availability of editing the value of product quantity adjustment with “+/-” buttons (0 — can be edited in product properties, 1 — cannot be edited in product properties, 2 — disabled).
  • order_multiplicity_factor float Products add-to-cart step (multiplicity factor).
  • order_multiplicity_factor_fixed int Availability of editing the products add-to-cart step (0 — can be edited in product properties, 1 — cannot be edited in product properties, 2 — disabled).
  • stock_base_ratio float Conversion ratio between a stock unit and a base unit, i.e. how many base units are contained in one stock unit.
  • stock_base_ratio_fixed int Availability of editing the conversion ratio between a stock unit and a base unit (0 — can be edited in product properties, 1 — cannot be edited in product properties, 2 — disabled).

Example

https://demo1.webasyst.com/api.php/shop.type.getInfo?