Endpoints

Transportistas

Catálogo de transportistas. Se usa como referencia (carrier_entity_id) al emitir Guías de Remisión (tipo 06).

GET/carriers API Key

Lista 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.

CampoTipoRequeridoDescripción
businessIdintID del negocio.
pageint No Número de página. Por defecto 1.
perPageint No Tamaño de página. Por defecto 25, máximo 100. Alias: limit.
sortBystring No Campo de ordenamiento. Valores admitidos: id, identification, businessName, email, cellphone, address, createdAt. Por defecto businessName asc.
sortDirstring No Sentido del ordenamiento: asc o desc.
searchstring No Búsqueda parcial sobre identificación, razón social y correo.
identificationTypeIdint No Filtra por tipo de identificación.
idsstring No Lista de IDs separados por coma. Devuelve únicamente esos registros.
GET/carriers/{id} API Key

Obtiene un transportista por su ID.

CampoTipoRequeridoDescripción
businessIdintID del negocio.
GET/carriers/search/{identification} API Key

Busca un transportista por número de identificación.

POST/carriers API Key

Crea un nuevo transportista.

CampoTipoRequeridoDescripción
businessIdintID del negocio.
identificationTypeIdintTipo de identificación (ver /catalogs/identification-types).
identificationstring(20)Número de identificación.
businessNamestring(200)Razón social o nombre.
addressstring No Dirección.
phoneNumberstring(20) No Teléfono fijo.
phoneExtensionstring(10) No Extensión telefónica.
cellphonestring(20) No Celular.
emailstring 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"
}
PUT/carriers/{id} API Key

Actualiza un transportista existente.

json
{
  "businessName": "Logística Andina Cía. Ltda.",
  "email": "contacto@logisticaandina.com"
}
DELETE/carriers/{id} API Key

Elimina (soft-delete) un transportista.

json
{ "businessId": 1 }