Regions

Manage delivery regions and location-based region lookups.

Base URL: /api/v1/partner/regions

Endpoints Overview

Method	Endpoint	Description
GET	/{regionId}	Get region by id
GET	/	Search regions
GET	/nearby	Get nearby region

---

Get region by id

GET /api/v1/partner/regions/{regionId}

Retrieve a single delivery region by its ID.

Path Parameters

Parameter	Type	Description
regionId	string	The region i d

Response

Returns a BlazeRegion object.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
name	string	No	Name
active	boolean	No	Whether active (default: true)
latitude	double	No	Latitude
longitude	double	No	Longitude
regionDefault	boolean	No	Region Default (default: false)
deliveryFee	number	No	Delivery Fee
openAt	string	No	Open At
openAtNumeric	integer	No	Open At Numeric
closeAtNumeric	integer	No	Close At Numeric
closeAt	string	No	Close At
daysClose	string[]	No	Days Close
minOrderAmount	number	No	Min Order Amount
freeDeliveryAfter	number	No	Free Delivery After
zoneType	string	No	Zone Type. One of: zipCode (default: zipCode)
fileZone	string	No	File Zone
taxRuleId	string	No	Tax Rule identifier
deliveryCharge	number	No	Delivery Charge
kmlEdges	BlazeKmlEdge[]	No	Kml Edges
zipCodes	string[]	No	Zip Codes
kmlColor	string	No	Kml Color (default: ``)
allowedConsumerTypes	ConsumerType[]	No	Allowed Consumer Types

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "name": "string",
  "active": true,
  "latitude": 0,
  "longitude": 0,
  "regionDefault": false,
  "deliveryFee": 0,
  "openAt": "string",
  "openAtNumeric": 0,
  "closeAtNumeric": 0,
  "closeAt": "string",
  "daysClose": [],
  "minOrderAmount": 0,
  "freeDeliveryAfter": 0,
  "zoneType": "zipCode",
  "fileZone": "string",
  "taxRuleId": "abc123",
  "deliveryCharge": 0,
  "kmlEdges": [
    {
      "active": false,
      "coordinates": [],
      "asset": {}
    }
  ],
  "zipCodes": [],
  "kmlColor": "",
  "allowedConsumerTypes": [
    {}
  ]
}

---

Search regions

GET /api/v1/partner/regions

Retrieve a paginated list of delivery regions. Use skip and limit for pagination.

Query Parameters

Parameter	Type	Required	Description
skip	integer	No	Number of records to skip
limit	integer	No	Maximum records to return

Response

Returns a paginated SearchResult of BlazeRegion objects.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
name	string	No	Name
active	boolean	No	Whether active (default: true)
latitude	double	No	Latitude
longitude	double	No	Longitude
regionDefault	boolean	No	Region Default (default: false)
deliveryFee	number	No	Delivery Fee
openAt	string	No	Open At
openAtNumeric	integer	No	Open At Numeric
closeAtNumeric	integer	No	Close At Numeric
closeAt	string	No	Close At
daysClose	string[]	No	Days Close
minOrderAmount	number	No	Min Order Amount
freeDeliveryAfter	number	No	Free Delivery After
zoneType	string	No	Zone Type. One of: zipCode (default: zipCode)
fileZone	string	No	File Zone
taxRuleId	string	No	Tax Rule identifier
deliveryCharge	number	No	Delivery Charge
kmlEdges	BlazeKmlEdge[]	No	Kml Edges
zipCodes	string[]	No	Zip Codes
kmlColor	string	No	Kml Color (default: ``)
allowedConsumerTypes	ConsumerType[]	No	Allowed Consumer Types

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "name": "string",
  "active": true,
  "latitude": 0,
  "longitude": 0,
  "regionDefault": false,
  "deliveryFee": 0,
  "openAt": "string",
  "openAtNumeric": 0,
  "closeAtNumeric": 0,
  "closeAt": "string",
  "daysClose": [],
  "minOrderAmount": 0,
  "freeDeliveryAfter": 0,
  "zoneType": "zipCode",
  "fileZone": "string",
  "taxRuleId": "abc123",
  "deliveryCharge": 0,
  "kmlEdges": [
    {
      "active": false,
      "coordinates": [],
      "asset": {}
    }
  ],
  "zipCodes": [],
  "kmlColor": "",
  "allowedConsumerTypes": [
    {}
  ]
}

---

Get nearby region

GET /api/v1/partner/regions/nearby

Find the delivery region that matches a geographic location. Provide either lat/long coordinates or a zipCode. Returns the matching region based on the store's configured delivery zones.

Query Parameters

Parameter	Type	Required	Description
lat	double	No	Latitude coordinate
long	double	No	Longitude coordinate
zipCode	string	No	ZIP code for location lookup

Response

Returns a BlazeRegion object.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
name	string	No	Name
active	boolean	No	Whether active (default: true)
latitude	double	No	Latitude
longitude	double	No	Longitude
regionDefault	boolean	No	Region Default (default: false)
deliveryFee	number	No	Delivery Fee
openAt	string	No	Open At
openAtNumeric	integer	No	Open At Numeric
closeAtNumeric	integer	No	Close At Numeric
closeAt	string	No	Close At
daysClose	string[]	No	Days Close
minOrderAmount	number	No	Min Order Amount
freeDeliveryAfter	number	No	Free Delivery After
zoneType	string	No	Zone Type. One of: zipCode (default: zipCode)
fileZone	string	No	File Zone
taxRuleId	string	No	Tax Rule identifier
deliveryCharge	number	No	Delivery Charge
kmlEdges	BlazeKmlEdge[]	No	Kml Edges
zipCodes	string[]	No	Zip Codes
kmlColor	string	No	Kml Color (default: ``)
allowedConsumerTypes	ConsumerType[]	No	Allowed Consumer Types

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "name": "string",
  "active": true,
  "latitude": 0,
  "longitude": 0,
  "regionDefault": false,
  "deliveryFee": 0,
  "openAt": "string",
  "openAtNumeric": 0,
  "closeAtNumeric": 0,
  "closeAt": "string",
  "daysClose": [],
  "minOrderAmount": 0,
  "freeDeliveryAfter": 0,
  "zoneType": "zipCode",
  "fileZone": "string",
  "taxRuleId": "abc123",
  "deliveryCharge": 0,
  "kmlEdges": [
    {
      "active": false,
      "coordinates": [],
      "asset": {}
    }
  ],
  "zipCodes": [],
  "kmlColor": "",
  "allowedConsumerTypes": [
    {}
  ]
}