Create a branch

curl --request POST \
  --url https://api.dev.shadowchef.co/v1/partner/branches \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "PA-Smoke Branch",
  "address": "Jl. Sudirman Kav. 1, Jakarta",
  "phone": "+6281234567890",
  "lat": -6.2088,
  "lon": 106.8456,
  "country_id": 4,
  "city_id": 31,
  "currency_id": 4,
  "brand_ids": [
    663
  ],
  "day_availability": [
    0,
    1,
    2,
    3,
    4,
    5,
    6
  ],
  "subscription_type": 1,
  "custom_vat_config": false,
  "is_churned": false,
  "bir_config_enabled": false,
  "is_vat_registered": false,
  "authless_webshop_order_details_enabled": false,
  "authless_add_order_details_enabled": false,
  "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": 900,
          "endTime": 2200
        }
      ]
    },
    "6": {
      "disabled": false,
      "slots": [
        {
          "startTime": 900,
          "endTime": 2200
        }
      ]
    }
  }
}
'

const url = 'https://api.dev.shadowchef.co/v1/partner/branches';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: 'PA-Smoke Branch',
    address: 'Jl. Sudirman Kav. 1, Jakarta',
    phone: '+6281234567890',
    lat: -6.2088,
    lon: 106.8456,
    country_id: 4,
    city_id: 31,
    currency_id: 4,
    brand_ids: [663],
    day_availability: [0, 1, 2, 3, 4, 5, 6],
    subscription_type: 1,
    custom_vat_config: false,
    is_churned: false,
    bir_config_enabled: false,
    is_vat_registered: false,
    authless_webshop_order_details_enabled: false,
    authless_add_order_details_enabled: false,
    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: 900, endTime: 2200}]},
      '6': {disabled: false, slots: [{startTime: 900, endTime: 2200}]}
    }
  })
};

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"

payload = {
    "title": "PA-Smoke Branch",
    "address": "Jl. Sudirman Kav. 1, Jakarta",
    "phone": "+6281234567890",
    "lat": -6.2088,
    "lon": 106.8456,
    "country_id": 4,
    "city_id": 31,
    "currency_id": 4,
    "brand_ids": [663],
    "day_availability": [0, 1, 2, 3, 4, 5, 6],
    "subscription_type": 1,
    "custom_vat_config": False,
    "is_churned": False,
    "bir_config_enabled": False,
    "is_vat_registered": False,
    "authless_webshop_order_details_enabled": False,
    "authless_add_order_details_enabled": False,
    "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": 900,
                    "endTime": 2200
                }
            ]
        },
        "6": {
            "disabled": False,
            "slots": [
                {
                    "startTime": 900,
                    "endTime": 2200
                }
            ]
        }
    }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(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"

	payload := strings.NewReader("{\n  \"title\": \"PA-Smoke Branch\",\n  \"address\": \"Jl. Sudirman Kav. 1, Jakarta\",\n  \"phone\": \"+6281234567890\",\n  \"lat\": -6.2088,\n  \"lon\": 106.8456,\n  \"country_id\": 4,\n  \"city_id\": 31,\n  \"currency_id\": 4,\n  \"brand_ids\": [\n    663\n  ],\n  \"day_availability\": [\n    0,\n    1,\n    2,\n    3,\n    4,\n    5,\n    6\n  ],\n  \"subscription_type\": 1,\n  \"custom_vat_config\": false,\n  \"is_churned\": false,\n  \"bir_config_enabled\": false,\n  \"is_vat_registered\": false,\n  \"authless_webshop_order_details_enabled\": false,\n  \"authless_add_order_details_enabled\": false,\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\": 900,\n          \"endTime\": 2200\n        }\n      ]\n    },\n    \"6\": {\n      \"disabled\": false,\n      \"slots\": [\n        {\n          \"startTime\": 900,\n          \"endTime\": 2200\n        }\n      ]\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", 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",
  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([
    'title' => 'PA-Smoke Branch',
    'address' => 'Jl. Sudirman Kav. 1, Jakarta',
    'phone' => '+6281234567890',
    'lat' => -6.2088,
    'lon' => 106.8456,
    'country_id' => 4,
    'city_id' => 31,
    'currency_id' => 4,
    'brand_ids' => [
        663
    ],
    'day_availability' => [
        0,
        1,
        2,
        3,
        4,
        5,
        6
    ],
    'subscription_type' => 1,
    'custom_vat_config' => false,
    'is_churned' => false,
    'bir_config_enabled' => false,
    'is_vat_registered' => false,
    'authless_webshop_order_details_enabled' => false,
    'authless_add_order_details_enabled' => false,
    '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' => 900,
                                                                'endTime' => 2200
                                ]
                ]
        ],
        '6' => [
                'disabled' => false,
                'slots' => [
                                [
                                                                'startTime' => 900,
                                                                'endTime' => 2200
                                ]
                ]
        ]
    ]
  ]),
  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>"
  }
}

