advertiser/transaction/item
These resources allow dynamic tracking advertisers to manage item information of existing transactions at the item level without requiring the full transaction information to be submitted in the request.
This resource allows dynamic tracking advertisers to add an item to an existing transaction without needing to provide the additional information about the transaction.
| POST | ||||
|---|---|---|---|---|
| Post Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| order_id | (Order ID) A unique ID, supplied by the advertiser, identifying transaction. Allowed Characters: Alpha-Numerics (A-Za-z0-9), dashes (-), underscores (_) |
Character (50) | N/A | Yes |
| id | A unique ID, supplied by the advertiser, identifying the item. Otherwise known as the product ID, or SKU. Allowed Characters: Alpha-Numerics (A-Za-z0-9), dashes (-), underscores (_) |
Character (50) | N/A | Yes |
| amount | The sale amount of the ITEM_ID. The unit price should reflect any coupon or discount that is applied to an order and should be before shipping and taxes. For full returns or cancellations, this field should be set to zero (0). |
* Decimal | N/A | Yes |
| quantity | The quantity of ITEM_ID ordered. Must be a non-negative integer. |
* Integer | N/A | Yes |
| category | The category ID that is meaningful to you for ITEM_ID. | Character (64) | N/A | No |
| currency | The currency of the item prices being passed for the order. When not supplied, amounts are assumed to be in the program's native currency. Accepted values are the three-letter abbreviations of the currencies supported by our platform: USD, CAD, GBP, EUR, AUD, CNY, JPY, INR, KRW, SGD, RUB, TRY, BRL, MXN, ARS, CHF, HKD. |
Character (3) | N/A | No |
This resource allows dynamic tracking advertisers to reverse out an item of a transaction (set quantity and amount to zero) without needing to provide the additional information about the transaction.
| DELETE | ||||
|---|---|---|---|---|
| Request Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| order_id | (Order ID) A unique ID, supplied by the advertiser, identifying transaction. Allowed Characters: Alpha-Numerics (A-Za-z0-9), dashes (-), underscores (_) |
Character (50) | N/A | Yes |
| id | A unique ID, supplied by the advertiser, identifying the item. Otherwise known as the product ID, or SKU. Allowed Characters: Alpha-Numerics (A-Za-z0-9), dashes (-), underscores (_) |
Character (50) | N/A | Yes |