Create an unavailability range for an article
curl --request POST \
--url https://server.twicecommerce.com/v1/admin/unavailabilities/ \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"articleId": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"unavailabilityEvents": [
{
"type": "sale",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"orderId": "<string>",
"orderStockItemId": "<string>",
"blockerType": "<string>",
"scheduledEventId": "<string>",
"serviceLocationId": "<string>"
}
'import requests
url = "https://server.twicecommerce.com/v1/admin/unavailabilities/"
payload = {
"articleId": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"unavailabilityEvents": [
{
"type": "sale",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"orderId": "<string>",
"orderStockItemId": "<string>",
"blockerType": "<string>",
"scheduledEventId": "<string>",
"serviceLocationId": "<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({
articleId: '<string>',
start: '2023-11-07T05:31:56Z',
end: '2023-11-07T05:31:56Z',
unavailabilityEvents: [{type: 'sale', timestamp: '2023-11-07T05:31:56Z'}],
orderId: '<string>',
orderStockItemId: '<string>',
blockerType: '<string>',
scheduledEventId: '<string>',
serviceLocationId: '<string>'
})
};
fetch('https://server.twicecommerce.com/v1/admin/unavailabilities/', 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/unavailabilities/",
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([
'articleId' => '<string>',
'start' => '2023-11-07T05:31:56Z',
'end' => '2023-11-07T05:31:56Z',
'unavailabilityEvents' => [
[
'type' => 'sale',
'timestamp' => '2023-11-07T05:31:56Z'
]
],
'orderId' => '<string>',
'orderStockItemId' => '<string>',
'blockerType' => '<string>',
'scheduledEventId' => '<string>',
'serviceLocationId' => '<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/unavailabilities/"
payload := strings.NewReader("{\n \"articleId\": \"<string>\",\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"unavailabilityEvents\": [\n {\n \"type\": \"sale\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"orderId\": \"<string>\",\n \"orderStockItemId\": \"<string>\",\n \"blockerType\": \"<string>\",\n \"scheduledEventId\": \"<string>\",\n \"serviceLocationId\": \"<string>\"\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/unavailabilities/")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"articleId\": \"<string>\",\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"unavailabilityEvents\": [\n {\n \"type\": \"sale\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"orderId\": \"<string>\",\n \"orderStockItemId\": \"<string>\",\n \"blockerType\": \"<string>\",\n \"scheduledEventId\": \"<string>\",\n \"serviceLocationId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.twicecommerce.com/v1/admin/unavailabilities/")
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 \"articleId\": \"<string>\",\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"unavailabilityEvents\": [\n {\n \"type\": \"sale\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"orderId\": \"<string>\",\n \"orderStockItemId\": \"<string>\",\n \"blockerType\": \"<string>\",\n \"scheduledEventId\": \"<string>\",\n \"serviceLocationId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"range": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"tenantId": "<string>",
"articleId": "<string>",
"orderId": "<string>",
"blockerType": "<string>",
"orderStockItemId": "<string>",
"slotId": "<string>",
"scheduledEventId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"intervals": {
"type": "sale",
"range": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"unavailabilityId": "<string>",
"tenantId": "<string>"
}
}Create an unavailability range for an article
Blocks an article for a period, removing it from computed availability, e.g. for maintenance.
POST
/
v1
/
admin
/
unavailabilities
/
Create an unavailability range for an article
curl --request POST \
--url https://server.twicecommerce.com/v1/admin/unavailabilities/ \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"articleId": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"unavailabilityEvents": [
{
"type": "sale",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"orderId": "<string>",
"orderStockItemId": "<string>",
"blockerType": "<string>",
"scheduledEventId": "<string>",
"serviceLocationId": "<string>"
}
'import requests
url = "https://server.twicecommerce.com/v1/admin/unavailabilities/"
payload = {
"articleId": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"unavailabilityEvents": [
{
"type": "sale",
"timestamp": "2023-11-07T05:31:56Z"
}
],
"orderId": "<string>",
"orderStockItemId": "<string>",
"blockerType": "<string>",
"scheduledEventId": "<string>",
"serviceLocationId": "<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({
articleId: '<string>',
start: '2023-11-07T05:31:56Z',
end: '2023-11-07T05:31:56Z',
unavailabilityEvents: [{type: 'sale', timestamp: '2023-11-07T05:31:56Z'}],
orderId: '<string>',
orderStockItemId: '<string>',
blockerType: '<string>',
scheduledEventId: '<string>',
serviceLocationId: '<string>'
})
};
fetch('https://server.twicecommerce.com/v1/admin/unavailabilities/', 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/unavailabilities/",
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([
'articleId' => '<string>',
'start' => '2023-11-07T05:31:56Z',
'end' => '2023-11-07T05:31:56Z',
'unavailabilityEvents' => [
[
'type' => 'sale',
'timestamp' => '2023-11-07T05:31:56Z'
]
],
'orderId' => '<string>',
'orderStockItemId' => '<string>',
'blockerType' => '<string>',
'scheduledEventId' => '<string>',
'serviceLocationId' => '<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/unavailabilities/"
payload := strings.NewReader("{\n \"articleId\": \"<string>\",\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"unavailabilityEvents\": [\n {\n \"type\": \"sale\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"orderId\": \"<string>\",\n \"orderStockItemId\": \"<string>\",\n \"blockerType\": \"<string>\",\n \"scheduledEventId\": \"<string>\",\n \"serviceLocationId\": \"<string>\"\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/unavailabilities/")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"articleId\": \"<string>\",\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"unavailabilityEvents\": [\n {\n \"type\": \"sale\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"orderId\": \"<string>\",\n \"orderStockItemId\": \"<string>\",\n \"blockerType\": \"<string>\",\n \"scheduledEventId\": \"<string>\",\n \"serviceLocationId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.twicecommerce.com/v1/admin/unavailabilities/")
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 \"articleId\": \"<string>\",\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"unavailabilityEvents\": [\n {\n \"type\": \"sale\",\n \"timestamp\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"orderId\": \"<string>\",\n \"orderStockItemId\": \"<string>\",\n \"blockerType\": \"<string>\",\n \"scheduledEventId\": \"<string>\",\n \"serviceLocationId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"range": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"tenantId": "<string>",
"articleId": "<string>",
"orderId": "<string>",
"blockerType": "<string>",
"orderStockItemId": "<string>",
"slotId": "<string>",
"scheduledEventId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"intervals": {
"type": "sale",
"range": {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z"
},
"unavailabilityId": "<string>",
"tenantId": "<string>"
}
}Authorizations
API key for the Twice API
Body
application/json
Body
Pattern:
^(?:(?:\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))$Pattern:
^(?:(?:\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))$- Option 1
- Option 2
Hide child attributes
Hide child attributes
Available options:
sale Pattern:
^(?:(?:\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
Hide child attributes
Hide child attributes
Pattern:
^(?:(?:\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))$Pattern:
^(?:(?:\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))$Pattern:
^(?:(?:\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))$Hide child attributes
Hide child attributes
Available options:
sale, sales-reservation, buffer, booking Hide child attributes
Hide child attributes
Pattern:
^(?:(?:\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))$Pattern:
^(?:(?:\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))$Was this page helpful?