Estimate Incentives
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/transactions/incentive-estimate \
--header 'Content-Type: application/json' \
--data '
{
"trigger_id": 123,
"total": 123,
"transacted_at": "<string>",
"timezone": "<string>",
"items": [
{
"name": "<string>",
"price_sell": 123,
"quantity": 123,
"sku": "<string>",
"product_variant_sku": "<string>",
"price_current": 123
}
],
"profile_id": "<string>",
"profile_id_handle": "<string>",
"location_id": "<string>"
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/transactions/incentive-estimate"
payload = {
"trigger_id": 123,
"total": 123,
"transacted_at": "<string>",
"timezone": "<string>",
"items": [
{
"name": "<string>",
"price_sell": 123,
"quantity": 123,
"sku": "<string>",
"product_variant_sku": "<string>",
"price_current": 123
}
],
"profile_id": "<string>",
"profile_id_handle": "<string>",
"location_id": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
trigger_id: 123,
total: 123,
transacted_at: '<string>',
timezone: '<string>',
items: [
{
name: '<string>',
price_sell: 123,
quantity: 123,
sku: '<string>',
product_variant_sku: '<string>',
price_current: 123
}
],
profile_id: '<string>',
profile_id_handle: '<string>',
location_id: '<string>'
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/transactions/incentive-estimate', 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://api.{tenant}.getomneo.com/api/v3/transactions/incentive-estimate",
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([
'trigger_id' => 123,
'total' => 123,
'transacted_at' => '<string>',
'timezone' => '<string>',
'items' => [
[
'name' => '<string>',
'price_sell' => 123,
'quantity' => 123,
'sku' => '<string>',
'product_variant_sku' => '<string>',
'price_current' => 123
]
],
'profile_id' => '<string>',
'profile_id_handle' => '<string>',
'location_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/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://api.{tenant}.getomneo.com/api/v3/transactions/incentive-estimate"
payload := strings.NewReader("{\n \"trigger_id\": 123,\n \"total\": 123,\n \"transacted_at\": \"<string>\",\n \"timezone\": \"<string>\",\n \"items\": [\n {\n \"name\": \"<string>\",\n \"price_sell\": 123,\n \"quantity\": 123,\n \"sku\": \"<string>\",\n \"product_variant_sku\": \"<string>\",\n \"price_current\": 123\n }\n ],\n \"profile_id\": \"<string>\",\n \"profile_id_handle\": \"<string>\",\n \"location_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/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://api.{tenant}.getomneo.com/api/v3/transactions/incentive-estimate")
.header("Content-Type", "application/json")
.body("{\n \"trigger_id\": 123,\n \"total\": 123,\n \"transacted_at\": \"<string>\",\n \"timezone\": \"<string>\",\n \"items\": [\n {\n \"name\": \"<string>\",\n \"price_sell\": 123,\n \"quantity\": 123,\n \"sku\": \"<string>\",\n \"product_variant_sku\": \"<string>\",\n \"price_current\": 123\n }\n ],\n \"profile_id\": \"<string>\",\n \"profile_id_handle\": \"<string>\",\n \"location_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/transactions/incentive-estimate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"trigger_id\": 123,\n \"total\": 123,\n \"transacted_at\": \"<string>\",\n \"timezone\": \"<string>\",\n \"items\": [\n {\n \"name\": \"<string>\",\n \"price_sell\": 123,\n \"quantity\": 123,\n \"sku\": \"<string>\",\n \"product_variant_sku\": \"<string>\",\n \"price_current\": 123\n }\n ],\n \"profile_id\": \"<string>\",\n \"profile_id_handle\": \"<string>\",\n \"location_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Transaction
Estimate Incentives
A POST to the /transactions/incentive-estimate endpoint allows your application to estimate incentives for a mock transaction without persisting it.
POST
/
v3
/
transactions
/
incentive-estimate
Estimate Incentives
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/transactions/incentive-estimate \
--header 'Content-Type: application/json' \
--data '
{
"trigger_id": 123,
"total": 123,
"transacted_at": "<string>",
"timezone": "<string>",
"items": [
{
"name": "<string>",
"price_sell": 123,
"quantity": 123,
"sku": "<string>",
"product_variant_sku": "<string>",
"price_current": 123
}
],
"profile_id": "<string>",
"profile_id_handle": "<string>",
"location_id": "<string>"
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/transactions/incentive-estimate"
payload = {
"trigger_id": 123,
"total": 123,
"transacted_at": "<string>",
"timezone": "<string>",
"items": [
{
"name": "<string>",
"price_sell": 123,
"quantity": 123,
"sku": "<string>",
"product_variant_sku": "<string>",
"price_current": 123
}
],
"profile_id": "<string>",
"profile_id_handle": "<string>",
"location_id": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
trigger_id: 123,
total: 123,
transacted_at: '<string>',
timezone: '<string>',
items: [
{
name: '<string>',
price_sell: 123,
quantity: 123,
sku: '<string>',
product_variant_sku: '<string>',
price_current: 123
}
],
profile_id: '<string>',
profile_id_handle: '<string>',
location_id: '<string>'
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/transactions/incentive-estimate', 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://api.{tenant}.getomneo.com/api/v3/transactions/incentive-estimate",
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([
'trigger_id' => 123,
'total' => 123,
'transacted_at' => '<string>',
'timezone' => '<string>',
'items' => [
[
'name' => '<string>',
'price_sell' => 123,
'quantity' => 123,
'sku' => '<string>',
'product_variant_sku' => '<string>',
'price_current' => 123
]
],
'profile_id' => '<string>',
'profile_id_handle' => '<string>',
'location_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/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://api.{tenant}.getomneo.com/api/v3/transactions/incentive-estimate"
payload := strings.NewReader("{\n \"trigger_id\": 123,\n \"total\": 123,\n \"transacted_at\": \"<string>\",\n \"timezone\": \"<string>\",\n \"items\": [\n {\n \"name\": \"<string>\",\n \"price_sell\": 123,\n \"quantity\": 123,\n \"sku\": \"<string>\",\n \"product_variant_sku\": \"<string>\",\n \"price_current\": 123\n }\n ],\n \"profile_id\": \"<string>\",\n \"profile_id_handle\": \"<string>\",\n \"location_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/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://api.{tenant}.getomneo.com/api/v3/transactions/incentive-estimate")
.header("Content-Type", "application/json")
.body("{\n \"trigger_id\": 123,\n \"total\": 123,\n \"transacted_at\": \"<string>\",\n \"timezone\": \"<string>\",\n \"items\": [\n {\n \"name\": \"<string>\",\n \"price_sell\": 123,\n \"quantity\": 123,\n \"sku\": \"<string>\",\n \"product_variant_sku\": \"<string>\",\n \"price_current\": 123\n }\n ],\n \"profile_id\": \"<string>\",\n \"profile_id_handle\": \"<string>\",\n \"location_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/transactions/incentive-estimate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"trigger_id\": 123,\n \"total\": 123,\n \"transacted_at\": \"<string>\",\n \"timezone\": \"<string>\",\n \"items\": [\n {\n \"name\": \"<string>\",\n \"price_sell\": 123,\n \"quantity\": 123,\n \"sku\": \"<string>\",\n \"product_variant_sku\": \"<string>\",\n \"price_current\": 123\n }\n ],\n \"profile_id\": \"<string>\",\n \"profile_id_handle\": \"<string>\",\n \"location_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Body
application/json
Response
- Option 1
- Option 2
Show child attributes
Show child attributes
⌘I