List fulfillment options - Fire spark

{
  "data": [
    {
      "id": "delivery",
      "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "brand_id": null,
      "merchant_id": "22222222-2222-2222-2222-222222222222",
      "name": "Delivery",
      "type": "DELIVERY",
      "status": "ACTIVE"
    },
    {
      "id": "pickup",
      "uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "brand_id": null,
      "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,
      "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.

Query parameters

Parameter	Required	Description
`channel_id`	No	External channel identifier. When set, only fulfillments whose `channel_ids` include this value are returned.

Request

curl "https://firespark.cloud/api/storefront/v1/fulfillment?channel_id=app" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response

The response wraps an array of fulfillment objects in data. Only ACTIVE options are included.

{
  "data": [
    {
      "id": "delivery",
      "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "brand_id": null,
      "merchant_id": "22222222-2222-2222-2222-222222222222",
      "name": "Delivery",
      "type": "DELIVERY",
      "status": "ACTIVE"
    },
    {
      "id": "pickup",
      "uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "brand_id": null,
      "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,
      "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.
`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`.
`checkout_release`	boolean	`true` when the workflow has a Release checkout node. Checkout should wait on `order.changed` / `checkout_state`.

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.