Preview sell promotion
curl --request POST \
--url https://api.collectpure.com/execution/v2/sell/quotes/{quoteId}/promotion-preview \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"promotionCode": "<string>",
"selectedOptionalIds": [
"<string>"
]
}
'import requests
url = "https://api.collectpure.com/execution/v2/sell/quotes/{quoteId}/promotion-preview"
payload = {
"promotionCode": "<string>",
"selectedOptionalIds": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({promotionCode: '<string>', selectedOptionalIds: ['<string>']})
};
fetch('https://api.collectpure.com/execution/v2/sell/quotes/{quoteId}/promotion-preview', 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.collectpure.com/execution/v2/sell/quotes/{quoteId}/promotion-preview",
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([
'promotionCode' => '<string>',
'selectedOptionalIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-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://api.collectpure.com/execution/v2/sell/quotes/{quoteId}/promotion-preview"
payload := strings.NewReader("{\n \"promotionCode\": \"<string>\",\n \"selectedOptionalIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.collectpure.com/execution/v2/sell/quotes/{quoteId}/promotion-preview")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"promotionCode\": \"<string>\",\n \"selectedOptionalIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.collectpure.com/execution/v2/sell/quotes/{quoteId}/promotion-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"promotionCode\": \"<string>\",\n \"selectedOptionalIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"status": "applied",
"appliedCode": "<string>",
"totalDiscount": 123,
"appliedPromotions": [
{
"promotionId": "<string>",
"promotionType": "<string>",
"label": "<string>",
"discountAmount": 123,
"params": {},
"sourceCode": "<string>",
"sourceCodeId": "<string>",
"sourceGrantId": "<string>"
}
],
"quote": {
"quoteId": "<string>",
"expiresAt": "<string>",
"refreshedAt": "<string>",
"lineItems": [
{
"id": "<string>",
"quantity": 123,
"price": 123,
"status": "<string>",
"disabled": true,
"error": "<string>",
"product": {
"sku": "<string>",
"title": "<string>",
"fulfillmentDays": 123
},
"variant": {
"title": "<string>"
},
"offer": {
"id": "<string>",
"productId": "<string>",
"variantId": "<string>",
"price": 123,
"quantity": 123,
"spotPremium": 123,
"spotPremiumDollar": 123
}
}
],
"fees": [
{
"id": "<string>",
"label": "<string>",
"amount": 123,
"rate": 123
}
],
"optionals": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"fee": 123,
"selected": true,
"enabled": true,
"disabledReason": "<string>",
"disclaimer": {
"label": "<string>",
"url": "<string>"
}
}
],
"subtotal": 123,
"total": 123
}
}
}Execution - Sell
Preview sell promotion
Preview how a promotion code affects sell quote pricing without committing. Loads the current checkout session, then calls the port promotion preview.
Requires role: stytch_admin
Rate limit: 120 requests burst, 60 requests/minute sustained.
POST
/
execution
/
v2
/
sell
/
quotes
/
{quoteId}
/
promotion-preview
Preview sell promotion
curl --request POST \
--url https://api.collectpure.com/execution/v2/sell/quotes/{quoteId}/promotion-preview \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"promotionCode": "<string>",
"selectedOptionalIds": [
"<string>"
]
}
'import requests
url = "https://api.collectpure.com/execution/v2/sell/quotes/{quoteId}/promotion-preview"
payload = {
"promotionCode": "<string>",
"selectedOptionalIds": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({promotionCode: '<string>', selectedOptionalIds: ['<string>']})
};
fetch('https://api.collectpure.com/execution/v2/sell/quotes/{quoteId}/promotion-preview', 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.collectpure.com/execution/v2/sell/quotes/{quoteId}/promotion-preview",
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([
'promotionCode' => '<string>',
'selectedOptionalIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-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://api.collectpure.com/execution/v2/sell/quotes/{quoteId}/promotion-preview"
payload := strings.NewReader("{\n \"promotionCode\": \"<string>\",\n \"selectedOptionalIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.collectpure.com/execution/v2/sell/quotes/{quoteId}/promotion-preview")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"promotionCode\": \"<string>\",\n \"selectedOptionalIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.collectpure.com/execution/v2/sell/quotes/{quoteId}/promotion-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"promotionCode\": \"<string>\",\n \"selectedOptionalIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"status": "applied",
"appliedCode": "<string>",
"totalDiscount": 123,
"appliedPromotions": [
{
"promotionId": "<string>",
"promotionType": "<string>",
"label": "<string>",
"discountAmount": 123,
"params": {},
"sourceCode": "<string>",
"sourceCodeId": "<string>",
"sourceGrantId": "<string>"
}
],
"quote": {
"quoteId": "<string>",
"expiresAt": "<string>",
"refreshedAt": "<string>",
"lineItems": [
{
"id": "<string>",
"quantity": 123,
"price": 123,
"status": "<string>",
"disabled": true,
"error": "<string>",
"product": {
"sku": "<string>",
"title": "<string>",
"fulfillmentDays": 123
},
"variant": {
"title": "<string>"
},
"offer": {
"id": "<string>",
"productId": "<string>",
"variantId": "<string>",
"price": 123,
"quantity": 123,
"spotPremium": 123,
"spotPremiumDollar": 123
}
}
],
"fees": [
{
"id": "<string>",
"label": "<string>",
"amount": 123,
"rate": 123
}
],
"optionals": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"fee": 123,
"selected": true,
"enabled": true,
"disabledReason": "<string>",
"disclaimer": {
"label": "<string>",
"url": "<string>"
}
}
],
"subtotal": 123,
"total": 123
}
}
}Authorizations
API key for authentication
Path Parameters
The quote ID (cart ID) to preview a promotion against
Body
application/json
Was this page helpful?
⌘I