Bulk APIs for Creating & Updating Store Associates

Point of Sale provides a set of bulk APIs to create, update, or upsert multiple store associates at once. The bulk endpoint supports three main operations:

Create new or update existing associates based on storeAssociateID
Create new associates in bulk
Update existing associates

Upsert Associates (Create or Update)

Use this PUT request to create a new associate (if the ID doesn’t exist) or update the existing associate (if the ID exists).

1curl --location --request PUT 'https://staging.predictspring.com/service/merchant/v1/associates/bulk' \
2--header 'PredictSpring-API-Key: 5vQyY72pGz8jLwMh3k' \
3--header 'PredictSpring-MerchantID: SHOPNOW20140910' \
4--header 'PredictSpring-Locale: en_US' \
5--header 'PredictSpring-Region: US' \
6--header 'PredictSpring-Username: user@predictspring.com' \
7--header 'Content-Type: application/json' \
8--data-raw '{
9    "associateList": [
10        {
11            "firstName": "Richard",
12            "lastName": "Britto",
13            "role": "STORE_MANAGER",
14            "storeAssociateID": "9000102",
15            "storeID": "1920",
16            "gender": "Male",
17            "hireDate": 1679081600000,
18            "emailId": "rb@gmail.com",
19            "storeType": "Retail",
20            "active": false,
21            "storeAssociatePassword": "200000Es",
22            "storeAssociatePasswordPin": "1234"
23        }
24     ]
25}'

Create Associates

Use this POST request to create new associates. Each storeAssociateID must be unique and must not exist in the system yet.

1curl --location 'https://staging.predictspring.com/service/merchant/v1/associates/bulk' \
2--header 'PredictSpring-API-Key: 5vQyY72pGz8jLwMh3k' \
3--header 'PredictSpring-MerchantID: SHOPNOW20140910' \
4--header 'PredictSpring-Locale: en_US' \
5--header 'PredictSpring-Region: US' \
6--header 'PredictSpring-Username: user@predictspring.com' \
7--header 'Content-Type: application/json' \
8--data-raw '{
9    "associateList": [
10        {
11            "firstName": "Richard",
12            "lastName": "Britto",
13            "role": "STORE_MANAGER",
14            "storeAssociateID": "9000101",
15            "storeID": "1920",
16            "gender": "Male",
17            "hireDate": 1679081600000,
18            "emailId": "rb@gmail.com",
19            "storeType": "Retail",
20            "active": false,
21            "storeAssociatePassword": "200000Es",
22            "storeAssociatePasswordPin": "1234"
23        }
24     ]
25}'

Update Associates

Use this PATCH request to update existing associates. Only provide the fields you want to update.

1curl --location --request PATCH 'https://staging.predictspring.com/service/merchant/v1/associates/bulk' \
2--header 'PredictSpring-API-Key: 5vQyY72pGz8jLwMh3k' \
3--header 'PredictSpring-MerchantID: SHOPNOW20140910' \
4--header 'PredictSpring-Locale: en_US' \
5--header 'PredictSpring-Region: US' \
6--header 'PredictSpring-Username: user@predictspring.com' \
7--header 'Content-Type: application/json' \
8--data '{
9    "associateList": [
10        {
11            "storeAssociateID": "2025",
12            "storeAssociatePassword": "2026"
13        }
14    ]
15}'