Saltar al contenido principal

Get mine

GET 
/company_data

Obtener mi compañía

Request​

Header Parameters

    Authorization stringrequired

    Token de Auth del Usuario

Responses​

OK

Schema
    status integer
    data object

    Modelo de CompanyData

    _id string
    name string
    socialName string
    address object
    email string
    phone string
    street_address string
    street_number string
    city string
    state string
    country string
    zipcode string
    neighborhood string
    province string
    location object
    type string
    coodinates number[]

    Possible values: <= 2

    place_id string
    name_address string
    timezone string
    addresses array
    address_default object

    Direcciones de Envío / Recogida. 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.

    neighborhood string
    placeId string
    can_be_deleted boolean
    isDefault boolean
    createdAt string
    updatedAt string
    invoice_data object
    taxid string
    email string
    phone string
    name_address string
    contact_person object
    name string
    lastname string
    email string
    phone string
    status boolean
    reason string
    reasonDate string
    reasonMessage string
    users object[]
  • 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 object

    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: [company, trucker]

    Default value: company

    Tipo de compañia: default -> Habitual multitennant -> Tiene flota propia y contrata servicios externos Spot mining -> Especial para mineria

    address object

    Direcciones de Envío / Recogida. 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.

    neighborhood string
    placeId string
    can_be_deleted boolean
    isDefault boolean
    createdAt string
    updatedAt string
    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.

    neighborhood string
    placeId string
    can_be_deleted boolean
    isDefault boolean
    createdAt string
    updatedAt string
  • ]
    • contact_person
    invoice_data stringrequired

    Possible values: non-empty

    Datos fiscales usados para la generación de las facturas y Contrato

    name stringrequired

    Possible values: non-empty

    Nombre Comercial de la compañia

    reason string

    Motivo del Bloqueo de la compañia. Ver status

    reasonMessage string

    Explicación del Bloqueo de la compañia. Ver status

    socialName string

    Possible values: non-empty

    Nombre Legal de la compañia. Será usado para los documentos legales

    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

    users undefined[]

    Possible values: >= 1

    Los usuarios de la compañia

    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

  • ]
    • accountType string
Loading...