Get shipping zones and pricing tiers

Retrieve available delivery zones and distance-based pricing tiers for the store.

Returns:

• pricing_tiers: Distance-based pricing (e.g., 0-5km: KES 50, 5-10km: KES 100)
• delivery_zones: Custom polygon zones (e.g., CBD Zone: KES 150)

Dual Pricing System:

• Distance-based tiers are automatically applied based on calculated distance
• Custom zones override tiers when customer is inside a defined zone
• Both can have free delivery thresholds based on order total

Caching:

• This endpoint uses ETag caching (60 seconds)
• Supports If-None-Match header for conditional requests

GET /v1/shipping/zones

Get shipping zones and pricing tiers

cURL

curl --request GET \
  --url https://api.tybritelabs.com/v1/shipping/zones \
  --header 'Authorization: Bearer <token>'

200

{
  "pricing_tiers": [
    {
      "tier_name": "Within Nairobi",
      "min_distance_meters": 0,
      "max_distance_meters": 50000,
      "delivery_fee": 100,
      "free_delivery_threshold": 100000,
      "is_active": true,
      "priority": 1
    }
  ],
  "delivery_zones": [
    {
      "zone_name": "CBD Zone",
      "delivery_fee": 150,
      "free_delivery_threshold": 2000,
      "is_active": true,
      "priority": 1,
      "color": "#3B82F6"
    }
  ]
}

Authorizations

Authorization · string · header · required

API Key Authentication

Use your API key in the Authorization header:

Authorization: Bearer tybrite_sk_live_YOUR_KEY

Key Types:

Secret Keys (Server-Side Only):

• Format: tybrite_sk_live_* (production) or tybrite_sk_test_* (sandbox)
• Full read/write access to all endpoints
• ⚠️ NEVER expose in client-side code or public repositories
• Required for: write operations, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

• Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
• Read-only access (GET requests only, plus POST semantic search)
• ✅ Safe for client-side JavaScript, mobile apps, and public code
• Allowed for: browsing products, search, CMS content, pricing queries

Endpoint-Specific Requirements:

• Authentication endpoints (/v1/auth/*): Secret key required
• Payment verification (POST /v1/payments/verify): Secret key required
• AI Recommendations (POST /v1/recommendations): Secret key required
• Semantic Search (POST /v1/search): Both key types allowed (read-only operation)
• All write operations: Secret key required
• All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Response

200

application/json

Shipping zones and pricing tiers

pricing_tiers · object[]

Show child attributes

delivery_zones · object[]

Show child attributes