curl --request PATCH \
--url https://api.dev.shadowchef.co/v1/partner/branches/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"address": "<string>",
"phone": "<string>",
"lat": 123,
"lon": 123,
"city_id": 123,
"day_availability": [
3
],
"subscription_type": 123,
"available_times": {
"0": {
"disabled": false,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"1": {
"disabled": false,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"2": {
"disabled": false,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"3": {
"disabled": false,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"4": {
"disabled": false,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"5": {
"disabled": false,
"slots": [
{
"startTime": 1000,
"endTime": 2300
}
]
},
"6": {
"disabled": false,
"slots": [
{
"startTime": 1000,
"endTime": 2300
}
]
}
},
"custom_vat_config": true,
"google_map_link": "<string>",
"secondary_phone": "<string>",
"brand_ids": [
123
],
"kitchen_equipment_ids": [
123
],
"brand_list_changed": false,
"kitchen_equipment_list_changed": false,
"populate_menu_for_new_brand": false,
"vat_enabled": true,
"vat_inclusive": true,
"vat_label": "<string>",
"vat_calculation_pre_discount": true,
"vat_percentage": 123,
"prioritize_item_level_vat": true,
"order_cleanup_time": 123,
"manual_order_auto_accept_enabled": false,
"is_shift_enabled": false,
"is_driver_progress_enabled": false,
"marketplace_enabled": true,
"webshop_otp_required": true,
"bir_config_enabled": true,
"price_group_id": 123
}
'const url = 'https://api.dev.shadowchef.co/v1/partner/branches/{id}';
const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
address: '<string>',
phone: '<string>',
lat: 123,
lon: 123,
city_id: 123,
day_availability: [3],
subscription_type: 123,
available_times: {
'0': {disabled: false, slots: [{startTime: 900, endTime: 2200}]},
'1': {disabled: false, slots: [{startTime: 900, endTime: 2200}]},
'2': {disabled: false, slots: [{startTime: 900, endTime: 2200}]},
'3': {disabled: false, slots: [{startTime: 900, endTime: 2200}]},
'4': {disabled: false, slots: [{startTime: 900, endTime: 2200}]},
'5': {disabled: false, slots: [{startTime: 1000, endTime: 2300}]},
'6': {disabled: false, slots: [{startTime: 1000, endTime: 2300}]}
},
custom_vat_config: true,
google_map_link: '<string>',
secondary_phone: '<string>',
brand_ids: [123],
kitchen_equipment_ids: [123],
brand_list_changed: false,
kitchen_equipment_list_changed: false,
populate_menu_for_new_brand: false,
vat_enabled: true,
vat_inclusive: true,
vat_label: '<string>',
vat_calculation_pre_discount: true,
vat_percentage: 123,
prioritize_item_level_vat: true,
order_cleanup_time: 123,
manual_order_auto_accept_enabled: false,
is_shift_enabled: false,
is_driver_progress_enabled: false,
marketplace_enabled: true,
webshop_otp_required: true,
bir_config_enabled: true,
price_group_id: 123
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://api.dev.shadowchef.co/v1/partner/branches/{id}"
payload = {
"title": "<string>",
"address": "<string>",
"phone": "<string>",
"lat": 123,
"lon": 123,
"city_id": 123,
"day_availability": [3],
"subscription_type": 123,
"available_times": {
"0": {
"disabled": False,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"1": {
"disabled": False,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"2": {
"disabled": False,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"3": {
"disabled": False,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"4": {
"disabled": False,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"5": {
"disabled": False,
"slots": [
{
"startTime": 1000,
"endTime": 2300
}
]
},
"6": {
"disabled": False,
"slots": [
{
"startTime": 1000,
"endTime": 2300
}
]
}
},
"custom_vat_config": True,
"google_map_link": "<string>",
"secondary_phone": "<string>",
"brand_ids": [123],
"kitchen_equipment_ids": [123],
"brand_list_changed": False,
"kitchen_equipment_list_changed": False,
"populate_menu_for_new_brand": False,
"vat_enabled": True,
"vat_inclusive": True,
"vat_label": "<string>",
"vat_calculation_pre_discount": True,
"vat_percentage": 123,
"prioritize_item_level_vat": True,
"order_cleanup_time": 123,
"manual_order_auto_accept_enabled": False,
"is_shift_enabled": False,
"is_driver_progress_enabled": False,
"marketplace_enabled": True,
"webshop_otp_required": True,
"bir_config_enabled": True,
"price_group_id": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.dev.shadowchef.co/v1/partner/branches/{id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"address\": \"<string>\",\n \"phone\": \"<string>\",\n \"lat\": 123,\n \"lon\": 123,\n \"city_id\": 123,\n \"day_availability\": [\n 3\n ],\n \"subscription_type\": 123,\n \"available_times\": {\n \"0\": {\n \"disabled\": false,\n \"slots\": [\n {\n \"startTime\": 900,\n \"endTime\": 2200\n }\n ]\n },\n \"1\": {\n \"disabled\": false,\n \"slots\": [\n {\n \"startTime\": 900,\n \"endTime\": 2200\n }\n ]\n },\n \"2\": {\n \"disabled\": false,\n \"slots\": [\n {\n \"startTime\": 900,\n \"endTime\": 2200\n }\n ]\n },\n \"3\": {\n \"disabled\": false,\n \"slots\": [\n {\n \"startTime\": 900,\n \"endTime\": 2200\n }\n ]\n },\n \"4\": {\n \"disabled\": false,\n \"slots\": [\n {\n \"startTime\": 900,\n \"endTime\": 2200\n }\n ]\n },\n \"5\": {\n \"disabled\": false,\n \"slots\": [\n {\n \"startTime\": 1000,\n \"endTime\": 2300\n }\n ]\n },\n \"6\": {\n \"disabled\": false,\n \"slots\": [\n {\n \"startTime\": 1000,\n \"endTime\": 2300\n }\n ]\n }\n },\n \"custom_vat_config\": true,\n \"google_map_link\": \"<string>\",\n \"secondary_phone\": \"<string>\",\n \"brand_ids\": [\n 123\n ],\n \"kitchen_equipment_ids\": [\n 123\n ],\n \"brand_list_changed\": false,\n \"kitchen_equipment_list_changed\": false,\n \"populate_menu_for_new_brand\": false,\n \"vat_enabled\": true,\n \"vat_inclusive\": true,\n \"vat_label\": \"<string>\",\n \"vat_calculation_pre_discount\": true,\n \"vat_percentage\": 123,\n \"prioritize_item_level_vat\": true,\n \"order_cleanup_time\": 123,\n \"manual_order_auto_accept_enabled\": false,\n \"is_shift_enabled\": false,\n \"is_driver_progress_enabled\": false,\n \"marketplace_enabled\": true,\n \"webshop_otp_required\": true,\n \"bir_config_enabled\": true,\n \"price_group_id\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dev.shadowchef.co/v1/partner/branches/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'address' => '<string>',
'phone' => '<string>',
'lat' => 123,
'lon' => 123,
'city_id' => 123,
'day_availability' => [
3
],
'subscription_type' => 123,
'available_times' => [
'0' => [
'disabled' => false,
'slots' => [
[
'startTime' => 900,
'endTime' => 2200
]
]
],
'1' => [
'disabled' => false,
'slots' => [
[
'startTime' => 900,
'endTime' => 2200
]
]
],
'2' => [
'disabled' => false,
'slots' => [
[
'startTime' => 900,
'endTime' => 2200
]
]
],
'3' => [
'disabled' => false,
'slots' => [
[
'startTime' => 900,
'endTime' => 2200
]
]
],
'4' => [
'disabled' => false,
'slots' => [
[
'startTime' => 900,
'endTime' => 2200
]
]
],
'5' => [
'disabled' => false,
'slots' => [
[
'startTime' => 1000,
'endTime' => 2300
]
]
],
'6' => [
'disabled' => false,
'slots' => [
[
'startTime' => 1000,
'endTime' => 2300
]
]
]
],
'custom_vat_config' => true,
'google_map_link' => '<string>',
'secondary_phone' => '<string>',
'brand_ids' => [
123
],
'kitchen_equipment_ids' => [
123
],
'brand_list_changed' => false,
'kitchen_equipment_list_changed' => false,
'populate_menu_for_new_brand' => false,
'vat_enabled' => true,
'vat_inclusive' => true,
'vat_label' => '<string>',
'vat_calculation_pre_discount' => true,
'vat_percentage' => 123,
'prioritize_item_level_vat' => true,
'order_cleanup_time' => 123,
'manual_order_auto_accept_enabled' => false,
'is_shift_enabled' => false,
'is_driver_progress_enabled' => false,
'marketplace_enabled' => true,
'webshop_otp_required' => true,
'bir_config_enabled' => true,
'price_group_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"request_id": "req_4d1b7e3f-...",
"data": "<unknown>",
"error": {
"code": "auth_invalid_credential",
"message": "<string>",
"details": "<unknown>"
}
}{
"request_id": "req_4d1b7e3f-...",
"data": "<unknown>",
"error": {
"code": "request_invalid",
"message": "<string>",
"details": "<unknown>"
}
}{
"request_id": "req_4d1b7e3f-...",
"data": "<unknown>",
"error": {
"code": "resource_not_found",
"message": "<string>",
"details": "<unknown>"
}
}Update a branch
Updates an existing branch. Re-send brand_ids whenever you
change brand assignment and set brand_list_changed: true.
curl --request PATCH \
--url https://api.dev.shadowchef.co/v1/partner/branches/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"address": "<string>",
"phone": "<string>",
"lat": 123,
"lon": 123,
"city_id": 123,
"day_availability": [
3
],
"subscription_type": 123,
"available_times": {
"0": {
"disabled": false,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"1": {
"disabled": false,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"2": {
"disabled": false,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"3": {
"disabled": false,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"4": {
"disabled": false,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"5": {
"disabled": false,
"slots": [
{
"startTime": 1000,
"endTime": 2300
}
]
},
"6": {
"disabled": false,
"slots": [
{
"startTime": 1000,
"endTime": 2300
}
]
}
},
"custom_vat_config": true,
"google_map_link": "<string>",
"secondary_phone": "<string>",
"brand_ids": [
123
],
"kitchen_equipment_ids": [
123
],
"brand_list_changed": false,
"kitchen_equipment_list_changed": false,
"populate_menu_for_new_brand": false,
"vat_enabled": true,
"vat_inclusive": true,
"vat_label": "<string>",
"vat_calculation_pre_discount": true,
"vat_percentage": 123,
"prioritize_item_level_vat": true,
"order_cleanup_time": 123,
"manual_order_auto_accept_enabled": false,
"is_shift_enabled": false,
"is_driver_progress_enabled": false,
"marketplace_enabled": true,
"webshop_otp_required": true,
"bir_config_enabled": true,
"price_group_id": 123
}
'const url = 'https://api.dev.shadowchef.co/v1/partner/branches/{id}';
const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
address: '<string>',
phone: '<string>',
lat: 123,
lon: 123,
city_id: 123,
day_availability: [3],
subscription_type: 123,
available_times: {
'0': {disabled: false, slots: [{startTime: 900, endTime: 2200}]},
'1': {disabled: false, slots: [{startTime: 900, endTime: 2200}]},
'2': {disabled: false, slots: [{startTime: 900, endTime: 2200}]},
'3': {disabled: false, slots: [{startTime: 900, endTime: 2200}]},
'4': {disabled: false, slots: [{startTime: 900, endTime: 2200}]},
'5': {disabled: false, slots: [{startTime: 1000, endTime: 2300}]},
'6': {disabled: false, slots: [{startTime: 1000, endTime: 2300}]}
},
custom_vat_config: true,
google_map_link: '<string>',
secondary_phone: '<string>',
brand_ids: [123],
kitchen_equipment_ids: [123],
brand_list_changed: false,
kitchen_equipment_list_changed: false,
populate_menu_for_new_brand: false,
vat_enabled: true,
vat_inclusive: true,
vat_label: '<string>',
vat_calculation_pre_discount: true,
vat_percentage: 123,
prioritize_item_level_vat: true,
order_cleanup_time: 123,
manual_order_auto_accept_enabled: false,
is_shift_enabled: false,
is_driver_progress_enabled: false,
marketplace_enabled: true,
webshop_otp_required: true,
bir_config_enabled: true,
price_group_id: 123
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://api.dev.shadowchef.co/v1/partner/branches/{id}"
payload = {
"title": "<string>",
"address": "<string>",
"phone": "<string>",
"lat": 123,
"lon": 123,
"city_id": 123,
"day_availability": [3],
"subscription_type": 123,
"available_times": {
"0": {
"disabled": False,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"1": {
"disabled": False,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"2": {
"disabled": False,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"3": {
"disabled": False,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"4": {
"disabled": False,
"slots": [
{
"startTime": 900,
"endTime": 2200
}
]
},
"5": {
"disabled": False,
"slots": [
{
"startTime": 1000,
"endTime": 2300
}
]
},
"6": {
"disabled": False,
"slots": [
{
"startTime": 1000,
"endTime": 2300
}
]
}
},
"custom_vat_config": True,
"google_map_link": "<string>",
"secondary_phone": "<string>",
"brand_ids": [123],
"kitchen_equipment_ids": [123],
"brand_list_changed": False,
"kitchen_equipment_list_changed": False,
"populate_menu_for_new_brand": False,
"vat_enabled": True,
"vat_inclusive": True,
"vat_label": "<string>",
"vat_calculation_pre_discount": True,
"vat_percentage": 123,
"prioritize_item_level_vat": True,
"order_cleanup_time": 123,
"manual_order_auto_accept_enabled": False,
"is_shift_enabled": False,
"is_driver_progress_enabled": False,
"marketplace_enabled": True,
"webshop_otp_required": True,
"bir_config_enabled": True,
"price_group_id": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.dev.shadowchef.co/v1/partner/branches/{id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"address\": \"<string>\",\n \"phone\": \"<string>\",\n \"lat\": 123,\n \"lon\": 123,\n \"city_id\": 123,\n \"day_availability\": [\n 3\n ],\n \"subscription_type\": 123,\n \"available_times\": {\n \"0\": {\n \"disabled\": false,\n \"slots\": [\n {\n \"startTime\": 900,\n \"endTime\": 2200\n }\n ]\n },\n \"1\": {\n \"disabled\": false,\n \"slots\": [\n {\n \"startTime\": 900,\n \"endTime\": 2200\n }\n ]\n },\n \"2\": {\n \"disabled\": false,\n \"slots\": [\n {\n \"startTime\": 900,\n \"endTime\": 2200\n }\n ]\n },\n \"3\": {\n \"disabled\": false,\n \"slots\": [\n {\n \"startTime\": 900,\n \"endTime\": 2200\n }\n ]\n },\n \"4\": {\n \"disabled\": false,\n \"slots\": [\n {\n \"startTime\": 900,\n \"endTime\": 2200\n }\n ]\n },\n \"5\": {\n \"disabled\": false,\n \"slots\": [\n {\n \"startTime\": 1000,\n \"endTime\": 2300\n }\n ]\n },\n \"6\": {\n \"disabled\": false,\n \"slots\": [\n {\n \"startTime\": 1000,\n \"endTime\": 2300\n }\n ]\n }\n },\n \"custom_vat_config\": true,\n \"google_map_link\": \"<string>\",\n \"secondary_phone\": \"<string>\",\n \"brand_ids\": [\n 123\n ],\n \"kitchen_equipment_ids\": [\n 123\n ],\n \"brand_list_changed\": false,\n \"kitchen_equipment_list_changed\": false,\n \"populate_menu_for_new_brand\": false,\n \"vat_enabled\": true,\n \"vat_inclusive\": true,\n \"vat_label\": \"<string>\",\n \"vat_calculation_pre_discount\": true,\n \"vat_percentage\": 123,\n \"prioritize_item_level_vat\": true,\n \"order_cleanup_time\": 123,\n \"manual_order_auto_accept_enabled\": false,\n \"is_shift_enabled\": false,\n \"is_driver_progress_enabled\": false,\n \"marketplace_enabled\": true,\n \"webshop_otp_required\": true,\n \"bir_config_enabled\": true,\n \"price_group_id\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dev.shadowchef.co/v1/partner/branches/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'address' => '<string>',
'phone' => '<string>',
'lat' => 123,
'lon' => 123,
'city_id' => 123,
'day_availability' => [
3
],
'subscription_type' => 123,
'available_times' => [
'0' => [
'disabled' => false,
'slots' => [
[
'startTime' => 900,
'endTime' => 2200
]
]
],
'1' => [
'disabled' => false,
'slots' => [
[
'startTime' => 900,
'endTime' => 2200
]
]
],
'2' => [
'disabled' => false,
'slots' => [
[
'startTime' => 900,
'endTime' => 2200
]
]
],
'3' => [
'disabled' => false,
'slots' => [
[
'startTime' => 900,
'endTime' => 2200
]
]
],
'4' => [
'disabled' => false,
'slots' => [
[
'startTime' => 900,
'endTime' => 2200
]
]
],
'5' => [
'disabled' => false,
'slots' => [
[
'startTime' => 1000,
'endTime' => 2300
]
]
],
'6' => [
'disabled' => false,
'slots' => [
[
'startTime' => 1000,
'endTime' => 2300
]
]
]
],
'custom_vat_config' => true,
'google_map_link' => '<string>',
'secondary_phone' => '<string>',
'brand_ids' => [
123
],
'kitchen_equipment_ids' => [
123
],
'brand_list_changed' => false,
'kitchen_equipment_list_changed' => false,
'populate_menu_for_new_brand' => false,
'vat_enabled' => true,
'vat_inclusive' => true,
'vat_label' => '<string>',
'vat_calculation_pre_discount' => true,
'vat_percentage' => 123,
'prioritize_item_level_vat' => true,
'order_cleanup_time' => 123,
'manual_order_auto_accept_enabled' => false,
'is_shift_enabled' => false,
'is_driver_progress_enabled' => false,
'marketplace_enabled' => true,
'webshop_otp_required' => true,
'bir_config_enabled' => true,
'price_group_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"request_id": "req_4d1b7e3f-...",
"data": "<unknown>",
"error": {
"code": "auth_invalid_credential",
"message": "<string>",
"details": "<unknown>"
}
}{
"request_id": "req_4d1b7e3f-...",
"data": "<unknown>",
"error": {
"code": "request_invalid",
"message": "<string>",
"details": "<unknown>"
}
}{
"request_id": "req_4d1b7e3f-...",
"data": "<unknown>",
"error": {
"code": "resource_not_found",
"message": "<string>",
"details": "<unknown>"
}
}Authorizations
Authorization: Basic base64(partner_key:secret_key).
Credentials are issued by a klikit operator. The plaintext
secret_key is shown once at issuance and cannot be retrieved
later — store it securely. If lost, ask your operator to rotate
the secret to receive a new one. The old secret stops working
immediately on rotation; there is no overlap window.
Path Parameters
Body
Mirrors core's BranchCreateUpdateReq. business_id is
overwritten by the forwarder. phone must be E.164
(+<country><digits>). available_times follows the same
weekday-keyed shape as section availability.
1 - 2555 - 255E.164
Numeric country id used inside BranchCreateRequest.country_id
and a few other resolver calls. Only ids with configured = 1
are listed — anything outside this list is rejected upstream.
| id | iso | country |
|---|---|---|
| 1 | AUS | Australia |
| 2 | PHL | Philippines |
| 3 | SGP | Singapore |
| 4 | IDN | Indonesia |
| 5 | TWN | Taiwan |
| 6 | MYS | Malaysia |
| 7 | GBR | United Kingdom |
| 8 | HKG | Hong Kong |
| 9 | THA | Thailand |
| 10 | JPN | Japan |
| 11 | VNM | Vietnam |
| 12 | KHM | Cambodia |
| 23 | ARG | Argentina |
| 30 | BGD | Bangladesh |
| 38 | BOL | Bolivia |
| 43 | BRA | Brazil |
| 59 | COL | Colombia |
| 64 | CRI | Costa Rica |
| 75 | ECU | Ecuador |
| 101 | GTM | Guatemala |
| 151 | MEX | Mexico |
| 167 | NZL | New Zealand |
| 168 | NIC | Nicaragua |
| 182 | PER | Peru |
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 23, 30, 38, 43, 59, 64, 75, 101, 151, 167, 168, 182 Numeric currency id used inside BranchCreateRequest.currency_id.
Each id is paired with the matching ISO 4217 code partners
already use inside PriceMap (the string key under each
provider entry).
| id | code |
|---|---|
| 1 | AUD |
| 2 | PHP |
| 3 | SGD |
| 4 | IDR |
| 5 | TWD |
| 6 | MYR |
| 7 | GBP |
| 8 | HKD |
| 9 | THB |
| 10 | JPY |
| 11 | VND |
| 12 | KHR |
| 13 | BDT |
| 14 | ARS |
| 15 | BOB |
| 16 | BRL |
| 17 | COP |
| 18 | CRC |
| 19 | USD |
| 20 | GTQ |
| 21 | MXN |
| 22 | NZD |
| 23 | NIO |
| 24 | PEN |
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24 1 - 7 elements0 <= x <= 6Weekly schedule keyed by weekday number as a string:
"0" = Sunday … "6" = Saturday. Every day must have at least
one slot. To make a section dark for a day, set
disabled: true and pass any placeholder slot (the disabled
flag wins).
Show child attributes
Show child attributes
{
"0": {
"disabled": false,
"slots": [{ "startTime": 900, "endTime": 2200 }]
},
"1": {
"disabled": false,
"slots": [{ "startTime": 900, "endTime": 2200 }]
},
"2": {
"disabled": false,
"slots": [{ "startTime": 900, "endTime": 2200 }]
},
"3": {
"disabled": false,
"slots": [{ "startTime": 900, "endTime": 2200 }]
},
"4": {
"disabled": false,
"slots": [{ "startTime": 900, "endTime": 2200 }]
},
"5": {
"disabled": false,
"slots": [{ "startTime": 1000, "endTime": 2300 }]
},
"6": {
"disabled": false,
"slots": [{ "startTime": 1000, "endTime": 2300 }]
}
}
Cleanup window in minutes.
Pricing group this branch sells at (see
listPriceGroups). Update
semantics: a PATCH body that omits this field CLEARS an
existing assignment (branch reverts to base prices) — once a
branch is on a group, include price_group_id in every
branch update you send.
Response
Branch updated.
Canonical response wrapper. Every response — success or error —
carries the request_id so you can quote one id to klikit
support to correlate a request end-to-end.
"req_4d1b7e3f-..."
Endpoint-specific payload on success.
Machine-readable error code + human message. The code is stable
across releases — switch on code in your client code rather
than parsing the message text.
Common codes you will encounter as a partner:
| Code | HTTP | Meaning |
|---|---|---|
auth_missing | 401 | Authorization header absent / malformed |
auth_invalid_credential | 401 | partner_key or secret_key did not verify |
auth_revoked | 403 | Credential is revoked |
auth_forbidden | 403 | Credential not authorized for the requested scope |
request_invalid | 400 | Body / query parameters failed validation |
request_missing_idempotency_key | 400 | Write endpoint called without Idempotency-Key |
request_invalid_range | 400 | Date range > 90 days |
resource_not_found | 404 | Order / store / mapping does not exist |
resource_unmapped | 404 | Stock / availability call referenced an unknown SKU |
state_invalid_transition | 409 | Order PATCH not allowed by current state |
state_idempotency_conflict | 409 | Same Idempotency-Key reused with a different body |
rate_limit_exceeded | 429 | Per-credential rate cap hit |
downstream_unavailable | 502 | An internal klikit dependency is unreachable |
Show child attributes
Show child attributes