Delivery zones

Delete delivery zone

Deactivates a delivery zone belonging to a connected location.

此内容尚不支持你的语言。

DELETEhttps://api.maple.inc/v1/locations/{locationId}/delivery_zones/{zoneId}API key

Deactivates a delivery zone belonging to a connected location. Requires delivery_zones:write 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
zoneId string path required

Responses

200 OK

object string required

Always delivery_zone.
id string required
deleted boolean required

Always true.

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.

Delete delivery zone

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

import os
import requests

r = requests.delete(
    f"{os.environ['MAPLE_BASE']}/locations/str_123/delivery_zones/ZONE_ID",
    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/ZONE_ID`, {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.MAPLE_KEY}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

{
  "object": "delivery_zone",
  "id": "string",
  "deleted": true
}

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