Attribution and Rules
Category File
| File Name | Field Name | Requirement | Description | Format |
|---|---|---|---|---|
| Category File | category_id | Required | Unique category id identifier. | String: Must be unique |
| Category File | category_path | Required | Full category path. This will be used for category path updates and creation of new paths. | String delimited by > |
Enrichment File
| File Name | Field Name | Requirement | Description | Format |
|---|---|---|---|---|
| Enrichment File | product_id | Required | Unique product Id to help identify all SKU groupings within a product | String |
| Enrichment File | product_name | Required | Product name | String |
| Enrichment File | variant_options | Optional | Pass variant option type (ie: Color) separated by : variant option value (ie: White) in one string.Color:WhiteIf a sku has multiple variant options, use | to concatenate the optionsColor:White|Size:Small | String pipe deliminited |
| Enrichment File | sku | Required | Unique sku id of an item | String |
| Enrichment File | brand | Optional | Brand name | String |
| Enrichment File | name | Required | Variant name (excluding brand name) | String |
| Enrichment File | extended_name | Optional | Extended name | String |
| Enrichment File | long_description | Optional | Long description of an item. Note: if is_perishable = 1, product_grade, product_origin, product_size will be appended to the long description. | String |
| Enrichment File | ingredients | Optional | Variant ingredients which also gets appended to product description on the PDP | String |
| Enrichment File | category_id | Required | Category identifier for where a sku is located on the site | String - Mapping to Category File value |
| Enrichment File | is_chill | Optional | Used for on-demand (express) fulfillment, this identifies if an item needs to be in a freezer. If an order has 1 or more isfrozen order variants, a snowflake icon will show in express to let pickers & riders know about freezer items. _Only applicable if Express is enabled for your organization | Integer: 0 - No, 1 - Yes |
| Enrichment File | is_frozen | Optional | Used for on-demand (express) fulfillment, this identifies if an item needs to be in a freezer. If an order has 1 or more isfrozen order variants, a snowflake icon will show in express to let pickers & riders know about freezer items. _Only applicable if Express is enabled for your organization | Integer: 0 - No, 1 - Yes |
| Enrichment File | is_dry_good | Optional | Used for on-demand (express) fulfillment, this identifies if an item is a dry good. The attribute will appear in Xpress Admin on Order Details and in the pack slip. Only applicable if Express is enabled for your organization | Integer: 0 - No, 1 - Yes |
| Enrichment File | is_fresh_food | Optional | Used for on-demand (express) fulfillment, this identifies if an item is fresh food. The attribute will appear in Xpress Admin on Order Details and in the pack slip. Only applicable if Express is enabled for your organization | Integer: 0 - No, 1 - Yes |
| Enrichment File | weight | Optional | Unit weight of an item | Float |
| Enrichment File | length | Optional | Unit length of an item | Float |
| Enrichment File | width | Optional | Unit width of an item | Float |
| Enrichment File | height | Optional | Unit height of an item | Float |
| Enrichment File | volume | Optional | Unit volume of an item | Float |
| Enrichment File | non_halal | Optional | Used to identify if item is non halal | Integer: 0 - No, 1 - Yes |
| Enrichment File | is_age_gated | Optional | Used for any age gated items where customer must select they are over 21 years old to purchase | Integer: 0 - No, 1 - Yes |
| Enrichment File | max_cart_quantity | Optional | The max quantity a customer can purchase of an item in one order. | Integer |
| Enrichment File | unit_count | Required | Unit count | Integer - For example Coca Cola 1 Liter: Unit Count = 1 |
| Enrichment File | unit_type | Required | Unit type | String - For example Coca Cola 1 Liter: Unit Type = Each |
| Enrichment File | is_perishable | Optional | If an item is perishable then certain attributes (product grade, product size, product origin) must be shown on the Product Details tab. We append these attributes to Long Description. | Integer: 0 - No, 1 - Yes |
| Enrichment File | product_origin | Optional | If an item is perishable then certain attributes (product grade, product size, product origin) must be shown on the Product Details tab. We append these attributes to Long Description. | String |
| Enrichment File | product_grade | Optional | If an item is perishable then certain attributes (product grade, product size, product origin) can be shown on the Product Details tab. We append these attributes to Long Description. | String |
| Enrichment File | product_size | Optional | If an item is perishable then certain attributes (product grade, product size, product origin) must be shown on the Product Details tab. We append these attributes to Long Description. | String |
| Enrichment File | upcs | Required | UPC of an item | String |
| Enrichment File | barcode | Optional | Barcode for an itm | String |
| Enrichment File | tax_rate | Optional | Tax rate will be included in the item price. Only applicable if VAT is enabled for your organization | Float representing the percent of tax e.g. 10% = 10.00 |
| Enrichment File | seo_title | Optional | SEO title of a sku | String |
| Enrichment File | seo_keywords | Optional | SEO keywords of a sku. Using | as concatenation, you'll be able to send multiple keywords. Ie: milk|fresh milk|dairy | String pipe deliminated |
| Enrichment File | seo_description | Optional | SEO description of a sku | String |
| Enrichment File | cost | Optional | Cost of sku | Float |
| Enrichment File | show_in_product_list | Optional | Flag to identify if SKU appears in galleries. If set to false, SKU will not appear in galleries but still found with direct PDP link. (ie: giveaway items). Default is 1 | Integer: 0 - No, 1 - Yes |
| Enrichment File | display_as_oos | Optional | Flag to identify if SKU should still appear on site if item is OOS. Default is 0 | Integer: 0 - No, 1 - Yes |
| Enrichment File | google_category_path | Optional | Google product category path used for product feeds. Only applicable if product feeds is enabled for your organization | String |
| Enrichment File | customer_scope | Optional | Flag to identify user scope of a sku. Default is 0. Only applicable if B2B is enabled for your organization | 0 - Default → Variant exposed for all users, regardless of view type 1 - Business Users Only → Variant exposed for only users in Business view 2 - Exclude Business Users → Variant only exposed for users in Standard view |
| Enrichment File | product_keywords | Optional | Product keywords that enables Spresso platform search capabilities. | String pipe deliminated |
| Enrichment File | fulfillment_method | Deprecated | Please note this field is moving to the inventory file to allow setting by fulfiller_location One variant can only have one fultillment method 0 = parcel delivery 1 = express delivery/pick up | Integer: 0 (Parcel/Standard) or 1 (In House, BOPIS) |
| Enrichment File | image_links | Required Can leave empty for enrichment updates if there are no image updates | Links to the publicly accessible storage container for catalog image hosting, use | multiple images | Pipe delimited URLs from storage container |
| Enrichment File | show_expiration_date | Optional | If a variant has an associated expiration date and this field is set to true, it will display to customers on web and mobile apps. | Integer: 0 - False (Do Not Display default) 1 - True (Display) |
| Enrichment File | avatax_code | Optional | The variants associated tax code. Required for calculating tax via Avalara Only applicable if your organization leverages Avalara for tax management | Text |
| Enrichment File | requires_bottle_deposit | Optional | 0 - false 1 - true Only applicable for US based customers | Integer 0 - False 1 - True |
| Enrichment File | bottle_volume | Optional | The fluid ounces of each bottle/can in a pack. Required for calculating bottle deposit fee. Only applicable for US based customers | Float |
| Enrichment File | piece_count | Optional | The number of bottles/cans in the pack. Required for calculating bottle deposit fee. Only applicable for US based customers | Integer |
| Enrichment File | beverage_container_material | Optional | The material of the bottle/can. Only required for calculating the bottle deposit fee with Avalara. Only applicable for US-based customers leveraging Avalara for tax management | Integer Key/Value mapping: 0 - Glass 1 - Paperboard 2 - Plastic #1 (PET) 3 - Plastic #2 (HDPE) 4 - Plastic #3 (PVC) 5 - Plastic #4 (LDPE) 6 - Plastic #5 (PP) 7 - Plastic #6 (PS) 8 - Aluminum 9 - Plastic #7 (Other) 10 - Bi-Metal 11 - BoxBladderPouch |
| Enrichment File | slug | Optional | Allows clients to customize and set the slug of variants Logic & Validation: No special characters (will be stripped) or spaces (please use "-" instead) If slug column header exists in the file: - If row value exists, update slug to row value - If row value is empty/null, the slug will update to via the default logic (this means if you previously set a variant's slug to a custom value, it will be defaulted back to our default logic for the given row) If slug header does not exist in the file - If the slug value is empty on BE (for new product creation), update slug to default value - If the slug value is not empty (existing product), no updates will be made to the slug value Default Slug Logic: brand + name + extended_name | Text |
| Enrichment File | show_in_bulk_purchase_list | Optional | Allows admins to display variant on the bulk purchase page (if enabled for your organization) All variants are set to 0 by default. If the column exists in the file and is empty: the variant value will be set to 0. If the column does not exist in the file, there will be no change to the variant's value | Boolean: 0 - False; 1 - True. |
| Enrichment File | bulk_purchase_unit_price | Optional | Allows admins to set a variant's discounted bulk unit price on the bulk purchase page (if enabled for your organization) | Float |
| Enrichment File | bulk_purchase_selling_units | Optional | Allows admins to set a variant's discounted bulk selling units on the bulk purchase page (if enabled for your organization) | Integer |
| Enrichment File | future_bulk_purchase_unit_price | Optional | Allows admins to set a variant's discounted future bulk unit price on the bulk purchase page (if enabled for your organization) | Float |
| Enrichment File | future_bulk_purchase_price_effective_date | Optional | Allows admins to set a variant's discounted future bulk unit price effective date on the bulk purchase page (if enabled for your organization) | Date: YYYY-MM-DD |
| Enrichment File | b2b_tax_rate | Optional | - If field header is included and blank, set to null - If field header is not included, do not change values | Integer |
Pricing File
| File Name | Field Name | Requirement | Description | Format |
|---|---|---|---|---|
| Pricing File | mall_code | Required | Maps to the parent mall created in the store creation file | String |
| Pricing File | mall_name | Optional | Maps to the parent mall created in the store creation file | String |
| Pricing File | store_code | Required | Maps to the store code in the parent mall created in the store creation file | String - must be unique |
| Pricing File | store_name | Optional | Maps to the store name in the parent mall | String |
| Pricing File | sku | Required | Maps to existing SKU | String |
| Pricing File | price | Required | Standard price of the item | Float |
| Pricing File | sale_price | Optional | Sale price of the item. Any additional promotions created in Foxtrot admin will be applied on top of this sale price | Float |
Inventory File
| File Name | Field Name | Requirement | Description | Format |
|---|---|---|---|---|
| Inventory File | mall_code | Required | Maps to the parent mall created in the store creation file | String |
| Inventory File | mall_name | Optional | Maps to the parent mall created in the store creation file | String |
| Inventory File | store_code | Required | Maps to the store code in the parent mall created in the store creation file | String - must be unique |
| Inventory File | store_name | Optional | Maps to the store name in the parent mall | String |
| Inventory File | sku | Required | Maps to existing SKU | String |
| Inventory File | quantity | Required | Available selling quantity of an item | Interger |
| Inventory File | is_published | Required | Flag to identify if sku should be visible to customers or not. Default is 1. | Integer: 0 - No, 1 - Yes |
| Inventory File | expiration_date | Optional | (Optional) the date of expiration. format is YYYY-MM-DD and localized to client timezone | Date: YYYY-MM-DD Format |
| Inventory File | fulfillment_method | Required | Please note this field is permanently moving to the inventory file to allow setting by fulfiller_location One variant can have one or multiple fultillment methods 0 = parcel delivery 1 = express delivery/pick up 0,1 = parcel delivery + express delivery/pickup | String: 0 - Parcel/Standard 1 - Local Delivery/Pickup 0,1 - Parcel + Local Delivery/Pickup |
Inventory Delta File
| File Name | Field Name | Requirement | Description | Format |
|---|---|---|---|---|
| Inventory File | mall_code | Required | Maps to the parent mall created in the store creation file | String |
| Inventory File | mall_name | Optional | Maps to the parent mall created in the store creation file | String |
| Inventory File | store_code | Required | Maps to the store code in the parent mall created in the store creation file | String - must be unique |
| Inventory File | store_name | Optional | Maps to the store name in the parent mall | String |
| Inventory File | sku | Required | Maps to existing SKU | String |
| Inventory File | quantity_delta | Required | By default we will assume a positive integer and add that number to the existing quantity A negative value will signify a subtraction of the existing inventory | Integer |
| Inventory File | is_published | Required | Flag to identify if sku should be visible to customers or not. Default is 1. | Integer: 0 - No, 1 - Yes |
Updated 10 days ago