get_coupon_group_details_m
Summary
| API Name | get_coupon_group_details_m |
|---|---|
| Class | administration_services_m |
| Update Version | 44 |
Description
Returns details of specified coupon group
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. |
| group_no | long | Yes |
Specifies client defined id for coupon group or Aria assigned group number. Alternative required field: client_defined_id |
|
| client_defined_id | string | 100 | Yes |
Client defined unique identifier Alternative required field: group_no |
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 coupon_groups object | ||||
| coupon_groups | object | No |
The coupon_groups associated with this method. |
|
| Name | Type | Length | Required | Description |
| ▶group_no | long | Yes |
Aria-assigned unique identifier for coupon group. |
|
| ▶client_defined_id | string | Yes |
Client defined identifier for coupon group |
|
| ▶group_name | string | Yes |
Specified coupon group name. |
|
| ▶description | string | Yes |
Specifies group description. Pass ~ to delete the previously saved description. |
|
| ▶precedence | string | Yes |
Specifies the precedence of the coupon group. |
|
| Start of coupons object | ||||
| ▶coupons | object | No |
An array of coupon codes to be associated with this coupon group. |
|
| Name | Type | Length | Required | Description |
| ▶▶coupon_cd | string | No |
Specifies Coupon Code you like to assign with this coupon group. |
|
| End of coupons object | ||||
| End of coupon_groups object | ||||