Access:
Affiliate authentication required, secure connections (https://) only.
Frequency limitation(s): 100 request(s) per hour. 500 request(s) per day.
Description:
This module is for submitting new transaction inquiries.
Supported Output Formats:
- csv
- html
- tab
- 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.
- merchant_id
- Type: integer
- Required: true
- Description: An AvantLink assigned Merchant identifier.
- module
- Type: string
- Required: true
- Description: For this module, specify "TransactionInquiry".
- transaction_id
- Type: string
- Required: true
- Description: A sales transaction id, a.k.a. order id.
- website_id
- Type: integer
- Required: true
- Description: An AvantLink assigned Affiliate website identifier.
- custom_tracking_code
- Type: string
- Required: false
- Description: A custom string to be appended to AvantLink click-through URLs, for use with your own personal tracking mechanisms.
- 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.
- transaction_amt
- Type: float
- Required: false
- Description: Must be in decimal format. Do not include commas and currency symbols, e.g. invalid: $12,432.45 valid: 12432.45