Proveedores de Domicilio

Crear o editar un proveedor de domicilio

Crea un nuevo proveedor de domicilio o actualiza uno existente.

  • Si se envía _id en el body, se actualiza el proveedor existente.
  • Si no se envía _id, se crea un nuevo proveedor.
  • Se puede adjuntar una imagen (campo avatar) como multipart/form-data.
  • Requiere el permiso DP_POST (Crear/Editar).
post/deliveryProviders

Request

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

Request body multipart/form-data

_idstring

ID del proveedor. Si se envía, se actualiza; si no, se crea.

namestring required

Nombre del proveedor de domicilio

urlImagestring

URL de la imagen del proveedor (se sobreescribe si se sube avatar)

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

paymentMethodstring

ID del método de pago asociado al proveedor

avatarstring binary

Imagen del proveedor (máximo 8MB)

Example request

{
  "_id": "507f1f77bcf86cd799439011",
  "name": "Rappi",
  "urlImage": "https://ejemplo.com/rappi.png",
  "isActive": true,
  "percentagePerSale": 15,
  "unpaidSalesForDefault": true,
  "paymentMethod": "507f1f77bcf86cd799439033"
}

Response

Proveedor de domicilio creado o actualizado 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.