Destinatarios

Antes de empezar

• Un destinatario es otra persona que puede recibir el pedido en nombre del cliente.
• Solo puede haber un destinatario activo. Al guardar uno activo, los demás dejan de serlo.
• El documento y el email no se pueden repetir entre los destinatarios de un mismo cliente.

Listar destinatarios

GET /api/v1/ecommerce/receive-extra

Respuesta

{
  "success": true,
  "message": "Listado de datos mostrados de forma correcta.",
  "data": [
    {
      "id": 7,
      "document": "45678912",
      "name": "María López",
      "position": "Asistente",
      "email": "[email protected]",
      "phone": "987654321",
      "country_id": "PE",
      "status": true
    }
  ]
}

Campo	Tipo	Qué es
document	texto	Documento de identidad
name	texto	Nombre completo
position	texto o null	Cargo, si se indicó
email	texto	Correo
phone	texto	Teléfono
country_id	texto	Código del país del teléfono
status	booleano	Si es el destinatario activo

Añadir un destinatario

POST /api/v1/ecommerce/receive-extra/register

Cuerpo

Campo	Tipo	Obligatorio	Reglas
name	texto	Sí	Máximo 200 caracteres
document	texto	Sí	Máximo 20 caracteres. No puede repetirse entre los destinatarios del cliente
email	texto	Sí	Email válido de hasta 50 caracteres. No puede repetirse entre los destinatarios del cliente
phone	texto	Sí	Entre 9 y 20 caracteres
country_id	texto	Sí	Código del país, hasta 5 caracteres
position	texto	No	Máximo 100 caracteres
status	booleano	Sí	true para que sea el destinatario activo

{
  "name": "María López",
  "document": "45678912",
  "email": "[email protected]",
  "phone": "987654321",
  "country_id": "PE",
  "position": "Asistente",
  "status": true
}

Respuesta

Devuelve el destinatario creado, con los mismos campos que el listado.

Si algo sale mal

HTTP	code	Cuándo	Qué hacer
422	VALIDATION_ERROR	Falta un campo, o el documento o el email ya están registrados en otro destinatario del cliente	Corrige el campo que indica errors

Editar un destinatario

PUT /api/v1/ecommerce/receive-extra/update/{id}

Solo cambia los campos que se envían: los demás se quedan como estaban. Así, para cambiar el teléfono basta con enviar phone.

Cuerpo

Los mismos campos que al añadir, todos opcionales. Si un campo se envía, tiene que cumplir sus reglas y no puede ir vacío. La excepción es position: enviarlo en null borra el cargo.

{ "phone": "911222333" }

Si se envía status: true, este pasa a ser el destinatario activo y los demás dejan de serlo.

Respuesta

Devuelve el destinatario actualizado, con los mismos campos que el listado.

Si algo sale mal

HTTP	code	Cuándo	Qué hacer
422	VALIDATION_ERROR	Un campo enviado está vacío o no cumple sus reglas, o el documento o el email ya los tiene otro destinatario del cliente	Corrige el campo que indica errors
404	RECIPIENT_NOT_FOUND	El destinatario no existe o no es del cliente	Vuelve a listar los destinatarios

Borrar un destinatario

DELETE /api/v1/ecommerce/receive-extra/delete/{id}

{ "success": true, "message": "Información procesada con éxito", "data": null }

Si el destinatario borrado era el activo, pasa a ser activo otro de los que quedan.

Si algo sale mal

HTTP	code	Cuándo
404	RECIPIENT_NOT_FOUND	El destinatario no existe o no es del cliente