List fulfillment options - Fire spark

{
  "data": [
    {
      "id": "delivery",
      "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Delivery",
      "type": "DELIVERY",
      "status": "ACTIVE",
      "channel_ids": ["app", "web", "call-center"]
    },
    {
      "id": "pickup",
      "uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Pickup",
      "type": "PICKUP",
      "status": "ACTIVE",
      "channel_ids": ["app", "web"]
    },
    {
      "id": "drive-thru",
      "uid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Drive-thru",
      "type": "DRIVE_THRU",
      "status": "ACTIVE",
      "channel_ids": ["kiosk"]
    }
  ]
}

Returns all fulfillment options configured for the authenticated merchant. Use this endpoint to map Fire spark fulfillment types to pickup, delivery, and dine-in flows in your POS or RMS before syncing stores and composing menus.

Requires an access token with the fulfillment:read scope. See Token to obtain a token.

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/integrations/v1/fulfillment?channel_id=app" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response

The response wraps an array of fulfillment objects in data. Each object represents one fulfillment mode — built-in types such as DELIVERY and PICKUP, or custom types such as DRIVE_THRU.

{
  "data": [
    {
      "id": "delivery",
      "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Delivery",
      "type": "DELIVERY",
      "status": "ACTIVE",
      "channel_ids": ["app", "web", "call-center"]
    },
    {
      "id": "pickup",
      "uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Pickup",
      "type": "PICKUP",
      "status": "ACTIVE",
      "channel_ids": ["app", "web"]
    },
    {
      "id": "drive-thru",
      "uid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Drive-thru",
      "type": "DRIVE_THRU",
      "status": "ACTIVE",
      "channel_ids": ["kiosk"]
    }
  ]
}

Fulfillment object

Field	Type	Description
`id`	string	External fulfillment identifier. Alphanumeric characters, `_`, and `-` only. 1–64 characters. Unique per merchant.
`uid`	string (UUID)	Fire spark internal identifier.
`merchant_id`	string (UUID)	Merchant the fulfillment option belongs to.
`name`	string	Display name. 1–100 characters.
`type`	string	Fulfillment type code. 1–100 characters. Unique per merchant among active records. Common values: `DELIVERY`, `PICKUP`, `DINE_IN`. Custom codes such as `DRIVE_THRU` or `CURBSIDE` are supported.
`status`	string	`ACTIVE` or `INACTIVE`.
`channel_ids`	string[]	External channel identifiers where this fulfillment is available. Empty means inaccessible on every channel.

Mapping fulfillment to your POS

Match the id field to the fulfillment identifier in your POS or RMS. Fire spark uses this external ID when composing menus and attaching fulfillment rules to stores and channels.

Fulfillment uid values are stable Fire spark identifiers. Use id for cross-system mapping and uid when referencing fulfillment options in other Fire spark API calls. Use type when you need the semantic mode code (DELIVERY, PICKUP, and so on).

Error responses

Status	Description
`401`	Missing or invalid access token.
`403`	Token does not include the `fulfillment:read` scope.