Listado - Entregas/Servicios

GET 
https://api.cargoffer.com/api/delivery

Listado de todos los servicios

Request

Query Parameters

limit integer

Elementos por Pagina, Default 25

page integer

Default value: 1

Pagina a Consultar, Default 1. En caso que se envíe una pagina que no exista se cambiará en back por la ultima

order string

Forma de Ordenación o campo desde el que ordenar

Header Parameters

apikey stringrequired

Apikey de una company vinculada a un usuario

Responses

200

Example response

application/json

Schema

Schema

data object
docs object[]
Array [
_id string
Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$
Id de uso interno de la base datos
auction objectrequired
Este es el objeto completo de Subasta. Ten en cuenta que habrá campos que sean de uso interno de la base de datos o del servidor y no se podrán modificar con la edición o creación del objeto.
Los Objetos relacionados y los listados de objetos; en el momento de la creación y edición NO son necesarios poner el objeto completo, será solo necesrio poner el _id correspondiente del objeto.
_id string
Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$
Id de uso interno de la base datos
bids_count integer
Default value: 0
Numero de Pujas en la Subasta
cancelled_company_date timestamp
Possible values: non-empty
Fecha en la que ha sido cancelado por la Compañia
cancelled_trucker_date timestamp
Possible values: non-empty
Fecha en la que ha sido cancelado por el Transportista (TruckerCia)
cargo_height integer
Possible values: <= 4500
Default value: 0
Altura de la carga. Ten en cuenta el valor de is_imperial_measure para saber de cm/ En caso quwe no se envíe dato en la creación, se tomará la altura máxima de un pallet para ello .
cargo_type stringrequired
Possible values: [pallets, full, package, trailer]
Tipo de Envío: Bulto, Paletizado, CArga Completa, Metros Lineales
cargo_weight integerrequired
Possible values: <= 24000
Peso de la Carga. Ten en cuenta el valor del is_imperial_measure para saber si son kg/lb
createdAt timestamp
Possible values: non-empty
custom_code string
Possible values: <= 560 characters
Este campo será de uso interno (tuyo) para la organización de las subastas y de loas entregaas.
date_end stringrequired
Possible values: non-empty
Fecha de fin de la subasta. Se aceptarán pujas hasta esta fecha. Si llegada esta fecha no hay pujas, se considera 'empty
date_start stringrequired
Possible values: non-empty
Fecha comienzo subasta. Se considera Draft si este campo es null; y planned, si tiene algún valor > NOW().
deletedAt timestamp
Possible values: non-empty
email_end_notified boolean
Su valor será true en caso que se haya mandando las notificaciones al terminar
etd_address objectrequired
Direcciones de Envío / Recogida. Son necesarias para que el calculo de costes, rutas y funcionamiento general de la plataforma sea correcto. Ten en cuenta que usaremos tanto la posición GPS como el código postal para gestinar y comprobar que todos los datos son correctos; por lo que es importante que estén correctos. En caso que algún dato esté mal introducido; ten en cuenta que serán registrados en el contrato y todos los documentos legales del proceso.
_id string
Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$
Id de uso interno de la base datos
city string
Possible values: non-empty
Ciudad de la dirección
company_name stringrequired
Possible values: non-empty
Nombre de la compañia destino. Será usada para verificación de datos
country stringrequired
Possible values: >= 3 characters and <= 20 characters
https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
location objectrequired
Posicion GPS de localización
name string
Possible values: non-empty
Nombre (o apodo) que le das a la dirección para tu uso
name_address stringrequired
Possible values: non-empty
Dato completo
phone string
Possible values: non-empty
Telefono de contacto del usuario
province string
Possible values: non-empty
Provincia de la dirección
state string
Possible values: non-empty
Provincia o Comunidad de la dirección. En caso de no ser compatible con el formato de la dirección puede quedar vacio
street_address string
Possible values: non-empty
Dirección Fisica; calle, avenida, etc
street_number string
Possible values: non-empty
Numero de Portal de la dirección
zipcode stringrequired
Possible values: non-empty
Codigo Postal de la dirección. Dependerá del pais para el uso de un formato u otro.
etd_cargo_method string
Possible values: non-empty, [back, lateral, superior]
Default value: back
En caso que haya un metodo de Carga o una acceso al dock de carga determinado en el Origen de l viaje.
etd_date timestamp
Possible values: non-empty
Fecha de Entrega. En caso que haya un margen de tiempo, ten en cuenta la hora de comienzo
etd_extra_time integer
Possible values: <= 99999
Default value: 0
Tiempo rango extra desde el etd_date., Corresponden al numero de minutos entre la fecha de entrega y el rango horario. Por ejempo Si la etd_date está a las 08:00 la hora, esto será el numero de minutos para la entreega a las 08:05
etl_address object
Direcciones de Envío / Recogida. Son necesarias para que el calculo de costes, rutas y funcionamiento general de la plataforma sea correcto. Ten en cuenta que usaremos tanto la posición GPS como el código postal para gestinar y comprobar que todos los datos son correctos; por lo que es importante que estén correctos. En caso que algún dato esté mal introducido; ten en cuenta que serán registrados en el contrato y todos los documentos legales del proceso.
_id string
Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$
Id de uso interno de la base datos
city string
Possible values: non-empty
Ciudad de la dirección
company_name stringrequired
Possible values: non-empty
Nombre de la compañia destino. Será usada para verificación de datos
country stringrequired
Possible values: >= 3 characters and <= 20 characters
https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
location objectrequired
Posicion GPS de localización
name string
Possible values: non-empty
Nombre (o apodo) que le das a la dirección para tu uso
name_address stringrequired
Possible values: non-empty
Dato completo
phone string
Possible values: non-empty
Telefono de contacto del usuario
province string
Possible values: non-empty
Provincia de la dirección
state string
Possible values: non-empty
Provincia o Comunidad de la dirección. En caso de no ser compatible con el formato de la dirección puede quedar vacio
street_address string
Possible values: non-empty
Dirección Fisica; calle, avenida, etc
street_number string
Possible values: non-empty
Numero de Portal de la dirección
zipcode stringrequired
Possible values: non-empty
Codigo Postal de la dirección. Dependerá del pais para el uso de un formato u otro.
etl_cargo_method string
Possible values: non-empty, [back, lateral, superior]
Default value: back
Metodos de carga permitidos para la carga en ETL
etl_date timestamp
Possible values: non-empty
Fecha de Recogida. En caso que haya un margen de tiempo, ten en cuenta la hora de comienzo
etl_extra_time integer
Possible values: <= 9999
Default value: 0
Tiempo rango extra desde el etl_date., Corresponden al numero de minutos entre la fecha de recogida y el rango horario. Por ejempo Si la etd_date está a las 08:00 la hora, esto será el numero de minutos para la entreega a las 08:05
fresh_cargo_temp integer
Possible values: >= -30 and <= 10
Default value: 0
En caso que is_fresh a True, este valor el Requerido. Y será la temperatura optima de carga
had_etd_cargo_method boolean
Dispone de metodo de carga en Destino
had_etl_cargo_method had_etd_cargo_method (boolean)
Dispone de metodo de carga en Origen
hscode string
Codigo de Harminnozción Europeo. https://trade.ec.europa.eu/access-to-markets/en/content/harmonised-system-0
is_fresh boolean
Si el envío es refrigerado. Revisar el campo fresh_cargo_temp
is_imperial_measure boolean
Para marcar si usaremos Metricas imperiales (Liubras, pulgadas) o Metricas Decimales (cm, kg)
is_pallet boolean
Si el envío es paletizado. Revisar el campo cargo_type
linear_meters integer
Default value: 0
En caso que el carto_type sea "bulto" se tendrá en cuenta para calculo del volumen. Serán los mettros longitudinales de la carga
pallets_num integer
Possible values: <= 66
Default value: 0
Numero de pallets en el Envío
pallets_type string
Possible values: non-empty, [european, american, none]
Default value: european
Tipo de Pallet a usar. Se usará para calculos de volumen, medidas y comprobaciones legales. Tiene en cuenta el valor del campo is_pallet
plate_full_trailer string
Matricula del remolque, en caso de que el tipo de envío sea un remoqule directamente. Solo es aplicable en el tipo de cargo_type correspondiente.
service_code string
Id Unico dentro de la plataforma de Cargofer; se genera de forma automatica en la creación, y no se podrá repetir.
Sirve como código de trazabilidad de todo el envío, desde la creación a la entrega.
sign_image_cia string
Imagen de Firma del Cargador. Está en formato Base64
sign_image_trucker string
Imagen de Firma del Transportista; solo podría modificarse si aún no se ha firmado por ambas partes,. Está en formato Base64
signed_by_company boolean
Se cambia automaticamente cuando el Company/CArgador ha firmado; se usa para comprobaciones más sencillas.
signed_by_company_date timestamp
Possible values: non-empty
Fecha en la que ha sido firmado por la Company/Cargador. Se genera automaticamente en el servidor cuando se suba e firma correspondiente.
signed_by_company_notify boolean
Si ha sido notificado para firmar a Transportista (TruckerCia)
signed_by_trucker boolean
Si ha sido firmado por el Transportista (TruckerCia)
signed_by_trucker_date timestamp
Possible values: non-empty
Fecha en la que ha sido firmado por el Transportista (TruckerCia)
signed_by_trucker_notify boolean
Si ha sido notificado para firmar a la Compañia (Cargador)
status string
Possible values: [draft, planned, published, empty, awarded, approved, locked, canceled, rejected]
Default value: draft
Es el estado actual de la subasta. No será editable se modificará el estado dependiendo de los valores, condiciones de la subasta. draft - Borrador; no es publico y es editable planned - Planificada; Se puede bloquear. Aun no recibe pujas, por que no entró en tiempo de puja. published - Publicada empty - Desierta, sin Pujas awarded - Adjudicada approved - Aprobada, en proceso de Envío; ya no es editable. Y está asociada a un delivery. canceled - Cancelada por la Company rejected - Rechazada por el Trucker
updatedAt timestamp
Possible values: non-empty
Fecha de la ultima modificación del objeto
cargo_height integer
Possible values: <= 4500
Default value: 0
Altura de la carga. Ten en cuenta el valor de is_imperial_measure para saber de cm/inch
cargo_weight integer
Possible values: <= 24000
Peso de la Carga. Ten en cuenta el valor del is_imperial_measure para saber si son kg/lb
category string
TODO: Aun no están definidas las categorias
company objectrequired
Compañia Cargadora que es el origen de la subasta. Ya sea multitennant o Default. OJO: En el APi-Rest NO se permite la edición de estos datos, serán readOnly
_id string
Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$
Id de uso interno de la base datos
accountType string
Possible values: [default, multitennant, mining, custom]
Default value: default
Tipo de compañia: default -> Habitual ; la usa para publicar sus necesidades de carga y llevar el seguimiento. multitennant -> Tiene flota propia y contrata servicios externos Spot mining -> Especial para mineria custom - Cueta especial hecha a medida del cliente.
address object
Direcciones de Envío / Recogida. Son necesarias para que el calculo de costes, rutas y funcionamiento general de la plataforma sea correcto. Ten en cuenta que usaremos tanto la posición GPS como el código postal para gestinar y comprobar que todos los datos son correctos; por lo que es importante que estén correctos. En caso que algún dato esté mal introducido; ten en cuenta que serán registrados en el contrato y todos los documentos legales del proceso.
_id string
Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$
Id de uso interno de la base datos
city string
Possible values: non-empty
Ciudad de la dirección
company_name stringrequired
Possible values: non-empty
Nombre de la compañia destino. Será usada para verificación de datos
country stringrequired
Possible values: >= 3 characters and <= 20 characters
https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
location objectrequired
Posicion GPS de localización
name string
Possible values: non-empty
Nombre (o apodo) que le das a la dirección para tu uso
name_address stringrequired
Possible values: non-empty
Dato completo
phone string
Possible values: non-empty
Telefono de contacto del usuario
province string
Possible values: non-empty
Provincia de la dirección
state string
Possible values: non-empty
Provincia o Comunidad de la dirección. En caso de no ser compatible con el formato de la dirección puede quedar vacio
street_address string
Possible values: non-empty
Dirección Fisica; calle, avenida, etc
street_number string
Possible values: non-empty
Numero de Portal de la dirección
zipcode stringrequired
Possible values: non-empty
Codigo Postal de la dirección. Dependerá del pais para el uso de un formato u otro.
addresses object[]
Direcciones de Clientes. Usadas para Origen/Destino de las Auctions
Array [
_id string
Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$
Id de uso interno de la base datos
city string
Possible values: non-empty
Ciudad de la dirección
company_name stringrequired
Possible values: non-empty
Nombre de la compañia destino. Será usada para verificación de datos
country stringrequired
Possible values: >= 3 characters and <= 20 characters
https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
location objectrequired
Posicion GPS de localización
name string
Possible values: non-empty
Nombre (o apodo) que le das a la dirección para tu uso
name_address stringrequired
Possible values: non-empty
Dato completo
phone string
Possible values: non-empty
Telefono de contacto del usuario
province string
Possible values: non-empty
Provincia de la dirección
state string
Possible values: non-empty
Provincia o Comunidad de la dirección. En caso de no ser compatible con el formato de la dirección puede quedar vacio
street_address string
Possible values: non-empty
Dirección Fisica; calle, avenida, etc
street_number string
Possible values: non-empty
Numero de Portal de la dirección
zipcode stringrequired
Possible values: non-empty
Codigo Postal de la dirección. Dependerá del pais para el uso de un formato u otro.
]
contact_person object
Datos de la persona de contacto de una empresa. En el momento de registro de una empresa serán rellenados con los datos del formulario; yt luego podrán ser editados manualmente para especficar.
Será usado para el envíos de correos, comunicación e incidencias.
name string
Nombre de la persona de contacto.
lastname string
Primer apellido de la persona de contacto
email string
Email de contacto. Caundo se cree una Compañia será rellenado con el dato de ladel registro
phone string
invoice_data objectrequired
Datos de la facturación. Se usan para la generación de las facturas y para los enlaces fiscales correspondientes.
taxid string
NIF/DNI de la empresa, o numero fiscal
email email
phone regex
Possible values: Value must match regular expression 32435454N
Telefono de contacto de la dirección
name_address string
Dirección completa: GO Fit, Calle de la Verdad, Opañel, Carabanchel, Madrid, Comunidad de Madrid, 28019, España
name stringrequired
Possible values: non-empty
Nombre Comercial de la compañia
reason string
Possible values: [BAD_USER, NONE, PENDING, ACTIVE, BLOCKED]
Default value: NONE
reasonMessage string
Explicación del Bloqueo de la compañia. Ver status
socialName stringrequired
Possible values: non-empty
Nombre Legal de la compañia. Será usado para los documentos legales
status boolean
Si el usuario está habilitado o no para entrar en la plataforma, se aplica a todos los truckers asociados En caso de False; los datos de reason y reasonMessage tendrán inf
Cuando se registra una nueva compñai; hay que validar el correo del admin antes de poder ser true. Es modificado en el servidor. ción
truckers object[]
Conductores de la Compañia; estos tendrán acceso a la aplicación de transportistas con acceso a los servicios gestionados desde el panel de Company MultiTennant. para cuentas Multitennant
Array [
_id string
position object
Array de servicios y su última posición conocida
deliveries object[]
role string
Rol de la cuenta ("driver", "dev", "gestor" o "admin")
status boolean
Estado de la cuenta (Bloqueado o activo en booleano).
reason string
Razón de bloqueo de la cuenta.
emailVerified boolean
Booleano que indica si está el email verificado.
phone string
Teléfono del camionero.
country string
País de residencia del camionero.
timezone string
Zona horaria del camionero.
image string
Imagen del camionero.
recovery_token string
Token de recuperación de contraseña.
i18n string
Idioma del usuario camionero.
deleted boolean
Booleano que indica si el usuario ha sido borrado.
name string
Nombre del camionero.
lastname string
Apellido del camionero.
email string
Email del camionero (Debe ser único)
taxid string
Documento de identidad del camionero (Debe ser único).
password string
Contraseña hasheada de la cuenta de camionero.
]
users object[]
Possible values: >= 1
Los usuarios de la compañia
Array [
_id string
Possible values: non-empty
ID unico generado aleatoriamente en el momento de creación
birthDate string
Possible values: non-empty
Fecha de nacimiento del Usuario
cia
country ISO 3166-1required
Possible values: non-empty
https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
createdAt timeStamp
Possible values: non-empty
TimeStamp de la creación del objeto
email stringrequired
Possible values: non-empty
Email usado para el Login. Debe ser unico en el el sistema
emailVerified boolean
Boolean para saber si un usuario ha validado el correo. No se podrá conectar si no está validado
i18n string
Possible values: >= 2 characters and <= 3 characters
Codigo ISO del idioma Actual
lastSignInAt date-time
Possible values: non-empty
TimeStamp del ultimo Login de usuario
lastSignInIp ipv4
Possible values: non-empty
Ultima IP desde la que se ha conectado el usuario
lastname stringrequired
Possible values: non-empty
Apellido del Usuario
name stringrequired
Possible values: non-empty
Nombre del Usuario
phone string
Possible values: non-empty
Telefono de contacto del usuario
photoUrl string
Código de fichero de photo (Optional)
resetPasswordSentAt timeStamp
Possible values: non-empty
Timestamp de cuando se ha pedido el reseteo de password
role string
Possible values: non-empty, [gestor, admin]
Default value: gestor
Role del usuario. En caso de ser Gestor, podrá crear drivers para su Company. Siempre tiene que haber 1 admin
status string
Possible values: [pending, active, suspended, blocked]
Default value: pending
Si el usuario está habilitado o no para entrar en la plataforma. Pending -> Pendiente de Aprobar Active -> Puede Usar la plataforma Suspended -> Bloqueado Temporalmente Blocked -> Bloqueado de forma Permanente
taxid stringrequired
timezone string
Possible values: non-empty
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
updatedAt timeStamp
Possible values: non-empty
TimeStamp de la ultima actualización del Objeto
]
deleted boolean
Si los datos de la base de datos se han borrado o no. En caso que sea true, los datos serán de solo lectura y no se podran modificar. Se mantienen por cohrencia de información o por que son necesarios para documentos cruzados
vehicles object[]
Listado de los vehiculos internos de la compañia; para cuentas Multitennant
Array [
_id string
cargo_type string[]
Tipos de metodos de carga validos para el camión ("NONE", "up", "lateral", "back")
vehicle_type string
Tipo de camión ("NONE", "r3c", "tir", "rt", "r2c", "r2d", "van", "frc", "f2c", "adr", "ft", "pt", "cc", "hdcc", "dump", "live" o "cocar")
image string
Imagén del camión.
itv string
Documento de ITV del camión.
shipping_type string
Camión refrigerado o seco ("fresh" o "dry")
plate string
Matricula del camión.
fresh_cargo_temp integer
Temperatura a la que puede llegar el camión en caso de ser refrigerado, en grados Celsius.
]
hasSign boolean
Si tiene configurado o no la firma de la empresa. Es necesario para poder generar las subastas y para generar la documentacion de los eCMR
createdAt date-time
updatedAt date-time
payment_settings object
Este objeto será rellenado de forma automatica con el enlace de Stripe para la facturación. En casos especiales y cuentas custm puede que no tenga uinformación o sea null/undefined.
contract object
Contrato de Envío. Se genera automaticamente cuando se acepta un servicio por ambas partes (Compañia y Transportista)
_id string
Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$
Id de uso interno de la base datos
code stringrequired
Possible values: >= 12 characters and <= 12 characters, Value must match regular expression [A-Za-z0-9]{12}
Código de acceso al fichero
createdAt date-time
Possible values: non-empty
updatedAt date-time
Possible values: non-empty
url stringrequired
Dirección S3 del Fichero
createdAt timestamp
Possible values: non-empty
date_eta date-time
ETA de llegada al Destino
description string
Desripción de la entrega.
docs object[]
Documentación del Envío y los contratos
Array [
_id string
Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$
Id de uso interno de la base datos
createdAt date-time
Possible values: non-empty
expiredDate stringrequired
Fecha hasta la que es valida la documentación
name stringrequired
Possible values: non-empty
status string
Possible values: [pending, approved, rejected]
Default value: pending
Estado de aprobación de la documentación
updatedAt date-time
Possible values: non-empty
]
etd_address objectrequired
Direcciones de Envío / Recogida. Son necesarias para que el calculo de costes, rutas y funcionamiento general de la plataforma sea correcto. Ten en cuenta que usaremos tanto la posición GPS como el código postal para gestinar y comprobar que todos los datos son correctos; por lo que es importante que estén correctos. En caso que algún dato esté mal introducido; ten en cuenta que serán registrados en el contrato y todos los documentos legales del proceso.
_id string
Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$
Id de uso interno de la base datos
city string
Possible values: non-empty
Ciudad de la dirección
company_name stringrequired
Possible values: non-empty
Nombre de la compañia destino. Será usada para verificación de datos
country stringrequired
Possible values: >= 3 characters and <= 20 characters
https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
location objectrequired
Posicion GPS de localización
name string
Possible values: non-empty
Nombre (o apodo) que le das a la dirección para tu uso
name_address stringrequired
Possible values: non-empty
Dato completo
phone string
Possible values: non-empty
Telefono de contacto del usuario
province string
Possible values: non-empty
Provincia de la dirección
state string
Possible values: non-empty
Provincia o Comunidad de la dirección. En caso de no ser compatible con el formato de la dirección puede quedar vacio
street_address string
Possible values: non-empty
Dirección Fisica; calle, avenida, etc
street_number string
Possible values: non-empty
Numero de Portal de la dirección
zipcode stringrequired
Possible values: non-empty
Codigo Postal de la dirección. Dependerá del pais para el uso de un formato u otro.
etd_cargo_method string
Possible values: non-empty, [back, lateral, superior]
Default value: back
Metodos de carga permitidos para la carga en ETD
etd_photos string[]
Fotogafias de la entrega como prueba de recepción
etl_address objectrequired
Direcciones de Envío / Recogida. Son necesarias para que el calculo de costes, rutas y funcionamiento general de la plataforma sea correcto. Ten en cuenta que usaremos tanto la posición GPS como el código postal para gestinar y comprobar que todos los datos son correctos; por lo que es importante que estén correctos. En caso que algún dato esté mal introducido; ten en cuenta que serán registrados en el contrato y todos los documentos legales del proceso.
_id string
Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$
Id de uso interno de la base datos
city string
Possible values: non-empty
Ciudad de la dirección
company_name stringrequired
Possible values: non-empty
Nombre de la compañia destino. Será usada para verificación de datos
country stringrequired
Possible values: >= 3 characters and <= 20 characters
https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
location objectrequired
Posicion GPS de localización
name string
Possible values: non-empty
Nombre (o apodo) que le das a la dirección para tu uso
name_address stringrequired
Possible values: non-empty
Dato completo
phone string
Possible values: non-empty
Telefono de contacto del usuario
province string
Possible values: non-empty
Provincia de la dirección
state string
Possible values: non-empty
Provincia o Comunidad de la dirección. En caso de no ser compatible con el formato de la dirección puede quedar vacio
street_address string
Possible values: non-empty
Dirección Fisica; calle, avenida, etc
street_number string
Possible values: non-empty
Numero de Portal de la dirección
zipcode stringrequired
Possible values: non-empty
Codigo Postal de la dirección. Dependerá del pais para el uso de un formato u otro.
etl_cargo_method string
Possible values: non-empty, [back, lateral, superior]
Default value: back
Metodos de carga permitidos para la carga en ETL
etl_photos string[]
Fotogafias de la recogida como prueba de recepción
fresh_cargo_temp integer
Possible values: >= -273 and <= 1000
Default value: 0
En caso que is_fresh a True, este valor el Requerido. Y será la temperatura optima de carga
had_etd_cargo_method boolean
Si hay metodos de carga en destino
had_etl_cargo_method boolean
Si hay metodos de carga en origen
is_fresh boolean
Si es una carga refrigerada
is_imperial_measure boolean
Para marcar si usaremos Metricas imperiales (Libras, pulgadas) o Metricas Decimales (cm, kg)
is_pallet boolean
Si el envío es paletizado. Revisar el campo cargo_type
pallets_num integer
Possible values: <= 66
Default value: 0
Numero de pallets en el Envío
pallets_type string
Possible values: non-empty, [european, american, none]
Default value: european
Tipo de Pallet a usar. Se usará para calculos de volumen, medidas y comprobaciones legales. Tiene en cuenta el valor del campo is_pallet
service_code string
Geneerado en el momento de creación, solo lectura. Identifica de forma unica el servicio desde la subasta hasta la entrega
status string
Possible values: [planned, replanned, accepted, issue, delivered, claimed., canceled, collected]
Default value: planned
Es el estado actual de la subasta. No será editable se modificará el estado dependiendo de los valores, condiciones de la subasta. draft - Borrador planned - Planificada published - Publicada empty - Desierta, sin Pujas awarded - Adjudicada approved - Aprobada, en proceso de Envío canceled - Cancelada por la Company rejected - Rechazada por el Trucker
trucker_cia objectrequired
Compañia de camioneros. En caso que sea un SoloDriver, se considera Admin de una empresa con 1 solo User.
_id string
Possible values: non-empty
ID unico generado aleatoriamente en el momento de creación
address stringrequired
Possible values: non-empty
admin object
_id string
position object
Array de servicios y su última posición conocida
deliveries object[]
role string
Rol de la cuenta ("driver", "dev", "gestor" o "admin")
status boolean
Estado de la cuenta (Bloqueado o activo en booleano).
reason string
Razón de bloqueo de la cuenta.
emailVerified boolean
Booleano que indica si está el email verificado.
phone string
Teléfono del camionero.
country string
País de residencia del camionero.
timezone string
Zona horaria del camionero.
image string
Imagen del camionero.
recovery_token string
Token de recuperación de contraseña.
i18n string
Idioma del usuario camionero.
deleted boolean
Booleano que indica si el usuario ha sido borrado.
name string
Nombre del camionero.
lastname string
Apellido del camionero.
email string
Email del camionero (Debe ser único)
taxid string
Documento de identidad del camionero (Debe ser único).
password string
Contraseña hasheada de la cuenta de camionero.
country stringrequired
Possible values: non-empty
https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
createdAt timestamp
Possible values: non-empty
name stringrequired
Possible values: non-empty
phone string
Possible values: non-empty
status string
Possible values: [pending, active, suspended, blocked]
Default value: pending
Si el usuario está habilitado o no para entrar en la plataforma, se aplica a todos los truckers asociados Pending -> Pendiente de Aprobar Active -> Puede Usar la plataforma Suspended -> Bloqueado Temporalmente Blocked -> Bloqueado de forma Permanente
taxid stringrequired
Possible values: non-empty
Identificación Fiscal
timezone string
Possible values: non-empty
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
updatedAt timestamp
Possible values: non-empty
users object[]
Possible values: >= 1
Gestores y Conductores
Array [
_id string
position object
Array de servicios y su última posición conocida
deliveries object[]
role string
Rol de la cuenta ("driver", "dev", "gestor" o "admin")
status boolean
Estado de la cuenta (Bloqueado o activo en booleano).
reason string
Razón de bloqueo de la cuenta.
emailVerified boolean
Booleano que indica si está el email verificado.
phone string
Teléfono del camionero.
country string
País de residencia del camionero.
timezone string
Zona horaria del camionero.
image string
Imagen del camionero.
recovery_token string
Token de recuperación de contraseña.
i18n string
Idioma del usuario camionero.
deleted boolean
Booleano que indica si el usuario ha sido borrado.
name string
Nombre del camionero.
lastname string
Apellido del camionero.
email string
Email del camionero (Debe ser único)
taxid string
Documento de identidad del camionero (Debe ser único).
password string
Contraseña hasheada de la cuenta de camionero.
]
vehicles object[]
Possible values: >= 1
Listado de Trucks que tiene la compañia
Array [
_id string
cargo_type string[]
Tipos de metodos de carga validos para el camión ("NONE", "up", "lateral", "back")
vehicle_type string
Tipo de camión ("NONE", "r3c", "tir", "rt", "r2c", "r2d", "van", "frc", "f2c", "adr", "ft", "pt", "cc", "hdcc", "dump", "live" o "cocar")
image string
Imagén del camión.
itv string
Documento de ITV del camión.
shipping_type string
Camión refrigerado o seco ("fresh" o "dry")
plate string
Matricula del camión.
fresh_cargo_temp integer
Temperatura a la que puede llegar el camión en caso de ser refrigerado, en grados Celsius.
]
updatedAt timestamp
Possible values: non-empty
]
hasNextPage boolean
hasPrevPage boolean
limit integer
nextPage integer
page integer
pagingCounter integer
prevPage integer
totalDocs integer
totalPages integer
status integer

