Get details for a campaign

Get details for a campaign

Required permissions: CAMPAIGN

get

/tenants/{tenantUid}/campaigns/{campaignUid}

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

campaignUidstringRequired

Reference to a campaign.

Pattern: ^[A-Za-z0-9-_]+

Responses

200

Example response

application/json

namestringRequired

statusstring · enumRequired

ENUM	Description
NEW	Campaign is in a modeling state. Can be modified
ACTIVE	Campaign is active, and is considered when making sales operations. Campaign can not be modified
CLOSED	Campaign is closed.

Possible values:

displayNamestringRequired

validFromstring · date-timeRequired

validTostring · date-timeRequired

typestring · enumRequired

ENUM	Description
CAMPAIGN	Normal campaign with rules set
PRICELIST	A campaign that includes a pricelist. No rules applies

Possible values:

discountTypestring · enumRequired

ENUM	Description
CHEAPEST_PRODUCT	Cheapest product will be discounted
QUALIFIED_PRODUCT	All qualified products will be discounted
ORDER_DISCOUNT	An order discount will be added to the order

Possible values:

quantityThresholdintegerRequired

amountThresholdintegerRequired

discountAmountintegerRequired

discountPercentintegerRequired

maxUsageintegerRequired

priorityintegerRequired

campaignUidstringRequiredPattern: ^[A-Za-z0-9-_]+

campaignCodestringRequired

preventCombinationsbooleanRequired

get/tenants/{tenantUid}/campaigns/{campaignUid}

GET /v2/tenants/{tenantUid}/campaigns/{campaignUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "name": "text",
  "status": "NEW",
  "displayName": "text",
  "validFrom": "2026-01-01T00:00:00.000Z",
  "validTo": "2026-01-01T00:00:00.000Z",
  "type": "CAMPAIGN",
  "discountType": "CHEAPEST_PRODUCT",
  "selection": {
    "include": {
      "productGroups:": [
        {
          "productGroupUid": "text",
          "name": "text"
        }
      ],
      "brands": [
        {
          "brandUid": "text",
          "name": "text"
        }
      ],
      "categories": [
        {
          "categoryUid": "text",
          "name": "text"
        }
      ],
      "products": [
        {
          "productUid": "text",
          "name": "text",
          "sku": "text"
        }
      ]
    },
    "exclude": {
      "productGroups:": [
        {
          "productGroupUid": "text",
          "name": "text"
        }
      ],
      "brands": [
        {
          "brandUid": "text",
          "name": "text"
        }
      ],
      "categories": [
        {
          "categoryUid": "text",
          "name": "text"
        }
      ],
      "products": [
        {
          "productUid": "text",
          "name": "text",
          "sku": "text"
        }
      ]
    }
  },
  "quantityThreshold": 1,
  "amountThreshold": 1,
  "discountAmount": 1,
  "discountPercent": 1,
  "maxUsage": 1,
  "priority": 1,
  "pricelist": {
    "pricelistUid": "text",
    "name": "text"
  },
  "stores": [
    {
      "storeUid": "text",
      "name": "text"
    }
  ],
  "campaignUid": "text",
  "campaignCode": "text",
  "preventCombinations": true,
  "customerGroup": {
    "customerGroupUid": "text",
    "name": "text"
  }
}