Istores API Documentation
MyIstores Api

categories

Endpoint:https://api.istores.co.il

List categories

Get all categories

GET
https://api.istores.co.il
/categories

Get all categories

Get all categories › Responses

  • successboolean
    Example: true
  • responseobject[]
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Create New Category

POST
https://api.istores.co.il
/categories

Create new Cateogry

Create New Category › Request Body

  • descriptionsobject

    Object with language ids as index

    Example: {"3":{"name":"T-shirts","description":"My T-shirts description","meta_title":"T-shirts","meta_description":"My T-shirts description","meta_keyword":"My,T-shirts,clothes"}}
  • parent_idstring

    Set parent category (from your own categories ids), set 0 to ignore this option

    Example: 2
    Default: 0
  • keywordstring

    Set url keyword

    Example: my-category
  • imagestring

    Inser valid image url (best to use cloudinary service to upload there first)

  • topinteger · boolean

    Show/Hide this category at the top bar (0/1)

  • sort_orderinteger

    Set category order number (affect the visual part in the store)

    Example: 12
  • homefeaturedinteger · boolean

    Show/Hide this category at the main page (1/0)

  • statusinteger · boolean

    Enable/Disable this category (1/0)

  • hiddeninteger · boolean

    Show/Hide the category from the store area (will be available by direct link to)

Create New Category › Responses

success

  • successboolean
    Example: true
  • responsestring
    Example: Category created successfully, id: 126
  • category_idinteger
    Example: 126
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Get existing category data

GET
https://api.istores.co.il
/categories/{category_id}

Get Category data by ID

Get existing category data › path Parameters

  • category_idinteger · int64 · required

    category ID

Get existing category data › Responses

success

  • successboolean
    Example: true
  • category_idinteger
    Example: 45
  • sort_orderinteger
    Example: 10
  • topinteger
    Example: 0
  • parent_idinteger
    Example: 2
  • statusinteger
    Example: 1
  • imagestring
    Example: https://example.com/images/sample-image.png
  • keywordstring
    Example: new-keyword-123
  • homefeaturedinteger
    Example: 1
  • hiddeninteger
    Example: 1
  • urlstring
    Example: https://example.com/new-category-url
  • descriptionobject

    The key of the object represent the language id

    Example: {"3":{"name":"Canned Goods","description":"Assorted canned goods.","meta_title":"Canned Goods","meta_description":"Variety of canned goods.","meta_keyword":"Canned,Goods,Food"}}
  • category_filtersobject
    Example: {"30":{"filter_id":30,"filter_name":"Added Value","filter_group_id":16,"filter_group_name":"Value Group"}}
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Edit existing category

PUT
https://api.istores.co.il
/categories/{category_id}

Edit existing category by category ID

Edit existing category › path Parameters

  • category_idinteger · int64 · required

    Category Id

Edit existing category › Request Body

  • descriptionsobject

    Object with language ids as index

    Example: {"3":{"name":"T-shirts","description":"My T-shirts description","meta_title":"T-shirts","meta_description":"My T-shirts description","meta_keyword":"My,T-shirts,clothes"}}
  • parent_idstring

    Set parent category (from your own categories ids), set 0 to ignore this option

    Example: 2
    Default: 0
  • keywordstring

    Set url keyword

    Example: my-category
  • imagestring

    Inser valid image url (best to use cloudinary service to upload there first)

  • topinteger · boolean

    Show/Hide this category at the top bar (0/1)

  • sort_orderinteger

    Set category order number (affect the visual part in the store)

    Example: 12
  • homefeaturedinteger · boolean

    Show/Hide this category at the main page (1/0)

  • statusinteger · boolean

    Enable/Disable this category (1/0)

  • hiddeninteger · boolean

    Show/Hide the category from the store area (will be available by direct link to)

Edit existing category › Responses

success

  • successboolean
    Example: true
  • responsestring
    Example: Category updated successfully, id: 126
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Delete existing category

DELETE
https://api.istores.co.il
/categories/{category_id}

Delete category by Id

Delete existing category › path Parameters

  • category_idinteger · int64 · required

    Category Id

    Example: 12500

Delete existing category › Responses

success

  • successboolean
    Example: true
  • responsestring
    Example: Category deleted successfully, id: 126
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49
Customersproducts options