Restofy Docs

Listar canales de entrega

POST /api/fulfillments/list-fulfillments

Descripción

Retorna los canales de entrega disponibles del restaurante, paginados, con búsqueda y filtro por tipo.

Detalles

Lista los canales de entrega disponibles del restaurante. Permite buscar por coincidencia parcial en el nombre y acotar por tipo de entrega. Cada canal incluye su tipo y si es del sistema. Los canales eliminados no se incluyen en la respuesta.

Permisos requeridos

admin.module

Request

Nombre Tipo Requerido Reglas
query string No
max:100
fulfillmentTypeId int No
min_value:1

Paginación

defaultLimit 50
maxLimit 100
allowedSorts name, createdAt
defaultSort name
defaultDir asc
withTotal true

Ejemplo de request

curl -X POST https://app.restofy.co/api/fulfillments/list-fulfillments \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <accessToken>"

Los valores son demo: reemplázalos por datos reales del negocio.

Ejemplo de respuesta

Actualizado: 2026-07-15T13:20:48Z
HTTP 200

Request

{
    "query": "Domicilio propio"
}

Response

{
    "success": true,
    "message": "Operación realizada correctamente",
    "data": {
        "fulfillments": [
            {
                "uuid": "81fa4b62-7eb3-11f1-ac02-f2368af4d8ac",
                "name": "Domicilio propio",
                "description": "Domicilio con repartidor del restaurante",
                "callerMode": null,
                "isSystem": 0,
                "fulfillmentTypeId": 4,
                "fulfillmentTypeCode": "fulfillment.delivery",
                "fulfillmentTypeName": "A domicilio",
                "createdAt": "2026-04-20T13:36:27.000Z"
            }
        ],
        "pagination": {
            "page": 1,
            "limit": 50,
            "total": 1,
            "totalPages": 1,
            "hasNext": false,
            "hasPrev": false
        }
    }
}