In the table below there is the description of the fields available in Insights for the Activity Model. Please refer to this article to understand how to generate a new visualization.
Field Name: The name used in Insights.
Description: A brief explanation about the field in Insights.
Type:
Dimension: Data can be aggregated by that value (e.g.
Sale City, all of the metrics will be aggregated and grouped by the city in which the sale took place)Metric: Quantities (e.g. the value of an order)
Date: Date-time value. It can also be used as a dimension to aggregate values by specific time frames (weekly, monthly, annual and so on).
Activity fields
Field Name | Description |
|---|---|
Activity Associate Name | The name of the employee who was associated with the specific activity (sale, return, fulfillment, rejection) |
Activity Attributed Associate Name | The name of the sales associate who was credited with the sale during the checkout process by the Ringing Associate. |
Activity Catalog | The catalog used for the activity. Not always applicable or populated. |
Activity City | The city in which an activity occurred. This is based on the store location. |
Activity Country Code | The Country Code in which an activity occurred. This is based on the store location. |
Activity Date | The date time that the activity occurred, which is localized to the sale location. If no sale location is available, defaults to a pre-determined tenant timezone. |
Activity Date (w/ Offset) | The same as activity date. However, this field allows you to set a "Timezone Offset" in hours to change all dates to your local timezone. Shows the date of an activity such as items sold, or returned items. Good for use in Net Sales or Net Items in order to capture all things happening in a time period, instead of only Order Dates or Return Dates in a given period. |
Activity Date UTC | Activity Date (w/ Offset) should be used instead. All dates here are GMT-0.The date at which an activity occurred. This varies based on activity type. For example, Activity Type of Item will show the order date. Activity type of Returned will show the return date. This is good for use in "NET" of something (Net Sales, Net Items). |
Activity Locale | The Catalog locale used for this activity. |
Activity Location | "Location" is the store name for a given activity. This is a custom string that is created during store creation and can be a store or warehouse. |
Activity Location ID | "Location ID" is the ID for a given location. This is a custom string that is created during store creation and can be a store or warehouse. |
Activity Location Type | The type of location that a given activity was sent to. Typically: store or dc |
Activity State | The state in which an activity occurred, where applicable. This is based on the store location. |
Activity Timezone | The timezone in which an activity occurred. This is based on the store location. |
Activity Type | The type of record you are viewing. For example activity type item is a sold item. If you want to see all items that were returned for last week, use Activity Date (w/ Offset) = last week and Activity Type = returned. |
Activity Value | The value in original currency of a given activity. This is not applicable for all activity types. |
Activity Value AUD | The value in original currency of a given activity that is converted to AUD. This is not applicable for all activity types. |
Activity Value CAD | The value in original currency of a given activity that is converted to CAD. This is not applicable for all activity types. |
Activity Value EUR | The value in original currency of a given activity that is converted to EUR. This is not applicable for all activity types. |
Activity Value GBP | The value in original currency of a given activity that is converted to GBP. This is not applicable for all activity types. |
Activity Zip Code | The zip code in which an activity occurred, where applicable. This is based on the store location. |
Discount Date | The date time that the activity occurred, which is localized to the sale location. If no sale location is available, defaults to a pre-determined tenant timezone. |
Discounts Coupon Code | The coupon code that was applied to the item or order. |
Discounts Creation Date UTC | The date at which the promotionw as applied in GMT-0. |
Discounts Level | The level at which a discount is applied. Typically order or item level. |
Discounts Price Adjustment | The change to the price that a given discount is providing. |
Discounts Promotion Id UUID | The unique NewStore platform identifier of the promotion. |
Discounts Rate | The rate at which an item is discounted based on the discount effect. For example, fixed rate or the percentage. |
Discounts Reason | What is entered into the associate app when applying a manual discount during checkout or the name of the coupon. |
Discounts Type | The method at which a discount is applied. Typically percentage or fixed rate. |
EA Filter | |
Fulfillment Catalog | The catalog which will be used for order fulfillment. |
Fulfillment City | The city in which an activity occurred. This is based on the store or warehouse location. |
Fulfillment Country Code | The country in which an activity occurred. This is based on the store or warehouse location. |
Fulfillment Created At | The date and time at which a fulfillment request was created based on the timezone of the fulfillment location in which the fulfillment request was assigned. |
Fulfillment Created At UTC | The date and time at which a fulfillment request was created. |
Fulfillment Insert Time | The date and time when the fulfillment request was added to the NewStore platform. |
Fulfillment Locale | The locale (language and country or region identifier) which is relevant to the given fulfillent request. |
Fulfillment Location | The store name or warehouse name where a given item was asked to be fulfilled. This is a custom value configured during setup of locations. |
Fulfillment Location Id | The location ID name where a given item was asked to be fulfilled. This is a custom value configured during setup of locations. |
Fulfillment Location Type | The type of location that a given fulfillment was sent to. Typically: store or dc |
Fulfillment Service Level | Carrier service level provided by the shipping provider. |
Fulfillment Service Level Carrier | Carrier service level provided by the shipping provider. Can vary slightly from service level. |
Fulfillment Shipping Carrier | Carrier used to ship items |
Fulfillment State | The state in which an activity occurred. This is based on the store or dc location. |
Fulfillment Status | The current status of a given fulfillment. For example shipped, rejected, or cancelled. |
Fulfillment Task Canceled At Local | The local time at which a task has been canceled |
Fulfillment Task Canceled At UTC | The time in UTC at which a task has been canceled |
Fulfillment Task Created At Local | Time in local time at which the fulfillment task has been created in store-fulfillment |
Fulfillment Task Created At UTC | The time in UTC at which the fulfillment task has been created in store-fulfillment |
Fulfillment Task Delivery Booking Error Description | |
Fulfillment Task Delivery Booking Error Type | |
Fulfillment Task Delivery Booking Status | The status of the shipping or delivery booking for the specific fulfillment request. |
Fulfillment Task Handed Over At Local | The local time at which the fulfillment task has been picked by carrier or customer |
Fulfillment Task Handed Over At UTC | The time in UTC at which the fulfillment task has been picked by carrier or customer |
Fulfillment Task Picked At Local | The local time at which the items were marked as picked |
Fulfillment Task Picked At UTC | The time in UTC at which the items were marked as picked |
Fulfillment Task Printing At Local | The local time at which a user triggered printing: this starts documents generation and packages cannot be modified anymore. |
Fulfillment Task Printing At UTC | The time in UTC at which a user triggered printing: this starts documents generation and packages cannot be modified anymore. |
Fulfillment Task Ready At Local | The local time at which the fulfillment task has been completed, ready to get picked up by carrier or customer |
Fulfillment Task Ready At UTC | The time in UTC at which the fulfillment task has been completed, ready to get picked up by carrier or customer |
Fulfillment Task Started At Local | The local time at which the fulfillment task has been started, which means added to a wave |
Fulfillment Task Started At UTC | The time in UTC at which the fulfillment task has been started, which means added to a wave |
Fulfillment Task Updated At | |
Fulfillment Task Updated At Local | |
Fulfillment Task Wave Id | Fulfillment tasks are processed in waves. wave can contain one or more tasks. this is done so that the associate app can show all items to pick from a store’s shelves in bulk. |
Fulfillment Timezone | The timezone in which an activity occurred. This is based on the store or dc location. |
Fulfillment UUID | The unique identifier of a given fulfillment request. Unique Count Fulfillment UUID in order to know how many fulfillment requests of X number of items were created in a given time period. |
Fulfillment Zip Code | The zip code in which an activity occurred. This is based on the store or dc location. |
Hours Filter (Activity Date) | Uses Hour Start and Hour End parameters that can be added to a liveboard to filter activities by hour of the day. |
Item Order ID (UUID) | "Items". The Item Order ID is a unique identifier of a specific item in a specific order. Unique Count Item Order ID (UUID) to count how many items exist. |
Last Refresh in Minutes | The time since the data was last refreshed in minutes. I no new activity occurs, this still updates. |
Order Date (w/ Offset) | The date at which an order was placed. When using this field in an answer, the "Timezone Offset" will be available to convert the Order Dates from GMT-0 to whichever timezone you would like. The Timezone Offset can be configured on a liveboard to change all dates on the liveboard to a different timezone. |
Order ID | The Order identifier used by all systems. "Orders". Unique Count Order ID to know how many orders have occurred for a given search. One of the most used metrics. |
Order ID UUID | Use "Order ID" instead. This is the NewStore unique Order ID. |
Payment Amount | The full amount of the transaction. Not recommended to use since this will multiple the transaction value based on how many payment methods are used. |
Payment Currency | The currency the payment was transacted in. |
Payment Instrument ID | This is an internal identifier for the specific payment within the payment integration. The instrument id is unique across all identifier of payment and repeat itself for every new transaction done with this instrument. |
Payment Method | The payment method used for the transaction. The default possible values are: 'cash', 'credit_card', 'gift_card'. |
Payment Origin | The selected payment option within the associate app. This maps directly to the payment_options API configuration. |
Payment PSP ID | The Payment Service Provider number for the transaction. This is imported from the payment provider. |
Payment Processed At UTC | The date and time of a payment that is in GMT-0. |
Payment Provider | The payment provider who processed the transaction. |
Payment Transaction Amount | The amount on the given payment instrument. Recommended to sum the value of payments for a period of time. |
Payment Transaction Amount AUD | The amount for a given payment instrument converted daily to AUD. |
Payment Transaction Amount CAD | The amount for a given payment instrument converted daily to CAD. |
Payment Transaction Amount EUR | The amount for a given payment instrument converted daily to EUR. |
Payment Transaction Amount GBP | The amount for a given payment instrument converted daily to GBP. |
Payment Transaction Amount USD | The type of payment transaction - "authorization, capture, revoke, refund". |
Payment Transaction Type | Whether a transaction is being collected, or given back. Typically Capture or Refund. |
Payment Type | The type of payment transaction - "authorization, capture, revoke, refund". |
Payment Wallet | The payment wallet used for the transaction. For example, direct (typically in-store payments) Apple Pay, Android Pay. |
Processed At (w/ Offset) | The date at which a payment was processed. When using this field in an answer, the "Timezone Offset" will be available to convert the Order Dates from GMT-0 to whichever timezone you would like. The Timezone Offset can be configured on a liveboard to change all dates on the liveboard to a different timezone. |
Production Retailers | |
Rejection Associate ID | The unique identifier of the person who rejected a given fulfillment request. |
Rejection Associate Name | The rejection associate name who rejected an item for a given fulfillment request. |
Rejection Date | The date time that the activity occurred, which is localized to the rejection location. If no rejection information location is available, defaults to a pre-determined tenant timezone. |
Rejection Date UTC | The date at which a fulfillment request was rejected. |
Rejection Insert Time | |
Rejection Reason | The reason an item was rejected from fulfillment. The reason is a custom value. |
Retailer | The tenant name. This can be found in the address bar while viewing NOM. |
Return Adjustment Reason | When a return processed, it can include a reason for the adjustment in return value. |
Return Associate Name | When applicable, the associate who received the return. |
Return Catalog | |
Return City | The city in which an activity occurred. This is based on the store or dc location. |
Return Country Code | The country code in which an activity occurred. This is based on the store or dc location. |
Return Created At UTC | Use Return Date (w/ Offset) instead. The time and date at which a return was created at in GMT-0. |
Return Customer ID (UUID) | The NewStore UUID of the customer who returned the item. This can be used to link to the customer profile in NOM. |
Return Date | The date time that the activity occurred, which is localized to the return location. If no return information location is available, defaults to a pre-determined tenant timezone. |
Return Date (w/ Offset) | The date at which a return was created. When using a field with an Offset, the Timezone Offset will appear and allow changing the timezone from GMT-0 to your local timezone if desired. |
Return Id (UUID) | The unique identifier of a specific return. Unique Count Return ID (UUID) will provide all returns for a given time period. A return ID can apply to more than one item. |
Return Insert Time | |
Return Item Condition | When a return is processed, it can include a condition for the returned items. |
Return Item Condition Code | Optionally, a condition code can be supplied when returns are received. |
Return Item Type | The type of item returned. Typically 'product' for an item that is returned, but can also include 'shipping' if that is also credited. |
Return Locale | |
Return Location | The location name for where an item was returned. This is configured when setting up locations. |
Return Location Type | If an item was returned to a store or a dc |
Return Product Name | Please use the Sale Product Name instead. |
Return Product SKU | Please use Sale Product SKU instead. |
Return Reason | A return reason can be provided when a return is processed. |
Return Refund Amount | The amount refunded during a return event |
Return Refund Amount Adjusted | The amount a refund was reduced or adjusted. |
Return Refund Net | The value of what is returned in original currency. |
Return Refund Net AUD | The value of what is returned converted to AUD, without taxes. |
Return Refund Net CAD | The value of what is returned converted to CAD, without taxes. |
Return Refund Net EUR | The value of what is returned converted to EUR, without taxes. |
Return Refund Net GBP | The value of what is returned converted to GBP, without taxes. |
Return Refund Net USD | The value of what is returned converted to USD, without taxes. |
Return Refund Tax | The value of what is returned in original currency but only the tax amount. Can be added to "return refund net" to determine gross refund. |
Return Return Code | The retailer specific return code for a given return reason. |
Return Returned At | |
Return Returned To | The location ID of the place an item was returned to. Usually shorthand for Return Location. |
Return State | The state in which an activity occurred. This is based on the store or dc location. |
Return Timezone | The timezone in which an activity occurred. This is based on the store or dc location. |
Return Zip Code | The zip code in which an activity occurred. This is based on the store or dc location. |
Sale Attributed Associate ID | The UUID of the sales associate who was credited with the sale during the checkout process by the Ringing Associate. |
Sale Attributed Associate Name | The name of the sales associate who was credited with the sale during the checkout process by the Ringing Associate. |
Sale Catalog | The catalog that the item was sold out of. |
Sale Catalog Keywords | A JSON list of keywords describing the product. By default, this field has no effect in the NewStore applications. Example [boot, trek, goretex]. Use "contains" formula in Omni Insights to match on specific keywords. |
Sale Categories | The category path. Example Furniture > Chairs |
Sale Category | Main category path. Example Boots > Trekking |
Sale Category Leaf | Deepest final category, of all Category Paths for the given SKU. |
Sale Channel | The channel provided during a sale. This is customizable but is typically a store id, or website id for web orders. |
Sale Channel Type | Always Store for store orders. Typically is Web or Store. However, injected orders can have any value. |
Sale City | City in which a sale occurred that is pulled from the store location information. |
Sale Country Code | The Country Code for the location of the purchase. |
Sale Customer External ID | The external identifier that is injected into NewStore |
Sale Customer ID | The ID of the customer making the purchase. |
Sale Customer ID (UUID) | The NewStore unique identifier of the customer who made the purchase. This can be used to link to the NOM page for the customer. |
Sale Customer Type | Is new, existing, or anonymous based on whether NewStore has created a new profile, has an existing profile, or the order is anonymous. Includes all time customer profiles on NewStore. |
Sale Extended Attributes | JSON blob of all extended attributes of an item |
Sale External Identifier | JSON blob of all external identifiers of an item. |
Sale Fulfilled From | The ID of the location where an item was sold from. Typically is short-hand for a Sale Location. |
Sale Fulfilled With | The service level of an item that is determined during a sale. This can change after an item is routed or is further down the order process. The value will be In_Store_Handover for all cash and carry orders. |
Sale Is BOPIS Uplift | Sales from stores that are credited to a BOPIS action. Items bought in store on the same day as a pick-up. Only orders marked as shipped are considered as uplift. |
Sale Is BORIS Uplift | Sales from stores that are credited to a BORIS action. Items bought in store on the same day as a return. |
Sale Is Historical | Was this sale injected into NewStore after it happened. This typically means the order came from a different Order Management System. |
Sale Is Offline | Was this sale captured while the device was in offline mode. |
Sale Item Discount | The discount applied at the item level during a sale. |
Sale Item List Price | The catalog price of the item. |
Sale Item Status | The status of a specific item in an order. Can be a variety of options but typically complete = item is in the customers hands, returned, cancelled, etc. |
Sale Item Tax Base | What tax base was used to calculate the tax during a sale. |
Sale Item Type | Item types are typically gift-card, shipping, and product but can vary based on individual configuration |
Sale Locale | The locale of the catalog used in the sale. |
Sale Location | The name of the location that the sale occurred. Typically the Store Name |
Sale Location Type | |
Sale Order Currency | The currency in which the sale occurred. |
Sale Order Date | The date time that the activity occurred, which is localized to the sale location. If no sale information location is available, defaults to a pre-determined tenant timezone. |
Sale Order Date UTC | The date the order was placed. |
Sale Order Discount | The order level discounts applied during checkout. |
Sale Order Status | The status of the overall order. This is where to find blind returns, which will have order status "created_for_blind_return", as well as on hold orders, failed, and closed. |
Sale Price List | The catalog price of the item per quantity one. Equal to item_list_price unless overriden by a pricebook. If the item is in a group, this is the price after proration. |
Sale Price Net | Actual price of items sold in original currency (includes discounts, promotions, and does not include tax). |
Sale Price Net (w/ VAT) | Actual price of items sold in original currency (includes discounts, promotions). Tax is added to the net price when the tax method = vat_included. |
Sale Price Net AUD | Actual price of an item converted to AUD without tax, and with discounts applied. Exchange rates use yesterdays rate for today until market close. |
Sale Price Net CAD | Actual price of an item converted to CAD without tax, and with discounts applied. Exchange rates use yesterdays rate for today until market close. |
Sale Price Net EUR | Actual price of an item converted to EUR without tax, and with discounts applied. Exchange rates use yesterdays rate for today until market close. |
Sale Price Net GBP | Actual price of an item converted to GBP without tax, and with discounts applied. Exchange rates use yesterdays rate for today until market close. |
Sale Price Net USD | Actual price of an item converted to USD without tax, and with discounts applied. Exchange rates use yesterdays rate for today until market close. |
Sale Price Tax | The tax that is charged for a given item. To include tax into Net Sales, create a formula to add sum (Sale Price Net) + sum (Sale Price Tax). Use Sale Tax Method to understand if tax is included or not. |
Sale Product Article Number | From "External Identifier". |
Sale Product Color | The color of the item that was sold. |
Sale Product EAN13 | From "External Identifier". |
Sale Product Gender | From "Extended Attributes". |
Sale Product Hang Tag SKU | From "Extended Attributes". |
Sale Product Legacy Order Id | From "Extended Attributes". |
Sale Product Name | The name of the item that was sold. The same SKU may be sold with a localized product name. Compare products across regions by using the SKU, or look at the Sale Catalog, Sale Language. |
Sale Product SKU | The SKU of the item that was sold. |
Sale Product Serial Number | From "Extended Attributes". |
Sale Product Size | Size of the item that was sold. |
Sale Product Subcat | From "Extended Attributes". |
Sale Product UPC | Will pull UPC from "External Identifier" with fallback to "Extended Attributes". |
Sale Product Variation 1 | Variations are a common customization but we have included it because many brands use this for tracking Styles. |
Sale Product Variation 2 | Variations are a common customization but we have included it because many brands use this for tracking Styles. |
Sale Ringing Associate Id | The ID of the sales associate who was logged into the Associate App and processed the sale. |
Sale Ringing Associate Name | The name of the sales associate who was logged into the Associate App and processed the sale. |
Sale Shipping Method | The shipping method that was determined at the sale of an item. This can change later as an order is processed due to available shipping options when the shipment is actually created. |
Sale State | The state at which a sale occurred. Uses the State linked to the location created. |
Sale Store ID | The store ID for where an item was sold. Typically short-hand for Store Location. |
Sale Timezone | The timezone at which the item was purchased. |
Sale Variant Group Id | |
Sale Zip Code | The Zip Code of the location that sold the item. |
Sale is Cash and Carry | Was the item bought in a store, or shipped after purchase. This is typically used to find Endless Aisle orders in conjunction with Sale Channel Type = store. |
Sales Comparison Period (Pilot feature) | |
Sales This Period (Pilot feature) | |
Shipment Associate Name | The associate who marked an order as handed over. This can be empty when a carrier picks up an item and no associate is marked during handover. |
Shipment Carrier | The Carrier used for the shipment. |
Shipment Carrier Service Level | The service level that was used for the item. |
Shipment Date | The date time that the activity occurred, which is localized to the shipment location. If no shipment location is available, defaults to a pre-determined tenant timezone. |
Shipment Price Net | The value of the items in a given shipment reduced by discounts and not including tax. |
Shipment Price Net AUD | The value in AUD of the items in a given shipment reduced by discounts and not including tax. |
Shipment Price Net CAD | The value in CAD of the items in a given shipment reduced by discounts and not including tax. |
Shipment Price Net EUR | The value in EUR of the items in a given shipment reduced by discounts and not including tax. |
Shipment Price Net GBP | The value in GBP of the items in a given shipment reduced by discounts and not including tax. |
Shipment Price Net USD | The value in USD of the items in a given shipment reduced by discounts and not including tax. |
Shipment Price Tax | The value of the separate tax in a given shipment. |
Shipment Shipped At UTC | The date/time of a shipment. Requires integration from DC shipping notifications or store fulfillment. |
Shipment Tracking Code | The tracking code associated to a shipment. |
TY & LY PST (Calendar) | True if the Activity Date = today in PST or 365 days ago in PST |
This Week (Sunday) | True/false if the days requested fall into this week starting on Sunday. This can be used to filter a liveboard to include all days since and including Sunday. |