Istores API Documentation
MyIstores Api

custom_field

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

Get custom field list

GET
https://api.istores.co.il
/custom_fields/{limit}/{page}

Get list of custom fields

Get custom field list › path Parameters

  • limitinteger · int64 · required

    the limit of the custom fields recieved each call

  • pageinteger · int64 · required

    the page number (start page is 0)

Get custom field list › Responses

success

  • successboolean
    Example: true
  • responseobject

Get single custom field

GET
https://api.istores.co.il
/custom_field/{custom_field_id}

Get single custom field full details

Get single custom field › path Parameters

  • custom_field_idinteger · int64 · required

    custom field id

Get single custom field › Responses

success

  • successboolean
    Example: true
  • responseobject

Update existing custom field

PUT
https://api.istores.co.il
/custom_field/{custom_field_id}

Update existing custom field

Update existing custom field › path Parameters

  • custom_field_idinteger · int64 · required

    custom field id

Update existing custom field › Request Body

  • nameobject

    Object of names by lagnuage id

    Example: {"3":"House num"}
  • typestring

    Fill the type of the custom field (there is api request for valid list of types)

    Example: radio
  • locationstring

    The location of the custom field (now only 'address available')

    Example: address
  • validationstring

    A valid regex pattern for the custom field (leave empty to allow all chars)

    Example:
  • sort_orderinteger

    The order of the custom field in the relation to another fields

  • slugstring

    A valid slug without sapcing for inner proccesses and API (you can leave it empty, the system will create it automaticly)

  • statusinteger · boolean

    The status of the custom field ('1' means its active)

  • requiredinteger · boolean

    If field is required pass '1'

  • custom_field_valueobject[]

    Array of objects with data of the custom field values (only if its multi value field like radio or checkbox)

Update existing custom field › Responses

Custom field deleted successfullyy

  • successboolean
    Example: true
  • responseobject

Delete existing custom field

DELETE
https://api.istores.co.il
/custom_field/{custom_field_id}

Delete existing custom field

Delete existing custom field › path Parameters

  • custom_field_idinteger · int64 · required

    custom field id

Delete existing custom field › Responses

Custom field deleted successfullyy

  • successboolean
    Example: true
  • responseobject

Create new custom field

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

Create new custom field

Create new custom field › Request Body

  • nameobject

    Object of names by lagnuage id

    Example: {"3":"House num"}
  • typestring

    Fill the type of the custom field (there is api request for valid list of types)

    Example: radio
  • locationstring

    The location of the custom field (now only 'address available')

    Example: address
  • validationstring

    A valid regex pattern for the custom field (leave empty to allow all chars)

    Example:
  • sort_orderinteger

    The order of the custom field in the relation to another fields

  • slugstring

    A valid slug without sapcing for inner proccesses and API (you can leave it empty, the system will create it automaticly)

  • statusinteger · boolean

    The status of the custom field ('1' means its active)

  • requiredinteger · boolean

    If field is required pass '1'

  • custom_field_valueobject[]

    Array of objects with data of the custom field values (only if its multi value field like radio or checkbox)

Create new custom field › Responses

Custom field deleted successfullyy

  • successboolean
    Example: true
  • responseobject

Get list of custom field types

GET
https://api.istores.co.il
/custom_field_info/types

Get list of custom field types

Get list of custom field types › Responses

Success

  • successboolean
    Example: true
  • responseobject

Get list of custom field types

GET
https://api.istores.co.il
/custom_field_info/locations

Get list of custom field types

Get list of custom field types › Responses

Success

  • successboolean
    Example: true
  • responseobject
custom orderscoupons