Delivery zones

List delivery zones

Lists the active delivery zones for a connected location.

GEThttps://api.maple.inc/v1/locations/{locationId}/delivery_zonesAPI key

Lists the active delivery zones for a connected location. Requires delivery_zones:read and an active connection to the location.

Authorization

Send your API key as Authorization: Bearer <key>: mpk_test_… against the sandbox (https://api.staging.maple.inc/v1), mpk_live_… against production. See Authentication. The samples read the key from MAPLE_KEY and the base URL from MAPLE_BASE, as set up in the Quickstart.

Parameters

locationId string path required

Responses

200 OK

object string required

Always list.
data object[] required
data[].object string required

Always delivery_zone.
data[].id string required
data[].location_id string required
data[].name string required
data[].zone_type string required

One of polygon, circle.
data[].polygon object required

A GeoJSON Polygon. Coordinates are [longitude, latitude] rings; the first ring must be closed.
data[].polygon.type string required

Always Polygon.
data[].polygon.coordinates [number, number][][] required
data[].radius_miles number or null required
data[].delivery_fee_cents number required
data[].min_order_cents number or null required
data[].max_distance_miles number or null required
data[].is_active boolean required
data[].priority number required
data[].created_at string required
data[].updated_at string required

Errors

400 Bad request DeveloperApiBadRequest
401 Unauthorized DeveloperApiUnauthorized
403 Forbidden DeveloperApiForbidden
404 Not found DeveloperApiNotFound
429 Too many requests DeveloperApiRateLimited

Every error body names the error in _tag, explains it in message, and says where to report it in feedback. See Errors.

A 429 also sends Retry-After: Seconds to wait before retrying; also returned as retry_after in the body.

List delivery zones

curl "$MAPLE_BASE/locations/str_123/delivery_zones" \
  -H "Authorization: Bearer $MAPLE_KEY"

import os
import requests

r = requests.get(
    f"{os.environ['MAPLE_BASE']}/locations/str_123/delivery_zones",
    headers={"Authorization": f"Bearer {os.environ['MAPLE_KEY']}"},
    timeout=30,
)
r.raise_for_status()
print(r.json())

const res = await fetch(`${process.env.MAPLE_BASE}/locations/str_123/delivery_zones`, {
  headers: {
    Authorization: `Bearer ${process.env.MAPLE_KEY}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

{
  "object": "list",
  "data": [
    {
      "object": "delivery_zone",
      "id": "string",
      "location_id": "str_123",
      "name": "string",
      "zone_type": "polygon",
      "polygon": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              null,
              null
            ]
          ]
        ]
      },
      "radius_miles": 1.5,
      "delivery_fee_cents": 1.5,
      "min_order_cents": 1.5,
      "max_distance_miles": 1.5,
      "is_active": true,
      "priority": 1.5,
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

{
  "_tag": "DeveloperApiBadRequest",
  "code": "string",
  "message": "string",
  "feedback": "string"
}