Skip to main content
GET
Retrieve delivery settings

Authorizations

x-api-key
string
header
required

Location/organization API key.

Path Parameters

location_id
string
required

Response

The delivery settings.

object
enum<string>
Available options:
delivery_settings
location_id
string
delivery_enabled
boolean
pickup_enabled
boolean
provider
enum<string> | null

The publicly manageable delivery provider, or null when delivery is managed outside the public API.

Available options:
handledByStore,
uberDirect,
chaskis
fee_strategy
enum<string>

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.

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[]
max_delivery_radius_in_km
number | null
max_delivery_fee
object | null
min_order_amount
number | null
max_order_amount
number | null

Maximum explicit delivery order subtotal. Null removes the location cap; provider-specific limits may still apply.

Required range: x >= 0
collection_max_order_amount
number | null

Maximum click & collect order subtotal; null disables the pickup cap.

Required range: x >= 0
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