Skip to main content
PATCH
/
v1
/
locations
/
{location_id}
/
delivery_settings
Update delivery settings
curl --request PATCH \
  --url https://api.chataigne.ai/v1/locations/{location_id}/delivery_settings \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "delivery_enabled": true,
  "pickup_enabled": true,
  "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": 0.5,
  "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
    }
  ],
  "chaskis_flat_fee": {
    "amount": 123,
    "currency": "<string>"
  },
  "chaskis_per_km_fee": {
    "amount": 123,
    "currency": "<string>"
  },
  "max_delivery_radius_in_km": 1,
  "max_delivery_fee": {
    "amount": 123,
    "currency": "<string>"
  },
  "min_order_amount": 1,
  "max_order_amount": 1,
  "max_items_number": 2,
  "uber_direct_pickup_notes_enabled": true,
  "uber_direct_pickup_notes": "<string>",
  "uber_direct_ums_enabled": true,
  "uber_direct_auto_dmc": {
    "enabled": true,
    "price_tiers": [
      {
        "up_to_order_amount": 80,
        "courier_count": 1,
        "delivery_fee_multiplier": 1.5
      }
    ],
    "volume_multipliers": [
      {
        "courier_count": 2,
        "delivery_fee_multiplier": 1.5
      }
    ]
  }
}
'
{
  "object": "delivery_settings",
  "location_id": "<string>",
  "delivery_enabled": true,
  "pickup_enabled": true,
  "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
    }
  ],
  "chaskis_flat_fee": {
    "amount": 123,
    "currency": "<string>"
  },
  "chaskis_per_km_fee": {
    "amount": 123,
    "currency": "<string>"
  },
  "max_delivery_radius_in_km": 123,
  "max_delivery_fee": {
    "amount": 123,
    "currency": "<string>"
  },
  "min_order_amount": 123,
  "max_order_amount": 123,
  "max_items_number": 123,
  "uber_direct_pickup_notes_enabled": true,
  "uber_direct_pickup_notes": "<string>",
  "uber_direct_ums_enabled": true,
  "uber_direct_auto_dmc": {
    "enabled": true,
    "price_tiers": [
      {
        "up_to_order_amount": 80,
        "courier_count": 1,
        "delivery_fee_multiplier": 1.5
      }
    ],
    "volume_multipliers": [
      {
        "courier_count": 2,
        "delivery_fee_multiplier": 1.5
      }
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

Location/organization API key.

Path Parameters

​
location_id
string
required

Body

application/json

PATCH body; omitted fields are preserved. Nullable fields can be set to null to clear/reset them.

​
delivery_enabled
boolean
​
pickup_enabled
boolean
​
provider
enum<string>
Available options:
handledByStore,
uberDirect,
chaskis,
dood
​
fee_strategy
enum<string>
Available options:
postalCode,
deliveryZone,
percentage,
customerPaysAll,
restaurantPaysAll,
smart,
distanceRange
​
postal_codes
object[] | null
​
delivery_zones
object[] | null
​
fee_percentage
number | null
Required range: 0 <= x <= 1
​
smart_parameters
object | null
​
distance_ranges
object[] | null
​
chaskis_flat_fee
object
​
chaskis_per_km_fee
object
​
max_delivery_radius_in_km
number | null
Required range: x >= 0
​
max_delivery_fee
object | null
​
min_order_amount
number | null
Required range: x >= 0
​
max_order_amount
number | null
Required range: x >= 0
​
max_items_number
integer | null
Required range: x >= 1
​
delivery_verification_mode
enum<string> | null
Available options:
picture,
pincode
​
uber_direct_pickup_notes_enabled
boolean
​
uber_direct_pickup_notes
string | null
Maximum string length: 280
​
uber_direct_ums_enabled
boolean
​
uber_direct_auto_dmc
object | null

Response

The updated delivery settings.

​
object
enum<string>
Available options:
delivery_settings
​
location_id
string
​
delivery_enabled
boolean
​
pickup_enabled
boolean
​
provider
enum<string>
Available options:
handledByStore,
uberDirect,
chaskis,
dood
​
fee_strategy
enum<string>
Available options:
postalCode,
deliveryZone,
percentage,
customerPaysAll,
restaurantPaysAll,
smart,
distanceRange
​
postal_codes
object[]
​
delivery_zones
object[]
​
fee_percentage
number | null
​
smart_parameters
object | null
​
distance_ranges
object[]
​
chaskis_flat_fee
object
​
chaskis_per_km_fee
object
​
max_delivery_radius_in_km
number | null
​
max_delivery_fee
object | null
​
min_order_amount
number | null
​
max_order_amount
number | null
​
max_items_number
number | null
​
delivery_verification_mode
enum<string> | null
Available options:
picture,
pincode
​
uber_direct_pickup_notes_enabled
boolean
​
uber_direct_pickup_notes
string | null
​
uber_direct_ums_enabled
boolean
​
uber_direct_auto_dmc
object | null