Skip to main content
GET
List fulfillment options
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.

Request

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.

Fulfillment object

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

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Ok

data
object[]