Home > Aria6 User Documentation > Aria6 object query api > get_coupon_history

get_coupon_history

Table of contents

Input Arguments
Querystring Keys
Output Arguments

Returns a list of coupons applied to an account.

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.
	query_string	string	1000	The criteria which all returned objects must match. Different objects have a different set of searchable criteria.Fields marked with "*Query" in the returns section can be used as part of the query_string. Valid operations for the query string include "=", "!=", "<", "<=", ">=", ">", "IS NULL", "IS NOT NULL", "LIKE", and "NOT LIKE". The first operand must always be a field name, and the second operand must always be a value (except for "IS NULL" and "IS NOT NULL", where the second operand is implicitly "NULL"). If the second operand contains a space, less than, greater than, or equals sign, then it must be enclosed in double quotes. The second operand may not contain double quotes. Multiple conditions must be joined with either "AND" or "OR". Additionally, any queryable field can also be used to order the results, by appending "ORDER BY" to the query, followed by a field name and either "ASC" or "DESC".
	limit	long	12	The maximum number of objects to be returned by this call. Note that Aria recommends a maximum limit of less than 1,000. Higher limits may take much longer to return data. If you do not specify a value, or specify a value of "0", this field defaults to 100. Specifying a value of "-1" returns a count of the number of matching records, but does not return any records.
	offset	long	12	The number of records to skip. Note that both "0" and NULL will cause the interface not to skip any records.

Key Name	Description
acct_no	Aria-assigned unique account identifier.
user_id	Unique alphanumeric identifier for an account holder.
coupon_cd	Coupon identification code.
coupon_create_date	Date on which the coupon was added to the account.
coupon_cancel_date	Date on which the coupon was canceled for the account (if applicable).

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.
starting_record	long	This indicates the number of objects that were (or would be) skipped before beginning output.
total_records	long	This is the total number of objects that matched the provided criteria.
coupon_history	hash
acct_no	long	Aria-assigned unique account identifier.
user_id	string	Unique alphanumeric identifier for an account holder.
client_acct_id	string	Client-specified account identifier
currency_cd	string	ISO currency code.
coupon_cd	string	Coupon identification code.
coupon_create_date	string	Date on which the coupon was added to the account.
coupon_status	string	1 = Active/Not canceled. -1 = Canceled
coupon_cancel_date	string	Date on which the coupon was canceled for the account (if applicable).

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.

© Copyright 2023 Aria Developer Central

Powered by CXone Expert ®