Get Search Campaigns

Get list of Search campaigns.

GET /commerce/catalog/storefront/campaigns/all

Error

A valid request URL is required to generate request examples

200

[
  {
    "auditInfo": {
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "updateDate": "2023-11-07T05:31:56Z"
    },
    "campaignDescription": "<string>",
    "campaignEndDate": "2023-11-07T05:31:56Z",
    "campaignId": "<string>",
    "campaignName": "<string>",
    "campaignStartDate": "2023-11-07T05:31:56Z",
    "json": "<string>",
    "listingSettings": {
      "fieldValueBoost": {
        "boostType": "<string>",
        "fields": [
          {
            "fieldName": "<string>",
            "valueExpressions": [
              {
                "boost": 123,
                "operator": "<string>",
                "value": "<string>"
              }
            ]
          }
        ]
      }
    },
    "productSuggestSettings": {
      "fieldValueBoost": {
        "boostType": "<string>",
        "fields": [
          {
            "fieldName": "<string>",
            "valueExpressions": [
              {
                "boost": 123,
                "operator": "<string>",
                "value": "<string>"
              }
            ]
          }
        ]
      },
      "searchTermAssociations": [
        "<string>"
      ]
    },
    "siteId": 123,
    "siteSearchSettings": {
      "fieldValueBoost": {
        "boostType": "<string>",
        "fields": [
          {
            "fieldName": "<string>",
            "valueExpressions": [
              {
                "boost": 123,
                "operator": "<string>",
                "value": "<string>"
              }
            ]
          }
        ]
      },
      "searchTermAssociations": [
        "<string>"
      ]
    },
    "statusId": 123,
    "tenantId": 123
  }
]

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

auditInfo · object

Show child attributes

campaignDescription · string | null

campaignEndDate · string<date-time> | null

campaignId · string | null

campaignName · string | null

campaignStartDate · string<date-time> | null

json · string | null

listingSettings · object

Show child attributes

productSuggestSettings · object

Show child attributes

siteId · integer<int32>

siteSearchSettings · object

Show child attributes

statusId · integer<int32> | null

tenantId · integer<int32>