Skip to main content

List - Deliveries/Services

GET 

/api/delivery

List of all services

Request

Query Parameters

    limit integer

    Items per Page, Default 25

    page integer

    Default value: 1

    Page to Query, Default 1

    order string

    Sorting method or field to sort by

Header Parameters

    apikey stringrequired

    Apikey of a company linked to a user

Responses

Example response

Schema
    data object
    docs object[]
  • Array [
  • _id string

    Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$

    Internal ID for database usage.

    auction objectrequired

    This is the complete Auction object. Please note that there will be fields that are for internal use of the database or server and cannot be modified during the editing or creation of the object.

    _id string

    Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$

    Internal ID for database usage.

    bids_count integer

    Default value: 0

    Number of bids in the auction

    cancelled_company_date timestamp

    Possible values: non-empty

    Date on which it has been canceled by the Company

    cancelled_trucker_date timestamp

    Possible values: non-empty

    Date on which it has been canceled by the Carrier (TruckerCia)

    cargo_height integer

    Possible values: <= 4500

    Default value: 0

    Cargo height. Take into account the value of is_imperial_measure to determine if it's in cm/inch

    cargo_type string

    Possible values: [pallets, full, package, trailer]

    Type of Shipment: Parcel, Palletized, Full Load, Linear Meters

    cargo_weight integer

    Possible values: <= 24000

    Weight of the Cargo. Consider the value of is_imperial_measure to determine if it's in kg/lb

    createdAt timestamp

    Possible values: non-empty

    custom_code string

    This field will be for internal use (yours) for organizing auctions and deliveries.

    date_end string

    Possible values: non-empty

    End date of the auction. Bids will be accepted until this date. If there are no bids by this date, it is considered 'empty'.

    date_start string

    Possible values: non-empty

    Start date of the auction. It is considered Draft if this field is null; and planned if it has any value > NOW().

    deletedAt timestamp

    Possible values: non-empty

    email_end_notified boolean

    Its value will be true if notifications have been sent upon completion.

    etd_address object

    Shipping / Pickup Addresses. They are necessary for the calculation of costs, routes, and general operation of the platform to be correct. Keep in mind that we will use both GPS coordinates and postal codes to manage and verify that all data is correct; therefore, it is important that they are accurate. In case any data is incorrectly entered, consider that they will be recorded in the contract and all legal documents of the process.

    _id string

    Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$

    Internal ID for database usage.

    city string

    Possible values: non-empty

    City of the address

    company_name stringrequired

    Possible values: non-empty

    Name of the destination company. It will be used for data verification.

    country stringrequired

    Possible values: >= 3 characters and <= 20 characters

    https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes

    location objectrequired

    GPS location position

    name string

    Possible values: non-empty

    Name (or nickname) you give to the address for your use

    name_address stringrequired

    Possible values: non-empty

    Complete data

    phone string

    Possible values: non-empty

    User's contact phone number

    province string

    Possible values: non-empty

    Province of the address

    state string

    Possible values: non-empty

    Province or Community of the address. In case it's not compatible with the address format, it may remain empty.

    street_address string

    Possible values: non-empty

    Physical address; street, avenue, etc.

    street_number string

    Possible values: non-empty

    House number of the address

    zipcode stringrequired

    Possible values: non-empty

    Postal code of the address. It will depend on the country for the use of one format or another.

    etd_cargo_method string

    Possible values: non-empty, [back, lateral, superior]

    Default value: back

    Allowed loading methods for the ETD cargo

    etd_date timestamp

    Possible values: non-empty

    Delivery date. If there is a time margin, consider the start time.

    etd_extra_time integer

    Possible values: <= 99999

    Default value: 0

    Extra time range from the etd_date. Corresponds to the number of minutes between the delivery date and the time range. For example, if the etd_date is at 08:00, this will be the number of minutes for the delivery at 08:05.

    etl_address object

    Shipping / Pickup Addresses. They are necessary for the calculation of costs, routes, and general operation of the platform to be correct. Keep in mind that we will use both GPS coordinates and postal codes to manage and verify that all data is correct; therefore, it is important that they are accurate. In case any data is incorrectly entered, consider that they will be recorded in the contract and all legal documents of the process.

    _id string

    Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$

    Internal ID for database usage.

    city string

    Possible values: non-empty

    City of the address

    company_name stringrequired

    Possible values: non-empty

    Name of the destination company. It will be used for data verification.

    country stringrequired

    Possible values: >= 3 characters and <= 20 characters

    https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes

    location objectrequired

    GPS location position

    name string

    Possible values: non-empty

    Name (or nickname) you give to the address for your use

    name_address stringrequired

    Possible values: non-empty

    Complete data

    phone string

    Possible values: non-empty

    User's contact phone number

    province string

    Possible values: non-empty

    Province of the address

    state string

    Possible values: non-empty

    Province or Community of the address. In case it's not compatible with the address format, it may remain empty.

    street_address string

    Possible values: non-empty

    Physical address; street, avenue, etc.

    street_number string

    Possible values: non-empty

    House number of the address

    zipcode stringrequired

    Possible values: non-empty

    Postal code of the address. It will depend on the country for the use of one format or another.

    etl_cargo_method string

    Possible values: non-empty, [back, lateral, superior]

    Default value: back

    Allowed loading methods for the ETL cargo

    etl_date timestamp

    Possible values: non-empty

    Pickup date. If there is a time margin, consider the start time.

    etl_extra_time integer

    Possible values: <= 9999

    Default value: 0

    Extra time range from the etl_date. Corresponds to the number of minutes between the pickup date and the time range. For example, if the etd_date is at 08:00, this will be the number of minutes for the delivery at 08:05.

    fresh_cargo_temp integer

    Possible values: >= -273 and <= 1000

    Default value: 0

    If is_fresh is True, this value is required. And it will be the optimal cargo temperature.

    had_etd_cargo_method boolean

    It has a loading method at the Destination

    had_etl_cargo_method boolean

    It has a loading method at the Origin

    hscode string

    European Harmonization Code. https://trade.ec.europa.eu/access-to-markets/en/content/harmonised-system-0

    is_fresh boolean

    If the shipment is refrigerated. Check the fresh_cargo_temp field.

    is_imperial_measure boolean

    To indicate whether we will use Imperial metrics (Pounds, inches) or Decimal metrics (cm, kg)

    is_pallet boolean

    If the shipment is palletized. Check the cargo_type field.

    linear_meters integer

    Default value: 0

    The linear meters of the shipment. Check the cargo_type field.

    pallets_num integer

    Possible values: <= 66

    Default value: 0

    Number of pallets in the shipment.

    pallets_type string

    Possible values: non-empty, [european, american, none]

    Default value: european

    Type of pallet to use. It will be used for volume calculations, measurements, and legal checks. Consider the value of the is_pallet field.

    plate_full_trailer string

    Trailer license plate, in case the shipment type is directly a trailer. It is not the same as Full Load. The format of the license plate will depend on the country.

    service_code string

    Unique code generated upon the creation of the auction. It serves as a traceability code for the entire shipment, from creation to delivery.

    sign_image_cia string

    Signature image of the loader. It is in Base64 format.

    sign_image_trucker string

    Signature image of the carrier. It is in Base64 format.

    signed_by_company boolean

    If it has been signed by the Company (Loader)

    signed_by_company_date timestamp

    Possible values: non-empty

    Date on which it has been signed by the Company

    signed_by_company_notify boolean

    If it has been notified to be signed by the Carrier (TruckerCia)

    signed_by_trucker boolean

    If it has been signed by the Carrier (TruckerCia)

    signed_by_trucker_date timestamp

    Possible values: non-empty

    Date on which it has been signed by the Carrier (TruckerCia)

    signed_by_trucker_notify boolean

    If it has been notified to be signed by the Company (Loader)

    status string

    Possible values: [draft, planned, published, empty, awarded, approved, locked, canceled, rejected]

    Default value: draft

    This is the current status of the auction. It will not be editable. The status will be modified depending on the values, conditions of the auction. draft - Draft planned - Planned published - Published empty - Empty, no Bids awarded - Awarded approved - Approved, in Shipping process canceled - Canceled by the Company rejected - Rejected by the Trucker

    updatedAt timestamp

    Possible values: non-empty

    Date of the last modification of the object

    cargo_height integer

    Possible values: <= 4500

    Default value: 0

    Cargo height. Take into account the value of is_imperial_measure to determine if it's in cm/inch

    cargo_weight integer

    Possible values: <= 24000

    Weight of the Cargo. Consider the value of is_imperial_measure to determine if it's in kg/lb

    category string

    TODO: Categories are not yet defined.

    company objectrequired

    Loading company which is the origin of the auction. Whether it's multitennant or Default. NOTE: In the REST API, editing of these data is not allowed, they will be readOnly.

    _id string

    Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$

    Internal ID for database usage.

    accountType string

    Possible values: [default, multitennant, mining]

    Default value: default

    Company type: default -> Regular multitennant -> Owns fleet and contracts external Spot services mining -> Specialized for mining

    address object

    Shipping / Pickup Addresses. They are necessary for the calculation of costs, routes, and general operation of the platform to be correct. Keep in mind that we will use both GPS coordinates and postal codes to manage and verify that all data is correct; therefore, it is important that they are accurate. In case any data is incorrectly entered, consider that they will be recorded in the contract and all legal documents of the process.

    _id string

    Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$

    Internal ID for database usage.

    city string

    Possible values: non-empty

    City of the address

    company_name stringrequired

    Possible values: non-empty

    Name of the destination company. It will be used for data verification.

    country stringrequired

    Possible values: >= 3 characters and <= 20 characters

    https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes

    location objectrequired

    GPS location position

    name string

    Possible values: non-empty

    Name (or nickname) you give to the address for your use

    name_address stringrequired

    Possible values: non-empty

    Complete data

    phone string

    Possible values: non-empty

    User's contact phone number

    province string

    Possible values: non-empty

    Province of the address

    state string

    Possible values: non-empty

    Province or Community of the address. In case it's not compatible with the address format, it may remain empty.

    street_address string

    Possible values: non-empty

    Physical address; street, avenue, etc.

    street_number string

    Possible values: non-empty

    House number of the address

    zipcode stringrequired

    Possible values: non-empty

    Postal code of the address. It will depend on the country for the use of one format or another.

    addresses object[]

    Customer Addresses. Used for Origin/Destination of the Auctions

  • Array [
  • _id string

    Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$

    Internal ID for database usage.

    city string

    Possible values: non-empty

    City of the address

    company_name stringrequired

    Possible values: non-empty

    Name of the destination company. It will be used for data verification.

    country stringrequired

    Possible values: >= 3 characters and <= 20 characters

    https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes

    location objectrequired

    GPS location position

    name string

    Possible values: non-empty

    Name (or nickname) you give to the address for your use

    name_address stringrequired

    Possible values: non-empty

    Complete data

    phone string

    Possible values: non-empty

    User's contact phone number

    province string

    Possible values: non-empty

    Province of the address

    state string

    Possible values: non-empty

    Province or Community of the address. In case it's not compatible with the address format, it may remain empty.

    street_address string

    Possible values: non-empty

    Physical address; street, avenue, etc.

    street_number string

    Possible values: non-empty

    House number of the address

    zipcode stringrequired

    Possible values: non-empty

    Postal code of the address. It will depend on the country for the use of one format or another.

  • ]
  • contact_person object

    Admin User or Manager of the Company

    _id string

    Possible values: non-empty

    Unique ID generated randomly at the time of creation

    birthDate string

    Possible values: non-empty

    User's date of birth

    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 of the object creation

    email stringrequired

    Possible values: non-empty

    Email used for login. Must be unique in the system.

    emailVerified boolean

    Boolean to know if a user has validated the email. They cannot log in if it's not validated.

    i18n string

    Possible values: >= 2 characters and <= 3 characters

    ISO code of the current language

    lastSignInAt date-time

    Possible values: non-empty

    Timestamp of the user's last login

    lastSignInIp ipv4

    Possible values: non-empty

    Last IP from which the user has connected

    lastname stringrequired

    Possible values: non-empty

    User's Last Name

    name stringrequired

    Possible values: non-empty

    User's First Name

    phone string

    Possible values: non-empty

    User's contact phone number

    photoUrl string

    Photo file code (Optional)

    resetPasswordSentAt timeStamp

    Possible values: non-empty

    Timestamp of when the password reset was requested

    role string

    Possible values: non-empty, [gestor, admin]

    Default value: gestor

    User's role. If a Manager, they can create drivers for their Company. There must always be 1 admin.

    status string

    Possible values: [pending, active, suspended, blocked]

    Default value: pending

    If the user is enabled or not to enter the platform. Pending -> Pending Approval Active -> Can use the platform Suspended -> Temporarily Blocked Blocked -> Permanently Blocked

    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 of the last update of the Object

    invoice_data stringrequired

    Possible values: non-empty

    Fiscal data used for the generation of invoices and contracts

    name stringrequired

    Possible values: non-empty

    Commercial name of the company

    reason string

    Reason for the company's blockage. See status

    reasonMessage string

    Explanation of the company's blockage. See status

    socialName string

    Possible values: non-empty

    Legal name of the company. It will be used for legal documents

    status string

    Possible values: [pending, active, suspended, blocked]

    Default value: pending

    If the user is enabled or not to access the platform, applies to all associated truckers Pending -> Pending Approval Active -> Can use the platform Suspended -> Temporarily Blocked Blocked -> Permanently Blocked

    truckers object[]

    Drivers of the Company; they will have access to the carrier application with access to the services managed from the MultiTennant Company panel, for MultiTennant accounts.

  • Array [
  • _id string
    position object

    Array of services and their last known position

    deliveries object[]
    role string

    Account role ("driver", "dev", "manager" or "admin")

    status boolean

    Account status (Locked or active in boolean).

    reason string

    Account blocking reason.

    emailVerified boolean

    Boolean that indicates whether the email is verified.

    phone string

    Trucker's phone.

    country string

    Country of residence of the trucker.

    timezone string

    Trucker time zone.

    image string

    Trucker image.

    recovery_token string

    Password recovery token.

    i18n string

    Language of the trucker user.

    deleted boolean

    Boolean indicating whether the user has been deleted.

    name string

    Name of the trucker.

    lastname string

    Truck driver's last name.

    email string

    Trucker email (Must be unique)

    taxid string

    Truck's identity document (Must be unique).

    password string

    Hashed password of the trucker account.

  • ]
  • users object[]

    Possible values: >= 1

    The users of the company

  • Array [
  • _id string

    Possible values: non-empty

    Unique ID generated randomly at the time of creation

    birthDate string

    Possible values: non-empty

    User's date of birth

    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 of the object creation

    email stringrequired

    Possible values: non-empty

    Email used for login. Must be unique in the system.

    emailVerified boolean

    Boolean to know if a user has validated the email. They cannot log in if it's not validated.

    i18n string

    Possible values: >= 2 characters and <= 3 characters

    ISO code of the current language

    lastSignInAt date-time

    Possible values: non-empty

    Timestamp of the user's last login

    lastSignInIp ipv4

    Possible values: non-empty

    Last IP from which the user has connected

    lastname stringrequired

    Possible values: non-empty

    User's Last Name

    name stringrequired

    Possible values: non-empty

    User's First Name

    phone string

    Possible values: non-empty

    User's contact phone number

    photoUrl string

    Photo file code (Optional)

    resetPasswordSentAt timeStamp

    Possible values: non-empty

    Timestamp of when the password reset was requested

    role string

    Possible values: non-empty, [gestor, admin]

    Default value: gestor

    User's role. If a Manager, they can create drivers for their Company. There must always be 1 admin.

    status string

    Possible values: [pending, active, suspended, blocked]

    Default value: pending

    If the user is enabled or not to enter the platform. Pending -> Pending Approval Active -> Can use the platform Suspended -> Temporarily Blocked Blocked -> Permanently Blocked

    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 of the last update of the Object

  • ]
  • vehicles object[]

    List of the internal vehicles of the company; for MultiTennant accounts

  • Array [
  • _id string
    cargo_type string[]

    Types of loading methods valid for the truck ("NONE", "up", "lateral", "back")

    vehicle_type string

    Truck type ("NONE", "r3c", "tir", "rt", "r2c", "r2d", "van", "frc", "f2c", "adr", "ft", "pt ", "cc", "hdcc", "dump", "live" or "cocar")

    image string

    Image of the truck.

    itv string

    Truck ITV document.

    shipping_type string

    Refrigerated or dry truck ("fresh" or "dry")

    plate string

    Truck plate

    fresh_cargo_temp integer

    Temperature that the truck can reach if it is refrigerated, in degrees Celsius.

  • ]
  • contract object

    Shipping Contract. It is automatically generated when a service is accepted by both parties (Company and Carrier).

    _id string

    Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$

    Internal ID for database usage.

    code stringrequired

    Possible values: >= 12 characters and <= 12 characters, Value must match regular expression [A-Za-z0-9]{12}

    Access code to the file

    createdAt date-time

    Possible values: non-empty

    updatedAt date-time

    Possible values: non-empty

    url stringrequired

    S3 File Address

    createdAt timestamp

    Possible values: non-empty

    date_eta date-time

    ETA of arrival at the Destination

    description string

    Delivery description.

    docs object[]

    Documentation of the Shipment and contracts

  • Array [
  • _id string

    Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$

    Internal ID for database usage.

    createdAt date-time

    Possible values: non-empty

    expiredDate stringrequired

    Date until which the documentation is valid

    name stringrequired

    Possible values: non-empty

    status string

    Possible values: [pending, approved, rejected]

    Default value: pending

    Approval status of the documentation

    updatedAt date-time

    Possible values: non-empty

  • ]
  • etd_address objectrequired

    Shipping / Pickup Addresses. They are necessary for the calculation of costs, routes, and general operation of the platform to be correct. Keep in mind that we will use both GPS coordinates and postal codes to manage and verify that all data is correct; therefore, it is important that they are accurate. In case any data is incorrectly entered, consider that they will be recorded in the contract and all legal documents of the process.

    _id string

    Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$

    Internal ID for database usage.

    city string

    Possible values: non-empty

    City of the address

    company_name stringrequired

    Possible values: non-empty

    Name of the destination company. It will be used for data verification.

    country stringrequired

    Possible values: >= 3 characters and <= 20 characters

    https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes

    location objectrequired

    GPS location position

    name string

    Possible values: non-empty

    Name (or nickname) you give to the address for your use

    name_address stringrequired

    Possible values: non-empty

    Complete data

    phone string

    Possible values: non-empty

    User's contact phone number

    province string

    Possible values: non-empty

    Province of the address

    state string

    Possible values: non-empty

    Province or Community of the address. In case it's not compatible with the address format, it may remain empty.

    street_address string

    Possible values: non-empty

    Physical address; street, avenue, etc.

    street_number string

    Possible values: non-empty

    House number of the address

    zipcode stringrequired

    Possible values: non-empty

    Postal code of the address. It will depend on the country for the use of one format or another.

    etd_cargo_method string

    Possible values: non-empty, [back, lateral, superior]

    Default value: back

    Allowed loading methods for the ETD cargo

    etd_photos string[]

    Photographs of the delivery as proof of receipt

    etl_address objectrequired

    Shipping / Pickup Addresses. They are necessary for the calculation of costs, routes, and general operation of the platform to be correct. Keep in mind that we will use both GPS coordinates and postal codes to manage and verify that all data is correct; therefore, it is important that they are accurate. In case any data is incorrectly entered, consider that they will be recorded in the contract and all legal documents of the process.

    _id string

    Possible values: non-empty, Value must match regular expression ^[0-9a-fA-F]{24}$

    Internal ID for database usage.

    city string

    Possible values: non-empty

    City of the address

    company_name stringrequired

    Possible values: non-empty

    Name of the destination company. It will be used for data verification.

    country stringrequired

    Possible values: >= 3 characters and <= 20 characters

    https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes

    location objectrequired

    GPS location position

    name string

    Possible values: non-empty

    Name (or nickname) you give to the address for your use

    name_address stringrequired

    Possible values: non-empty

    Complete data

    phone string

    Possible values: non-empty

    User's contact phone number

    province string

    Possible values: non-empty

    Province of the address

    state string

    Possible values: non-empty

    Province or Community of the address. In case it's not compatible with the address format, it may remain empty.

    street_address string

    Possible values: non-empty

    Physical address; street, avenue, etc.

    street_number string

    Possible values: non-empty

    House number of the address

    zipcode stringrequired

    Possible values: non-empty

    Postal code of the address. It will depend on the country for the use of one format or another.

    etl_cargo_method string

    Possible values: non-empty, [back, lateral, superior]

    Default value: back

    Allowed loading methods for the ETL cargo

    etl_photos string[]

    Photographs of the pickup as proof of receipt

    fresh_cargo_temp integer

    Possible values: >= -273 and <= 1000

    Default value: 0

    If is_fresh is True, this value is required. And it will be the optimal cargo temperature.

    had_etd_cargo_method boolean

    If there are loading methods at the destination

    had_etl_cargo_method boolean

    If there are loading methods at the origin

    is_fresh boolean

    If it is a refrigerated cargo

    is_imperial_measure boolean

    To indicate whether we will use Imperial metrics (Pounds, inches) or Decimal metrics (cm, kg).

    is_pallet boolean

    If the shipment is palletized. Check the cargo_type field.

    pallets_num integer

    Possible values: <= 66

    Default value: 0

    Number of pallets in the shipment.

    pallets_type string

    Possible values: non-empty, [european, american, none]

    Default value: european

    Type of pallet to use. It will be used for volume calculations, measurements, and legal checks. Consider the value of the is_pallet field.

    service_code string

    Generated at creation time, read-only. Uniquely identifies the service from auction to delivery

    status string

    Possible values: [planned, replanned, accepted, issue, delivered, claimed., canceled, collected]

    Default value: planned

    This is the current status of the auction. It will not be editable. The status will be modified depending on the values, conditions of the auction. draft - Draft planned - Planned published - Published empty - Empty, no Bids awarded - Awarded approved - Approved, in Shipping process canceled - Canceled by the Company rejected - Rejected by the Trucker

    trucker_cia objectrequired

    Trucking company. In case it's a SoloDriver, it's considered an Admin of a company with only 1 User.

    _id string

    Possible values: non-empty

    Unique ID generated randomly at the time of creation

    address stringrequired

    Possible values: non-empty

    admin object
    _id string
    position object

    Array of services and their last known position

    deliveries object[]
    role string

    Account role ("driver", "dev", "manager" or "admin")

    status boolean

    Account status (Locked or active in boolean).

    reason string

    Account blocking reason.

    emailVerified boolean

    Boolean that indicates whether the email is verified.

    phone string

    Trucker's phone.

    country string

    Country of residence of the trucker.

    timezone string

    Trucker time zone.

    image string

    Trucker image.

    recovery_token string

    Password recovery token.

    i18n string

    Language of the trucker user.

    deleted boolean

    Boolean indicating whether the user has been deleted.

    name string

    Name of the trucker.

    lastname string

    Truck driver's last name.

    email string

    Trucker email (Must be unique)

    taxid string

    Truck's identity document (Must be unique).

    password string

    Hashed password of the trucker account.

    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

    If the user is enabled or not to enter the platform, applies to all associated truckers Pending -> Pending Approval Active -> Can use the platform Suspended -> Temporarily Blocked Blocked -> Permanently Blocked

    taxid stringrequired

    Possible values: non-empty

    Tax Identification

    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

    Managers and Drivers

  • Array [
  • _id string
    position object

    Array of services and their last known position

    deliveries object[]
    role string

    Account role ("driver", "dev", "manager" or "admin")

    status boolean

    Account status (Locked or active in boolean).

    reason string

    Account blocking reason.

    emailVerified boolean

    Boolean that indicates whether the email is verified.

    phone string

    Trucker's phone.

    country string

    Country of residence of the trucker.

    timezone string

    Trucker time zone.

    image string

    Trucker image.

    recovery_token string

    Password recovery token.

    i18n string

    Language of the trucker user.

    deleted boolean

    Boolean indicating whether the user has been deleted.

    name string

    Name of the trucker.

    lastname string

    Truck driver's last name.

    email string

    Trucker email (Must be unique)

    taxid string

    Truck's identity document (Must be unique).

    password string

    Hashed password of the trucker account.

  • ]
  • vehicles object[]

    Possible values: >= 1

    List of Trucks owned by the company

  • Array [
  • _id string
    cargo_type string[]

    Types of loading methods valid for the truck ("NONE", "up", "lateral", "back")

    vehicle_type string

    Truck type ("NONE", "r3c", "tir", "rt", "r2c", "r2d", "van", "frc", "f2c", "adr", "ft", "pt ", "cc", "hdcc", "dump", "live" or "cocar")

    image string

    Image of the truck.

    itv string

    Truck ITV document.

    shipping_type string

    Refrigerated or dry truck ("fresh" or "dry")

    plate string

    Truck plate

    fresh_cargo_temp integer

    Temperature that the truck can reach if it is refrigerated, in degrees 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
Loading...