Skip to main content

MerchantTransactionAdjustment

Updated

Access:

Merchant authentication required, secure connections (https://) only.
Frequency limitation(s): 3000 request(s) per day.

Description:

This module provides the ability to enter partial or full adjustments to order/sale transactions, thereby offsetting any commissions paid to both the referring affiliate and the AvantLink network itself.

Here are a couple of example scenarios that may help clarify how to specify "adjustment_amount" values for this module:

  • The original transaction amount is $125.00, and the entire transaction was subsequently canceled or returned. To fully reverse this transaction, you would use a value of 125.00 for the "adjustment_amount" parameter.
  • The original transaction is made up of two items, one costing $60.00 and the other costing $40.00. If the customer cancels or returns the $40.00 item, you would use a value of 40.00 for the "adjustment_amount" parameter. This would add a negative transaction of ($40.00), leaving a positive commissionable amount of $60.00 for this transaction.

 

Supported Output Formats:

  • csv
  • tab
  • xml

Parameters:

  • adjustment_amount
    • Type: string
    • Required: true
    • Description: The desired adjustment amount, with no dollar sign or comma formatting (decimal places are allowed).
  • adjustment_type
    • Type: string
    • Required: true
    • Description: The reason the transaction is being adjusted; must be one of: "ADJUSTMENT", "CANCELED", "FRAUD", "RETURN".
  • 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 "MerchantTransactionAdjustment".
  • transaction_id
    • Type: string
    • Required: true
    • Description: The unique identifier of the sale/order/transaction to be adjusted.
  • adjustment_batch_mode
    • Type: boolean
    • Required: false
    • Description: Enabling adjustment_batch_mode will force the use of shorter (less descriptive) error messages, more suitable for summarizing the results of processing multiple adjustment records.
  • adjustment_convert_currency
    • Type: boolean
    • Required: false
    • Description: Whether or not to perform currency conversion in the same manner as the original transaction, if applicable.
  • adjustment_item_quantity
    • Type: integer
    • Required: false
    • Description: If performing an item-specific adjustment, this represents the quantity of the items being adjusted.
  • adjustment_item_sku
    • Type: string
    • Required: false
    • Description: If performing an item-specific adjustment, this represents the Product ID or SKU from your e-commerce system for the item being adjusted.
  • 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.

Related articles