Sign in
Purchase Plan

Retrieve a private store

Retrieve a private store matching the provided query parameters.

get/v1/shoppers/me/purchase-plan

Query parameters

tokenstring

Provide the authorized or anonymous token for a shopper.

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.

idstring
isAuthenticationRequiredToBrowsestring
purchasePlanNamestring
brandDisplayNamestring
targetMarketIdstring
targetMarketNamestring

Example response

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