branches

Create a branch

Adds a new branch under your business. business_id is taken from the credential and any value in the body is overwritten. Mandatory fields the upstream validates: title, address, phone (E.164), lat / lon, city_id, country_id, currency_id, day_availability (1–7), subscription_type, available_times, custom_vat_config.

Read-this-first gotchas

country_id + city_id are validated together against the cities table. A pair that doesn’t join surfaces as 502 downstream_unavailable. Pull the valid combinations from CountryId and CityId (grouped per country).
The branches table has a few NOT NULL columns that the upstream DTO doesn’t mark as required — sending them unspecified surfaces as 500 internal_error with Column '<name>' cannot be null. Pass them explicitly (each defaults to false if you don’t care about the feature):
- is_churned
- bir_config_enabled
- is_vat_registered
- authless_webshop_order_details_enabled
- authless_add_order_details_enabled
currency_id should match the country’s primary currency (see CurrencyId for the full table).

POST

partner

branches

Create a branch

curl --request POST \
  --url https://api.dev.shadowchef.co/v1/partner/branches \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "PA-Smoke Branch",
  "address": "Jl. Sudirman Kav. 1, Jakarta",
  "phone": "+6281234567890",
  "lat": -6.2088,
  "lon": 106.8456,
  "country_id": 4,
  "city_id": 31,
  "currency_id": 4,
  "brand_ids": [
    663
  ],
  "day_availability": [
    0,
    1,
    2,
    3,
    4,
    5,
    6
  ],
  "subscription_type": 1,
  "custom_vat_config": false,
  "is_churned": false,
  "bir_config_enabled": false,
  "is_vat_registered": false,
  "authless_webshop_order_details_enabled": false,
  "authless_add_order_details_enabled": false,
  "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": 900,
          "endTime": 2200
        }
      ]
    },
    "6": {
      "disabled": false,
      "slots": [
        {
          "startTime": 900,
          "endTime": 2200
        }
      ]
    }
  }
}
'

const url = 'https://api.dev.shadowchef.co/v1/partner/branches';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: 'PA-Smoke Branch',
    address: 'Jl. Sudirman Kav. 1, Jakarta',
    phone: '+6281234567890',
    lat: -6.2088,
    lon: 106.8456,
    country_id: 4,
    city_id: 31,
    currency_id: 4,
    brand_ids: [663],
    day_availability: [0, 1, 2, 3, 4, 5, 6],
    subscription_type: 1,
    custom_vat_config: false,
    is_churned: false,
    bir_config_enabled: false,
    is_vat_registered: false,
    authless_webshop_order_details_enabled: false,
    authless_add_order_details_enabled: false,
    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: 900, endTime: 2200}]},
      '6': {disabled: false, slots: [{startTime: 900, endTime: 2200}]}
    }
  })
};

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"

