Skip to main content

Details - Auction/Shipment

GET 
/api/auction/:serviceCode

Auction/Shipment Detail

Request​

Path Parameters

    serviceCode stringrequired

Header Parameters

    apikey stringrequired

    Apikey of a company linked to a user

Responses​

Example response

Schema
    status string
    data object

    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

Loading...