Campaign

PreviousCaching NextCategories

Was this helpful?

Get details for a campaign

get

Get details for a campaign

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

campaignUidstringrequired

Reference to a campaign.

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

Responses

application/json

objectoptional

get

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": "2025-04-18T01:08:30.568Z",
  "validTo": "2025-04-18T01:08:30.568Z",
  "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
}

Delete an existing campaign

delete

Delete an existing campaign

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

campaignUidstringrequired

Reference to a campaign.

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

Responses

delete

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

204

No Content

List products for a campaign

get

List products for a campaign

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

campaignUidstringrequired

Reference to a campaign.

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

Query parameters

pageNumberintegeroptional

Reference to a specific page in a result set.

pageSizeintegeroptional

The number of items per page in a result set.

sortBystringoptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumoptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Available options:

selectionstring · enumoptional

ENUM	Description
INCLUDE	Query for included products in campaign
EXCLUDE	Query for excluded products in campaign

Available options:

Responses

application/json

objectoptional

get

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

200

Example response

{
  "items": [
    {
      "productUid": "text",
      "name": "text",
      "sku": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Get list of campaigns

get

Get list of campaigns

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Query parameters

pageNumberintegeroptional

Reference to a specific page in a result set.

pageSizeintegeroptional

The number of items per page in a result set.

sortBystringoptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumoptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Available options:

namestringoptional

Reference to a name

displayNamestringoptional

Reference to a display name

campaignCodestringoptional

Reference to a campaign code

validFromstring · date-timeoptional

Reference to a valid from

validTostring · date-timeoptional

Reference to a valid to

typestring · enumoptional

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

Available options:

discountTypestring · enumoptional

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

Available options:

Responses

application/json

objectoptional

get

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

200

Example response

{
  "items": [
    {
      "name": "text",
      "status": "NEW",
      "displayName": "text",
      "validFrom": "2025-04-18T01:08:30.568Z",
      "validTo": "2025-04-18T01:08:30.568Z",
      "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
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Search for campaigns

post

Search for campaigns

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Query parameters

pageNumberintegeroptional

Reference to a specific page in a result set.

pageSizeintegeroptional

The number of items per page in a result set.

sortBystringoptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumoptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Available options:

Body

querystringoptional

campaignCodestringoptional

discountTypestring · enumoptional

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

Available options:

displayNamestringoptional

namestringoptional

typestring · enumoptional

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

Available options:

validFromstring · date-timeoptional

validTostring · date-timeoptional

Responses

application/json

objectoptional

post

POST /v2/tenants/{tenantUid}/campaigns/search HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "query": "text",
  "campaignCode": "text",
  "discountType": "CHEAPEST_PRODUCT",
  "displayName": "text",
  "name": "text",
  "type": "CAMPAIGN",
  "validFrom": "2025-04-18T01:08:30.568Z",
  "validTo": "2025-04-18T01:08:30.568Z"
}

200

Example response

{
  "items": [
    {
      "name": "text",
      "status": "NEW",
      "displayName": "text",
      "validFrom": "2025-04-18T01:08:30.568Z",
      "validTo": "2025-04-18T01:08:30.568Z",
      "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
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create new campaign

post

Create new campaign

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

Body

namestringrequired

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

Available options:

discountTypestring · enumoptional

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

Available options:

storeUidsstring[]required

quantityThresholdintegeroptional

A quantity that qualifies for the campaign to apply.

If both quantity and amount are set, both criteria must be met.

amountThresholdintegeroptional

An amount that qualifies for the campaign to apply.

If both quantity and amount are set, both criteria must be met.

discountAmountintegeroptional

Discount amount given when the criteria are met.

discountPercentintegeroptional

Discount percent given when the criteria are met.

maxUsageintegeroptional

The max number of times the campaign can be applied to the order

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

priorityintegeroptional

Priority for the campaign if more than one campaign applies. Lower number = higher priority.

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

campaignCodestringoptional

If campaignCode is set, it means that this campaign has to be manually actived on an order via PUT on the order

preventCombinationsbooleanoptional

Flag to indicate that this campaign should not be combined with other campaigns. If any orderlines matches this campaign and priority is set to 1, no other campaigns will be considered.

Responses

application/json

objectoptional

post

POST /v2/tenants/{tenantUid}/campaigns HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 384

{
  "name": "text",
  "displayName": "text",
  "validFrom": "2025-04-18T01:08:30.568Z",
  "validTo": "2025-04-18T01:08:30.568Z",
  "type": "CAMPAIGN",
  "discountType": "CHEAPEST_PRODUCT",
  "storeUids": [
    "text"
  ],
  "quantityThreshold": 1,
  "amountThreshold": 1,
  "discountAmount": 1,
  "discountPercent": 1,
  "maxUsage": 1,
  "pricelistUid": "text",
  "priority": 1,
  "campaignUid": "text",
  "campaignCode": "text",
  "preventCombinations": true
}

201

Example response

{
  "name": "text",
  "status": "NEW",
  "displayName": "text",
  "validFrom": "2025-04-18T01:08:30.568Z",
  "validTo": "2025-04-18T01:08:30.568Z",
  "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
}

Update an existing campaign

put

Update an existing campaign

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

campaignUidstringrequired

Reference to a campaign.

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

Body

This request updates an existing campaign.

IMPORTANT! The request must include all storeUids the campaign is valid for.

namestringoptional

displayNamestringoptional

statusstring · enumoptional

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.

Available options:

validFromstring · date-timeoptional

validTostring · date-timeoptional

storeUidsstring[]optional

quantityThresholdintegeroptional

amountThresholdintegeroptional

discountAmountintegeroptional

discountPercentintegeroptional

maxUsageintegeroptional

priorityintegeroptional

pricelistUidstringoptionalPattern: ^[A-Za-z0-9-_]*

campaignCodestringoptional

discountTypestring · enumoptional

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

Available options:

preventCombinationsbooleanoptional

Responses

application/json

objectoptional

put

PUT /v2/tenants/{tenantUid}/campaigns/{campaignUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 360

{
  "name": "text",
  "displayName": "text",
  "status": "NEW",
  "validFrom": "2025-04-18T01:08:30.568Z",
  "validTo": "2025-04-18T01:08:30.568Z",
  "storeUids": [
    "text"
  ],
  "quantityThreshold": 1,
  "amountThreshold": 1,
  "discountAmount": 1,
  "discountPercent": 1,
  "maxUsage": 1,
  "priority": 1,
  "pricelistUid": "text",
  "campaignCode": "text",
  "discountType": "CHEAPEST_PRODUCT",
  "preventCombinations": true
}

200

Example response

{
  "name": "text",
  "status": "NEW",
  "displayName": "text",
  "validFrom": "2025-04-18T01:08:30.568Z",
  "validTo": "2025-04-18T01:08:30.568Z",
  "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
}

Set selections on a campaign

post

Set selections on a campaign

Authorizations

Path parameters

tenantUidstringrequired

Reference to a tenant.

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

campaignUidstringrequired

Reference to a campaign.

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

Body

This request has 3 sections:

create: A selection to create in the campaign delete: A selection to delete from campaign.

createobjectoptional

This request contains a selection of product groups, brands and exact productUids to include or exclude in a campaign.

deleteobjectoptional

This request contains a selection of product groups, brands and exact productUids to include or exclude in a campaign.

Responses

application/json

objectoptional

post

POST /v2/tenants/{tenantUid}/campaigns/{campaignUid}/selections HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 455

{
  "create": {
    "include": {
      "productGroupUids": [
        "text"
      ],
      "brandUids": [
        "text"
      ],
      "categoryUids": [
        "text"
      ],
      "productUids": [
        "text"
      ]
    },
    "exclude": {
      "productGroupUids": [
        "text"
      ],
      "brandUids": [
        "text"
      ],
      "categoryUids": [
        "text"
      ],
      "productUids": [
        "text"
      ]
    }
  },
  "delete": {
    "include": {
      "productGroupUids": [
        "text"
      ],
      "brandUids": [
        "text"
      ],
      "categoryUids": [
        "text"
      ],
      "productUids": [
        "text"
      ]
    },
    "exclude": {
      "productGroupUids": [
        "text"
      ],
      "brandUids": [
        "text"
      ],
      "categoryUids": [
        "text"
      ],
      "productUids": [
        "text"
      ]
    }
  }
}

200

Example response

{
  "name": "text",
  "status": "NEW",
  "displayName": "text",
  "validFrom": "2025-04-18T01:08:30.568Z",
  "validTo": "2025-04-18T01:08:30.568Z",
  "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
}