Saltar al contenido principal
PUT
/
fulfillment
Actualizar opciones de fulfillment
curl --request PUT \
  --url https://api.example.com/fulfillment
{
  "data": {
    "created": 2,
    "updated": 1
  }
}
Crea o actualiza una o más opciones de fulfillment para el comercio autenticado. Usa este endpoint para sincronizar nombres, códigos de tipo y estado de fulfillment desde tu stack operacional hacia Fire spark. Cada elemento del arreglo se empareja por id. Si no existe una opción con ese id para el comercio, Fire spark la crea. Si ya existe, Fire spark actualiza los campos editables indicados abajo. Los campos omitidos conservan su valor actual en una actualización.
Requiere un access token con el scope fulfillment:write. Consulta Autorizar para obtener un token.
Los valores id de fulfillment son inmutables. No puedes cambiar el id de una opción existente mediante este endpoint — envía el mismo id en cada sincronización.

​
Solicitud

Envía un arreglo JSON. Cada elemento representa una opción de fulfillment. Incluye id en cada elemento — es el identificador externo estable y la clave de upsert. No puede cambiarse después de crear la opción. 
curl -X PUT "https://firespark.vercel.app/api/integrations/v1/fulfillment" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "id": "delivery",
      "name": "Delivery",
      "type": "DELIVERY",
      "status": "ACTIVE"
    },
    {
      "id": "pickup",
      "name": "Pickup",
      "type": "PICKUP",
      "status": "ACTIVE"
    },
    {
      "id": "drive-thru",
      "name": "Drive-thru",
      "type": "DRIVE_THRU",
      "status": "ACTIVE"
    }
  ]'

​
Campos de la solicitud

CampoTipoDescripción
idstringRequerido. Identificador externo de fulfillment. Solo caracteres alfanuméricos, _ y -. 1–64 caracteres. Único por comercio. Clave de upsert. No puede cambiarse después de crear la opción.
namestringNombre para mostrar. 1–100 caracteres.
typestringRequerido al crear. Có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.
statusstringACTIVE o INACTIVE.
Cada comercio puede tener como máximo una opción de fulfillment activa por código type. Intentar crear o actualizar un segundo registro activo con el mismo type devuelve un error de validación.

​
Respuesta

{
  "data": {
    "created": 2,
    "updated": 1
  }
}

​
Respuestas de error

EstadoDescripción
400El cuerpo de la solicitud no pasó la validación. Revisa las restricciones de campos arriba.
401Access token ausente o inválido.
403El token no incluye el scope fulfillment:write.
422Violación de regla de negocio — por ejemplo intentar cambiar un id de fulfillment, o duplicar id, name o type para el comercio entre registros activos.
Error de validación
{
  "error": "validation_error",
  "message": "type: Required"
}