Get campaign sites

Shop API v1
GET*base*/campaign-sites
GET*base*/campaign-sites/*campaignSiteURI*
Authentication:API key

Fetches a specific campaign site referenced by its name, or the full campaign sites list.

If the campaignSiteURI parameter is specified, one campaign site is fetched, otherwise all campaign sites are fetched.

Parameters

campaignSiteURI

string
optional
Campaign Site URI, unique key for this campaign site.

Response

200 Content-type: application/json

object key

campaign site object
required

The campaignSiteURI for the campaign site object.

"canada": {"name": "Canada"} for campaign site with URI canada.

name

string
The name of the campaign site.

market

string
The market ID that should be set for the customer.

goTo

string
The URL the customer should be redirected to after the market has been set.

campaignSite

string
The URI for this campaign site.

Response example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
HTTP/1.1 200 OK
Content-type: application/json

{
   "canada" : {
      "market" : "16",
      "name" : "canada",
      "goTo" : "",
      "campaignSite" : "canada"
   }
}

Error example

1
2
3
4
5
6
7
8
HTTP/1.1 404 Not Found
Content-type: application/json

{
   "errors" : {
      "campaignSite" : "not found"
   }
}