Private store

Learn more about private stores.

Private store query parameters

To filter the private store response, specify one or more query parameters separated by an ampersand (&). The following topics describe the query parameters for the private store (purchase-plan). For more information on how to use query parameters, see Fields and query parameters.

Expand

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

Fields

Use the fields query parameter to specify the fields that appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response tiforSee Fields query parameter for more information and examples.

Token

The token is the authorized or anonymous token for the shopper.

Authorize private store query parameters

You can specify one or more query parameters separated by an ampersand (&) to filter the private store authorized response. The following topics describe the query parameters available for authenticating the shopper session for a private store (purchase-plan/authorize). For more information on how to use query parameters, see Fields and query parameters.

Expand

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

Fields

Use the fields query parameter to specify the fields that appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time. See the Fields query parameter for more information and examples.

Token

The token is the authorized or anonymous token for the shopper.

Search private store query parameters

To filter the private store search response, specify one or more query parameters separated by an ampersand (&). The following topics describe the query parameters available for private store search (purchase-plan/search). For more information on how to use query parameters, see Fields and query parameters.

Email address

Use the emailAddress to supply the shopper's email address you want to use for the search. This query parameter only applies to Searching for a private store.

Email domain

Use the emailDomain to supply the domain name you want to use for the search. This query parameter only applies to Searching for a private store.

emailInvitationAddress

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 private store shopper who sent the invite. This query parameter only applies to Searching for a private store.

emailInvitationPin

The PIN that is associated with an email invitation. If a private store shopper invites a friend to view a private store, the PIN is provided with the invitation. Note, Required only if emailInvitationAddress was provided. This query parameter only applies to Searching for a private store.

Expand

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

genericIdentifier

The generic identifier to use for the search. This query parameter only applies to Searching for a private store.

genericIdentifierPin

The PIN that accompanies the generic identifier for the search. This query parameter is required if provide the genericIdentifier. This query parameter only applies to Searching for a private store.

ipAddress

The IP address to use for the search. This query parameter only applies to Searching for a private store.

referralUrl

The referral URL to use for the search. This query parameter only applies to Searching for a private store.

Token

The token is the authorized or anonymous token for the shopper.