Pricing
Create a pricing template
Creates a saved pricing strategy template with strategy-specific arguments. Optionally set the template’s price-change market (priceChangeSource + priceChangeCountry, both or neither; null/null means use the shop default). Variants bound to this template inherit its market, so changing it re-prices bound variants.
Create a pricing template
curl --request POST \
--url https://app.pricepirate.com/api/v1/pricing-templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "Default Idealo strategy",
"pricingStrategyId": "strategy-lowest-price",
"args": {
"marginPercent": 8
},
"priceChangeSource": "IDEALO",
"priceChangeCountry": "DE"
}
'import requests
url = "https://app.pricepirate.com/api/v1/pricing-templates"
payload = {
"name": "Default Idealo strategy",
"pricingStrategyId": "strategy-lowest-price",
"args": { "marginPercent": 8 },
"priceChangeSource": "IDEALO",
"priceChangeCountry": "DE"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Default Idealo strategy',
pricingStrategyId: 'strategy-lowest-price',
args: {marginPercent: 8},
priceChangeSource: 'IDEALO',
priceChangeCountry: 'DE'
})
};
fetch('https://app.pricepirate.com/api/v1/pricing-templates', 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://app.pricepirate.com/api/v1/pricing-templates",
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([
'name' => 'Default Idealo strategy',
'pricingStrategyId' => 'strategy-lowest-price',
'args' => [
'marginPercent' => 8
],
'priceChangeSource' => 'IDEALO',
'priceChangeCountry' => 'DE'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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://app.pricepirate.com/api/v1/pricing-templates"
payload := strings.NewReader("{\n \"name\": \"Default Idealo strategy\",\n \"pricingStrategyId\": \"strategy-lowest-price\",\n \"args\": {\n \"marginPercent\": 8\n },\n \"priceChangeSource\": \"IDEALO\",\n \"priceChangeCountry\": \"DE\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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://app.pricepirate.com/api/v1/pricing-templates")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Default Idealo strategy\",\n \"pricingStrategyId\": \"strategy-lowest-price\",\n \"args\": {\n \"marginPercent\": 8\n },\n \"priceChangeSource\": \"IDEALO\",\n \"priceChangeCountry\": \"DE\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.pricepirate.com/api/v1/pricing-templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Default Idealo strategy\",\n \"pricingStrategyId\": \"strategy-lowest-price\",\n \"args\": {\n \"marginPercent\": 8\n },\n \"priceChangeSource\": \"IDEALO\",\n \"priceChangeCountry\": \"DE\"\n}"
response = http.request(request)
puts response.read_body{
"id": "template-123",
"name": "Default Idealo strategy",
"pricingStrategyId": "strategy-lowest-price",
"args": {
"marginPercent": 8
},
"priceChangeSource": "IDEALO",
"priceChangeCountry": "DE"
}{
"error": {
"code": "BAD_REQUEST",
"message": "JSON body must be an object",
"details": "Validation details may be included for invalid inputs.",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Missing or invalid Authorization header",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Forbidden",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "idempotency_key_reuse",
"message": "Idempotency-Key was already used for a different request",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "TOO_MANY_REQUESTS",
"message": "Rate limit exceeded",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}Authorizations
Public API token passed as Authorization: Bearer .
Headers
Required for write requests. Reuse the same key only when retrying the exact same request.
Body
application/json
Pricing template to create.
Available options:
IDEALO, GOOGLE_SHOPPING, KLARNA, PRICERUNNER, ALLEGRO, AMAZON Available options:
AE, AT, AU, BE, BG, BR, CA, CH, CN, CZ, DE, DK, ES, FI, FR, GR, HR, HU, IE, IN, IT, JP, NL, NO, PL, PT, RO, MX, SE, SK, UK, US Response
Successful response.
Was this page helpful?
⌘I
Create a pricing template
curl --request POST \
--url https://app.pricepirate.com/api/v1/pricing-templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"name": "Default Idealo strategy",
"pricingStrategyId": "strategy-lowest-price",
"args": {
"marginPercent": 8
},
"priceChangeSource": "IDEALO",
"priceChangeCountry": "DE"
}
'import requests
url = "https://app.pricepirate.com/api/v1/pricing-templates"
payload = {
"name": "Default Idealo strategy",
"pricingStrategyId": "strategy-lowest-price",
"args": { "marginPercent": 8 },
"priceChangeSource": "IDEALO",
"priceChangeCountry": "DE"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Default Idealo strategy',
pricingStrategyId: 'strategy-lowest-price',
args: {marginPercent: 8},
priceChangeSource: 'IDEALO',
priceChangeCountry: 'DE'
})
};
fetch('https://app.pricepirate.com/api/v1/pricing-templates', 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://app.pricepirate.com/api/v1/pricing-templates",
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([
'name' => 'Default Idealo strategy',
'pricingStrategyId' => 'strategy-lowest-price',
'args' => [
'marginPercent' => 8
],
'priceChangeSource' => 'IDEALO',
'priceChangeCountry' => 'DE'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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://app.pricepirate.com/api/v1/pricing-templates"
payload := strings.NewReader("{\n \"name\": \"Default Idealo strategy\",\n \"pricingStrategyId\": \"strategy-lowest-price\",\n \"args\": {\n \"marginPercent\": 8\n },\n \"priceChangeSource\": \"IDEALO\",\n \"priceChangeCountry\": \"DE\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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://app.pricepirate.com/api/v1/pricing-templates")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Default Idealo strategy\",\n \"pricingStrategyId\": \"strategy-lowest-price\",\n \"args\": {\n \"marginPercent\": 8\n },\n \"priceChangeSource\": \"IDEALO\",\n \"priceChangeCountry\": \"DE\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.pricepirate.com/api/v1/pricing-templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Default Idealo strategy\",\n \"pricingStrategyId\": \"strategy-lowest-price\",\n \"args\": {\n \"marginPercent\": 8\n },\n \"priceChangeSource\": \"IDEALO\",\n \"priceChangeCountry\": \"DE\"\n}"
response = http.request(request)
puts response.read_body{
"id": "template-123",
"name": "Default Idealo strategy",
"pricingStrategyId": "strategy-lowest-price",
"args": {
"marginPercent": 8
},
"priceChangeSource": "IDEALO",
"priceChangeCountry": "DE"
}{
"error": {
"code": "BAD_REQUEST",
"message": "JSON body must be an object",
"details": "Validation details may be included for invalid inputs.",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Missing or invalid Authorization header",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Forbidden",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "idempotency_key_reuse",
"message": "Idempotency-Key was already used for a different request",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "TOO_MANY_REQUESTS",
"message": "Rate limit exceeded",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}