Saltar al contenido principal
GET
/
fulfillment
Listar opciones de fulfillment
curl --request GET \
  --url https://api.example.com/fulfillment
{
  "data": [
    {
      "id": "delivery",
      "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "organization_id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Delivery",
      "type": "DELIVERY",
      "status": "ACTIVE"
    },
    {
      "id": "pickup",
      "uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "organization_id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Pickup",
      "type": "PICKUP",
      "status": "ACTIVE"
    },
    {
      "id": "drive-thru",
      "uid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "organization_id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Drive-thru",
      "type": "DRIVE_THRU",
      "status": "ACTIVE"
    }
  ]
}
Devuelve todas las opciones de fulfillment configuradas para el comercio autenticado. Usa este endpoint para mapear tipos de fulfillment de Fire spark con flujos de retiro, delivery y dine-in en tu POS o RMS antes de sincronizar tiendas y componer menús.
Requiere un access token con el scope fulfillment:read. Consulta Autorizar para obtener un token.

​
Solicitud

curl "https://firespark.vercel.app/api/integrations/v1/fulfillment" \
  -H "Authorization: Bearer ACCESS_TOKEN"

​
Respuesta

La respuesta envuelve un arreglo de objetos de fulfillment en data. Cada objeto representa un modo de fulfillment — tipos integrados como DELIVERY y PICKUP, o tipos personalizados como DRIVE_THRU. 
{
  "data": [
    {
      "id": "delivery",
      "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "organization_id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Delivery",
      "type": "DELIVERY",
      "status": "ACTIVE"
    },
    {
      "id": "pickup",
      "uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "organization_id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Pickup",
      "type": "PICKUP",
      "status": "ACTIVE"
    },
    {
      "id": "drive-thru",
      "uid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "organization_id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Drive-thru",
      "type": "DRIVE_THRU",
      "status": "ACTIVE"
    }
  ]
}

​
Objeto fulfillment

CampoTipoDescripción
idstringIdentificador externo de fulfillment. Solo caracteres alfanuméricos, _ y -. 1–64 caracteres. Único por comercio.
uidstring (UUID)Identificador interno de Fire spark.
organization_idstring (UUID)Organización propietaria del comercio.
merchant_idstring (UUID)Comercio al que pertenece la opción de fulfillment.
namestringNombre para mostrar. 1–100 caracteres.
typestringCódigo del tipo de fulfillment. 1–100 caracteres. Único por comercio entre registros activos. Valores comunes: DELIVERY, PICKUP, DINE_IN. También se admiten códigos personalizados como DRIVE_THRU o CURBSIDE.
statusstringACTIVE o INACTIVE.

​
Mapear fulfillment con tu POS

Haz coincidir el campo id con el identificador de fulfillment en tu POS o RMS. Fire spark usa este ID externo al componer menús y adjuntar reglas de fulfillment a tiendas y canales.
Los valores uid de fulfillment son identificadores estables de Fire spark. Usa id para mapeo entre sistemas y uid al referenciar opciones de fulfillment en otras llamadas a la API de Fire spark. Usa type cuando necesites el código semántico del modo (DELIVERY, PICKUP, etc.).

​
Respuestas de error

EstadoDescripción
401Access token ausente o inválido.
403El token no incluye el scope fulfillment:read.