Istores API Documentation
MyIstores Api

orders

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

orders

Get order status ids

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

Get order Status ids that can be passed to order list method

Get order status ids › Responses

success

  • successboolean
    Example: true
  • responseobject
    Example: {"1":[{"order_status_id":2,"name":"Processing"},{"order_status_id":3,"name":"Shipped"}]}
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Get order list

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

Get full list with all orders with date filter

Get order list › Request Body
optional

  • date_fromstring · required

    Valid date (year-month-day) wich we start the filter from

    Example: 2020-01-20
  • date_tostring · required

    Valid date (year-month-day) wich we end the filter

    Example: 2020-01-25
  • limitinteger · min: 1 · max: 100 · required

    Limit orders per page (minimum 1)

    Example: 10
  • pageinteger · min: 1 · required

    Limit orders per page (minimum 1)

    Example: 1
  • order_status_idsinteger[]

    Array of valid order status ids - Leave empty or dont pass this property to get full llist

    Example: [1,5]

Get order list › Responses

success

  • successboolean
    Example: true
  • responseobject[]

    array with all orders

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

Get single order

GET
https://api.istores.co.il
/order/{order_id}

Get order details by order id

Get single order › path Parameters

  • order_idinteger · int64 · required

    Order ID

Get single order › Responses

success

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

Update order status

POST
https://api.istores.co.il
/order/{order_id}/update_status

Updating single order status and adding comment , with optional notify

Update order status › path Parameters

  • order_idinteger · int64 · required

    Order ID

Update order status › Request Body

  • order_status_idinteger · required

    Number that represent valid order status id (you can find API call for this statuses)

    Example: 2
  • commentstring

    Comment that will appear in the order status history related to the status you update

    Example: Sent to customer X
  • notifyinteger · enum

    Pass 1 if you want to notifiy the customer abouth the status change

    Enum values:
    0
    1
    Default: 0
  • sms_notifyinteger · enum

    Pass 1 if you want to notify client by sms

    Enum values:
    0
    1
    Default: 0
  • sms_contentstring · max: 150

    Message that will be sent to the customer associated with current order

    Example: Thank you, your order complete!
    Default: null

Update order status › Responses

success

  • successboolean

    Determine if update action executed successfullyy

    Example: true
  • messagestring

    Include short description if there is an error or success

    Example: Order status updated successfully
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Update order history comment

POST
https://api.istores.co.il
/order/{order_id}/update_history

Updating single order history comment only without notify or status changes

Update order history comment › path Parameters

  • order_idinteger · int64 · required

    Order ID

Update order history comment › Request Body

  • commentstring · required

    Comment that will appear in the order status history related to the status you update

    Example: Sent to customer X

Update order history comment › Responses

success

  • successboolean

    Determine if update action executed successfullyy

    Example: true
  • messagestring

    Include short description if there is an error or success

    Example: Order status updated successfully
  • request_idstring
    Example: 1ef2da0b-6f98-6fec-b13f-06c63b84be49

Crete invoice

POST
https://api.istores.co.il
/order/{order_id}/create_doc

Create invoice for single order

Crete invoice › path Parameters

  • order_idinteger · int64 · required

    Order ID

Crete invoice › Request Body

  • doc_typestring · enum

    The document type must be one of (invrec,invoice,receipt,refund)

    Enum values:
    invrec
    invoice
    receipt
    refund
    Example: invoice
  • company_personal_namestring

    Not required field that allows you to override the exist name with new personal/company name for invoice

    Example: My Company LTD
  • company_personal_idstring

    Not required field that allows you to override the esit persona; id with new personal/company Bn Number

    Example: 23455234234
  • telephonestring

    Not required field that allows you to override order's phone for the document

    Example: 0548654366
  • emailstring

    Not required field that allows you to override order's email for the document receiver

  • refund_sum

Crete invoice › Responses

In case of successfully request return details for invoice

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

Create shipping

POST
https://api.istores.co.il
/order/{order_id}/shipping/create

Create shipping

Create shipping › path Parameters

  • order_idinteger · int64 · required

    Order ID

Create shipping › Request Body

  • providerstring · enum

    Required field what shipping provider to create

    Enum values:
    chita
    Example: chita
  • packages_numberinteger

    The package number you will send and will be charged for (and get sticker for each package)

    Example: 3
  • shipping_typestring · enum

    The shipping type for current provider not required

    Enum values:
    door_to_door
    lockers
    Example: door_to_door

Create shipping › Responses

In case of successfully request return details for shipping created

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

Get sticker

POST
https://api.istores.co.il
/order/{order_id}/shipping/get_sticker

Get sticker

Get sticker › path Parameters

  • order_idinteger · int64 · required

    Order ID

Get sticker › Request Body

  • providerstring · enum

    Required field what shipping provider to create

    Enum values:
    chita
    Example: chita

Get sticker › Responses

string

Check shipping status

POST
https://api.istores.co.il
/order/{order_id}/shipping/status_check

Check shipping status

Check shipping status › path Parameters

  • order_idinteger · int64 · required

    Order ID

Check shipping status › Request Body

  • providerstring · enum

    Required field what shipping provider to create

    Enum values:
    chita
    Example: chita

Check shipping status › Responses

Return statuses list

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