Skip to content

4. Proveedores

Se entiende por proveedor a una empresa o persona que proporciona unidades de transporte

Este modulo es el encargado de gestionar los proveedores del sistema, se exponen los siguientes recursos:

Método Endpoint Descripción
GET /api/providers Lista de Proveedores registrados
POST /api/providers Crear un proveedor
GET /api/providers/{providerId} Detalles de Proveedor
PATCH /api/providers/{providerId} Modificación de datos de un Proveedor
DELETE /api/providers/{providerId} Eliminación de un Proveedor si no tiene datos relacionados

Ejemplo de cuerpo json POST

{
    "code": "Prv001",
    "name": "FerreAustro",
    "document_type_code": "ruc",
    "document_number": "056532664",
    "address": "Av. El triunfo",
    "phone": "417522654",
    "email": "ferreaustro@gmail.com",
    "commercial_representative": "Juan Perez",
    "contact_data": {
        "email": "ferreaustrocontact@gmail.com",
        "web": "https://www.google.com",
        "phone_1": "09412156",
        "phone_2": "09424545",
        "address": "Av. El triunfo"
    },
    "custom_properties" : {}
}

4.1 Parámetros

Nombre Modo Tipo Descripción
code Optional String Admite letras, números, guiones y guiones bajos pero no espacios
name Required String Nombre de proveedor
document_type_code Required String Tipo de documento registrado en el modulo de taxonomías del sistema
document_number Required String Número de Documento alfanumérico
address Optional String Dirección del proveedor
phone Optional String Teléfono del proveedor
email Optional String - Email Email del proveedor
commercial_representative Optional String Nombre del Representante Comercial
contact_data.email Optional String - Email Email de contacto
contact_data.web Optional String - Url Dirección Web
contact_data.phone_1 Optional String Teléfono 1
contact_data.phone_2 Optional String Teléfono 2
contact_data.address Optional String Dirección
custom_properties Optional Array Parámetros custom adicionales