Catálogo de transportistas. Se usa como referencia (carrier_entity_id) al emitir Guías de Remisión (tipo 06).
/carriers API KeyLista transportistas de un negocio.
Colección paginada: sin page ni perPage recibes la primera página de 25 registros y el bloque meta. Ver Paginación y filtros.
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| businessId | int | Sí | ID del negocio. |
| page | int | No | Número de página. Por defecto 1. |
| perPage | int | No | Tamaño de página. Por defecto 25, máximo 100. Alias: limit. |
| sortBy | string | No | Campo de ordenamiento. Valores admitidos: id, identification, businessName, email, cellphone, address, createdAt. Por defecto businessName asc. |
| sortDir | string | No | Sentido del ordenamiento: asc o desc. |
| search | string | No | Búsqueda parcial sobre identificación, razón social y correo. |
| identificationTypeId | int | No | Filtra por tipo de identificación. |
| ids | string | No | Lista de IDs separados por coma. Devuelve únicamente esos registros. |
/carriers/{id} API KeyObtiene un transportista por su ID.
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| businessId | int | Sí | ID del negocio. |
/carriers/search/{identification} API KeyBusca un transportista por número de identificación.
/carriers API KeyCrea un nuevo transportista.
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| businessId | int | Sí | ID del negocio. |
| identificationTypeId | int | Sí | Tipo de identificación (ver /catalogs/identification-types). |
| identification | string(20) | Sí | Número de identificación. |
| businessName | string(200) | Sí | Razón social o nombre. |
| address | string | No | Dirección. |
| phoneNumber | string(20) | No | Teléfono fijo. |
| phoneExtension | string(10) | No | Extensión telefónica. |
| cellphone | string(20) | No | Celular. |
| string | No | Correo electrónico. |
json
{
"businessId": 1,
"identificationTypeId": 1,
"identification": "0105678901",
"businessName": "Logística Andina",
"address": "Vía Daule km 14, Guayaquil",
"cellphone": "0991234567",
"email": "operaciones@logisticaandina.com"
}/carriers/{id} API KeyActualiza un transportista existente.
json
{
"businessName": "Logística Andina Cía. Ltda.",
"email": "contacto@logisticaandina.com"
}/carriers/{id} API KeyElimina (soft-delete) un transportista.
json
{ "businessId": 1 }
