List fulfillment options
curl --request GET \
--url https://firespark.cloud/api/storefront/v1/fulfillment \
--header 'Authorization: Bearer <token>'import requests
url = "https://firespark.cloud/api/storefront/v1/fulfillment"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://firespark.cloud/api/storefront/v1/fulfillment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://firespark.cloud/api/storefront/v1/fulfillment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://firespark.cloud/api/storefront/v1/fulfillment"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://firespark.cloud/api/storefront/v1/fulfillment")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://firespark.cloud/api/storefront/v1/fulfillment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "delivery",
"uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"brand_id": null,
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Delivery",
"type": "DELIVERY",
"status": "ACTIVE"
},
{
"id": "pickup",
"uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"brand_id": null,
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Pickup",
"type": "PICKUP",
"status": "ACTIVE"
},
{
"id": "drive-thru",
"uid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"brand_id": null,
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Drive-thru",
"type": "DRIVE_THRU",
"status": "ACTIVE"
}
]
}
Fulfillment
List fulfillment options
List all customer-facing fulfillment modes for the merchant.
GET
/
fulfillment
List fulfillment options
curl --request GET \
--url https://firespark.cloud/api/storefront/v1/fulfillment \
--header 'Authorization: Bearer <token>'import requests
url = "https://firespark.cloud/api/storefront/v1/fulfillment"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://firespark.cloud/api/storefront/v1/fulfillment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://firespark.cloud/api/storefront/v1/fulfillment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://firespark.cloud/api/storefront/v1/fulfillment"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://firespark.cloud/api/storefront/v1/fulfillment")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://firespark.cloud/api/storefront/v1/fulfillment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "delivery",
"uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"brand_id": null,
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Delivery",
"type": "DELIVERY",
"status": "ACTIVE"
},
{
"id": "pickup",
"uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"brand_id": null,
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Pickup",
"type": "PICKUP",
"status": "ACTIVE"
},
{
"id": "drive-thru",
"uid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"brand_id": null,
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Drive-thru",
"type": "DRIVE_THRU",
"status": "ACTIVE"
}
]
}
Returns every active fulfillment option configured for the merchant. Use this endpoint to build fulfillment pickers or to load fulfillment metadata before configuring checkout flows.
Requires a Fire spark access token obtained through token
exchange. The token scopes requests to the
authenticated customer and merchant.
Request
curl "https://firespark.cloud/api/storefront/v1/fulfillment" \
-H "Authorization: Bearer ACCESS_TOKEN"
Response
The response wraps an array of fulfillment objects indata. Only ACTIVE options are included.
{
"data": [
{
"id": "delivery",
"uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"brand_id": null,
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Delivery",
"type": "DELIVERY",
"status": "ACTIVE"
},
{
"id": "pickup",
"uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"brand_id": null,
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Pickup",
"type": "PICKUP",
"status": "ACTIVE"
},
{
"id": "drive-thru",
"uid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"brand_id": null,
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Drive-thru",
"type": "DRIVE_THRU",
"status": "ACTIVE"
}
]
}
Fulfillment object
| Field | Type | Description |
|---|---|---|
id | string | External fulfillment identifier. Alphanumeric characters, _, and - only. 1–64 characters. |
uid | string (UUID) | Fire spark internal identifier. |
brand_id | string | null | External brand identifier. null when the resource is not brand-scoped. |
organization_id | string (UUID) | Fire spark organization identifier. |
merchant_id | string (UUID) | Fire spark merchant identifier. |
name | string | Display name. 1–100 characters. |
type | string | Fulfillment type code. 1–100 characters. Common values: DELIVERY, PICKUP, DINE_IN. Custom codes such as DRIVE_THRU are supported. |
status | string | ACTIVE or INACTIVE. |
Store-level rules — pricing, coverage zones, availability, and instructions —
are returned on stores under each store’s
fulfillment object, keyed by fulfillment type. Use this endpoint for
merchant-wide definitions; use stores for what each location can honor.Error responses
| Status | Description |
|---|---|
401 | Missing or invalid access token. |
403 | Token does not have access to this merchant’s fulfillment options. |
⌘I