Istores API Documentation
MyIstores Api

shipping

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

Get list of shipping methods

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

Get full list of all client's shipping methods created by system with their settings and statuses

Get list of shipping methodsResponses

  • shipping_idinteger

    The shipping ID (used for /shipping/{shipping_id} request)

    Example: 33
  • display_namestring

    The display name of the shipping

    Example: My brand shipping
  • codestring

    Unique code for shipping for other systems usage

    Example: xyz_shipping
  • sort_orderinteger

    The sort order of the shipping compared to other shipping methods

    Example: 1
  • from_sumnumber · int64

    If there is from sum requirement for current shipping

    Example: 450
  • limit_sumnumber · int64

    If there is limit sum requirement for current shipping

    Example: 850
  • statusinteger

    The status of the shipping (1 - active and used, 0 - disabled)

    Example: 1
  • typeinteger

    The shipping type (0 - regular cart shipping, 1 - product related shipping type)

    Example: 1
  • costnumber · int64

    The shipping cost in system's currency

    Example: 265
  • tax_class_idinteger

    The id of the tax class

    Example: 0
  • shipping_feed_statusboolean · int32

    0 - not showing in feeds, 1 - showing in feeds

    Example: 1
  • settingsobject

    object with different shipping extra settings


Get single shipping method

GET
https://api.istores.co.il
/shipping/{shipping_id}

Get single shipping method created by system with it's settings and statuses

Get single shipping methodpath Parameters

  • shipping_idinteger · int32 · required

    Id of shipping we look for

Get single shipping methodResponses

success

  • display_namestring

    The display name of the shipping

    Example: My brand shipping
  • codestring

    Unique code for shipping for other systems usage

    Example: xyz_shipping
  • sort_orderinteger

    The sort order of the shipping compared to other shipping methods

    Example: 1
  • from_sumnumber · int64

    If there is from sum requirement for current shipping

    Example: 450
  • limit_sumnumber · int64

    If there is limit sum requirement for current shipping

    Example: 850
  • statusinteger

    The status of the shipping (1 - active and used, 0 - disabled)

    Example: 1
  • typeinteger

    The shipping type (0 - regular cart shipping, 1 - product related shipping type)

    Example: 1
  • costnumber · int64

    The shipping cost in system's currency

    Example: 265
  • tax_class_idinteger

    The id of the tax class

    Example: 0
  • shipping_feed_statusboolean · int32

    0 - not showing in feeds, 1 - showing in feeds

    Example: 1
  • settingsobject

    object with different shipping extra settings

  • descriptionsobject

    Object with current shipping descriptions

    Example: {"1":"Shipping description language id 1","3":"Shipping description language id 3"}
  • titlesobject

    Object with current shipping titles

    Example: {"1":"Shipping title language id 1","3":"Shipping title language id 3"}
  • additional_notesobject

    Object with current shipping additional_notes

    Example: {"1":"Shipping title additional_note id 1","3":"Shipping title additional_note id 3"}