Campaign

Operations for campaigns

Get page campaigns

get

Required Roles: ApiPublicQueries

Authorizations

basicAuthoAuth2apiKey

Path parameters

channelstringRequired

The channel

Query parameters

excludeProductsNotInRangebooleanOptional

Use this parameter to override the geo setting "exclude products not in range" for this request.

filterstring[]Optional

Filters for field values of returned pushed products.

idsOnlybooleanOptional

If the value true is passed, then only the record IDs will be returned, streamlining the results. Additionally, if the Geo module is enabled, the IDs of all markets the product is mapped to will be also included. If you do not need the other information in the results, this will help you to improve performance.

Default: false

latitudenumber · double · min: -90 · max: 90Optional

The latitude coordinate of the current location.

longitudenumber · double · min: -180 · max: 180Optional

The longitude coordinate of the current location.

marketIdstring[]Optional

Currently selected markets

maxDistancenumber · doubleOptional

Use this parameter to override the geo setting "maximum distance" for this request.

pageIdstringRequired

Use this parameter to pass a page ID for which you wish to obtain campaigns.

purchaserIdstringOptional

Use this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.

showMarketsbooleanOptional

Specifies whether the list of all existing markets and their distance to the search location should be included in the response. By default, the GEO setting "showMarkets" is applied.

sidstringOptional

This parameter is used to pass an id for the user session. This is important for recognising the user, if you want to trigger personalised campaigns, as well as for FACT-Finder tracking.

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /fact-finder//rest/v5/campaign/{channel}/page HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

{
  "campaigns": [
    {
      "activeQuestions": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "ad": true,
      "advisorTree": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "category": "text",
      "excludeProductsNotInMarkets": true,
      "excludeProductsNotInRange": true,
      "feedbackTexts": [
        {
          "html": true,
          "label": "product detail - below product",
          "position": 1,
          "teaser": true,
          "text": "text"
        }
      ],
      "flavour": "ADVISOR",
      "hits": [
        {
          "id": "text",
          "masterValues": {
            "ANY_ADDITIONAL_PROPERTY": {}
          },
          "variantValues": [
            {
              "ANY_ADDITIONAL_PROPERTY": {}
            }
          ]
        }
      ],
      "id": "text",
      "name": "text",
      "target": {
        "destination": "https://www.shop.de/about-us/contact.html",
        "name": "text"
      }
    }
  ],
  "geo": {
    "markets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "selectedMarkets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "showDistance": true,
    "showMarkets": true
  }
}

Get product campaigns

get

Required Roles: ApiPublicQueries

Authorizations

basicAuthoAuth2apiKey

Path parameters

channelstringRequired

The channel

Query parameters

excludeProductsNotInRangebooleanOptional

Use this parameter to override the geo setting "exclude products not in range" for this request.

filterstring[]Optional

Filters for field values of returned pushed products.

idstringRequired

Use this parameter to pass a ID (master or product) for which you wish to obtain campaigns.

idTypestring · enumOptional

Use this parameter to determine the type of ID passed to the method. Use 'productNumber' if the given ID is from the field with 'productNumber' role. Use 'id' if it is from the field with 'masterId' role.

Default: productNumberPossible values:

idsOnlybooleanOptional

If the value true is passed, then only the record IDs will be returned, streamlining the results. Additionally, if the Geo module is enabled, the IDs of all markets the product is mapped to will be also included. If you do not need the other information in the results, this will help you to improve performance.

Default: false

latitudenumber · double · min: -90 · max: 90Optional

The latitude coordinate of the current location.

longitudenumber · double · min: -180 · max: 180Optional

The longitude coordinate of the current location.

marketIdstring[]Optional

Currently selected markets

maxDistancenumber · doubleOptional

Use this parameter to override the geo setting "maximum distance" for this request.

purchaserIdstringOptional

Use this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.

showMarketsbooleanOptional

Specifies whether the list of all existing markets and their distance to the search location should be included in the response. By default, the GEO setting "showMarkets" is applied.

sidstringOptional

This parameter is used to pass an id for the user session. This is important for recognising the user, if you want to trigger personalised campaigns, as well as for FACT-Finder tracking.

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /fact-finder//rest/v5/campaign/{channel}/product HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

