Add or Edit Coupon

Call this API method to add or edit coupons. If the coupon_id parameter is null, a new coupon is added. This API is limited to 100 coupons per request. Coupons shared between races cannot be edited using the API. The API returns a list of coupon ids added or edited.

For JSON requests, the request should look like the example below.

{
	"coupons": [
		{
			"coupon_id": null,
			"coupon_code": "abc",
			"percentage": 25,
			"fixed_discount_in_cents": 0,
			"discount_type": "O",
			"start_date": "2015-01-01 00:00:00",
			"end_date": "2015-01-31 23:59:59",
			
			"applies_to_race_fee": "T",
			"exclude_event_cost": "F",
			"applies_to_giveaway": "F",
			"applies_to_addons": "F",
			"applies_to_club_membership_discounts": "F",
			"applies_to_race_memberships": "F",
			"applies_to_group_setup_fees": "F",
			"applies_to_group_special_event_costs": "F",
			"applies_to_age_based_pricing": "F",
			"applies_to_multi_person_pricing": "F",
			"applies_to_extra_fee": "F",
			"applies_with_multi_event_discount": "F",
			"applies_to_shipping_charges": "F",
			"applies_to_store": "F",
			
			"new_customer_only": "F",
			"minimum_amount_in_cents": 2000,
			"minimum_donation_amount_in_cents": 500,
			"limit_per_customer": 1,
			"max_uses": 10,
			"max_num_race_registrants": 10,
			"max_events_per_registration": 2,
			
			"event_specific": "F",
			"applicable_event_ids": [],
			
			"coupon_notes": null,
			"tags": []
		},
		{
			"coupon_id": 12345,
			"coupon_code": "xyz",
			"percentage": null,
			"fixed_discount_in_cents": 500,
			"discount_type": "O",
			"start_date": "2015-01-01 00:00:00",
			"end_date": null,
			
			"applies_to_race_fee": "T",
			"exclude_event_cost": "F",
			"applies_to_giveaway": "F",
			"applies_to_addons": "F",
			"applies_to_club_membership_discounts": "F",
			"applies_to_race_memberships": "F",
			"applies_to_group_setup_fees": "F",
			"applies_to_group_special_event_costs": "F",
			"applies_to_age_based_pricing": "F",
			"applies_to_multi_person_pricing": "F",
			"applies_to_extra_fee": "F",
			"applies_with_multi_event_discount": "F",
			"applies_to_shipping_charges": "F",
			"applies_to_store": "F",
			
			"new_customer_only": "T",
			"minimum_amount_in_cents": 0,
			"minimum_donation_amount_in_cents": null,
			"limit_per_customer": null,
			"max_uses": null,
			"max_num_race_registrants": null,
			"max_events_per_registration": null,
			
			"event_specific": "T",
			"applicable_event_ids": [123,456],
			
			"coupon_notes": "This coupons only applies to certain events.",
			"tags": ["tag1", "tag2"]
		}
	]
}

For XML requests, the request should look like the example below.

<coupons>
  <coupon>
		<coupon_id></coupon_id>
		<coupon_code>abc</coupon_code>
		<percentage>25</percentage>
		<fixed_discount_in_cents>0</fixed_discount_in_cents>
		<discount_type>O</discount_type>
		<start_date>2015-01-01 00:00:00</start_date>
		<end_date>2015-01-31 23:59:59</end_date>
		
		<applies_to_race_fee>T</applies_to_race_fee>
		<exclude_event_cost>F</exclude_event_cost>
		<applies_to_giveaway>F</applies_to_giveaway>
		<applies_to_addons>F</applies_to_addons>
		<applies_to_club_membership_discounts>F</applies_to_club_membership_discounts>
		<applies_to_race_memberships>F</applies_to_race_memberships>
		<applies_to_group_setup_fees>F</applies_to_group_setup_fees>
		<applies_to_group_special_event_costs>F</applies_to_group_special_event_costs>
		<applies_to_age_based_pricing>F</applies_to_age_based_pricing>
		<applies_to_multi_person_pricing>F</applies_to_multi_person_pricing>
		<applies_to_extra_fee>F</applies_to_extra_fee>
		<applies_with_multi_event_discount>F</applies_with_multi_event_discount>
		<applies_to_shipping_charges>F</applies_to_shipping_charges>
		<applies_to_store>F</applies_to_store>
		
		<new_customer_only>F</new_customer_only>
		<minimum_amount_in_cents>2000</minimum_amount_in_cents>
		<minimum_donation_amount_in_cents>500</minimum_donation_amount_in_cents>
		<limit_per_customer>1</limit_per_customer>
		<max_uses>10</max_uses>
		<max_num_race_registrants>10</max_num_race_registrants>
		<max_events_per_registration>2</max_events_per_registration>
		
		<event_specific>F</event_specific>
		<applicable_event_ids></applicable_event_ids>
		
		<coupon_notes></coupon_notes>
		<tags></tags>
	</coupon>
	<coupon>
		<coupon_id>12345</coupon_id>
		<coupon_code>xyz</coupon_code>
		<percentage></percentage>
		<fixed_discount_in_cents>500</fixed_discount_in_cents>
		<discount_type>O</discount_type>
		<start_date>2015-01-01 00:00:00</start_date>
		<end_date></end_date>
		
		<applies_to_race_fee>T</applies_to_race_fee>
		<exclude_event_cost>F</exclude_event_cost>
		<applies_to_giveaway>F</applies_to_giveaway>
		<applies_to_addons>F</applies_to_addons>
		<applies_to_club_membership_discounts>F</applies_to_club_membership_discounts>
		<applies_to_race_memberships>F</applies_to_race_memberships>
		<applies_to_group_setup_fees>F</applies_to_group_setup_fees>
		<applies_to_group_special_event_costs>F</applies_to_group_special_event_costs>
		<applies_to_age_based_pricing>F</applies_to_age_based_pricing>
		<applies_to_multi_person_pricing>F</applies_to_multi_person_pricing>
		<applies_to_extra_fee>F</applies_to_extra_fee>
		<applies_with_multi_event_discount>F</applies_with_multi_event_discount>
		<applies_to_shipping_charges>F</applies_to_shipping_charges>
		<applies_to_store>F</applies_to_store>
		
		<new_customer_only>T</new_customer_only>
		<minimum_amount_in_cents>0</minimum_amount_in_cents>
		<minimum_donation_amount_in_cents></minimum_donation_amount_in_cents>
		<limit_per_customer></limit_per_customer>
		<max_uses></max_uses>
		<max_num_race_registrants></max_num_race_registrants>
		<max_events_per_registration></max_events_per_registration>
		
		<event_specific>T</event_specific>
		<applicable_event_ids>
			<event_id>123</event_id>
			<event_id>456</event_id>
		</applicable_event_ids>
		
		<coupon_notes>This coupons only applies to certain events.</coupon_notes>
		<tags>
			<tag>tag1</tag>
			<tag>tag2</tag>
		</tags>
	</coupon>
</coupons>

URL

HTTP Method

Standard Parameters

Parameters