Proveedores de Domicilio

Obtener todos los proveedores de domicilio

Retorna la lista de proveedores de domicilio activos del negocio autenticado. Se puede filtrar por estado activo mediante el parámetro active. Requiere autenticación con Bearer Token.

get/deliveryProviders

Request

  • Base URL
    https://api.pirpos.com
  • URL
    https://api.pirpos.com/deliveryProviders
  • Auth
    HTTP bearer

Query parameters

activeboolean

Filtrar por estado activo del proveedor (true/false)

Response

Lista de proveedores de domicilio obtenida exitosamente

_idstring

ID único del proveedor de domicilio

businessstring

ID del negocio al que pertenece el proveedor

namestring

Nombre del proveedor de domicilio

urlImagestring

URL de la imagen/logo del proveedor

isActiveboolean

Si el proveedor está activo

percentagePerSalenumber

Porcentaje que cobra el proveedor por cada venta

unpaidSalesForDefaultboolean

Si las facturas quedan pendientes por pagar por defecto

deletedboolean

Si el proveedor está eliminado (soft delete)

modifiedOnstring date-time

Fecha de última modificación

createdOnstring date-time

Fecha de creación

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "business": "507f1f77bcf86cd799439012",
    "name": "Rappi",
    "urlImage": "https://ejemplo.com/rappi.png",
    "isActive": true,
    "percentagePerSale": 15,
    "unpaidSalesForDefault": true,
    "paymentMethod": {
      "_id": "507f1f77bcf86cd799439033",
      "name": "Transferencia"
    },
    "modifiedOn": "2025-08-04T10:30:00.000Z",
    "createdOn": "2025-08-01T09:15:00.000Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.