GetProductList

Returns a list of all products in the store.

  • Input data type => object
  • Output data type => array

Input parameters

  1. _session_hash (string)

    2. Required. Session identifier (received during login - doLogin)

  2. _offset (integer)

    3. Required. Specifies the offset of the results.

  3. _limit (integer)

    4. Required. Specifies the number of results in the query.

  4. _modified_from (dateTime)

    5. Specifies the modification date from which the results will be displayed. Time in unixtime format.

  5. _modified_to (dateTime)

    6. Specifies the modification date to which the results will be displayed. Time in unixtime format.

Output data

  1. created_at (dateTime)

    2. Entry creation date.

  2. updated_at (dateTime)

    3. Date of last entry modification.

  3. id (integer)

    4. Identifier.

  4. name (string)

    5. Product name. Maximum length is 255 characters.

  5. code (string)

    6. Product code.

  6. price (double)

    7. Net product price. Decimal separator is the dot "."

  7. price_brutto (double)

    8. Gross product price. Decimal separator is the dot "."

  8. category_id (integer)

    9. Default product category identifier. The category with the given ID must exist in the store.

  9. producer_id (integer)

    10. Product producer identifier. The producer with the given ID must exist in the store.

  10. vat (double)

    11. VAT tax given in percentages. The decimal separator used is the dot "."

  11. short_description (string)

    12. Short product description. The maximum length of the description depends on the database used, limitation of the TEXT field.

  12. description (string)

    13. Product description. The maximum length of the description depends on the database used, limitation of the TEXT field.

  13. active (integer)

    Specifies whether the product is active in the store.

    • 0 - inactive
    • 1 - active
  14. stock (string)

    15. Product stock.

  15. availability_id (integer)

    16. Specifies the availability name in case the stock is not specified.

  16. man_code (string)

    17. Manufacturer code.

  17. old_price (double)

    18. Old net product price. The decimal separator used is the dot "."

  18. old_price_brutto (double)

    19. Old gross product price. The decimal separator used is the dot "."

  19. wholesale_a_netto (double)

    20. Wholesale A net product price. The decimal separator used is the dot "."

  20. wholesale_a_brutto (double)

    21. Wholesale A gross product price. The decimal separator used is the dot "."

  21. wholesale_b_netto (double)

    22. Wholesale B net product price. The decimal separator used is the dot "."

  22. wholesale_b_brutto (double)

    23. Wholesale B gross product price. The decimal separator used is the dot "."

  23. wholesale_c_netto (double)

    24. Wholesale C net product price. The decimal separator used is the dot "."

  24. wholesale_c_brutto (double)

    25. Wholesale price C gross of the product. The decimal separator used is the dot "."

  25. tax_id (integer)

    26. VAT rate identifier.

  26. product_options (string)

    27. Product options according to the format from the import / export module.

  27. weight (double)

    28. Product weight.

  28. uom (string)

    29. Product unit of measure.

  29. is_stock_validated (integer)

    30. The Check stock level option.

  30. points_value (integer)

    31. The Price in points option.

  31. points_earn (integer)

    32. The Earned points option.

  32. points_only (integer)

    33. The Product only for points option.

  33. url (string)

    34. Friendly link.

  34. width(double)

    Width.

  35. height(double)

    Height.

  36. depth(double)

    Depth.

  37. link(string)

    Full link to the product