Crear - Subastas/Envíos

POST /api/auction

Para crear una Subasta primero hay que cumplir con una serie de pasos y validaciones.

La primera de todas es que la empresa cargadora tenga configurador un metodo de pago; es más comodo hacerlo pro la web, pero tambien habilitamos un proceso de Peticiones para ello, en la sección de configuracion/pago.

Otra cosa que tiene que estar configurada es tener al menos 2 direcciones, para poder tener un OPrigen/Destino.

Esquema de Creacion Auction

En caso que no tengas Direcciones; debes cargar primero las peticiones correspondientes con Address, si la cuenta no está validada y el correo no está validado; debes ir a la sección profile.

Si falta la firma; ve a la sección Configuracion.

Si todo esto es correcto; debes cubrir los campos de la subasta, según tus necesidades; pero siempre teniendo en cuenta las limitaciones de seguridad y coherencia.

Request

Header Parameters

apikey stringrequired

Apikey de una company vinculada a un usuario

application/json

Body

Para la creación de las Subastas; tanto publicas como privadas.

Ten en cuenta cuales són los datos obligatorios y cuales serán opcionales.

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

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().

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.

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_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

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)

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.

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

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

Responses

Example response

application/json

Schema
Example (from schema)

Schema

status string

data object

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

_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

etl_address object

_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

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

updatedAt timestamp

Possible values: non-empty

Fecha de la ultima modificación del objeto

{
  "status": "string",
  "data": {
    "_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"
  }
}

Esquema general de Error. Todos los códigos de error devueltos tendrán el código de error (status) y el mensaje de error al respecto. El Mensaje de error tendrá un formato ideantificable con de la siguiente forma:

application/json

Schema
Example (from schema)
ETL_DATE_INVALID

Schema

message string

Possible values: [ETL_DATE_INVALID, ETL_ADDRESS_NOT_FOUND, ETD_ADDRESS_NOT_FOUND, NOT_FOUND, NOT_ACTIVE, SERVICE_CODE_NOT_FOUND, AUCTION_NOT_FOUND, DATA_NOT_VALID, ERROR_SAVE_DELIVERY, FORM_DATA_NOT_VALID, FAVORITE_NOT_FOUND, ERROR_SAVE_FAVORITE, APIKEY_NOT_VALID, CARGO_WEIGHT_INVALID, CARGO_HEIGHT_INVALID, DATE_END_INVALID]

Default value: DATA_NOT_VALID

status integer

Possible values: [400, 401, 403, 404, 405, 406, 418, 500, 503]

Default value: 400

{
  "message": "DATA_NOT_VALID",
  "status": 400
}

{
  "message": "ETL_DATE_INVALID",
  "status": 400
}

Crear - Subastas/Envíos

/api/auction

Request​

Header Parameters

Body

Responses​

Request

Responses