Bulk User Management Service Details

The Bulk User Management service provides a batch interface that third-party applications and any other processes can use to manage Digital River-hosted user information in bulk form.

A few points to remember:

  • BulkUserManagement performs a secure operation. A loginID and password are required for any BulkUserManagement operation. At the start of file processing, a user will be authorized using the provided loginID and password. After a user is authorized, the complete file will be processed.
  • For optimal performance, a Bulk User Management file should not exceed 10,000 records per file.
  • You must configure Bulk User Management per site.

Supported Bulk User Management tasks include:

Note:

The shopperKey is a required field for all Bulk User Management tasks.

  • Activate users—Activate the existing users.
  • Inactivate users—Inactivate the existing active users.
  • Reset user password—Resets a user's password.
  • Get user information—Get information about the Digital River-hosted shoppers.
  • Add or update users—Add new users to or update existing users in the Digital River system. See Add Users and Update Users for more information.
  • Cancel subscriptions—Deactivate subscriptions for requisitions received in a request.
  • Activate subscriptions—Activate subscriptions for requisitions received in a request.
  • Modify renewal date of subscriptions—Modify the renewal date of subscriptions. The subscriptions will be set to expire on the requested renewal date as passed in by the client. The renewal reminder notification will be sent to the shopper "n" (n=3, 4, or 5) days before the expiration date of the subscription. This "n" days prior renewal reminder will be set as a product-level attribute.

    Note:

    You can send this call at any time. It has no restrictions other than you cannot set the renewal date earlier than the current date and make a call for a cancelled or returned line item.

  • Modify renewal mechanism for a subscription (manual or auto)—Modify the subscription renewal process. The valid values are as follows:
    • Auto—Converts a subscription to auto-renewal.
    • Manual—Converts a subscription to manual renewal.
    • Inactive—Converts a subscription to inactive. 
  • Cancel users' orders—Cancel the users' orders for the requisition or line item received in the request.

Add Users

The following table displays the minimum required fields when adding users.

Parent Element
Child Element
Grand-child Element
shopperKey
companyID

loginID

siteID

billingOptionToBeAddedOrUpdated
nickName

isDefault

billingOptionType

addressBookEntiresToBeAddedOrUpdated
nickName

isDefault

address
city
countryA2
country
countryName
line1
postalCode

Note:

The addressID is not required. The system generates the addressID for the new shopper.

Update Users

The following table displays the minimum required fields when updating users.

Parent Element
Child Element
Grand-child Element
shopperKey
userID OR 
(externalReferenceID AND siteID) OR 
(externalReferenceID AND companyID)OR 
(loginID AND siteID)

billingOptionToBeAddedOrUpdated
key
billingOptionID
nickName

isDefault

billingOptionType

billingOptionToBeDeleted
billingOptionID

addressBookEntiresToBeAddedOrUpdated
key
addressBookEntryID
nickName

isDefault

address

addressBookEntriesToBeDeleted
addressBookEntryID