Managing private stores

Lear how to manage private stores.

Managing a private store requires understanding the intricacies of API interactions to effectively access, modify, and monitor the store's settings and data. This guide aims to equip you with the knowledge to perform these operations seamlessly, focusing on authentication, fetching store details, updating configurations, and handling responses. Whether you're enhancing your backend systems or improving the user experience on the front end, the upcoming sections will guide you through each step with practical examples and code snippets. Get ready to unlock the full potential of your private store through precise and efficient API calls.

Getting a private store

Accessing the details of a private store is a straightforward process that involves making a REST API request. The following instructions will guide you through the process, whether you are integrating with your backend systems or querying for details to present in a user interface. Ensure you have your API key secret, as it's crucial for authorization.

Use the GET /v1/shoppers/me/purchase-plan to retrieve the details for a private store. Replace {YOUR_ACCESS_TOKEN} with your API key secret for authorization.

cURL

curl --location --request GET 'https://api.digitalriver.com/v1/shoppers/me/purchase-plan' \
--header 'authorization: bearer {Your_Access_token}\
...

200 OK response

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

See Purchase private store parameters for more information.

Searching for a private store

When accessing a private store's specifics is required, having an efficient search functionality is crucial. This section outlines the methodology to accurately search for a private store using specific identifiers and target market IDs. Following the steps, you can leverage the private store search capabilities to locate and retrieve essential details about any private store within your network. This process includes using an API key for secure authentication and demonstrates how to format your search requests to receive accurate data in response. Whether you're working on backend integration or enhancing user interfaces, these instructions will facilitate a smooth search operation for private stores.

To search for a private store, follow these steps:

1. Use the GET /v1/shoppers/me/purchase-plan/search request to start your search and include the appropriate query parameter. For more information, see Search private store query parameters.

2. Replace {YOUR_ACCESS_TOKEN} with your API key secret for authorization.

3. In the request body, specify the purchasePlanAuthorize object, including:

   • id: The ID of the purchasePlanAuthorize.

   • targetMarketId: The target market ID relevant to your private store.

Upon successful search, you will receive a 200 OK response containing details about the private store, such as the purchase plan and total results.

cURL

curl --location --request GET 'https://api.digitalriver.com/v1/shoppers/me/purchase-plan/search' \
--header 'authorization: bearer {Your_Access_token}\
...
--data-raw '{
    "purchasePlanAuthorize":{
        "id": "4912758700",
        "targetMarketId": "4897371800",
    }
}

200 OK response

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

Authorizing a purchase plan

Managing access to exclusive content or services through private stores is vital for maintaining a competitive edge and enhancing customer satisfaction in the ever-evolving eCommerce landscape. Authorizing a purchase plan is a critical step to authenticate a shopper's session, ensuring they gain access to specific private stores tailored to their needs. This guide provides a comprehensive overview of how to authorize a purchase plan, detailing the process and necessary steps to authenticate a current shopper session for access to a designated private store. Whether you are managing a single private store or multiple with varying access rules, understanding how to authorize a purchase plan effectively is key to streamlining your digital commerce operations.

Use POST /v1/shoppers/me/purchase-plan/-authorize to authenticate the current shopper session for a specific private store. Note that some private stores may have more than one configured access rule. Refer to this method for efficiently managing access to your private stores, especially when dealing with multiple access rules or frequently changing store configurations.

To authorize a purchase plan, ensuring that the current shopper session is authenticated for a specific private store, send the POST /v1/shoppers/me/purchase-plan/-authorize request to authorize a purchase plan. Replace {Your_Access_token} with your API key secret for authorization and any other required headers or body parameters to identify the private store and purchase plan. See Authorize private store query parameters for more information. For detailed instructions and endpoints, visit our API documentation's Authorize a purchase plan section.

cURL

curl --location --request GET 'https://api.digitalriver.com/v1/shoppers/me/purchase-plan/authorize' \
--header 'authorization: bearer {Your_Access_token}\
...

204 No Content

You will receive a 204 No Content response.

Upon a successful authorization request, you will receive a 204 No Content response. This indicates that the purchase plan has been successfully authorized for the current shopper session, and no further action is required.