Create private auction

POST /api/auction/private

Create a new PRIVATE auction, this will automatically generate a delivery/service with that information. It can only be created if the company associated with the API key is of type MULTITENNANT.

Request

Header Parameters

apikey stringrequired

Apikey of a company linked to a user

application/json

Body

award_price integer

The final awarded price in the auction, in monetary units.

linear_meters integer

Linear meters of the cargo, a measure used for certain types of cargo.

cargo_height integer

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

etl_cargo_method string

Origin loading method type ('back', 'up', 'side')

etd_cargo_method string

Destination loading method type ('back', 'up', 'side')

cargo_weight integer

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

date_end string

End date of the auction.

date_start string

Start date of the auction.

etd_address string

ID for the address of the destination.

etd_extra_time integer

Additional time allowed for unloading at the destination, in minutes.

etl_extra_time integer

Additional time allowed for loading at the origin, in minutes.

hscode string

HS (Harmonized System) code of the product, used for customs classification.

had_etl_cargo_method boolean

Indicates id is needed a specific loading method at the origin.

had_etd_cargo_method boolean

Indicates id is needed a specific loading method at the destiny.

etd_date string

Scheduled date for unloading at the destination.

etl_address string

ID for the address of the origin.

etl_date string

Scheduled date for loading at the origin.

fresh_cargo_temp integer

Required temperature for fresh cargo, in degrees Celsius.

is_fresh boolean

Indicates whether the cargo is fresh.

plate_full_trailer string

License plate of the full trailer, if applicable.

is_imperial_measure boolean

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

is_pallet boolean

Indicates whether the cargo is palletized.

pallets_num integer

Number of pallets in the cargo.

pallets_type string

Type of pallets used ('european', 'american' o 'none')

start_price integer

Starting price of the auction, in monetary units.

vehicle string

ID for the vehicle assigned for transportation.

trucker string

ID for the truck driver assigned for transportation.

cargo_type string

Type of cargo ('pallets', 'full', 'package' or 'trailer')

Responses

Example response

application/json

Schema
Example (from schema)

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

_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

{
  "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": "string",
    "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": true,
    "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": "string",
    "service_code": "string",
    "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"
  }
}

Create private auction

/api/auction/private

Request​

Header Parameters

Body

Responses​

Request

Responses