curl --request GET \
--url https://server.chataigne.ai/v1/locations/{location_id}/delivery_settings \
--header 'x-api-key: <api-key>'import requests
url = "https://server.chataigne.ai/v1/locations/{location_id}/delivery_settings"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://server.chataigne.ai/v1/locations/{location_id}/delivery_settings', 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.chataigne.ai/v1/locations/{location_id}/delivery_settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://server.chataigne.ai/v1/locations/{location_id}/delivery_settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://server.chataigne.ai/v1/locations/{location_id}/delivery_settings")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.chataigne.ai/v1/locations/{location_id}/delivery_settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"object": "delivery_settings",
"location_id": "<string>",
"delivery_enabled": true,
"pickup_enabled": true,
"provider": "handledByStore",
"fee_strategy": "postalCode",
"postal_codes": [
{
"postal_code": 1204,
"minimum_order_amount": 25,
"delivery_fee": {
"amount": 123,
"currency": "<string>"
}
}
],
"delivery_zones": [
{
"id": "zone-centre",
"name": "Centre-ville",
"polygon": [
{
"latitude": 46.20439,
"longitude": 6.14316
}
],
"minimum_order_amount": 25,
"delivery_fee": {
"amount": 123,
"currency": "<string>"
}
}
],
"fee_percentage": 123,
"smart_parameters": {
"menu_uplift": 0.15,
"uber_commission": 0.3,
"target_lift": 0.03,
"coverage_fraction": 0.8
},
"distance_ranges": [
{
"up_to_km": 2,
"displayed_fee": 3.5,
"minimum_order_amount": 20
}
],
"max_delivery_radius_in_km": 123,
"max_delivery_fee": {
"amount": 123,
"currency": "<string>"
},
"min_order_amount": 123,
"max_order_amount": 1,
"collection_max_order_amount": 1,
"max_items_number": 123,
"delivery_verification_mode": "picture",
"uber_direct_pickup_notes_enabled": true,
"uber_direct_pickup_notes": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}Retrieve delivery settings
curl --request GET \
--url https://server.chataigne.ai/v1/locations/{location_id}/delivery_settings \
--header 'x-api-key: <api-key>'import requests
url = "https://server.chataigne.ai/v1/locations/{location_id}/delivery_settings"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://server.chataigne.ai/v1/locations/{location_id}/delivery_settings', 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.chataigne.ai/v1/locations/{location_id}/delivery_settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://server.chataigne.ai/v1/locations/{location_id}/delivery_settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://server.chataigne.ai/v1/locations/{location_id}/delivery_settings")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.chataigne.ai/v1/locations/{location_id}/delivery_settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"object": "delivery_settings",
"location_id": "<string>",
"delivery_enabled": true,
"pickup_enabled": true,
"provider": "handledByStore",
"fee_strategy": "postalCode",
"postal_codes": [
{
"postal_code": 1204,
"minimum_order_amount": 25,
"delivery_fee": {
"amount": 123,
"currency": "<string>"
}
}
],
"delivery_zones": [
{
"id": "zone-centre",
"name": "Centre-ville",
"polygon": [
{
"latitude": 46.20439,
"longitude": 6.14316
}
],
"minimum_order_amount": 25,
"delivery_fee": {
"amount": 123,
"currency": "<string>"
}
}
],
"fee_percentage": 123,
"smart_parameters": {
"menu_uplift": 0.15,
"uber_commission": 0.3,
"target_lift": 0.03,
"coverage_fraction": 0.8
},
"distance_ranges": [
{
"up_to_km": 2,
"displayed_fee": 3.5,
"minimum_order_amount": 20
}
],
"max_delivery_radius_in_km": 123,
"max_delivery_fee": {
"amount": 123,
"currency": "<string>"
},
"min_order_amount": 123,
"max_order_amount": 1,
"collection_max_order_amount": 1,
"max_items_number": 123,
"delivery_verification_mode": "picture",
"uber_direct_pickup_notes_enabled": true,
"uber_direct_pickup_notes": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "<string>",
"request_id": "req_8f2c…",
"param": "<string>",
"details": {}
}
}Authorizations
Location/organization API key.
Path Parameters
Response
The delivery settings.
delivery_settings The publicly manageable delivery provider, or null when delivery is managed outside the public API.
handledByStore, uberDirect, chaskis postalCode uses the matching postal_codes entry; deliveryZone uses the matching polygon in delivery_zones; percentage charges the customer the fee_percentage share of the provider fee; customerPaysAll passes the full provider fee to the customer; restaurantPaysAll displays no delivery fee to the customer; smart calculates a distance-based customer fee using the smart pricing configuration; distanceRange uses the first matching bracket in distance_ranges.
postalCode, deliveryZone, percentage, customerPaysAll, restaurantPaysAll, smart, distanceRange Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum explicit delivery order subtotal. Null removes the location cap; provider-specific limits may still apply.
x >= 0Maximum click & collect order subtotal; null disables the pickup cap.
x >= 0picture, pincode