Purchase Plan

The Purchase Plan API provides the functionality behind API-driven private stores. A private store is an online store that caters exclusively to a known group of customers. The private store offers a custom shopping experience with special discounts or merchandising offers. The site owner, who has a Private Store Manager role in Global Commerce, configures private stores at the site level. In the Digital River Command Consoles, private stores were formerly called purchase plans and the APIs reflect the former nomenclature in version 1 (v1). Private stores allow sites to target segmented shoppers, called a target market. Sites can deploy, rotate, and retire private stores to suit current product marketing trends. A purchase plan limits purchases to shoppers who have been authorized by a purchase plan. 

Access Rules

Access rules control the authorization of shoppers allowed to shop within a private store. Use the following access rules to validate a shopper's access to a purchase plan:

  • Email Address–Determines access based on an email address of a shopper.
  • Email Domain–Determines access based on email domain. A shopper's email address must use a domain designated for the purchase plan.
  • Email Invitation–Determines access based on an email invitation from an authorized purchase plan shopper to another potential shopper.
  • Generic Identifier–Determines access based on a generic ID and PIN that is the same for all shoppers.
  • IP Address–Determines access based on the IP address of the shopper or an IP address range. A shopper must be on a network using a specific IP address or an IP address within a defined range.
  • Referral URL–Determines access based on the URL a shopper clicked to access a purchase plan.

For tighter security, a private store manager can configure multiple access rules. If your store requires more flexibility with authorizing shoppers via access rules, contact your Digital River representative.

See Purchase Plan Workflow for more information.

Methods


					Host: api.digitalriver.com
Accept: application/json
Authorization: bearer your_access_token
User-Agent: Apache-HttpClient/4.5.2 (Java/1.8.0_102)
			
					The request body should be empty.
			
					Content-Length: 455
			
					{
    "purchasePlan": {
        "uri": "https://dispatch-test.digitalriver.com/v1/shoppers/me/purchase-plan",
        "id": purchase_plan_ID,
        "isAuthenticationRequiredToBrowse": "true",
        "purchasePlanName": "@Email",
        "purchasePlanDescription": "@Email",
        "brandDisplayName": "@Email - Target Market",
        "brandLogoImage": null,
        "targetMarketId": target_market_ID,
        "targetMarketName": "@Email",
        "puchasePlanActivationType": "EmailAddress"
    }
}
			

Response Body Parameters

Field
Data Type
Visibility
Description
brandDisplayName
string
default
The brand name associated with the purchase plan.
brandLogoImage
link
default
A link to the brand logo associated with the purchase plan.
emailDomain
string
default
The email domain associated with the purchase plan.
id
string
default
The purchase plan ID.
isAuthenticationRequiredToBrowse
Boolean
default
When true, authentication is required to browse.
purchasePlanActivationType
string
default
Specifies how the purchase plan is activated.
purchasePlanName
string
default
The name of the purchase plan.
purchasePlanDescription
string
default
A description of the purchase plan.
targetMarketId
string
default
The target market ID.
tartgetMarketName
string
default
The name of the target market.