Information for: DEVELOPERS   PARTNERS   SUPPORT

Transaction Item Feed

Feed description

Transactions with line-level details linked to each customer. This includes product skus bought within each transaction, their associated revenue and other line status information such as demand, canceled, shipped or returned.

Feed structure

Field Name Required ? Data type Referential integrity Description
SourceTransactionItemNumber (key) Required String Webtag:SourceTransactionItemNumber The unique identifier of the transaction item in your data. If the item has multiple rows (e.g. after each status update, from “demand” to “shipped” for instance), this still needs to be unique per row. A conventional way to achieve this is to append the status of the item to its identifier.
SourceTransactionNumber Required String Transaction:SourceTransactionNumber, Webtag:SourceTransactionNumber The unique identifier of the transaction to which this item belongs.
SourceOrganizationNumber Required String Organization:SourceOrganizationNumber The identifier of the organization where the TransactionItem was purchased/returned.
Type Required String   The type of transaction item. This is to categorize purchases that should/should not be included in calculations (e.g. Lifetime Value, AOV, etc…). The only value that will be considered for calculations is “Purchase”. Anything else (e.g. “Swatch”, “Sample”) will be ingested but will be ignored in Customer Data Platform (CDP)’s standard calculations. If no value is provided, CDP will default to “Purchase”.
Subtype Required String   The type/status of the transaction item. The only accepted values are : “Demand” (for items that have been billed but didn’t ship yet), “Canceled” (for items that have been billed then canceled & refunded before shipping), “Shipped” (for items that have been billed and shipped) , “Returned” (for items that have been billed, shipped, then returned and refunded).
InvoiceDate Required Datetime   The date at which the overarching transaction was placed.
ShipDate Required Datetime   The date at which this specific transaction item was billed (Subtype=Demand), or canceled (Subtype=Canceled), or shipped (Subtype=Shipped), or returned (Subtype=Returned).
SourceProductNumber Required String Product:SourceProductNumber The identifier of the product purchased in that transaction item. There should only be one SourceProductNumber per line in this feed. If the customer purchased multiple distinct products in the same transaction, each unique SourceProductNumber should have its own transaction item line. If the customer purchased multiple times the same product, use only one line in this feed, with that product’s SourceProductNumber but a Quantity equal to the purchased quantity for that product.
Quantity Required Integer   The quantity for the product that was purchased in this transaction item. This value should reflect the Subtype : if Subtype=”Demand” or “Shipped” it should be positive, and if Subtype=”Canceled” or “Returned” it should be negative (to negate the lines corresponding to the past status of this item).
Weight Optional Float   The total weight of product sold in the transaction item. Note : this is not used in CDP’s calculations, and is simply provided as a standard “pass-through” attribute.
Volume Optional Float   The total volume of product sold in the transaction item. Note : this is not used in CDP’s calculations, and is simply provided as a standard “pass-through” attribute.
ListPrice Optional Float   The total ListPrice value of the product purchased in the transaction item.
Currency Optional String   The currency for this transaction item’s revenue/costs/discounts/other monetary amounts.
SaleRevenue Required Float   The price paid by the customer for this item, after discount (but before shipping/tax/fees). This is also referred to as “product revenue”. For most cases, it is Quantity*(UnitSalePrice-UnitDiscount). This value should reflect the Subtype of the item : if Subtype=”Demand” or “Shipped” it should be positive, and if Subtype=”Canceled” or “Returned” it should be negative (to negate the lines corresponding to the past status of this item).
Discount Required Float   The product discount for this item (before any discount on shipping/tax/ fee). It should also include any transaction-level discount if any was applied. This value should reflect the Subtype of the item : if Subtype=”Demand” or “Shipped” it should be positive, and if Subtype=”Canceled” or “Returned” it should be negative (to negate the lines corresponding to the past status of this item).
CostBasis Optional Float   The total Cost of Goods Sold (COGS) for this item. This field is required if you need CDP to compute the product margin. This value should reflect the Subtype of the item : if Subtype=”Demand” or “Shipped” it should be positive, and if Subtype=”Canceled” or “Returned” it should be negative (to negate the lines corresponding to the past status of this item).
Tax Optional Float   The amount of taxes paid by the customer on this item. This value should reflect the Subtype of the item : if Subtype=”Demand” or “Shipped” it should be positive, and if Subtype=”Canceled” or “Returned” it should be negative (to negate the lines corresponding to the past status of this item).
ShippingRevenue Optional Float   The amount paid by the customer for shipping this item. This value should reflect the Subtype of the item : if Subtype=”Demand” or “Shipped” it should be positive, and if Subtype=”Canceled” or “Returned” it should be negative (to negate the lines corresponding to the past status of this item).
ShippingCost Optional Float   The amount spent by your company to ship this item. This value should reflect the Subtype of the item : if Subtype=”Demand” or “Shipped” it should be positive, and if Subtype=”Canceled” or “Returned” it should be negative (to negate the lines corresponding to the past status of this item).
ShippingDiscount Optional Float   Any discount applied on shipping for this item. This value should reflect the Subtype of the item : if Subtype=”Demand” or “Shipped” it should be positive, and if Subtype=”Canceled” or “Returned” it should be negative (to negate the lines corresponding to the past status of this item).
OtherRevenue Optional Float   Any other non-product, non-shipping, non-tax revenue generated by this item (fees, others…). This value should reflect the Subtype of the item : if Subtype=”Demand” or “Shipped” it should be positive, and if Subtype=”Canceled” or “Returned” it should be negative (to negate the lines corresponding to the past status of this item).
OtherCosts Optional Float   Any other non-product, non-shipping cost generated by this item (fees…). This value should reflect the Subtype of the item : if Subtype=”Demand” or “Shipped” it should be positive, and if Subtype=”Canceled” or “Returned” it should be negative (to negate the lines corresponding to the past status of this item).
DateCreated Optional Datetime   The date at which the record was created in your system.
Gift Optional Boolean   A flag to indicate whether this item was a gift or not. Note : this is not used in CDP’s calculations, and is simply provided as a standard “pass-through” attribute.
Custom attributes Optional Any (float, datetime, string, boolean)   Custom attributes that you want to use inside the CDP application. Note that this customization is not self-service, requires you to engage with your CDP CSM, and involves some deployment effort.