Customer external reference identifier ERID

Understand the customer ERID.

The Remote User Management (also known as SSO) service requires an externalReferenceID as a customer identifier.

You must specify a unique externalReferenceID for each user because several objects use it. Failure to do so may violate your contract with Digital River and will cause users to get cross-linked.

You must specify a unique inbound userKey (in response to LoginRequest, GetUserRequest) for each user in the clients' database.

Using an external reference identifier for a customer

When you create a customer, you can specify the external reference ID. You can also update a customer using the POST /shoppers/me resource.

Specifying an external reference identifier when creating and getting a customer

The shopper object in the payload for a POST /shoppers request (where the client maintains the login credentials) includes an externalReferenceId as shown in line 5:

Payload example

{
 		"shopper": {
 			"firstname": "John",
			"lastname": "Johnson",
 			"externalreferenceid": "abc123",
 			"emailaddress": "[e-mail]",
 			"locale": "en_US",
 			"currency": "USD"
	 	}
 }

When you use the apShoppers resource to get a customer, you can use the expand query parameter to get the customer's external reference identifier. The GET does not return the external reference identifier field by default. Refer to the Shopper resource for more information about getting and creating customers.

Create a full access token using the external reference identifier

For the Client Credentials confidential flow only, you can create a full access token on behalf of a customer by passing in the external_reference_id form parameter in the payload:

Payload example

grant_type=client_credentials&dr_external_reference_id=partner-shopper-id

For more information, see POST oauth20/token under the Token API.