Access:
Affiliate authentication required, secure connections (https://) only.
Frequency limitation(s): 1000 request(s) per day.
Description:
This module provides functionality retrieving active affiliate merchant discounts
Supported Output Formats:
- csv
- xml
- json
Parameters:
- affiliate_id
- Type: integer
- Required: true
- Description: An AvantLink assigned affiliate identifier.
- auth_key
- Type: string
- Required: true
- Description: The AvantLink assigned authentication key for a particular affiliate or merchant. This is a randomly generated, 32-character, mixed alphanumeric string.
- module
- Type: string
- Required: true
- Description: For this module, specify "AffiliateMerchantDiscounts".
- website_id
- Type: integer
- Required: true
- Description: An AvantLink assigned affiliate website identifier.
Optional Parameters:
- coupon_codes_only
- Type: boolean
- Required: false
- Description: A boolean value to indicate whether to include only discounts with coupons (1 = yes, 0 = no)
- discount_rule_type
- Type: string
- Required: false
- Description: A string value indicating the discount rule type ("restricted", "exclusive", "qualified", "none")
- discount_type
- Type: string
- Required: false
- Description: A string value indicating the discount type ("coupon", "automatic")
- merchant_id
- Type: integer
- Required: false
- Description: An AvantLink assigned merchant identifier.
- merchant_ids
- Type: string
- Required: false
- Description: A pipe-delimited list of AvantLink assigned merchant identifiers, e.g. "123|456".
- output
- Type: string
- Required: false
- Description: The specific output format you wish to receive results in. Possible values include: csv (comma-separated text), html, js (javascript document.write statements), rss, tab (tab-delimited text), and xml (the default). Individual modules may not support all output methods.