payload = {
    "title": "PA-Smoke Branch",
    "address": "Jl. Sudirman Kav. 1, Jakarta",
    "phone": "+6281234567890",
    "lat": -6.2088,
    "lon": 106.8456,
    "country_id": 4,
    "city_id": 31,
    "currency_id": 4,
    "brand_ids": [663],
    "day_availability": [0, 1, 2, 3, 4, 5, 6],
    "subscription_type": 1,
    "custom_vat_config": False,
    "is_churned": False,
    "bir_config_enabled": False,
    "is_vat_registered": False,
    "authless_webshop_order_details_enabled": False,
    "authless_add_order_details_enabled": False,
    "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": 900,
                    "endTime": 2200
                }
            ]
        },
        "6": {
            "disabled": False,
            "slots": [
                {
                    "startTime": 900,
                    "endTime": 2200
                }
            ]
        }
    }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(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"

	payload := strings.NewReader("{\n  \"title\": \"PA-Smoke Branch\",\n  \"address\": \"Jl. Sudirman Kav. 1, Jakarta\",\n  \"phone\": \"+6281234567890\",\n  \"lat\": -6.2088,\n  \"lon\": 106.8456,\n  \"country_id\": 4,\n  \"city_id\": 31,\n  \"currency_id\": 4,\n  \"brand_ids\": [\n    663\n  ],\n  \"day_availability\": [\n    0,\n    1,\n    2,\n    3,\n    4,\n    5,\n    6\n  ],\n  \"subscription_type\": 1,\n  \"custom_vat_config\": false,\n  \"is_churned\": false,\n  \"bir_config_enabled\": false,\n  \"is_vat_registered\": false,\n  \"authless_webshop_order_details_enabled\": false,\n  \"authless_add_order_details_enabled\": false,\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\": 900,\n          \"endTime\": 2200\n        }\n      ]\n    },\n    \"6\": {\n      \"disabled\": false,\n      \"slots\": [\n        {\n          \"startTime\": 900,\n          \"endTime\": 2200\n        }\n      ]\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", 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",
  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([
    'title' => 'PA-Smoke Branch',
    'address' => 'Jl. Sudirman Kav. 1, Jakarta',
    'phone' => '+6281234567890',
    'lat' => -6.2088,
    'lon' => 106.8456,
    'country_id' => 4,
    'city_id' => 31,
    'currency_id' => 4,
    'brand_ids' => [
        663
    ],
    'day_availability' => [
        0,
        1,
        2,
        3,
        4,
        5,
        6
    ],
    'subscription_type' => 1,
    'custom_vat_config' => false,
    'is_churned' => false,
    'bir_config_enabled' => false,
    'is_vat_registered' => false,
    'authless_webshop_order_details_enabled' => false,
    'authless_add_order_details_enabled' => false,
    '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' => 900,
                                                                'endTime' => 2200
                                ]
                ]
        ],
        '6' => [
                'disabled' => false,
                'slots' => [
                                [
                                                                'startTime' => 900,
                                                                'endTime' => 2200
                                ]
                ]
        ]
    ]
  ]),
  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>"
  }
}

Authorizations

Authorization

string

header

required

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.

Body

application/json

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.

title

string

required

Required string length: 1 - 255

address

string

required

Required string length: 5 - 255

phone

string

required

E.164

lat

number

required

lon

number

required

country_id

enum<integer>

required

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

Available options:

1,

2,

3,

4,

5,

6,

7,

8,

9,

10,

11,

12,

23,

30,

38,

43,

59,

64,

75,

101,

151,

167,

168,

182

city_id

integer

required

Must belong to the supplied country_id — core validates the pair against the cities table and the gateway returns 502 downstream_unavailable on a join miss. See CityId for the per-country city list.

currency_id

enum<integer>

required

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

Available options:

1,

2,

3,

4,

5,

6,

7,

8,

9,

10,

11,

12,

13,

14,

15,

16,

17,

18,

19,

20,

21,

22,

23,

24

day_availability

integer[]

required

Required array length: 1 - 7 elements

Required range: 0 <= x <= 6

subscription_type

integer

required

available_times

object

required

Weekly 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

Example:

{
  "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

boolean

required

google_map_link

string | null

secondary_phone

string | null

brand_ids

integer[]

kitchen_equipment_ids

integer[]

brand_list_changed

boolean

default:false

kitchen_equipment_list_changed

boolean

default:false

vat_enabled

boolean | null

vat_inclusive

boolean | null

vat_label

string | null

vat_calculation_pre_discount

boolean | null

vat_percentage

number | null

prioritize_item_level_vat

boolean | null

order_cleanup_time

integer

Cleanup window in minutes.

manual_order_auto_accept_enabled

boolean

default:false

is_shift_enabled

boolean

default:false

is_driver_progress_enabled

boolean

default:false

marketplace_enabled

boolean | null

webshop_otp_required

boolean | null

bir_config_enabled

boolean | null

price_group_id

integer | null

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 created. Payload mirrors core's branch model — data.id is the new branch id.

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.

request_id

string

required

Example:

"req_4d1b7e3f-..."

data

any

Endpoint-specific payload on success.

error

object

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

Get started

Core concepts

Webhooks

Reference receivers

API reference

Create a branch

Authorizations

Body

Response

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

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

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