Skip to main content

Sending order line item data to LoudCrowd

Implementation guide for sending order line item data to LoudCrowd in order to set up commission rules for specific products

N
Written by Nicolas Comerci
Updated over 4 months ago

LoudCrowd Affiliate and Storefront programs support setting different commission rates for specific product SKUs, collections and brands within your overall product catalog. In order to set up these commission rules, LoudCrowd will need to have line item level information for orders placed on your eCommerce site.
​
After this data feed has been properly setup, LoudCrowd will have all the information needed to properly honor such product level attribution rules and different commission rates.


How to determine whether an order line item file is required

An order line item file is required for all LoudCrowd implementations that:

  1. Do not include a connection to your eCommerce ordering system APIs in order to directly and securely source order line item data.

  2. AND utilize LoudCrowd for affiliate attribution and reporting on revenue and products sold.

Generally an order line item file is not required for Shopify and Salesforce installations.

Pre-requisite: create an SFTP integration

Your order line item data file file can be sent to LoudCrowd via Secure File Transfer Protocol (SFTP). Your team will drop the file to a LoudCrowd-hosted SFTP server.

In order to set this up for your account, please contact your LoudCrowd Client Strategist via email. Your email should include:

  1. File purpose (ex., Order Line Item)

  2. Your server host's public SSH key (in the form RSA, ECDSA, or ED25519)

    1. Note: If you are sending multiple different data files to LoudCrowd, you can use the same key, or generate a different key for each.

  3. Sample file with the required fields (listed below), including 5 sample rows of order line item data.

LoudCrowd will create your SFTP server, and your Client Strategist will email you the following information to access your server:

  1. username

  2. SFTP server address

Drop an order line item file to LoudCrowd SFTP

In order to drop files to our SFTP server, the connection has the following requirements:

  1. SSH Public keys in the form RSA, ECDSA, or ED25519

  2. The file must be dropped into a directory named ~/order_line_items

  3. File must be a .csv or .tsv file

Requirements of the CSV file

Your CSV file should include the following fields

1) Line item fields:

  • productSku - the SKU for the product on a line item on the order

  • lineItemId - the id for the specific line item on the order. If your orders don't have specific ids for each line item, just repeat the product SKU for this field

  • quantity - the amount units of the line item product

  • currencyCode - the ISO4217 code for the currency involved in the line item

2) Line item amount fields:

Either:

  • grossAmount - the currency amount for the line item including tax

  • netAmount - the currency amount for the line item without tax

Or:

  • amount - the currency amount for the line item

  • tax - the currency amount for the tax deductions for the line item.

3) Order level fields:
The following fields include information for the top level order that are required for attribution and analytics. Include this data on the order for each line item provided in the file. Gross/Net amount fields are not supported at order level.

  • orderId - the id of the order in your system

  • email - the contact email of the buyer. Used to ensure ambassador's are not attributed to their own orders.

  • orderedAt - the date the order was placed on in ISO 8601 format.

  • canceledAt - the date the order was canceled at. This order will be hidden entirely from all revenue and commission analytics and ambassador attribution if provided.

  • totalOrderAmount - total amount for the order including tax, shipping, and any deductions to the order. Not including returns.

  • totalOrderTax - total amount of tax paid on the entire order. Not including tax refunds.

  • totalShipping - total shipping amount paid on the entire order. Not including shipping refunds.

  • affiliateCode - the affiliate code applied to the order

You can and should include multiple lines for each line item on each order.

Example

orderId,email,orderedAt,canceledAt,totalOrderAmount,totalOrderTax,totalOrderShipping,quantity,grossAmount,netAmount,productSku,lineItemId,currencyCode,affiliateCode
1,example1@loudcrowdcom,2025-01-01,,24.99,5,0,1,10,7.5,sku1,1234,USD,CODE1
1,example1@loudcrowdcom,2025-01-01,,24.99,5,0,1,9.99,7.49,sku2,12345,USD,CODE1
2,example1@loudcrowdcom,2025-01-02,2025-01-05,12,2,0,1,12,10,sku3,123456,USD,CODE2

Did this answer your question?