Istores API Documentation
MyIstores Api

coupons

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

Get list of coupons with filters

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

Get list of coupons with filters

Get list of coupons with filters › Request Body

  • pageinteger · min: 1 · max: 9999

    The start page for list pagination

    Example: 1
    Default: 1
  • limitinteger · min: 1 · max: 100

    The results count limit between 1 - 100

    Example: 50
    Default: 50
  • date_startstring · date

    Set the min date the coupon is valid from for usage

    Example: 2021-04-03
  • date_endstring · date

    Set the max date the coupon is valid from for usage

    Example: 2021-04-03
  • order_used_startstring · date

    The mininmum date for the order related to current coupon

    Example: 2021-04-03
  • order_used_endstring · date

    The maximum date for the order related to current coupon

    Example: 2021-04-03
  • date_added_startstring · date

    The mininmum date from the coupon added to system

    Example: 2021-04-03
  • date_added_endstring · date

    The maximum date from the coupon added to system

    Example: 2021-04-03
  • namestring

    The name of the coupon or part of it

    Example: summer sale
  • codestring

    The code of the coupon or part of it

    Example: SUMMER1012
  • typestring · enum

    The type of the coupon for filter

    Enum values:
    percent
    P
    fixed
    F
    gift
    D
  • order_idinteger · int32

    The order id related to the coupon

    Example: 54222

Get list of coupons with filters › Responses

Get single coupon info

GET
https://api.istores.co.il
/coupon/{coupon_id}

Get full data and info for a single coupon

Get single coupon info › path Parameters

  • coupon_idinteger · int32 · required

    The coupon id

Get single coupon info › Responses

success

  • coupon_idinteger

    The id represent the coupon for CRUD and etc

    Example: 23
  • namestring

    The coupon name

    Example: Gift for november
  • codestring

    The Coupon code

    Example: JHG34G
  • typestring · enum

    The type of the coupon (The letters at the example are the same as the string before)

    Enum values:
    percent
    P
    fixed
    F
    gift
    D
  • discountnumber · int64

    The discount value of the coupon (the behaviour depends on the coupon type)

    Example: 44
  • loggedinteger · enum · int32

    1 - The coupon only for logged customers | 2 - coupon available for everyone

    Enum values:
    0
    1
  • shippinginteger · enum · int32

    0 - Exclude shipping | 1 - Free shipping | 2 - Include the shipping at the math action for this coupon

    Enum values:
    0
    1
    2
  • totalinteger · int32

    The minimum total sum the customer have to reach in his cart to apply the coupon

    Example: 100
  • date_startstring · date

    The date the coupon is available from

    Example: 2021-04-03
  • date_endstring · date

    The maximum date the coupon is available

    Example: 2021-04-03
  • date_addedstring · date

    The date the coupon added

    Example: 2021-04-03
  • uses_totalstring

    The maximum total uses for this coupon

    Example: 3
  • uses_customerstring

    The maximum uses available for each registered customer (if the coupon only for registered customers)

    Example: 10
  • statusinteger · enum · int32

    1 - The coupon is active | 0 - The coupon not active

    Enum values:
    0
    1
  • multiple_dealsinteger · int32

    1 - The coupon enables more discounts | 0 - If coupon active other discounts will not work

    Example: 1
  • total_usedinteger · int32

    The total times the current coupon used at the system

    Example: 45
custom_fieldshipping