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)

Authorize a purchase plan

PreviousFind a purchase planNextApply a shopper to a cart

Last updated 11 months ago

Authorize a purchase plan

post

Authenticates a current shopper session into a specific private store. Some private stores may have more than one access rule configured.

Query parameters
tokenstringOptional

Provide the authorized or anonymous token for a shopper.

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.

Body
idstringOptionalExample: 11859200
isAuthenticationRequiredToBrowsestringOptionalExample: false
purchasePlanNamestringOptionalExample: Copy of @EmailDomain
brandDisplayNamestringOptionalExample: @EmailDomain
targetMarketIdstringOptionalExample: 35600
targetMarketNamestringOptionalExample: @EmailDomain
Responses
204
No Content.
400
* invalid-request
application/json
401
* Invalid Token
application/json
post
POST /v1/shoppers/me/purchase-plan/authorize HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "id": "11859200",
  "isAuthenticationRequiredToBrowse": "false",
  "purchasePlanName": "Copy of @EmailDomain",
  "brandDisplayName": "@EmailDomain",
  "targetMarketId": "35600",
  "targetMarketName": "@EmailDomain"
}

No content