Istores API Documentation
MyIstores Api

Products

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

List Products

Get products to store

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

Get products to store › path Parameters

  • limitinteger · int64 · min: 1 · max: 200 · required

    Limit of recieve products

  • pageinteger · int64 · required

    Page number

Get products to store › Responses

Ok

  • successboolean
    Example: true
  • Productsobject[]
  • resultsnumber
    Example: 233
  • pagesnumber
    Example: 100
  • pagenumber
    Example: 4
  • per_pagenumber
    Example: 2
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Get product by id

GET
https://api.istores.co.il
/products/{product_id}

Get product by id › path Parameters

  • product_idinteger · int64 · required

    Product Id

Get product by id › Responses

success

  • successboolean
    Example: true
  • productobject
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Update an existing Product

PUT
https://api.istores.co.il
/products/{product_id}

Update an existing Product › path Parameters

  • product_idinteger · int64 · required

    Product Id

Update an existing Product › Request Body

  • skustring

    The SKU od the product

    Example: dkasj234
  • modelstring
  • minimuminteger

    minimum items to add to cart

    Example: 10
  • upcstring

    UPC code for current product

  • weightinteger · float

    Numeric value of the weight of the product, if not passed it is zero

    Example: 40
  • weight_class_idinteger · int32

    The id of the weight class you are using for current product (There is separate API request that return all the weight classes, check "misc/dimension_lst")

    Example: 3
  • lengthinteger · float

    Numeric value of the length of the product, if not passed it is zero

    Example: 15
  • widthinteger · float

    Numeric value of the width of the product, if not passed it is zero

    Example: 15
  • heightinteger · float

    Numeric value of the height of the product, if not passed it is zero

    Example: 15
  • length_class_idinteger · int32

    The id of the length class you are using for current product (There is separate API request that return all the weight classes, check "misc/dimension_lst")

    Example: 3
  • stock_statusinteger

    Valid stock status id (you can find them in separate API call the returns stock status ids)

    Example: 7
  • subtractinteger · boolean

    Pass '1' if you want to activate subtruct feature, if not pass '0'

  • sort_orderinteger

    The order of the product related to another products

    Example: 9
  • statusinteger · boolean

    If you want disactivate the product pass '0' else pass '1'

  • keywordstring

    Keyword related to SEO

    Example: food
  • quantityinteger

    The quantity of your product

    Example: 10
  • hiddeninteger · boolean

    Hide your product from the customers by passing '1' else pass '0'

    Example: 0
  • imagestring

    Valid URL for valid image format (jpg,jpeg,png)

  • imagesobject[]

    Array of additional images sent for each product (optional)

  • pricenumber · float
    Example: 56.76
  • product_pricingobject
  • product_relatedinteger[]
    Example: [12,15,33]
  • product_categoryinteger[]
    Example: [555,444,123]
  • product_descriptionobject
    Example: {"3":{"name":"Green socks","description":"My brand socks"}}
  • sticker_statusinteger · boolean

    Defines if the the sticker enabled/disabled

  • sticker_typestring · enum

    Defines the type of the sticker

    Enum values:
    percent
    sum
    custom
  • sticker_textobject

    The text appears on sticker (referenced by language id) in case of custom text chosen

  • sticker_settingsobject

    The sticker text styling

  • product_optionobject[]

    Array of options objects (If you want to empty the option pass empty array !)

  • shipping_productinteger[]

    Array of numeric shipping ids that valid for product (type 1 and above)

    Example: [12,45,77]
  • product_specialobject[]

Update an existing Product › Responses

successfully request

  • successboolean
    Example: true
  • responsestring
    Example: Product Updated successfully, productID: 216
  • product_idnumber
    Example: 216
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Delete Product

DELETE
https://api.istores.co.il
/products/{product_id}

Delete Product › path Parameters

  • product_idinteger · int64 · required

    Product Id

Delete Product › Responses

successfully request

  • successboolean
    Example: true
  • responsestring
    Example: Product was delete successfully
  • product_idnumber
    Example: 216
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Edit multiple products in single request

PUT
https://api.istores.co.il
/products/bulk

Edit multiple products in single request › Request Body

  • product_idinteger

    Product ID that we update

    Example: 23331
  • quantityinteger

    Updated product's quantity

    Example: 3
  • pricenumber · float

    Product's price

    Example: 56.76

Edit multiple products in single request › Responses

success

  • successboolean
    Example: true
  • responsestring
    Example: Product bulk edit complete
  • updated_productsinteger[]

    List of items that updated

    Example: [64222,53331]
  • nothing_to_update_productsinteger[]

    List of items that were nothing to update

    Example: [54222,23331]
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Create New Product

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

Create New Product › Request Body

  • product_descriptionobject · required
    Example: {"3":{"name":"Green socks","description":"My brand socks"}}
  • skustring

    The SKU od the product

    Example: dkasj234
  • modelstring
  • minimuminteger

    minimum items to add to cart

    Example: 10
  • upcstring

    UPC code for current product

  • weightinteger · float

    Numeric value of the weight of the product, if not passed it is zero

    Example: 40
  • weight_class_idinteger · int32

    The id of the weight class you are using for current product (There is separate API request that return all the weight classes, check "misc/dimension_lst")

    Example: 3
  • lengthinteger · float

    Numeric value of the length of the product, if not passed it is zero

    Example: 15
  • widthinteger · float

    Numeric value of the width of the product, if not passed it is zero

    Example: 15
  • heightinteger · float

    Numeric value of the height of the product, if not passed it is zero

    Example: 15
  • length_class_idinteger · int32

    The id of the length class you are using for current product (There is separate API request that return all the weight classes, check "misc/dimension_lst")

    Example: 3
  • stock_statusinteger

    Valid stock status id (you can find them in separate API call the returns stock status ids)

    Example: 7
  • subtractinteger · boolean

    Pass '1' if you want to activate subtruct feature, if not pass '0'

  • sort_orderinteger

    The order of the product related to another products

    Example: 9
  • statusinteger · boolean

    If you want disactivate the product pass '0' else pass '1'

  • keywordstring

    Keyword related to SEO

    Example: food
  • quantityinteger

    The quantity of your product

    Example: 10
  • hiddeninteger · boolean

    Hide your product from the customers by passing '1' else pass '0'

    Example: 0
  • imagestring

    Valid URL for valid image format (jpg,jpeg,png)

  • imagesobject[]
  • pricenumber · float
    Example: 56.76
  • product_pricingobject
  • product_relatedinteger[]
    Example: [12,15,33]
  • product_categoryinteger[]
    Example: [555,444,123]
  • product_attributesobject[]
  • product_specialobject[]
  • product_optionobject[]

    Array of options objects

  • shipping_productinteger[]

    Array of numeric shipping ids that valid for product (type 1 and above)

    Example: [12,45,77]
  • sticker_statusinteger · boolean

    Defines if the sticker enabled / enabled/disabled

  • sticker_typestring · enum

    Defines wich type of sticker

    Enum values:
    percent
    sum
    custom
  • sticker_textobject

    The custom option text (for each language)

  • sticker_settingsobject

    All the sticker text styling options

Create New Product › Responses

successfully request

  • successboolean
    Example: true
  • responsestring
    Example: Product created successfully, productID: 970
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49
Customers