Registrar consignado en dirección de cliente
POST /api/consigneds/store-document
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Agrega al cliente una nueva dirección de entrega con consignado. Si ya existe un consignado con ese número se reutiliza; si no, se crea.
Quién puede usarlo: cualquier usuario autenticado (administrador o vendedor).
Formato de respuesta: heredado {success, message?, data?} sin paginación. Ante reglas de negocio puede responder HTTP 200 con success: false: revisa siempre success.
| Campo | Tipo | Obligatorio | Descripción / valores permitidos |
|---|---|---|---|
person_id |
integer | Sí | Id del cliente. |
identity_document_type_id / number / name |
string | Sí | Documento y nombre del consignado. |
telephone |
string | No | Teléfono (también se guarda en la dirección). |
country_id |
string | Sí | País de la dirección (PE). |
location_id |
array | Sí | Ubigeo [departamento, provincia, distrito]. |
address |
string | Sí | Dirección de entrega. |
establishment_code |
string | No | Código de establecimiento anexo SUNAT. |
Errores:
- Sin ubigeo de 3 elementos o dirección repetida (mismo cliente, distrito y dirección): HTTP 200 con
success: false.
Cuerpo
Content-Type: application/json
{
"person_id": "1",
"identity_document_type_id": "1",
"number": "45678912",
"name": "ROSA HUAMAN TORRES",
"telephone": "987111222",
"country_id": "PE",
"location_id": [
"04",
"0401",
"040101"
],
"address": "AV. EJERCITO 710, AREQUIPA",
"establishment_code": null
}
Respuestas
200 — Registrado
{
"id": 3,
"success": true,
"message": "Consignado registrado con éxito"
}
200 — Dirección repetida
{
"success": false,
"message": "Dirección ya existe"
}
Pruébalo
Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.