Skip to main content
GET
/
commerce
/
catalog
/
storefront
/
campaigns
/
{campaignId}
Error
A valid request URL is required to generate request examples
{
  "tenantId": 123,
  "siteId": 123,
  "campaignName": "<string>",
  "campaignId": "<string>",
  "json": "<string>",
  "campaignDescription": "<string>",
  "campaignStartDate": "2023-11-07T05:31:56Z",
  "campaignEndDate": "2023-11-07T05:31:56Z",
  "statusId": 123,
  "siteSearchSettings": {
    "searchTermAssociations": [
      "<string>"
    ],
    "fieldValueBoost": {
      "boostType": "<string>",
      "fields": [
        {
          "fieldName": "<string>",
          "valueExpressions": [
            {
              "value": "<string>",
              "boost": 123,
              "operator": "<string>"
            }
          ]
        }
      ]
    }
  },
  "productSuggestSettings": {
    "searchTermAssociations": [
      "<string>"
    ],
    "fieldValueBoost": {
      "boostType": "<string>",
      "fields": [
        {
          "fieldName": "<string>",
          "valueExpressions": [
            {
              "value": "<string>",
              "boost": 123,
              "operator": "<string>"
            }
          ]
        }
      ]
    }
  },
  "listingSettings": {
    "fieldValueBoost": {
      "boostType": "<string>",
      "fields": [
        {
          "fieldName": "<string>",
          "valueExpressions": [
            {
              "value": "<string>",
              "boost": 123,
              "operator": "<string>"
            }
          ]
        }
      ]
    }
  },
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

campaignId
string
required

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

Success

Campaign result from db

tenantId
integer<int32>
siteId
integer<int32>
campaignName
string | null
campaignId
string | null
json
string | null
campaignDescription
string | null
campaignStartDate
string<date-time> | null
campaignEndDate
string<date-time> | null
statusId
integer<int32> | null
siteSearchSettings
object
productSuggestSettings
object
listingSettings
object
auditInfo
object