CouponList_Load_Query

This function allows you to load one or more coupons from Miva.

See the List Load Query Overview guide to get started.

Search Filter Columns

id	code	descrip
custscope	dt_start	dt_end
max_use	max_per	active
use_count

Supported Sort Columns

One of these values would be passed in the sort request parameter to have the results sorted by that column. Value may be preceded by "-" for a descending sort.

id	code	descrip
custscope	dt_start	dt_end
max_use	max_per	active
use_count

Request Body Parameters

count	Type: Number	Title: Count	Count is used to tell Miva how many products you returned. If for example you are querying thousands of products you'll want to set the count to limit how many you get back in a single request.
offset	Type: Offset	Title: Number	Used in conjunction with the Count parameter for paginating results of large datasets. Default is 0 whcih is no offset.
sort	Type: String	Title: Sort	Field to sort results by. Avaiilable sorting fields listed below. Use - prefix for a decending sort.
Filter	Type: Object	Title: Filter	Array of Object containing search filters. See usage here: List Load Query Overview

Response Parameters

total_count	Type: Number	Title: Total Product Count	total_count is the total number of records that match your search criteria. Note: this is not always the total coupons returned. Based on the Count and Offset parameters passed, the number of records returned could be different than the total_count.
start_offset	Type: Number	Title: Start Offset	Number number of the starting offset number of coupons to return. Used in conjunction with the Count parameter for paginating results of large datasets.
id	Type: Number	Title: id	Coupon Id
code	Type: String	Title: Coupon Code	Coupon Code
descrip	Type: String	Title: Description	Coupon Description
custscope	Type: String	Title: Customer Scope	One of "A" (all shoppers), "X" (specific customers), or "L" (all logged-in shoppers)
dt_start	Type: Unix Timestamp	Title: DateTime Start	0 if no start time
dt_end	Type: Unix Timestamp	Title: Date Time End	0 if no end time
max_use	Type: Number	Title: Max Use	0 = unlimited
max_per	Type: Number	Title: Max use per customer	0 = unlimited
active	Type: Boolean	Title: Active	active
use_count	Type: Number	Title: Usage Count	Coupon Usage Count

CouponList_Load_Query

Search Filter Columns

Supported Sort Columns

Request Body Parameters

Response Parameters

Example Request

Example Response