get_coupons_m
Summary
| API Name | get_coupons_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
Returns list of client created coupons
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 12 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
||||||
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
||||||
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
||||||
| include_translations | string | 5 | No |
Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. Allowed values:
|
Outputs
| Name | Type | Length | Required | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error |
|||||||||||
| error_msg | string | No |
Textual description of any error that occurred. "OK" if there was no error. |
|||||||||||
| Start of coupons object | ||||||||||||||
| coupons | object | No |
The coupons associated with this method. |
|||||||||||
| Name | Type | Length | Required | Description | ||||||||||
| ▶coupon_cd | string | 100 | Yes |
Coupon Code |
||||||||||
| ▶coupon_desc | string | 100 | No |
Coupon description |
||||||||||
| ▶expires_after | string | 30 | Yes |
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 | 1 | No |
Specifies the coupon application. The parameter is available only for EOM Clients Allowed values:
|
||||||||||
| Start of coupon_translations object | ||||||||||||||
| ▶coupon_translations | object | No |
Array that contains all the translated values for a given locale. |
|||||||||||
| Name | Type | Length | Required | Description | ||||||||||
| ▶▶locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
||||||||||
| ▶▶locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
||||||||||
| ▶▶coupon_desc | string | 100 | No |
Coupon description |
||||||||||
| End of coupon_translations object | ||||||||||||||
| End of coupons object | ||||||||||||||