{
  "campaigns": [
    {
      "activeQuestions": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "ad": true,
      "advisorTree": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "category": "text",
      "excludeProductsNotInMarkets": true,
      "excludeProductsNotInRange": true,
      "feedbackTexts": [
        {
          "html": true,
          "label": "product detail - below product",
          "position": 1,
          "teaser": true,
          "text": "text"
        }
      ],
      "flavour": "ADVISOR",
      "hits": [
        {
          "id": "text",
          "masterValues": {
            "ANY_ADDITIONAL_PROPERTY": {}
          },
          "variantValues": [
            {
              "ANY_ADDITIONAL_PROPERTY": {}
            }
          ]
        }
      ],
      "id": "text",
      "name": "text",
      "target": {
        "destination": "https://www.shop.de/about-us/contact.html",
        "name": "text"
      }
    }
  ],
  "geo": {
    "markets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "selectedMarkets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "showDistance": true,
    "showMarkets": true
  }
}

Get shopping cart campaigns

get

Required Roles: ApiPublicQueries

Authorizations

basicAuthoAuth2apiKey

Path parameters

channelstringRequired

The channel

Query parameters

excludeProductsNotInRangebooleanOptional

Use this parameter to override the geo setting "exclude products not in range" for this request.

filterstring[]Optional

Filters for field values of returned pushed products.

idsOnlybooleanOptional

If the value true is passed, then only the record IDs will be returned, streamlining the results. Additionally, if the Geo module is enabled, the IDs of all markets the product is mapped to will be also included. If you do not need the other information in the results, this will help you to improve performance.

Default: false

latitudenumber · double · min: -90 · max: 90Optional

The latitude coordinate of the current location.

longitudenumber · double · min: -180 · max: 180Optional

The longitude coordinate of the current location.

marketIdstring[]Optional

Currently selected markets

maxDistancenumber · doubleOptional

Use this parameter to override the geo setting "maximum distance" for this request.

productNumberstring[]Required

Use this parameter to pass product ID(s) for which you wish to obtain campaigns.

purchaserIdstringOptional

Use this parameter to pass the purchaser ID. This ID is only needed, if the 'Customer-Specific Info' module is active. Otherwise it will be ignored.

showMarketsbooleanOptional

Specifies whether the list of all existing markets and their distance to the search location should be included in the response. By default, the GEO setting "showMarkets" is applied.

sidstringOptional

This parameter is used to pass an id for the user session. This is important for recognising the user, if you want to trigger personalised campaigns, as well as for FACT-Finder tracking.

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /fact-finder//rest/v5/campaign/{channel}/shoppingcart HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Accept: */*

{
  "campaigns": [
    {
      "activeQuestions": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "ad": true,
      "advisorTree": [
        {
          "answers": [
            "[Circular Reference]"
          ],
          "id": "text",
          "text": "text",
          "visible": true
        }
      ],
      "category": "text",
      "excludeProductsNotInMarkets": true,
      "excludeProductsNotInRange": true,
      "feedbackTexts": [
        {
          "html": true,
          "label": "product detail - below product",
          "position": 1,
          "teaser": true,
          "text": "text"
        }
      ],
      "flavour": "ADVISOR",
      "hits": [
        {
          "id": "text",
          "masterValues": {
            "ANY_ADDITIONAL_PROPERTY": {}
          },
          "variantValues": [
            {
              "ANY_ADDITIONAL_PROPERTY": {}
            }
          ]
        }
      ],
      "id": "text",
      "name": "text",
      "target": {
        "destination": "https://www.shop.de/about-us/contact.html",
        "name": "text"
      }
    }
  ],
  "geo": {
    "markets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "selectedMarkets": [
      {
        "distance": 1,
        "hasProducts": true,
        "id": "text",
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "searchParams": {
          "activeAbTests": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "advisorStatus": {
            "answerPath": "_0_0_0_1",
            "id": "text"
          },
          "articleNumberSearch": "DETECT",
          "customParameters": [
            {
              "cacheIrrelevant": true,
              "name": "text",
              "values": [
                "text"
              ]
            }
          ],
          "exactSearchMode": "LEGACY",
          "excludeProductsNotInRange": true,
          "filters": [
            {
              "filterWarning": "NON_EXISTING_FIELD",
              "name": "text",
              "substring": true,
              "values": [
                {
                  "exclude": true,
                  "type": "or",
                  "value": "text"
                }
              ]
            }
          ],
          "followSearch": "text",
          "hitsPerPage": 1,
          "location": {
            "latitude": 1,
            "longitude": 1
          },
          "marketIds": [
            "text"
          ],
          "maxCountVariants": 1,
          "maxDistance": 1,
          "page": 1,
          "purchaserId": "text",
          "query": "text",
          "searchField": "text",
          "showMarkets": true,
          "showPermutedSearchParams": true,
          "sortItems": [
            {
              "name": "text",
              "order": "asc"
            }
          ],
          "splitDocumentsAt": 1
        },
        "selected": "TRUE"
      }
    ],
    "showDistance": true,
    "showMarkets": true
  }
}