shop.category.update

Updates information about the specified product category.

Parameters

  • id GET

    Category ID.

  • parent_id POST Optional

    Parent category ID. If not specified, 0 is used by default.

  • depth POST Optional

    Nesting level in category hierarchy.

  • meta_title POST Optional

    TITLE element for category page.

  • meta_keywords POST Optional

    META keywords.

  • meta_description POST Optional

    META description.

  • url POST Optional

    URL of category page in storefront.

  • description POST Optional

    Description.

  • conditions POST Optional

    Products selection conditions string for dynamic categories, in which individual parameters are separated from each other with an ampersand.

    Examples of parameters:
    — create_datetime>=2022-10-13 (beginning of the period to check product creation dates)
    — create_datetime<=2022-10-15 (end of the period to check product creation dates)
    — price>=100 (beginning of the values range to check product prices)
    — price<=200 (end of the values range to check product prices)
    — compare_price>=200 (beginning of the values range to check product strike-through prices)
    — compare_price<=300 (end of the values range to check product strike-through prices)
    — purchase_price>=50 (beginning of the values range to check product purchase prices)
    — purchase_price<=70 (end of the values range to check product purchase prices)
    — edit_datetime>=2022-10-01 (beginning of the period to check last product editing date)
    — edit_datetime<=2022-10-10 (end of the period to check last product editing date)
    — rating>=3 (beginning of the values range to check product ratings)
    — rating<=5 (end of the values range to check product ratings)
    — type=14||13 (IDs of product types)
    — count>=5 (beginning of the values range to check product stock quantities)
    — count<=100 (end of the values range to check product stock quantities)
    — badge=lowprice||bestseller (product badges’ IDs)
    — brand.value_id=159,190 (IDs of values of a product feature with the 'brand' identifier)

  • filter POST Optional

    Products filter setup parameters, in the form of a string containing filter field identifiers separated by commas. As identifiers can be used numeric IDs of product features, and the 'price' string for the filter by price. The sort order of the field identifiers corresponds to the sort order of filter fields.

  • sort_products POST Optional

    Default product sorting rule composed of a product field name followed by a space and a direction value; e.g., 'name ASC', 'price DESC'.

    Available list of product sorting rules:
    — name ASC (by name)
    — price DESC (most expensive)
    — price ASC (least expensive)
    — rating DESC (highest rated)
    — rating ASC (lowest rated)
    — total_sales DESC (bestsellers by sold amount)
    — total_sales ASC (worst sellers)
    — count DESC (in stock)
    — create_datetime DESC (date added)
    — stock_worth DESC (stock net worth)

    An empty value corresponds to manual sort order defined in the store backend, only for static categories.

  • include_sub_categories POST Optional

    Flag (0 or 1) requiring to display products from subcategories.

  • status POST Optional

    Category status. 0­: hidden, 1: visible in storefront.

  • format GET Optional

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

Error codes

  • invalid_request

    Invalid formed request. Additional information about the error is available in error_description parameter.

  • access_denied

    Access to the specified API method for the current token is denied.

  • invalid_method

    Unknown API method.