Useful APIs

Learn about the most useful APIs when managing a Private Store.

Get access token by session token

Request
Request
GET /shoppers/token.json?apiKey={{client_id}}&session_token={{session_token}}
Authorization: {{apikey_secret_authr}}

Check if the access token is authenticated

Request
Request
GET /oauth20/access-tokens.json?token={{access_token}}
Authorization: {{apikey_secret_authr}}

Search for a private store

When you search for a Private Store, the id for purchasePlanAuthorize and the targetMarketId appears in the response. When you search for a Private Store, you need to provide id for the purchasePlanAuthorize and the targetMarketId in the request. Unless you frequently create and edit private stores, this step is not required. You should store or cache these attributes on your side.

HTTP
HTTP
"purchasePlanAuthorize":{
"id":"4912758700",
"targetMarketId":"4897371800",
}
}