Skip to main content

Coupon

v1

Description

Get notified when a new coupon is created or edited.


Supported Type

  • Create
  • Update

Payload

{
"event":{
"id":"0Wksq4whXcTfUOczebMFw3Z96lOiTMf2Lsm+1QBslEs=",
"name":"coupon",
"type":"update",
"version":"1",
"trace_id":[
"megatron.3f8235e6-303c-48f0-969f-e2c1b193af7d"
],
"created_timestamp":1628579516059
},
"payload":{
"coupon":{
"code":"ssrakhi15",
"rule":[
{
"key":1,
"max":900,
"min":1999,
"value":15
}
],
"tags":[
"platform"
],
"state":{
"is_public":true,
"is_display":true,
"is_archived":false
},
"action":{
"txn_mode":"coupon",
"action_date":null
},
"author":{
"created_by":"23477081",
"modified_by":"23477081"
},
"validity":{
"priority":0
},
"_schedule":{
"end":"2021-08-18T18:30:00+00:00",
"cron":null,
"start":"2021-08-10T07:11:42.233000+00:00",
"duration":null,
"next_schedule":[
{
"end":"2021-08-18T18:30:00+00:00",
"start":"2021-08-10T07:11:42.233000+00:00"
}
]
},
"date_meta":{
"created_on":"2021-08-06T08:51:39.587000+00:00",
"modified_on":"2021-08-10T07:11:56.053592+00:00"
},
"ownership":{
"payable_by":"",
"payable_category":"seller"
},
"type_slug":"percentage_quantity_percentage",
"validation":{
"app_id":[
"60228b962cd76c78c4b01494"
],
"anonymous":true,
"user_registered_after":null
},
"identifiers":{
"user_id":[

],
"collection_id":[
"60eef48e3df85f000109e76d",
"6077f683f995230001c9b62a",
"6077f4f5f995230001c9b629",
"60728ad63e5a10000178839a",
"60728a71236dfc0001cc04fe",
"60728a246cab0400014b7661",
"607289cbe3bada00019aadc7",
"607286c882c38800014524fe"
]
},
"display_meta":{
"auto":{
"title":"",
"subtitle":""
},
"apply":{
"title":"Coupon applied successfully",
"subtitle":""
},
"title":"Rakhi Offer",
"remove":{
"title":"",
"subtitle":""
},
"subtitle":"Enjoy 15% off on minimum cart value of INR1999",
"description":"Get 15% off Upto INR 900 on minimum cart value of INR 1999.\nOffer Applicable on Prepaid Orders Only. (Not Applicable on Sale Products)"
},
"restrictions":{
"uses":{
"maximum":{
"app":-1,
"user":-1,
"total":-1
},
"remaining":{
"app":-1,
"user":-1,
"total":-1
}
},
"payments":{
"nb":{
"uses":{
"max":-1
},
"codes":[

],
"types":[

],
"networks":[

]
},
"wl":{
"uses":{
"max":-1
},
"codes":[

],
"types":[

],
"networks":[

]
},
"upi":{
"uses":{
"max":-1
},
"codes":[

],
"types":[

],
"networks":[

]
},
"card":{
"uses":{
"max":-1
},
"codes":[

],
"types":[

],
"networks":[

]
}
},
"platforms":[
"web",
"android",
"ios"
],
"post_order":{
"return_allowed":false,
"cancellation_allowed":true
},
"price_range":{
"max":-1,
"min":-1
},
"ordering_stores":[

]
},
"rule_definition":{
"type":"percentage",
"scope":[
"collection_id"
],
"is_exact":false,
"auto_apply":false,
"value_type":"percentage",
"calculate_on":"esp",
"applicable_on":"quantity",
"currency_code":"INR"
}
}
},
"contains":[
"coupon"
],
"company_id":1438,
"application_id":"60228b962cd76c78c4b01494"
}

Object Properties

KeyTypeDescription
codestringCoupon unique code
rulearrayRules to be applied on coupon code i.e payment restriction, cart value, etc.