Table of Contents
- BYOD Overview
- Importing Retail and Finance Data
- Importing Marketing Data
- Importing Fulfillment Data
- Frequently Asked Questions
BYOD Overview
There are an endless number of channels and platforms that brands use to power their e-commerce business. Now, with "Bring your own data," brands can understand their brand’s performance across all channels on which they operate, not just the ones for which there are publicly-available integrations.
To begin the process of bringing your own data, please reach out to your account manager or sales representative. You may also submit a ticket to our support team for more information.
Importing Retail and Finance Data
Once you have the appropriate retail channels set up, data can be uploaded through Settings > Import Data. There are two types of data that can be uploaded for retail channels: retail and finance.
Retail templates cover sales data while finance templates cover costs.
Retail Template (example file)
| Field Name | Field Description | Accepted Values |
| start_date*† | The first date within the reporting date range. For data reported on a daily granularity, this value should be the same as end_date. Daily data is recommended, where possible. | See BYOD: Accepted date formats for accepted values. |
| end_date*† | The last date within the reporting date range. For data reported on a daily granularity, this value should be the same as start_date. Daily data is recommended, where possible. | See BYOD: Accepted date formats for accepted values. |
| partner_unit_id*† |
A static identifier assigned to the item by the channel. e.g. Amazon ASIN or Shopify variant ID |
|
| partner_unit_name | A human-readable name assigned to the item. | |
| partner_secondary_unit_id | A secondary identifier assigned to the item, often referred to as a SKU. | |
| partner_order_id† | A unique identifier assigned to the order by the channel. | |
| consumer_units | Total units purchased by customers. This field is required if consumer_sales is populated. | Must be a whole number. |
| consumer_sales | Total dollars paid by customers (excluding taxes and shipping, inclusive of discounts). This field is required if consumer_units is populated. | Must be represented in USD. Cannot contain fractions of a cent. |
| consumer_subscription_units | Total units purchased via subscription orders. | Must be a whole number. |
| consumer_subscription_sales | Total dollars paid by customers for subscription orders (excluding taxes and shipping, inclusive of discounts). | Must be represented in USD. Cannot contain fractions of a cent. |
| consumer_subscription_discount | Total discount applied to subscription orders. Please note that this is the total across all orders, not a per-unit discount. | Must be represented in USD. Cannot contain fractions of a cent. |
| promotion_id† | Promotion ID or discount code. Can contain multiple pipe-delimited values. | |
| consumer_promotion_units | Total units purchased where a discount or price promotion was applied. | Must be a whole number. |
| consumer_promotion_sales | Total dollars paid by customers where a discount or price promotion was applied (excluding taxes and shipping, inclusive of discounts). | Must be represented in USD. Cannot contain fractions of a cent. |
| consumer_promotion_discount | Total discount applied. Please note that this is the total across all orders, not a per-unit discount. | Must be represented in USD. Cannot contain fractions of a cent. |
| returned_units | Total units returned. This field is required if returned_product_sales is populated. | Must be a whole number. |
| returned_product_sales | Total dollar amount associated with returned products. This field is required if returned_units is populated. | Must be represented in USD. Cannot contain fractions of a cent. |
| postal_code† | The 5-digit postal code to which an order was shipped. | Must be a 5-digit US postal code. |
| country† | The country to which an order was shipped. The only supported value at the moment is US. | Must be US. |
| operations_partner_id† | The channel ID associated with the operations channel through which this/these order(s) were fulfilled. | Must be a valid channel ID listed in the Connected Channels table. |
| operations_partner_company_id† | The channel company ID associated with the account through which this/these order(s) were fulfilled. | Must be a valid channel company ID listed in the Connected Channels table. |
* Denotes a required field
† Denotes a field that is part of the primary key - this can be null
Finance Template (example file)
| Field Name | Field Description | Accepted Values |
| start_date*† | The first date within the reporting date range. For data reported on a daily granularity, this value should be the same as end_date. Daily data is recommended, where possible. | See BYOD: Accepted date formats for accepted values. |
| end_date*† | The last date within the reporting date range. For data reported on a daily granularity, this value should be the same as start_date. Daily data is recommended, where possible. | See BYOD: Accepted date formats for accepted values. |
| partner_unit_id† |
A static identifier assigned to the item by the channel. e.g. Amazon ASIN or Shopify variant ID |
|
| partner_unit_name | A human-readable name assigned to the item. | |
| partner_secondary_unit_id | A secondary identifier assigned to the item, often referred to as a SKU. | |
| brand_revenue | For vendor/wholesale relationships, customer sales represented as retailer COGS. This value is sometimes referred to as shipped/ordered COGS or POS cost and is calculated as units sold multiplied by the unit cost to retailer. This field is required if importing data for a vendor/wholesale retail channel. | Must be represented in USD. Cannot contain fractions of a cent. |
| shipment_to_fc_cost | Fees charged by a fulfillment service or retailer to transport an item from its receiving location to a fulfillment center. | Must be represented in USD. Cannot contain fractions of a cent. |
| fulfillment_cost | Fees charged by a fulfillment service or retailer to fulfill an order of an item. | Must be represented in USD. Cannot contain fractions of a cent. |
| selling_cost | Selling fees charged by a marketplace or retailer. | Must be represented in USD. Cannot contain fractions of a cent. |
| warehousing_cost | Fees associated with storing an item at a fulfillment center or warehouse. | Must be represented in USD. Cannot contain fractions of a cent. |
| promotions_cost |
Fees associated with running a promotional discount or coupon. This should not include subsidized discounts, only incremental fees. e.g. Brand A implements a $5 coupon. It costs $100 to publish the coupon and an additional $5 per unit sold to subsidize the discount. Brand A would enter $100 in this field. |
Must be represented in USD. Cannot contain fractions of a cent. |
| chargebacks | Fees associated with chargebacks, typically related to non-compliance charges. | Must be represented in USD. Cannot contain fractions of a cent. |
| miscellaneous_cost | Any miscellaneous costs not captured in other fields. | Must be represented in USD. Cannot contain fractions of a cent. |
| operations_partner_id† | The channel ID associated with the operations channel through which this/these order(s) were fulfilled. | Must be a valid channel ID listed in the Connected Channels table. |
| operations_partner_company_id† | The channel company ID associated with the account through which this/these order(s) were fulfilled. | Must be a valid channel company ID listed in the Connected Channels table. |
* Denotes a required field
† Denotes a field that is part of the primary key - this can be null
Importing Marketing Data
Once you have the appropriate marketing channels set up, data can be uploaded through Settings > Import Data. There are several types of data that can be uploaded for retail channels: marketing (generic), search, age, and gender.
Marketing campaign templates contain marketing data with no audience or search segmentation, which populate the majority of the visualizations across the various marketing pages. This should include all of the performance data you have for the campaigns that you have for your custom marketing channel.
Marketing search templates contain data specific to search-based advertising. Marketing age, gender, and geo templates contain performance metrics segmented by various audience attributes, where available. Any data uploaded to Incremental in these templates will only impact search- or audience-specific visualizations.
Marketing Campaign Template (example file)
| Field Name | Field Description | Accepted Values |
| start_date*† | The first date within the reporting date range. For data reported on a daily granularity, this value should be the same as end_date. Daily data is recommended, where possible. | See BYOD: Accepted date formats for accepted values. |
| end_date*† | The last date within the reporting date range. For data reported on a daily granularity, this value should be the same as start_date. Daily data is recommended, where possible. | See BYOD: Accepted date formats for accepted values. |
| retail_partner_id† | The channel ID for the retail channel associated with the campaign. | Must be a valid channel ID listed in the Connected Channels table. |
| retail_partner_company_id† | The channel company ID for the retail account associated with the campaign. | Must be a valid channel company ID listed in the Connected Channels table. |
| partner_campaign_id*† | A unique identifier assigned to the campaign by the channel. | |
| partner_campaign_name* | The name assigned to the campaign. | |
| campaign_type* | The media type or ad format associated with the campaign. |
Must be one of the following values: SPONSORED_PRODUCTS SPONSORED_BRANDS SPONSORED_BRANDS_VIDEO SPONSORED_DISPLAY DISPLAY VIDEO SEARCH SHOPPING SOCIAL_DISPLAY SOCIAL_VIDEO CONNECTED_TV SPONSORSHIP SOCIAL_INFLUENCER AUDIO DYNAMIC_CREATIVE |
| partner_unit_id† |
A static identifier assigned to the item by the channel. e.g. Amazon ASIN or Shopify variant ID |
|
| partner_unit_name | A human-readable name assigned to the item. | |
| partner_secondary_unit_id | A secondary identifier assigned to the item, often referred to as a SKU. | |
| impressions | Number of times an ad unit was shown. | Must be a whole number. |
| clicks | Number of times an ad unit was clicked. | Must be a whole number. |
| spend | Total dollars spent on the campaign. | Must be represented in USD. Cannot contain fractions of a cent. |
| units_ordered | Total units purchased that are directly attributable to the campaign. | Must be a whole number. |
| conversions | Total conversion events completed. | Must be a whole number. |
| attributed_sales | Total product sales directly attributable to the campaign. | Must be represented in USD. Cannot contain fractions of a cent. |
| engagements | Number of interactions with an ad unit. | Must be a whole number. |
| partner_ad_group_id† | A unique identifier assigned to the ad group by the channel. | |
| partner_ad_group_name | The name assigned to the ad group. |
* Denotes a required field
† Denotes a field that is part of the primary key - this can be null
Marketing Search Template
| Field Name | Field Description | Accepted Values |
| start_date*† | The first date within the reporting date range. For data reported on a daily granularity, this value should be the same as end_date. Daily data is recommended, where possible. | See BYOD: Accepted date formats for accepted values. |
| end_date*† | The last date within the reporting date range. For data reported on a daily granularity, this value should be the same as start_date. Daily data is recommended, where possible. | See BYOD: Accepted date formats for accepted values. |
| retail_partner_id† | The channel ID for the retail channel associated with the campaign. | Must be a valid channel ID listed in the Connected Channels table. |
| retail_partner_company_id† | The channel company ID for the retail account associated with the campaign. | Must be a valid channel company ID listed in the Connected Channels table. |
| partner_campaign_id*† | A unique identifier assigned to the campaign by the channel. | |
| partner_campaign_name* | The name assigned to the campaign. | |
| campaign_type* | The media type or ad format associated with the campaign. |
Must be one of the following values: SPONSORED_PRODUCTS SPONSORED_BRANDS SPONSORED_BRANDS_VIDEO SPONSORED_DISPLAY DISPLAY VIDEO SEARCH SHOPPING SOCIAL_DISPLAY SOCIAL_VIDEO CONNECTED_TV SPONSORSHIP SOCIAL_INFLUENCER AUDIO DYNAMIC_CREATIVE |
| keyword† | The targeted keyword. | |
| keyword_match_type† | The keyword matching strategy applied. |
Must be one of the following values: EXACT |
| search_term† | The query searched by the customer. | |
| impressions | Number of times an ad unit was shown. | Must be a whole number. |
| clicks | Number of times an ad unit was clicked. | Must be a whole number. |
| spend | Total dollars spent on the campaign. | Must be represented in USD. Cannot contain fractions of a cent. |
| units_ordered | Total units purchased that are directly attributable to the campaign. | Must be a whole number. |
| conversions | Total conversion events completed. | Must be a whole number. |
| attributed_sales | Total product sales directly attributable to the campaign. | Must be represented in USD. Cannot contain fractions of a cent. |
| engagements | Number of interactions with an ad unit. | Must be a whole number. |
| partner_ad_group_id† | A unique identifier assigned to the ad group by the channel. | |
| partner_ad_group_name† | The name assigned to the ad group. |
* Denotes a required field
† Denotes a field that is part of the primary key - this can be null
Marketing Age Template
| Field Name | Field Description | Accepted Values |
| start_date*† | The first date within the reporting date range. For data reported on a daily granularity, this value should be the same as end_date. Daily data is recommended, where possible. | See BYOD: Accepted date formats for accepted values. |
| end_date*† | The last date within the reporting date range. For data reported on a daily granularity, this value should be the same as start_date. Daily data is recommended, where possible. | See BYOD: Accepted date formats for accepted values. |
| retail_partner_id† | The channel ID for the retail channel associated with the campaign. | Must be a valid channel ID listed in the Connected Channels table. |
| retail_partner_company_id† | The channel company ID for the retail account associated with the campaign. | Must be a valid channel company ID listed in the Connected Channels table. |
| partner_campaign_id*† | A unique identifier assigned to the campaign by the channel. | |
| partner_campaign_name* | The name assigned to the campaign. | |
| campaign_type* | The media type or ad format associated with the campaign. |
Must be one of the following values: SPONSORED_PRODUCTS SPONSORED_BRANDS SPONSORED_BRANDS_VIDEO SPONSORED_DISPLAY DISPLAY VIDEO SEARCH SHOPPING SOCIAL_DISPLAY SOCIAL_VIDEO CONNECTED_TV SPONSORSHIP SOCIAL_INFLUENCER AUDIO DYNAMIC_CREATIVE |
| age_range*† | The age range for this demographic segment. |
Must be one of the following values: 13-17 |
| impressions | Number of times an ad unit was shown. | Must be a whole number. |
| clicks | Number of times an ad unit was clicked. | Must be a whole number. |
| spend | Total dollars spent on the campaign. | Must be represented in USD. Cannot contain fractions of a cent. |
| units_ordered | Total units purchased that are directly attributable to the campaign. | Must be a whole number. |
| conversions | Total conversion events completed. | Must be a whole number. |
| attributed_sales | Total product sales directly attributable to the campaign. | Must be represented in USD. Cannot contain fractions of a cent. |
| engagements | Number of interactions with an ad unit. | Must be a whole number. |
* Denotes a required field
† Denotes a field that is part of the primary key - this can be null
Marketing Gender Template
| Field Name | Field Description | Accepted Values |
| start_date*† | The first date within the reporting date range. For data reported on a daily granularity, this value should be the same as end_date. Daily data is recommended, where possible. | See BYOD: Accepted date formats for accepted values. |
| end_date*† | The last date within the reporting date range. For data reported on a daily granularity, this value should be the same as start_date. Daily data is recommended, where possible. | See BYOD: Accepted date formats for accepted values. |
| retail_partner_id† | The channel ID for the retail channel associated with the campaign. | Must be a valid channel ID listed in the Connected Channels table. |
| retail_partner_company_id† | The channel company ID for the retail account associated with the campaign. | Must be a valid channel company ID listed in the Connected Channels table. |
| partner_campaign_id*† | A unique identifier assigned to the campaign by the channel. | |
| partner_campaign_name* | The name assigned to the campaign. | |
| campaign_type* | The media type or ad format associated with the campaign. |
Must be one of the following values: SPONSORED_PRODUCTS SPONSORED_BRANDS SPONSORED_BRANDS_VIDEO SPONSORED_DISPLAY DISPLAY VIDEO SEARCH SHOPPING SOCIAL_DISPLAY SOCIAL_VIDEO CONNECTED_TV SPONSORSHIP SOCIAL_INFLUENCER AUDIO DYNAMIC_CREATIVE |
| gender*† | The gender for this demographic segment. |
Must be one of the following values: Male |
| impressions | Number of times an ad unit was shown. | Must be a whole number. |
| clicks | Number of times an ad unit was clicked. | Must be a whole number. |
| spend | Total dollars spent on the campaign. | Must be represented in USD. Cannot contain fractions of a cent. |
| units_ordered | Total units purchased that are directly attributable to the campaign. | Must be a whole number. |
| conversions | Total conversion events completed. | Must be a whole number. |
| attributed_sales | Total product sales directly attributable to the campaign. | Must be represented in USD. Cannot contain fractions of a cent. |
| engagements | Number of interactions with an ad unit. | Must be a whole number. |
* Denotes a required field
† Denotes a field that is part of the primary key - this can be null
Importing Fulfillment Data
Once you have created a custom operations channel, you will be able to upload data for this channel by navigating to Settings > Import Data. The data uploaded via a fulfillment template will populate the Operations dashboard.
Fulfillment Template
| Field Name | Field Description | Accepted Values |
| date*† | The date associated with the inventory data. | See BYOD: Accepted date formats for accepted values. |
| fc_id† | A unique static identifier for a fulfillment center. | |
| partner_unit_id*† | A static identifier assigned to the item. | |
| partner_unit_name | A human-readable name assigned to the item. | |
| retail_partner_id† | The channel ID associated with the retail channel through which this/these order(s) were fulfilled. | Must be a valid channel ID listed in the Connected Channels table. |
| retail_partner_company_id† | The channel company ID associated with the account through which this/these order(s) were fulfilled. | Must be a valid channel company ID listed in the Connected Channels table. |
| fulfillable_units* | Total units immediately available to be picked, packed, and shipped of any inventory age. This should include all inventory, regardless of inventory age. | Must be a whole number. |
| fulfillable_units_0_to_90 | Total units immediately available to be picked, packed, and shipped that are 0-90 days old. | Must be a whole number. |
| fulfillable_units_91_to_180 | Total units immediately available to be picked, packed, and shipped that are 91-180 days old. | Must be a whole number. |
| fulfillable_units_181_to_270 | Total units immediately available to be picked, packed, and shipped that are 181-270 days old. | Must be a whole number. |
| fulfillable_units_271_to_365 | Total units immediately available to be picked, packed, and shipped that are 271-365 days old. | Must be a whole number. |
| fulfillable_units_gt_365 | Total units immediately available to be picked, packed, and shipped that are 365+ days old. | Must be a whole number. |
| reserved_units | Total units that are on hold and cannot be sold. Reserved units may include inventory assigned to existing orders, being transferred between fulfillment centers, or requiring additional processing. | Must be a whole number. |
| unsellable_units | Total units in an unsellable condition. | Must be a whole number. |
| inbound_units | Total units en route to the fulfillment center. | Must be a whole number. |
* Denotes a required field
† Denotes a field that is part of the primary key - this can be null
Frequently Asked Questions
What types of data can I upload to Incremental?
Please see the Retail and Finance, Marketing, and Fulfillment sections above for descriptions on the available fields and metrics that can be uploaded to Incremental.
How long does it take for imported data to appear in the platform?
Imported data may take up to 24 hours to populate in Incremental reporting and the relevant ares of Incremental's platform.
I accidentally uploaded incorrect data. How do I resolve this?
If you wish to restate or correct any data that has already been uploaded, please re-upload the same file with updated values.
If the incorrect data needs to be deleted rather than replaced (e.g. the data for channel A was uploaded for channel B by mistake), please click here reach out to our support team for assistance. In your request, please provide the name of the impacted channel(s), file type(s), date range(s), and any other information that would help identify the data that you would like deleted.
Have another question? Click here to reach out to our support team.
Comments
0 comments
Article is closed for comments.