24/7 Support: 800.608.6482

Get Started

Navigation


Coupon_Insert

This function allows you to insert a coupon and assign it to a price Group

PriceGroup_ID is optional. To get a list of available price groups use PriceGroupList_Load_Query

Request Body Parameters

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
PriceGroup_ID Type:
Number
Title:
PriceGroup_ID
[optional] If specified the price group is assigned to the coupon

Response Parameters

success boolean value for if the request was successfull
id id of created coupon

Example Request

Example Response

Error Responses

error code
MER-JSN-00023
error message
One or more parameters are invali
  One of the required fields are missing.

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.

Accept

Copyright © 1997 – 2019 Miva©, Miva Merchant©, MivaPay©, MivaCon© Miva, Inc. All Rights Reserved.