Example (from schema)

{
  "data": {
    "docs": [
      {
        "_id": "5d84f846b0f6ba698f544dbf",
        "auction": {
          "_id": "string",
          "bids_count": 0,
          "cancelled_company_date": "2019-09-20T16:03:18.575Z",
          "cancelled_trucker_date": "2019-09-20T16:03:18.575Z",
          "cargo_height": 0,
          "cargo_type": "pallets",
          "cargo_weight": 2500,
          "createdAt": "2019-09-20T16:03:18.575Z",
          "custom_code": "REF2024-0101",
          "date_end": "2019-09-20T16:03:18.575Z",
          "date_start": "2019-09-20T16:03:18.575Z",
          "deletedAt": "2019-09-20T16:03:18.575Z",
          "email_end_notified": false,
          "etd_address": {
            "_id": "5d84f846b0f6ba698f544dbf",
            "city": "vigo",
            "company_name": "ABC Logistics",
            "country": "españa",
            "location": {
              "coordinates": [
                -8.7207,
                42.2406
              ],
              "type": "Point"
            },
            "name": "ABC Logistics Vigo",
            "name_address": "Aduana, 4, Rúa Concepción Arenal, Santiago de Vigo, Vigo, Pontevedra, Galicia, 36201, España",
            "phone": "+34981234567",
            "province": "Pontevedra",
            "state": "galicia",
            "street_address": "Rúa Concepción Arenal",
            "street_number": "4",
            "zipcode": "36201"
          },
          "etd_cargo_method": "back",
          "etd_date": "2019-09-20T16:03:18.575Z",
          "etd_extra_time": 1,
          "etl_address": {
            "_id": "5d84f846b0f6ba698f544dbf",
            "city": "vigo",
            "company_name": "ABC Logistics",
            "country": "españa",
            "location": {
              "coordinates": [
                -8.7207,
                42.2406
              ],
              "type": "Point"
            },
            "name": "ABC Logistics Vigo",
            "name_address": "Aduana, 4, Rúa Concepción Arenal, Santiago de Vigo, Vigo, Pontevedra, Galicia, 36201, España",
            "phone": "+34981234567",
            "province": "Pontevedra",
            "state": "galicia",
            "street_address": "Rúa Concepción Arenal",
            "street_number": "4",
            "zipcode": "36201"
          },
          "etl_cargo_method": "back",
          "etl_date": "2019-09-20T16:03:18.575Z",
          "etl_extra_time": 100,
          "fresh_cargo_temp": 3,
          "had_etd_cargo_method": false,
          "had_etl_cargo_method": false,
          "hscode": "0706.10",
          "is_fresh": false,
          "is_imperial_measure": false,
          "is_pallet": false,
          "linear_meters": 0,
          "pallets_num": 0,
          "pallets_type": "european",
          "plate_full_trailer": "1234-CDD",
          "service_code": "ACOMALg4667",
          "sign_image_cia": "string",
          "sign_image_trucker": "string",
          "signed_by_company": false,
          "signed_by_company_date": "2019-09-20T16:03:18.575Z",
          "signed_by_company_notify": false,
          "signed_by_trucker": false,
          "signed_by_trucker_date": "2019-09-20T16:03:18.575Z",
          "signed_by_trucker_notify": false,
          "status": "draft",
          "updatedAt": "2019-09-20T16:03:18.575Z"
        },
        "cargo_height": 0,
        "cargo_weight": 2500,
        "category": "string",
        "company": {
          "_id": "667be7657b28b3d0a3fc6950",
          "accountType": "default",
          "address": {
            "_id": "5d84f846b0f6ba698f544dbf",
            "city": "vigo",
            "company_name": "ABC Logistics",
            "country": "españa",
            "location": {
              "coordinates": [
                -8.7207,
                42.2406
              ],
              "type": "Point"
            },
            "name": "ABC Logistics Vigo",
            "name_address": "Aduana, 4, Rúa Concepción Arenal, Santiago de Vigo, Vigo, Pontevedra, Galicia, 36201, España",
            "phone": "+34981234567",
            "province": "Pontevedra",
            "state": "galicia",
            "street_address": "Rúa Concepción Arenal",
            "street_number": "4",
            "zipcode": "36201"
          },
          "addresses": [
            {
              "_id": "5d84f846b0f6ba698f544dbf",
              "city": "vigo",
              "company_name": "ABC Logistics",
              "country": "españa",
              "location": {
                "coordinates": [
                  -8.7207,
                  42.2406
                ],
                "type": "Point"
              },
              "name": "ABC Logistics Vigo",
              "name_address": "Aduana, 4, Rúa Concepción Arenal, Santiago de Vigo, Vigo, Pontevedra, Galicia, 36201, España",
              "phone": "+34981234567",
              "province": "Pontevedra",
              "state": "galicia",
              "street_address": "Rúa Concepción Arenal",
              "street_number": "4",
              "zipcode": "36201"
            }
          ],
          "contact_person": {
            "name": "string",
            "lastname": "string",
            "email": "string",
            "phone": "string"
          },
          "invoice_data": {
            "taxid": "32435454N",
            "email": "test@mail.com",
            "phone": "+34123456789",
            "name_address": "string"
          },
          "name": "Cargoffer",
          "reason": "NONE",
          "reasonMessage": "string",
          "socialName": "string",
          "status": "pending",
          "truckers": [
            {
              "_id": "65e1fc46a39d32135b12c7e0",
              "position": {
                "deliveries": []
              },
              "role": "driver",
              "status": true,
              "reason": "NONE",
              "emailVerified": false,
              "phone": "34668936908",
              "country": "esp",
              "timezone": "europe/madrid",
              "image": "",
              "recovery_token": "XXX",
              "i18n": "es",
              "deleted": false,
              "name": "Name",
              "lastname": "Lastname",
              "email": "email@example.com",
              "taxid": "12345678A",
              "password": "XXX"
            }
          ],
          "users": [
            {
              "_id": "5d84f846b0f6ba698f544dbf",
              "authenticationToken": "string",
              "birthDate": "2019-09-20T16:03:18.575Z",
              "country": "ESP",
              "createdAt": "2019-09-20T16:03:18.575Z",
              "email": "string",
              "emailVerified": true,
              "lastSignInAt": "2019-09-20T16:03:18.575Z",
              "lastSignInIp": "192.168.1.0",
              "lastname": "string",
              "name": "string",
              "password": "string",
              "phone": "+34 602247084",
              "resetPasswordSentAt": "2019-09-20T16:03:18.575Z",
              "resetPasswordToken": "NO-VISIBLE",
              "role": "admin",
              "status": true,
              "timezone": "string",
              "updatedAt": "2019-09-20T16:03:18.575Z"
            }
          ],
          "deleted": false,
          "vehicles": [
            {
              "_id": "65e1f94fc5953704852eb5a3",
              "cargo_type": [
                "back",
                "lateral"
              ],
              "vehicle_type": "rt",
              "image": "",
              "itv": "",
              "shipping_type": "dry",
              "plate": "0017bbb"
            }
          ],
          "hasSign": false,
          "createdAt": "2024-07-15T10:41:19.623Z",
          "updatedAt": "2024-07-15T10:41:19.623Z",
          "payment_settings": {}
        },
        "contract": {
          "_id": "string",
          "code": "string",
          "createdAt": "2019-09-20T16:03:18.575Z",
          "updatedAt": "2019-09-20T16:03:18.575Z",
          "url": "string"
        },
        "createdAt": "2019-09-20T16:03:18.575Z",
        "date_eta": "2019-09-20T16:03:18.575Z",
        "description": "string",
        "docs": [
          {
            "_id": "5d84f846b0f6ba698f544dbf",
            "createdAt": "2019-09-20T16:03:18.575Z",
            "expiredDate": "2019-09-20T16:03:18.575Z",
            "name": "string",
            "status": "pending",
            "updatedAt": "2019-09-20T16:03:18.575Z"
          }
        ],
        "etd_address": {
          "_id": "5d84f846b0f6ba698f544dbf",
          "city": "vigo",
          "company_name": "ABC Logistics",
          "country": "españa",
          "location": {
            "coordinates": [
              -8.7207,
              42.2406
            ],
            "type": "Point"
          },
          "name": "ABC Logistics Vigo",
          "name_address": "Aduana, 4, Rúa Concepción Arenal, Santiago de Vigo, Vigo, Pontevedra, Galicia, 36201, España",
          "phone": "+34981234567",
          "province": "Pontevedra",
          "state": "galicia",
          "street_address": "Rúa Concepción Arenal",
          "street_number": "4",
          "zipcode": "36201"
        },
        "etd_cargo_method": "back",
        "etd_photos": [
          "string"
        ],
        "etl_address": {
          "_id": "5d84f846b0f6ba698f544dbf",
          "city": "vigo",
          "company_name": "ABC Logistics",
          "country": "españa",
          "location": {
            "coordinates": [
              -8.7207,
              42.2406
            ],
            "type": "Point"
          },
          "name": "ABC Logistics Vigo",
          "name_address": "Aduana, 4, Rúa Concepción Arenal, Santiago de Vigo, Vigo, Pontevedra, Galicia, 36201, España",
          "phone": "+34981234567",
          "province": "Pontevedra",
          "state": "galicia",
          "street_address": "Rúa Concepción Arenal",
          "street_number": "4",
          "zipcode": "36201"
        },
        "etl_cargo_method": "back",
        "etl_photos": [
          "string"
        ],
        "fresh_cargo_temp": 3,
        "had_etd_cargo_method": false,
        "had_etl_cargo_method": false,
        "is_fresh": true,
        "is_imperial_measure": false,
        "is_pallet": false,
        "pallets_num": 0,
        "pallets_type": "european",
        "service_code": "string",
        "status": "planned",
        "trucker_cia": {
          "_id": "5d84f846b0f6ba698f544dbf",
          "address": "string",
          "admin": {
            "_id": "5d84f846b0f6ba698f544dbf",
            "authenticationToken": "string",
            "birthDate": "2019-09-20T16:03:18.575Z",
            "country": "ESP",
            "createdAt": "2019-09-20T16:03:18.575Z",
            "email": "string",
            "emailVerified": true,
            "lastSignInAt": "2019-09-20T16:03:18.575Z",
            "lastSignInIp": "192.168.1.0",
            "lastname": "string",
            "name": "string",
            "password": "string",
            "phone": "+34 602247084",
            "resetPasswordSentAt": "2019-09-20T16:03:18.575Z",
            "resetPasswordToken": "NO-VISIBLE",
            "role": "admin",
            "status": true,
            "timezone": "string",
            "updatedAt": "2019-09-20T16:03:18.575Z"
          },
          "country": "esp",
          "createdAt": "2019-09-20T16:03:18.575Z",
          "name": "string",
          "phone": "string",
          "status": "pending",
          "taxid": "string",
          "timezone": "Europe/Madrid",
          "updatedAt": "2019-09-20T16:03:18.575Z",
          "users": [
            {
              "_id": "5d84f846b0f6ba698f544dbf",
              "authenticationToken": "string",
              "birthDate": "2019-09-20T16:03:18.575Z",
              "country": "ESP",
              "createdAt": "2019-09-20T16:03:18.575Z",
              "email": "string",
              "emailVerified": true,
              "lastSignInAt": "2019-09-20T16:03:18.575Z",
              "lastSignInIp": "192.168.1.0",
              "lastname": "string",
              "name": "string",
              "password": "string",
              "phone": "+34 602247084",
              "resetPasswordSentAt": "2019-09-20T16:03:18.575Z",
              "resetPasswordToken": "NO-VISIBLE",
              "role": "admin",
              "status": true,
              "timezone": "string",
              "updatedAt": "2019-09-20T16:03:18.575Z"
            }
          ]
        },
        "updatedAt": "2019-09-20T16:03:18.575Z"
      }
    ],
    "hasNextPage": true,
    "hasPrevPage": true,
    "limit": 0,
    "nextPage": 0,
    "page": 0,
    "pagingCounter": 0,
    "prevPage": 0,
    "totalDocs": 0,
    "totalPages": 0
  },
  "status": 0
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://api.cargoffer.com/api/delivery' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://api.cargoffer.com

Parameters

apikey — headerrequired

limit — query

page — query

order — query

ResponseClear

Click the Send API Request button above and see the response here!