Imports personal offers to Promotion DB

curl --request POST \
  --url https://{host}/promotion/v3/personaloffers/bulk \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
[
  {
    "offerId": "<string>",
    "memberId": "<string>",
    "preActivated": true,
    "visibleFrom": "2023-11-07T05:31:56Z",
    "pickUpEndDate": "2023-11-07T05:31:56Z",
    "rule1Value": 123,
    "storeId": "<string>"
  }
]
'

import requests

url = "https://{host}/promotion/v3/personaloffers/bulk"

payload = [
    {
        "offerId": "<string>",
        "memberId": "<string>",
        "preActivated": True,
        "visibleFrom": "2023-11-07T05:31:56Z",
        "pickUpEndDate": "2023-11-07T05:31:56Z",
        "rule1Value": 123,
        "storeId": "<string>"
    }
]
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify([
    {
      offerId: '<string>',
      memberId: '<string>',
      preActivated: true,
      visibleFrom: '2023-11-07T05:31:56Z',
      pickUpEndDate: '2023-11-07T05:31:56Z',
      rule1Value: 123,
      storeId: '<string>'
    }
  ])
};

fetch('https://{host}/promotion/v3/personaloffers/bulk', 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}/promotion/v3/personaloffers/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'offerId' => '<string>',
        'memberId' => '<string>',
        'preActivated' => true,
        'visibleFrom' => '2023-11-07T05:31:56Z',
        'pickUpEndDate' => '2023-11-07T05:31:56Z',
        'rule1Value' => 123,
        'storeId' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json"
  ],
]);

$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}/promotion/v3/personaloffers/bulk"

	payload := strings.NewReader("[\n  {\n    \"offerId\": \"<string>\",\n    \"memberId\": \"<string>\",\n    \"preActivated\": true,\n    \"visibleFrom\": \"2023-11-07T05:31:56Z\",\n    \"pickUpEndDate\": \"2023-11-07T05:31:56Z\",\n    \"rule1Value\": 123,\n    \"storeId\": \"<string>\"\n  }\n]")

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

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	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}/promotion/v3/personaloffers/bulk")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("[\n  {\n    \"offerId\": \"<string>\",\n    \"memberId\": \"<string>\",\n    \"preActivated\": true,\n    \"visibleFrom\": \"2023-11-07T05:31:56Z\",\n    \"pickUpEndDate\": \"2023-11-07T05:31:56Z\",\n    \"rule1Value\": 123,\n    \"storeId\": \"<string>\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/promotion/v3/personaloffers/bulk")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "[\n  {\n    \"offerId\": \"<string>\",\n    \"memberId\": \"<string>\",\n    \"preActivated\": true,\n    \"visibleFrom\": \"2023-11-07T05:31:56Z\",\n    \"pickUpEndDate\": \"2023-11-07T05:31:56Z\",\n    \"rule1Value\": 123,\n    \"storeId\": \"<string>\"\n  }\n]"

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

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

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

Imports personal offers to Promotion DB

Used with external offer allocation imports. This endpoint can work directly through YARP integration layer of a client and via data import service if client choses to use file uploads. All imported offers are expected to have the same start and end dates. Dates from the first row will be used for other offers. If no dates are provided, dates from the campaign from the first row will be used.

Imported offers will not be available in app unless finish-bulk endpoint is called for current JobId.

If import of a bulk failed, this bulk will be reverted fully, other bulks with same JobId will not be reverted. To revert the whole import, call DELETE api/v1/personaloffers endpoint.

We do not recommend running multiple imports at the same time, as it can cause performance degradation.

Idempotent if we receive the exact same request, coupons from it will not be imported again. First (OfferId, MemberId) and last (OfferId, MemberId) of the batch are used as idempotency key.

POST

personaloffers

bulk

Imports personal offers to Promotion DB

curl --request POST \
  --url https://{host}/promotion/v3/personaloffers/bulk \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
[
  {
    "offerId": "<string>",
    "memberId": "<string>",
    "preActivated": true,
    "visibleFrom": "2023-11-07T05:31:56Z",
    "pickUpEndDate": "2023-11-07T05:31:56Z",
    "rule1Value": 123,
    "storeId": "<string>"
  }
]
'

import requests

url = "https://{host}/promotion/v3/personaloffers/bulk"

payload = [
    {
        "offerId": "<string>",
        "memberId": "<string>",
        "preActivated": True,
        "visibleFrom": "2023-11-07T05:31:56Z",
        "pickUpEndDate": "2023-11-07T05:31:56Z",
        "rule1Value": 123,
        "storeId": "<string>"
    }
]
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify([
    {
      offerId: '<string>',
      memberId: '<string>',
      preActivated: true,
      visibleFrom: '2023-11-07T05:31:56Z',
      pickUpEndDate: '2023-11-07T05:31:56Z',
      rule1Value: 123,
      storeId: '<string>'
    }
  ])
};

fetch('https://{host}/promotion/v3/personaloffers/bulk', 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}/promotion/v3/personaloffers/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'offerId' => '<string>',
        'memberId' => '<string>',
        'preActivated' => true,
        'visibleFrom' => '2023-11-07T05:31:56Z',
        'pickUpEndDate' => '2023-11-07T05:31:56Z',
        'rule1Value' => 123,
        'storeId' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json"
  ],
]);

$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}/promotion/v3/personaloffers/bulk"

	payload := strings.NewReader("[\n  {\n    \"offerId\": \"<string>\",\n    \"memberId\": \"<string>\",\n    \"preActivated\": true,\n    \"visibleFrom\": \"2023-11-07T05:31:56Z\",\n    \"pickUpEndDate\": \"2023-11-07T05:31:56Z\",\n    \"rule1Value\": 123,\n    \"storeId\": \"<string>\"\n  }\n]")

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

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	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}/promotion/v3/personaloffers/bulk")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("[\n  {\n    \"offerId\": \"<string>\",\n    \"memberId\": \"<string>\",\n    \"preActivated\": true,\n    \"visibleFrom\": \"2023-11-07T05:31:56Z\",\n    \"pickUpEndDate\": \"2023-11-07T05:31:56Z\",\n    \"rule1Value\": 123,\n    \"storeId\": \"<string>\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/promotion/v3/personaloffers/bulk")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "[\n  {\n    \"offerId\": \"<string>\",\n    \"memberId\": \"<string>\",\n    \"preActivated\": true,\n    \"visibleFrom\": \"2023-11-07T05:31:56Z\",\n    \"pickUpEndDate\": \"2023-11-07T05:31:56Z\",\n    \"rule1Value\": 123,\n    \"storeId\": \"<string>\"\n  }\n]"

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

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

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

Authorizations

Authorization

string

header

required

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

Headers

JobId

string

Body

offerId

string | null

memberId

string | null

preActivated

boolean

visibleFrom

string<date-time> | null

pickUpEndDate

string<date-time> | null

rule1Value

number<double> | null

storeId

string | null

Response

errors

object[] | null

Show child attributes

Last modified on August 10, 2026

⌘I