LogoLogo
Shopper APIs reference
Shopper APIs reference
  • Shopper APIs reference
  • OAuth
    • Tokens
    • Access tokens
  • Shoppers
    • Shoppers
    • Addresses
    • Payment options
  • Browse (product discovery)
    • Categories
    • Products
    • Product variations
    • Pricing
    • Inventory status
    • Financing
    • Offers
    • Purchase plan
    • Find a purchase plan
    • Authorize a purchase plan
  • Cart
    • Apply a shopper to a cart
    • Line items
    • Billing address
    • Shipping address
    • Payment methods
    • Shipping options
    • Web checkout
    • Submit a cart
    • Apply or detach payment methods
    • Apply a shipping option
    • Carts
    • Cart offers
    • API trigger offer
    • Resume cart
    • Third-party subscription engine
    • Tax registration
    • Price override
  • Orders
    • Orders
    • Order lookup
    • Order address
    • Returns
  • Subscriptions
    • Manage a subscription
    • Manage the subscription's renewal plan
    • Immediate midterm change
    • Payment
    • Address
    • Orders
    • Pending actions
    • Retrieve subscriptions
    • Subscription billing and shipping addresses
Powered by GitBook
On this page
  1. Browse (product discovery)

Find a purchase plan

PreviousPurchase planNextAuthorize a purchase plan

Last updated 11 months ago

Search for a purchase plan

get

Search for private store matching the provided query parameters.

Query parameters
tokenstringOptional

Provide the authorized or anonymous token for a shopper.

emailAddressstringOptional

Provide the email address to use for the search.

emailDomainstringOptional

Provide the email domain to use for the search.

emailInvitationAddressstringOptional

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.

emailInvitationPinstringOptional

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.

genericIdentifierstringOptional

Provide the generic identifier to use for the search.

genericIdentifierPinstringOptional

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

ipAddressstringOptional

Provide the IP address to use for the search.

referralUrlstringOptional

Provide the referral URL to use for the search.

expandstringOptional

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.

fieldsstringOptional

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.

Responses
200
Successful response.
application/json
400
* Invalid Request
application/json
401
* Invalid Token
application/json
get
GET /v1/shoppers/me/purchase-plan/search HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
  "uri": "https://api.digitalriver.com/v1/shoppers/me/purchase-plan/search",
  "purchasePlan": [
    {
      "currency": "USD",
      "value": "19.99"
    }
  ],
  "totalResults": "2"
}