Upload product filter

curl --request POST \
  --url https://{host}/bonus-calculation/v1/campaigns/{id}/files/{fileType} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form formFile='@example-file'

import requests

url = "https://{host}/bonus-calculation/v1/campaigns/{id}/files/{fileType}"

files = { "formFile": ("example-file", open("example-file", "rb")) }
headers = {"Authorization": "<api-key>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('formFile', '<string>');

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

options.body = form;

fetch('https://{host}/bonus-calculation/v1/campaigns/{id}/files/{fileType}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/bonus-calculation/v1/campaigns/{id}/files/{fileType}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"formFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/bonus-calculation/v1/campaigns/{id}/files/{fileType}"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"formFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/bonus-calculation/v1/campaigns/{id}/files/{fileType}")
  .header("Authorization", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"formFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/bonus-calculation/v1/campaigns/{id}/files/{fileType}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"formFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

Upload product filter

Uploads a file for the specified bonus campaign and updates the campaign’s associated file reference based on the specified CampaignFileType. Supported file types vary depending on the BonusType of the campaign. Upload will fail if the selected fileType is not compatible with the campaign’s bonus type.

Supported files types for bonus types:

ProductBonus: Percentage, FixedPrice
BasketBonus: ExcludedProductIds, ExcludedCategories
LocalBonus: ProductIds, ExcludedCategories

POST

campaigns

{id}

files

{fileType}

Upload product filter

curl --request POST \
  --url https://{host}/bonus-calculation/v1/campaigns/{id}/files/{fileType} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form formFile='@example-file'

import requests

url = "https://{host}/bonus-calculation/v1/campaigns/{id}/files/{fileType}"

files = { "formFile": ("example-file", open("example-file", "rb")) }
headers = {"Authorization": "<api-key>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('formFile', '<string>');

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

options.body = form;

fetch('https://{host}/bonus-calculation/v1/campaigns/{id}/files/{fileType}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/bonus-calculation/v1/campaigns/{id}/files/{fileType}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"formFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/bonus-calculation/v1/campaigns/{id}/files/{fileType}"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"formFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/bonus-calculation/v1/campaigns/{id}/files/{fileType}")
  .header("Authorization", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"formFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/bonus-calculation/v1/campaigns/{id}/files/{fileType}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"formFile\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

integer<int64>

required

The identifier of the bonus campaign.

fileType

enum<string>

required

The type of the file being uploaded. Determines which property on the campaign should be updated. Defaults to Percentage if not specified.

Available options:

Percentage,

FixedPrice,

CampaignPercentage,

Custom,

ProductIds,

ExcludedCategories,

MemberIds,

ExcludedProductIds

Body

multipart/form-data

formFile

file

required

The file to be uploaded. Must be provided in the multipart/form-data body.

Response

File uploaded successfully and campaign updated.

string | null

Last modified on August 10, 2026

⌘I