Validate a discount code against an order context
curl --request POST \
--url https://server.twicecommerce.com/v1/admin/discount-codes/validate \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"code": "<string>",
"items": {
"subtotal": 4503599627370495,
"id": "<string>",
"catalogItemId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"collectionIds": [
"<string>"
]
}
}
'import requests
url = "https://server.twicecommerce.com/v1/admin/discount-codes/validate"
payload = {
"code": "<string>",
"items": {
"subtotal": 4503599627370495,
"id": "<string>",
"catalogItemId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"collectionIds": ["<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({
code: '<string>',
items: {
subtotal: 4503599627370495,
id: '<string>',
catalogItemId: '<string>',
startDate: '2023-11-07T05:31:56Z',
collectionIds: ['<string>']
}
})
};
fetch('https://server.twicecommerce.com/v1/admin/discount-codes/validate', 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://server.twicecommerce.com/v1/admin/discount-codes/validate",
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([
'code' => '<string>',
'items' => [
'subtotal' => 4503599627370495,
'id' => '<string>',
'catalogItemId' => '<string>',
'startDate' => '2023-11-07T05:31:56Z',
'collectionIds' => [
'<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://server.twicecommerce.com/v1/admin/discount-codes/validate"
payload := strings.NewReader("{\n \"code\": \"<string>\",\n \"items\": {\n \"subtotal\": 4503599627370495,\n \"id\": \"<string>\",\n \"catalogItemId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"collectionIds\": [\n \"<string>\"\n ]\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://server.twicecommerce.com/v1/admin/discount-codes/validate")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"<string>\",\n \"items\": {\n \"subtotal\": 4503599627370495,\n \"id\": \"<string>\",\n \"catalogItemId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"collectionIds\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.twicecommerce.com/v1/admin/discount-codes/validate")
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 \"code\": \"<string>\",\n \"items\": {\n \"subtotal\": 4503599627370495,\n \"id\": \"<string>\",\n \"catalogItemId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"collectionIds\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"valid": true,
"code": {
"id": "<string>",
"code": "<string>",
"valueType": "percentage",
"value": 0,
"applicablePurchaseTypes": [
"sale"
]
},
"appliedValue": 0,
"allocations": [
{
"itemId": "<string>",
"value": 4503599627370495
}
]
}Validate a discount code against an order context
Dry-run validation of a code against an order context: checks the validity window, usage limits and applicability, and returns the computed effect without consuming a use. Applying for real happens via the order applyOrderDiscountCode endpoint.
POST
/
v1
/
admin
/
discount-codes
/
validate
Validate a discount code against an order context
curl --request POST \
--url https://server.twicecommerce.com/v1/admin/discount-codes/validate \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"code": "<string>",
"items": {
"subtotal": 4503599627370495,
"id": "<string>",
"catalogItemId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"collectionIds": [
"<string>"
]
}
}
'import requests
url = "https://server.twicecommerce.com/v1/admin/discount-codes/validate"
payload = {
"code": "<string>",
"items": {
"subtotal": 4503599627370495,
"id": "<string>",
"catalogItemId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"collectionIds": ["<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({
code: '<string>',
items: {
subtotal: 4503599627370495,
id: '<string>',
catalogItemId: '<string>',
startDate: '2023-11-07T05:31:56Z',
collectionIds: ['<string>']
}
})
};
fetch('https://server.twicecommerce.com/v1/admin/discount-codes/validate', 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://server.twicecommerce.com/v1/admin/discount-codes/validate",
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([
'code' => '<string>',
'items' => [
'subtotal' => 4503599627370495,
'id' => '<string>',
'catalogItemId' => '<string>',
'startDate' => '2023-11-07T05:31:56Z',
'collectionIds' => [
'<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://server.twicecommerce.com/v1/admin/discount-codes/validate"
payload := strings.NewReader("{\n \"code\": \"<string>\",\n \"items\": {\n \"subtotal\": 4503599627370495,\n \"id\": \"<string>\",\n \"catalogItemId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"collectionIds\": [\n \"<string>\"\n ]\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://server.twicecommerce.com/v1/admin/discount-codes/validate")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"<string>\",\n \"items\": {\n \"subtotal\": 4503599627370495,\n \"id\": \"<string>\",\n \"catalogItemId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"collectionIds\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.twicecommerce.com/v1/admin/discount-codes/validate")
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 \"code\": \"<string>\",\n \"items\": {\n \"subtotal\": 4503599627370495,\n \"id\": \"<string>\",\n \"catalogItemId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"collectionIds\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"valid": true,
"code": {
"id": "<string>",
"code": "<string>",
"valueType": "percentage",
"value": 0,
"applicablePurchaseTypes": [
"sale"
]
},
"appliedValue": 0,
"allocations": [
{
"itemId": "<string>",
"value": 4503599627370495
}
]
}Authorizations
API key for the Twice API
Body
application/json
Body
Required string length:
1 - 64Hide child attributes
Hide child attributes
Available options:
booking, sale, subscription, buyback Required range:
0 <= x <= 9007199254740991Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Response
200
- Option 1
- Option 2
Available options:
true Hide child attributes
Hide child attributes
Available options:
percentage, fixed_per_order, fixed_per_item Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
sale, booking, subscription Required range:
-9007199254740991 <= x <= 9007199254740991Was this page helpful?