Purchase Plan Authorize

The Purchase Plan Authorize API provides the ability to authorize a shopper session into a specific purchase plan. Use the Purchase Plan Search API to locate the purchase plans targeted toward a customer market. See Purchase Plan Workflow for more information.

Methods


					Host: api.digitalriver.com
User-Agent: API Client/1.0
Accept: */*
Authorization: bearer your_access_token
			
					<purchasePlanAuthorize>
    <id>your_purchase_plan_ID</id>
    <targetMarketId>99999</targetMarketId>
    <emailDomain>university.edu</emailDomain>
</purchasePlanAuthorize>
			
					HTTP/1.1 204 No Content
			
					The response body should be empty.
			

Request Body Parameters

Field
Data Type
Visibility
Description
emailAddress strign default The email address associated with the purchase plan. The microstore (target market) uses the emailAddress as an access rule.
emailDomain
string
default
The email domain associated with the purchase plan.
emailInvitationAddress string default The email invitation address associated with the purchase plan. The microstore uses the emailInvitationAddress as an access rule. The emailInvitationAddress requires the emailInvitationPin.
emailInvitationPin string default The email invitation pin associated with the purchase plan. 
genericIdentifier string default The generic identifier associated with the purchase plan. The microstore uses the genericIdentifier as an access rule. The genericIdentifier requires the genericIdentifierPin.
genericIdentifierPin string default The generic identifier associated with the purchase plan. 
id
string
default
The purchase plan ID.
ipAddresss string default The IP address associated with the purchase plan. The microstore uses the ipAddress as an access rule.
referralUrl string default The referral URL associated with the purchase plan. The microstore uses the referralUrl as an access rule.
targetMarketId
string
default
The target market ID.