Istores API Documentation
MyIstores Api

Modules

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

Storefront layout, header, and footer module CRUD.

List modules

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

Requires gateway permission themesModules. Access is restricted to the authenticated store. See Modules guide. Ordered by sort_order, then layout_module_id. Empty lists return 200 with response=[], results=0 and pages=0.

List modules › query Parameters

  • layout_idinteger

    Filter by layout; 0 selects global header/footer modules. Omit for all layouts.

  • positionstring · enum
    Enum values:
    content_top
    content_bottom
    header
    footer
  • pageinteger · min: 1
    Default: 1
  • limitinteger · min: 1 · max: 100
    Default: 10

List modules › Responses

Success

  • successboolean
    Example: true
  • responseobject[]
  • resultsinteger
  • pagesinteger
  • pageinteger
  • per_pageinteger
  • request_idstring

Create module

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

Requires gateway permission themesModules. Access is restricted to the authenticated store. See Modules guide.

Create module › Request Body

  • layout_idinteger · required

    0 for header/footer; otherwise an existing layout ID belonging to this store.

  • codestring · enum · required

    Must be allowed for the selected layout or global position.

    Enum values:
    homefeaturedcategory
    banners
    category_slide
    product_slide
    embed
    info_slider
    brands
    faq
  • componentstring · enum · required

    layout for a positive layout_id; otherwise must equal position.

    Enum values:
    layout
    header
    footer
  • positionstring · enum · required

    content_top/content_bottom for a layout; header/footer for layout_id 0.

    Enum values:
    content_top
    content_bottom
    header
    footer
  • sort_orderinteger · required
  • settingsobject · required

    Settings depend on code; see the Modules guide for required fields and allowed values. Send the full settings object on update.

  • bannersobject[]

    For code=banners. If supplied, replaces the banner collection: omitted existing banner IDs are deleted. Omit to retain existing banners; [] removes all.

Create module › Responses

Success

  • successboolean
    Example: true
  • responseobject
  • request_idstring

Get module

GET
https://api.istores.co.il
/modules/{layout_module_id}

Requires gateway permission themesModules. Access is restricted to the authenticated store. See Modules guide.

Get module › path Parameters

  • layout_module_idinteger · required

    Module ID belonging to the authenticated store.

Get module › Responses

Success

  • successboolean
    Example: true
  • responseobject
  • request_idstring

Update module

PUT
https://api.istores.co.il
/modules/{layout_module_id}

Requires gateway permission themesModules. Access is restricted to the authenticated store. See Modules guide. Send all required fields. The settings object is replaced, not patched.

Update module › path Parameters

  • layout_module_idinteger · required

    Module ID belonging to the authenticated store.

Update module › Request Body

  • layout_idinteger · required

    0 for header/footer; otherwise an existing layout ID belonging to this store.

  • codestring · enum · required

    Must be allowed for the selected layout or global position.

    Enum values:
    homefeaturedcategory
    banners
    category_slide
    product_slide
    embed
    info_slider
    brands
    faq
  • componentstring · enum · required

    layout for a positive layout_id; otherwise must equal position.

    Enum values:
    layout
    header
    footer
  • positionstring · enum · required

    content_top/content_bottom for a layout; header/footer for layout_id 0.

    Enum values:
    content_top
    content_bottom
    header
    footer
  • sort_orderinteger · required
  • settingsobject · required

    Settings depend on code; see the Modules guide for required fields and allowed values. Send the full settings object on update.

  • bannersobject[]

    For code=banners. If supplied, replaces the banner collection: omitted existing banner IDs are deleted. Omit to retain existing banners; [] removes all.

Update module › Responses

Success

  • successboolean
    Example: true
  • responseobject
  • request_idstring

Delete module

DELETE
https://api.istores.co.il
/modules/{layout_module_id}

Requires gateway permission themesModules. Access is restricted to the authenticated store. See Modules guide. Deleting a banners module also deletes its related banner images through the existing module lifecycle.

Delete module › path Parameters

  • layout_module_idinteger · required

    Module ID belonging to the authenticated store.

Delete module › Responses

Success

  • successboolean
    Example: true
  • responseobject
  • request_idstring
Store themesCustom orders