Home > Aria6 User Documentation > Aria6 admintools api > get_coupons
get_coupons
get_coupons
Returns list of client created coupons
Input Arguments
| Req | Field Name | Field Type | Max Length | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
 |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. | ||||||
|
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. | ||||||
| locale_no | int | 38 | Aria-assigned unique identifier of the locale used for translations. | |||||||
| OR | ||||||||||
| locale_name | string | 32 | Name of the locale to which the translations belong. | |||||||
| include_translations | string | 1 | Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.
Allowable values for include_translations
|
Output Arguments
| Field Name | Field Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| error_code | long | Aria-assigned error identifier. 0 indicates no error. | ||||||||
| error_msg | string | Textual description of any error that occurred. "OK" if there was no error. | ||||||||
| coupons | hash | |||||||||
 coupon_cd |
string | Coupon Code | ||||||||
| coupon_desc |
string | Coupon description | ||||||||
| expires_after |
string | Coupon Expiry Details. This detail is returned in string format and also that of similar to Admintools UI. Ex. "Mar 31, 2009 And 1 Uses" or "Never" or "3 Uses" | ||||||||
| coupon_scope |
int | Specifies the coupon application. The parameter is available only for EOM Clients.
Allowable values for coupon_scope
|
||||||||
| coupon_translations |
hash | Array that contains all the translated values for a given locale. | ||||||||
| locale_name |
string | Name of the locale | ||||||||
| locale_no |
int | Aria-assigned unique identifier of the locale used for translations. | ||||||||
| coupon_desc |
string | Coupon description |
- © Copyright 2022 Aria Developer Central