API Reference
Start typing to search…

The items object

The Items object holds data about the items in the order associated with an Action. With this endpoint, you can list all items within an action, retrieve a specific item in an action using its Sku (or ProductId) value, and update items (such as their quantity or price) within an action.

Attributes

Sku string

Stock-keeping unit (SKU) identifier that's been assigned to the item. Alternatively known as the ProductId.

ItemName string

Display name for the product in this action item.

Category string

Category for the product in this action item.

Quantity string

Number of units of the product in the action item.

SaleAmount string

Revenue amount for this action item.

Payout decimal

Commission amount calculated for the action item that will be paid out to the partner.

AdjustmentDate datetime

Date and time in ISO 8601 format when the action item was last updated. Attribute is empty if the item has never been modified.

AdjustmentReason enum

If the action item was adjusted (i.e., modified or reversed), lists the reason for why. Attribute is empty if the item has never been modified.

Possible enum values
OVERLIMIT_WEEKDAYCAPThe action item was adjusted since it was considered over the weekday limit cap set in the contact.
OVERLIMIT_WEEKENDCAPThe action item was adjusted since it was considered over the weekend limit cap set in the contact.
OVERLIMIT_BUDGETThe action item was adjusted since it was considered over the spend limit set in the contact.
OVERLIMIT_ACTIONCAPThe action item was adjusted since it was considered over the action limit set in the contact.
OVERLIMIT_CONCURRENTCALLSThe action item was adjusted since it was considered over the concurrent call limit set in the contact.
OVERLIMIT_UNKNOWN_CALLERIDThe action item was adjusted since it was considered over the unknown caller ID limit set in the contact.
RECALC_COMMThe action item was adjusted due to recalculating the commission.
MP_RETURNThe action item was adjusted due to the partner returning the commission.
APPROVEDThe action item was adjusted due to being manually approved.
REJECTEDThe action item was adjusted due to being rejected.
CONS_INFO_INVALIDThe action item was adjusted due to the consumer's information being invalid.
CONS_ERRORThe action item was adjusted due to consumer error.
CONS_FRAUDThe action item was adjusted due to consumer fraud.
ITEM_RETURNEDThe action item was adjusted due to it being returned.
ITEM_OUT_OF_STOCKThe action item was adjusted due to it being out of stock.
ORDER_ERRORThe action item was adjusted due to an order error.
PUB_ACT_DISPUTEThe action item was adjusted due to a dispute with the publisher's activity.
ADV_ACT_DISPUTEThe action item was adjusted due to a dispute with the advertiser's activity.
NOT_COMPLIANCE_TERMSThe action item was adjusted due to it not being in compliance with the terms (contract).
MP_ACCOUNT_DEATVIATEDThe action item was adjusted due to your account being deactivated.
CREDITED_DIFFERENT_MPThe action item was adjusted due to it being credited to another publisher.
ORDER_UPDATEThe action item was adjusted due to the order being updated.
OTHERThe action item was adjusted due for some other reason—contact the advertiser/brand to learn more.
TEST_ACTIONThe action item was adjusted due to it being part of a test action, meaning it's automatically reversed.
RESETAny adjustments to the action have been reset, meaning it is now in its original state.

Uri string

Unique reference to this action item in the impact.com API.

More attributes

View more attributes

SaleAmountCurrency currency

Three-letter ISO currency code for the revenue amount. Typically the default currency of your account. Not the currency originally sent in on the order.

PayoutCurrency currency

Three-letter ISO currency code for the payout amount. Typically the default currency of your account.

Rebate decimal

Discount (or rebate) amount applied to the action item.

RebateCurrency currency

Three-letter ISO currency code, in uppercase. Typically the default currency of your account. Not the currency originally sent in on the order.

{
	"Sku": "12345",
	"ItemName": "Acme Tennis Balls (One Dozen)",
	"Category": "Sports",
	"Quantity": "2",
	"SaleAmount": "19.27",
	"SaleAmountCurrency": "USD",
	"Payout": "0.77",
	"PayoutCurrency": "USD",
	"Rebate": "1.00",
	"RebateCurrency": "USD",
	"AdjustmentDate": "",
	"AdjustmentReason": "",
	"Uri": "/Mediapartners/<AccountSID>/Actions/1000.4636.401482/Items/12345"
}