Editar Cargador (Integrador)

PUT /api/company

Edsitar los datos generales de un cargador. Esta petición está pensada para ser usada por una Integrador. En caso que el Cargador edite sus propios datos, tienen prioridad sobre los que edite el Integrador.

OJO: Solo se podrán editar compañias que tengan referencia y vinculación con el integrador actual. En caso que una compañia no tenga vinculación, se devolverá un error.

Request

Query Parameters

idCia string

ID de la compañia cargadora a editar

Header Parameters

apikey stringrequired

Apikey de una company vinculada a un usuario

application/json

Body

Los datos para la genereación de una Compañia Cargadora; esto se usará para los Integradores y Perfiles internos de Cargoffer (Staff).

Cuando se cree el Cargador; este quedará asociado con el currentUser que haga la petición, de forma que si corresponde con un Integrador; podrá ser gestionador más adelante con las peticiones pertinentes.

email emailrequired

Possible values: Value must match regular expression ^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$

Default value: test@email.com

Será la direccion de contacto, el login de l cargador y el que se usará para las comunicaciones con el Cargador.

phone stringrequired

Possible values: Value must match regular expression ^[\+]?[(]?[0-9]{3}[)]?[-\s\.]?[0-9]{3}[-\s\.]?[0-9]{4,6}$

Default value: +34622333555

taxid stringrequired

Corresponde con el NIF (España) o el TaxID que corresponde con el pais de l Cargador. Se usará para los contratos legales, identificar de forma unica a la empresa y evitar empresas duplicadas.

address string[]required

Possible values: >= 2, <= 2

Corresponden con las posiciónes GPS de la dirección. Tiene que ser en formatio String, y en Orden de Longitud, Latitud

socialName stringrequired

Corresponde con el Nombre social de la empresa cargadora. Se usará para referencias y para las generación de documentación.

name stringrequired

Nombre legal de la empresa. Se usará para la generación de los contratos, y el ECMR; y los documentos legales encesrios para el servicio.,

user_name stringrequired

Nombre de la persona de Contacto de la empresa Cargadora

user_lastname stringrequired

Primera Apellido de la persona de contacto de la empresa cargadora

password string

Contraseña del Usuario de la empresa cargadora. En caso que no se envíe; se generará uno de forma aleatoria y se mandará a la persona de contacto.

Responses

200
default

Datos de la compañia cargador asociada al usuario actula. Algunos de los datos serán opcionales; por lo que se recomienda que se prepare el código para poderlos recibir o no.

application/json

Schema
Example (from schema)
Example 1

Schema

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

{
  "_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.269Z",
  "updatedAt": "2024-07-15T10:41:19.269Z",
  "payment_settings": {}
}

{
  "address": {
    "location": {
      "type": "Point",
      "coordinates": [
        -3.718497,
        40.393065
      ]
    },
    "email": "testIntegrador4@gmail.com",
    "phone": "123456789",
    "street_address": "Calle de la Verdad",
    "street_number": "",
    "city": "Madrid",
    "state": "Comunidad de Madrid",
    "country": "españa",
    "zipcode": "28019",
    "neighborhood": "Carabanchel",
    "name_address": "GO Fit, Calle de la Verdad, Opañel, Carabanchel, Madrid, Comunidad de Madrid, 28019, España",
    "timezone": "utc"
  },
  "invoice_data": {
    "taxid": "54652145A",
    "bank_account": "",
    "account_holder": "",
    "email": "",
    "name_address": "",
    "phone": "+34111222333"
  },
  "contact_person": {
    "email": "",
    "lastname": "",
    "name": "",
    "phone": "+34111222333"
  },
  "payment_settings": {
    "invoices": [],
    "stripe_customer": "cus_QMFSJ8eBl10C7l"
  },
  "_id": "667aa0feeeb681322081cc3e",
  "addresses": [
    "667aa0feeeb681322081cc3d",
    "667bc11d94702e9e8d2e9cb2"
  ],
  "status": false,
  "reason": "PENDING",
  "reasonMessage": "PENDING_CIA",
  "users": [
    "667aa108eeb681322081cc43"
  ],
  "accountType": "default",
  "vehicles": [],
  "truckers": [],
  "hasSign": false,
  "deleted": false,
  "name": "Test Integrador",
  "socialName": "Test Integrador SL",
  "createdAt": "2024-06-25T10:50:39.030Z",
  "updatedAt": "2024-06-26T07:19:57.556Z",
  "__v": 2
}

Editar Cargador (Integrador)

/api/company

Request​

Query Parameters

Header Parameters

Body

Responses​

Request

Responses