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).

curl --location --request PUT 'https://staging.predictspring.com/service/merchant/v1/associates/bulk' \
--header 'PredictSpring-API-Key: 5vQyY72pGz8jLwMh3k' \
--header 'PredictSpring-MerchantID: SHOPNOW20140910' \
--header 'PredictSpring-Locale: en_US' \
--header 'PredictSpring-Region: US' \
--header 'PredictSpring-Username: user@predictspring.com' \
--header 'Content-Type: application/json' \
--data-raw '{
    "associateList": [
        {
            "firstName": "Richard",
            "lastName": "Britto",
            "role": "STORE_MANAGER",
            "storeAssociateID": "9000102",
            "storeID": "1920",
            "gender": "Male",
            "hireDate": 1679081600000,
            "emailId": "rb@gmail.com",
            "storeType": "Retail",
            "active": false,
            "storeAssociatePassword": "200000Es",
            "storeAssociatePasswordPin": "1234"
        }
     ]
}'

Create Associates

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

curl --location 'https://staging.predictspring.com/service/merchant/v1/associates/bulk' \
--header 'PredictSpring-API-Key: 5vQyY72pGz8jLwMh3k' \
--header 'PredictSpring-MerchantID: SHOPNOW20140910' \
--header 'PredictSpring-Locale: en_US' \
--header 'PredictSpring-Region: US' \
--header 'PredictSpring-Username: user@predictspring.com' \
--header 'Content-Type: application/json' \
--data-raw '{
    "associateList": [
        {
            "firstName": "Richard",
            "lastName": "Britto",
            "role": "STORE_MANAGER",
            "storeAssociateID": "9000101",
            "storeID": "1920",
            "gender": "Male",
            "hireDate": 1679081600000,
            "emailId": "rb@gmail.com",
            "storeType": "Retail",
            "active": false,
            "storeAssociatePassword": "200000Es",
            "storeAssociatePasswordPin": "1234"
        }
     ]
}'

Update Associates

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

curl --location --request PATCH 'https://staging.predictspring.com/service/merchant/v1/associates/bulk' \
--header 'PredictSpring-API-Key: 5vQyY72pGz8jLwMh3k' \
--header 'PredictSpring-MerchantID: SHOPNOW20140910' \
--header 'PredictSpring-Locale: en_US' \
--header 'PredictSpring-Region: US' \
--header 'PredictSpring-Username: user@predictspring.com' \
--header 'Content-Type: application/json' \
--data '{
    "associateList": [
        {
            "storeAssociateID": "2025",
            "storeAssociatePassword": "2026"
        }
    ]
}'