Skip to main content

TransactionInquiryFeed

Updated

Access:

Affiliate authentication required, secure connections (https://) only.
Frequency limitation(s): 500 request(s) per hour. 10000 request(s) per day.

Description:

This module is for retrieving previously submitted 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.
  • module
    • Type: string
    • Required: true
    • Description: For this module, specify "TransactionInquiryFeed".
  • 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.
  • inquiry_date_begin
    • Type: date
    • Required: false
    • Description: The start of the date range for specifying a date range when the inquiry was submitted. Inquiries submitted today are returned by default. Must be specified in "yyyy-mm-dd hh:ii:ss" format.
  • inquiry_date_end
    • Type: date
    • Required: false
    • Description: The end of the date range for specifying a date range when the inquiry was submitted. Inquiries submitted today are returned by default. Must be specified in "yyyy-mm-dd hh:ii:ss" format.
  • inquiry_status
    • Type: string
    • Required: false
    • Description: One of: approved, canceled, confirmed, denied, submitted. If left blank all order inquiries will be returned.
  • merchant_id
    • Type: integer
    • Required: false
    • Description: An AvantLink assigned Merchant identifier.
  • 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_id
    • Type: string
    • Required: false
    • Description: A sales transaction id, a.k.a. order id.
  • transaction_inquiry_id
    • Type: integer
    • Required: false
    • Description: The id of a previously submitted transaction inquiry.
  • updated_date_begin
    • Type: date
    • Required: false
    • Description: The start of the date range for specifying a date range when the inquiry was last updated (i.e. approved, denied, submitted, etc.). Must be specified in "yyyy-mm-dd hh:ii:ss" format.
  • updated_date_end
    • Type: date
    • Required: false
    • Description: The end of the date range for specifying a date range when the inquiry was last updated (i.e. approved, denied, submitted, etc.). Must be specified in "yyyy-mm-dd hh:ii:ss" format.
  • website_id
    • Type: integer
    • Required: false
    • Description: An AvantLink assigned affiliate website identifier.

Related articles