GetCategoryList

Returns a list of all available categories. The list can be shortened using the _offset and _limit parameters.

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

Input parameters

  1. _session_hash (string)

    Required. Session identifier (received during login - doLogin)

  2. _offset (integer)

    Required. Specifies the offset of the results.

  3. _limit (integer)

    Required. Specifies the number of results in the query.

  4. _modified_from (dateTime)

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

  5. _modified_to (dateTime)

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

  6. parent_id (integer) optional

    Id of the parent category for which the list of categories will be returned.

  7. product_id (integer) optional

    Id of the product for which the list of categories will be returned.

Output data

  1. created_at (dateTime)

    Entry creation date.

  2. updated_at (dateTime)

    Date of last entry modification.

  3. id (integer)

    Category identifier

  4. name (string)

    Category name. Maximum length 255 characters.

  5. parent_id (integer)

    Parent identifier.

  6. image (string)

    File encoded with base64 method

  7. image_filename (string)

    File name containing the image

  8. description (string)

    Content of the description.

  9. main_page (integer)

    Option Show on main page

  10. is_active (integer)

    Active

  11. is_hidden (integer)

    Option Hide in category tree

  12. show_children_products (integer)

    Option Show products from subcategories

  13. url (string)

    Friendly link

  14. link(string)

    Full link to the category