Store Associate Feed

Format

The feed formats are CSV (comma-separated) and TSV (tab-separated).

Important All feed files should be saved in a UTF-8 (not to be confused with UTF-8 with BOM) format else you receive an error during upload.

Types

Full - A complete list of store associates across all stores in one feed file.

Frequency

It can either be scheduled or manually uploaded

Content

CMS Field Display Name	Data Type	Max Character Length	Description	Example Data
first_name	String	128	First name of an associate	Jake
last_name	String	128	Last name of an associate	Gayle
role*	String	512	Role of the associate	STORE_MANAGER, STORE_ASSOCIATE, etc.
store_associate_id*	String	128	Store associate ID	2036
store_type*	String	50	Store associate password	2036
store_associate_password_pin	String	512	Pin for when the password is forgotten	2036
store_id*	String	128	Store's ID	1
additional_store_ids	String	65535	Pipe-separated values of additional store IDs where the associate can log in	2021|2022
email_id	String	128	Email address of the associate	associate@predictspring.com
gender	String	7	Gender of the associate	male, female, unisex
hire_date	Number	-	Hire date in UTC milliseconds	1640995200000; for 1-Jan-2022 00:00:00, to convert the date to UTC milliseconds a data transformation rule can be added on the field mapping.
image_url	String	65535	Profile image link of the associate	https://www.imgurl/jake.png
is_active	Boolean	1	Status of the associate (active/inactive)	1=Active, 0=Inactive
merchant_password	String	256	Password of the associate in Demandware BM (or other ecomm system)	DWpwd123
merchant_user_id	String	128	User name of the associate in Demandware BM (or other ecomm system)	admin
mobile_config_token	Number	16	Corresponding app config token for the associate	1212
mobile_phone_number	String	40	Mobile phone number of the associate	(408) 555-1212
payment_device_id	String	128	Payment device ID of the associate	7777
payment_device_merchant_id	String	128	Branch account ID for payment service	7777
termination_date	Number	-	Termination date in UTC milliseconds Important The system automatically updates an associate to inactive if they attempt to log in after their termination date. For more information, see Creating Store Associates in Point of Sale CMS .	1640995200000; to convert the date to UTC milliseconds a data transformation rule can be added on the field mapping

Known Issues & Restrictions

• The feed is always a Full Feed i.e., only lines for associates where a change is required or a complete list of associates.
• To terminate an employee, you'll need to set the termination date and status as inactive (0).
• To render an associate inactive, you'll need to set the status as inactive (0). Though if an associate is on sabbatical leave, they can be rendered active based upon their return to work.
• If an associate works in all the stores, you cannot set the associate as "All" under additional_store_ids. Instead, you must set each store number (there is no limit on how many store numbers can be included in the field).
• In the initial file upload, the required Target Fields (denoted by an asterisk) must be mapped so they can be available as columns. However, they don’t need to have values and just need to line up with the schema.