delete_coupon_group_m Sample Call and Response
This example shows a client deleting two coupon groups in a single call, identified by their Aria-assigned group numbers. It is based on the delete_coupon_group_m method as defined in methods_m_r73.yml, Admin Tools API.
This example uses group_no, the Aria-assigned identifier, and does not show the alternative client_defined_id, since either one alone identifies the coupon groups to delete.
Sample call
{
"rest_call": "delete_coupon_group_m",
"output_format": "json",
"client_no": 700123,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"group_no": [652, 5653]
}
The rest_call and output_format fields are not part of the method’s own documented arguments. The REST layer adds them to every call: rest_call names the method being invoked, and output_format requests a JSON response rather than the default WDDX format. Within the method’s own arguments, client_no and auth_key identify and authenticate the client making the call. In the yml, group_no is declared as a field nested one level deep under its own name, which represents a flat array of the Aria-assigned group numbers rather than an array of one-key objects; this example deletes two coupon groups at once. The method also accepts client_defined_id, a similarly structured flat array of client-defined identifiers, as another way to identify the coupon groups to delete; this example uses group_no instead and omits client_defined_id.
Sample response
{
"error_code": 0,
"error_msg": "OK"
}
An error_code of zero, paired with an error_msg of “OK,” indicates that Aria deleted both coupon groups successfully. The method’s returns block consists only of these two error indicators, so there is no additional output to show.