Purchase Plan Search

The Purchase Plan Search API is a process resource that allows searches for purchase plans by query parameters that correspond to configured access rules. Types of access rules can include generic identifiers, email addresses, IP addresses, and referral URLs. A purchase plan provides special pricing on specific products for a selected group of shoppers. A purchase plan limits purchases to shoppers who have been authorized by a purchase plan. After using the Purchase Plan Search API  to locate matching purchase plans, you can use the Purchase Plan Authorize API to authorize the shopper session into a specific purchase plan.

Accessing the Purchase Plan Search API does not require an access token; however, you must pass a public API key as a query parameter along with the access rule search criteria. If you have a confidential API key, you must get an access token prior to searching for a purchase plan. After locating a purchase plan for a potential customer, use the Purchase Plan Authorize API to authorize the current shopper session into the purchase plan. The Purchase Plan Authorize API requires an access token.

Methods


					Host: api.digitalriver.com
User-Agent: API Client/1.0
Accept: */*
Authorization: bearer your_access_token
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			

Response Body Parameters

Field
Data Type
Visibility
Description
brandDisplayName
string
default
The brand name associated with the purchase plan.
brandLogoImage
uri default
A link to the brand logo associated with the purchase plan.
brandDisplayName string default Brand display name 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.
purchasePlanName
string
default
The name of the purchase plan.
targetMarketId
string
default
The target market ID.
tartgetMarketName
string
default
The name of the target market.