Set inventory rules for a catalog item
curl --request PUT \
--url https://server.twicecommerce.com/v1/admin/catalog/{id}/rules \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"label": "<string>",
"conditions": {
"label": "<string>",
"filters": {
"values": [
"<string>"
],
"attributeId": "<string>"
},
"quantity": 123,
"id": "<string>"
},
"quantity": 123,
"isVisible": true,
"id": "<string>",
"revenueSplitRate": 123
}
'import requests
url = "https://server.twicecommerce.com/v1/admin/catalog/{id}/rules"
payload = {
"label": "<string>",
"conditions": {
"label": "<string>",
"filters": {
"values": ["<string>"],
"attributeId": "<string>"
},
"quantity": 123,
"id": "<string>"
},
"quantity": 123,
"isVisible": True,
"id": "<string>",
"revenueSplitRate": 123
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: '<string>',
conditions: {
label: '<string>',
filters: {values: ['<string>'], attributeId: '<string>'},
quantity: 123,
id: '<string>'
},
quantity: 123,
isVisible: true,
id: '<string>',
revenueSplitRate: 123
})
};
fetch('https://server.twicecommerce.com/v1/admin/catalog/{id}/rules', 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/catalog/{id}/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'label' => '<string>',
'conditions' => [
'label' => '<string>',
'filters' => [
'values' => [
'<string>'
],
'attributeId' => '<string>'
],
'quantity' => 123,
'id' => '<string>'
],
'quantity' => 123,
'isVisible' => true,
'id' => '<string>',
'revenueSplitRate' => 123
]),
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/catalog/{id}/rules"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"conditions\": {\n \"label\": \"<string>\",\n \"filters\": {\n \"values\": [\n \"<string>\"\n ],\n \"attributeId\": \"<string>\"\n },\n \"quantity\": 123,\n \"id\": \"<string>\"\n },\n \"quantity\": 123,\n \"isVisible\": true,\n \"id\": \"<string>\",\n \"revenueSplitRate\": 123\n}")
req, _ := http.NewRequest("PUT", 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.put("https://server.twicecommerce.com/v1/admin/catalog/{id}/rules")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"conditions\": {\n \"label\": \"<string>\",\n \"filters\": {\n \"values\": [\n \"<string>\"\n ],\n \"attributeId\": \"<string>\"\n },\n \"quantity\": 123,\n \"id\": \"<string>\"\n },\n \"quantity\": 123,\n \"isVisible\": true,\n \"id\": \"<string>\",\n \"revenueSplitRate\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.twicecommerce.com/v1/admin/catalog/{id}/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"conditions\": {\n \"label\": \"<string>\",\n \"filters\": {\n \"values\": [\n \"<string>\"\n ],\n \"attributeId\": \"<string>\"\n },\n \"quantity\": 123,\n \"id\": \"<string>\"\n },\n \"quantity\": 123,\n \"isVisible\": true,\n \"id\": \"<string>\",\n \"revenueSplitRate\": 123\n}"
response = http.request(request)
puts response.read_bodytrueSets the rules that connect a listing to physical inventory — this is what makes it bookable. A catalog item holds no stock itself; without at least one rule whose conditions match real inventory, the listing resolves to zero availability. This replaces the full rule set for the item in one call (array upsert): include a rule/condition id to update it, omit the id to create.
PUT
/
v1
/
admin
/
catalog
/
{id}
/
rules
Set inventory rules for a catalog item
curl --request PUT \
--url https://server.twicecommerce.com/v1/admin/catalog/{id}/rules \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"label": "<string>",
"conditions": {
"label": "<string>",
"filters": {
"values": [
"<string>"
],
"attributeId": "<string>"
},
"quantity": 123,
"id": "<string>"
},
"quantity": 123,
"isVisible": true,
"id": "<string>",
"revenueSplitRate": 123
}
'import requests
url = "https://server.twicecommerce.com/v1/admin/catalog/{id}/rules"
payload = {
"label": "<string>",
"conditions": {
"label": "<string>",
"filters": {
"values": ["<string>"],
"attributeId": "<string>"
},
"quantity": 123,
"id": "<string>"
},
"quantity": 123,
"isVisible": True,
"id": "<string>",
"revenueSplitRate": 123
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: '<string>',
conditions: {
label: '<string>',
filters: {values: ['<string>'], attributeId: '<string>'},
quantity: 123,
id: '<string>'
},
quantity: 123,
isVisible: true,
id: '<string>',
revenueSplitRate: 123
})
};
fetch('https://server.twicecommerce.com/v1/admin/catalog/{id}/rules', 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/catalog/{id}/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'label' => '<string>',
'conditions' => [
'label' => '<string>',
'filters' => [
'values' => [
'<string>'
],
'attributeId' => '<string>'
],
'quantity' => 123,
'id' => '<string>'
],
'quantity' => 123,
'isVisible' => true,
'id' => '<string>',
'revenueSplitRate' => 123
]),
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/catalog/{id}/rules"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"conditions\": {\n \"label\": \"<string>\",\n \"filters\": {\n \"values\": [\n \"<string>\"\n ],\n \"attributeId\": \"<string>\"\n },\n \"quantity\": 123,\n \"id\": \"<string>\"\n },\n \"quantity\": 123,\n \"isVisible\": true,\n \"id\": \"<string>\",\n \"revenueSplitRate\": 123\n}")
req, _ := http.NewRequest("PUT", 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.put("https://server.twicecommerce.com/v1/admin/catalog/{id}/rules")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"conditions\": {\n \"label\": \"<string>\",\n \"filters\": {\n \"values\": [\n \"<string>\"\n ],\n \"attributeId\": \"<string>\"\n },\n \"quantity\": 123,\n \"id\": \"<string>\"\n },\n \"quantity\": 123,\n \"isVisible\": true,\n \"id\": \"<string>\",\n \"revenueSplitRate\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.twicecommerce.com/v1/admin/catalog/{id}/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"conditions\": {\n \"label\": \"<string>\",\n \"filters\": {\n \"values\": [\n \"<string>\"\n ],\n \"attributeId\": \"<string>\"\n },\n \"quantity\": 123,\n \"id\": \"<string>\"\n },\n \"quantity\": 123,\n \"isVisible\": true,\n \"id\": \"<string>\",\n \"revenueSplitRate\": 123\n}"
response = http.request(request)
puts response.read_bodytrueAuthorizations
API key for the Twice API
Path Parameters
Body
application/json
Body
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Available options:
attribute, item_code, sku_code, item_name, sku_name Available options:
startsWith, endsWith, contains, doesNotContain, eq, ne, gt, gte, lt, lte, inArray, notInArray, between, notBetween, isEmpty, isNotEmpty Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Available options:
attribute, item_code, sku_code, item_name, sku_name Available options:
startsWith, endsWith, contains, doesNotContain, eq, ne, gt, gte, lt, lte, inArray, notInArray, between, notBetween, isEmpty, isNotEmpty 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))$Response
200
The response is of type boolean.
Was this page helpful?