latestOpenAPI 3.0.02026-08-101013821017.9 KB

4b69392f93b9

Purchase Plan Search

Search for a purchase plan

Search for private store matching the provided query parameters.

get/v1/shoppers/me/purchase-plan/search

Query parameters

tokenstring

Provide the authorized or anonymous token for a shopper.

emailAddressstring

Provide the email address to use for the search.

emailDomainstring

Provide the email domain to use for the search.

emailInvitationAddressstring

Provide an email address associated with an invitation to a private store. When a private store shopper invites a friend to view a private store, the invitation email address belongs to the inviter.

emailInvitationPinstring

Provide a PIN associated with an email invitation. If a private store shopper invites a friend to view a private store, the PIN belongs to the invitation. Note that the emailInvitationPin is required when you provide the emailInvitationAddress.

genericIdentifierstring

Provide the generic identifier to use for the search.

genericIdentifierPinstring

Provide the PIN associated with the generic identifier for the search. Note that the genericIdentifierPin is required when you provide the genericIdentifier.

ipAddressstring

Provide the IP address to use for the search.

referralUrlstring

Provide the referral URL to use for the search.

expandstring

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.

fieldsstring

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

Response

Successful response.

uristring
totalResultsstring

Example response

{
  "uri": "https://api.digitalriver.com/v1/shoppers/me/purchase-plan/search",
  "purchasePlan": [
    {
      "currency": "USD",
      "value": "19.99"
    }
  ],
  "totalResults": "2"
}