24/7 Support: 800.608.6482

Navigation


Coupon_Update

This function allows you to update a coupon.

Only 1 of the coupon identifiers is required. To change the price group assignment see CouponPriceGroup_Update_Assigned

Request Body Parameters

Coupon_ID Type:
Number
Title:
Coupon_ID
Coupon_ID
Coupon_Code Type:
String
Title:
Coupon_Code
Coupon_Code
Edit_Coupon Type:
Number
Title:
Edit_Coupon
Edit_Coupon
Code Type:
Number
Title:
Coupon Code
This is the code customers will enter in the coupon box during checkout
Description Type:
String
Title:
Description
Description
Customer Scope Type:
Number
Title:
Customer Scope
One of "A" (all shoppers), "X" (specific customers), or "L" (all logged-in shoppers)
DateTime_Start Type:
Unix Timestamp
Title:
DateTime Start
0 if no start time
DateTime_End Type:
Unix Timestamp
Title:
DateTime End
0 if no end time
Max_Use Type:
Number
Title:
Max Use
0 = unlimited use
Max_Per Type:
Number
Title:
Max Use Per Customer
0 = unlimited
Active Type:
Boolean
Title:
Active
Active

Response Parameters

success boolean value for if the request was successfull

Example Request

Example Response

Error Responses

error code
MER-PGR-JSN-00105
error message
Unable to load coupon: One of Coupon_ID, Edit_Coupon or Coupon_Code must be specified
  Missing Required Coupon Identifier

Copyright © 1997 – 2026 Miva®, Miva Merchant®, MivaPay Vault®, Camp Miva®, Miva Connect®, Vexture℠, Miva, Inc. All Rights Reserved.