Autonomous Procurement
- ser_hcskb_api
To use the Autonomous Procurement feature, specific fields and values must be send with the transport order DTOs.
Transport Order DTO
Field | Description | Type (Length) | Value / Example | Mandatory |
|---|---|---|---|---|
status | Transport status. Must be AP | CHAR(3) | AP | True |
acceptance_deadline | A deadline given to a carrier or carriers to accept an offered transport. Deadline cannot be specified per carrier. The Deadline is exactly the time stamp in the provided time zone offset | CHAR(25) | 2021-11-18T11:30:00+03:00 | False |
vehicle | Aggregated from the first order. Please see Order Details. | True | ||
volume | Aggregated from the first order. Please see Order Details. | False 1) | ||
weight | Aggregated from the first order. Please see Order Details. | False 1) | ||
loading_meter | Aggregated from the first order. Please see Order Details. | False 1) |
Order Details DTO
Field | Description | Type (Length) | Value / Example | Mandatory |
|---|---|---|---|---|
vehicle | Vehicle type. Must be one of the following values: '"power only", | CHAR(50) | power only | True |
volume | Load volume. The attribute “unit” contains one of the supported volume units. See Measurement and Units, Statuses, and Enumerations | FLOAT | 30.6 | False 1) |
weight | Load weight, Attribute “unit” contains one of the supported weight units. See Measurement and Units, Statuses, and Enumerations | FLOAT | 15.5 | False 1) |
loading_meter | Length of the load on the vehicle. The attribute “unit” contains one of the supported length units. See Measurement and Units, Statuses, and Enumerations | FLOAT | 20.45 | False 1) |
transport_unit | A unit containing loading tackle data (e. g. pallet details). See Transport Unit | False 1) | ||
1) One of the following is mandatory: volume, weight, loading_meter or transport unit
Transport Unit DTO
Attribute | Description | Type (Length) | Value / Example | Mandatory |
|---|---|---|---|---|
name | Name or type of transport unit. If provided, must be pallet. This is the only possible transport unit presently. Must include the following qualifiers: dimensionLength, dimensionWidth and dimensionHeight | CHAR(50) | pallet | False 1) |
Amount | Amount of transport units | INTEGER | 33 | False 1) |
Stop DTO
Location
Attribute | Description | Type (Length) | Value / Example | Mandatory |
|---|---|---|---|---|
city | City | CHAR(100) | Ulm | True |
street | Street name and number | CHAR(100) | Heidenheimer Straße 55/1 | True |
zip | Postal code | CHAR(20) | 89075 | True |
country | Country code | CHAR(2) | DE | True |
Applicable for loading and unloading addresses.
Datetime Period
Attribute | Description | Type (Length) | Value / Example | Mandatory |
|---|---|---|---|---|
start | Loading/unloading period begin (date and time) | CHAR(19) | 2021-10-08T12:00:00 | True |
end | Loading/unloading period end (date and time) | CHAR(19) | 2021-10-08T14:15:00Z | True |
Applicable for loading and unloading addresses.
Price DTO
Field | Description | Type (Length) | Value / Example | Mandatory |
|---|---|---|---|---|
currency | Currency Use ISO 4217 currency codes. The following can be used for Autonomous Procurement: AUD, EUR, USD, JPY, NZD, PLN, MXN, CAD, RUB, COP, GBP, CHF, HUF, RON, CZK, HRK, RSD, BGN | CHAR(3) | EUR | True |
Allowed currencies are subject to change according to AP setup.
Reserved Parameter Qualifiers
Parameter qualifiers | Description | Type (Length) | Value / Example | Mandatory |
|---|---|---|---|---|
custom.tnx.cargotype | Specifies the type of transport order. The following values are possible. Main values: - FTL Also allowed: | CHAR(50) | FTL | True |
custom.temperature.min | Minimum temperature, must be >= -20°C or -30°F | INTEGER | -20 | False |
custom.temperature.max | Maximum temperature, must be <= 50°C or 75°F | INTEGER | 50 | False |
custom.temperature.unit | Temperature unit. Either Celsius (C) or Fahrenheit (F) | CHAR(1) | C | False |
custom.tnx.criticality | Criticality. Must be in the range 0-100 | INTEGER | 5 | False |
payload.capacity.min | Minimum payload capacity | INTEGER | 40 | False |
payload.capacity.max | Maximum payload capacity | INTEGER | 4000 | False |
custom.customs.requirements | Specific customer requirements. One of the following values are possible: - ATTESTBCP: Goods with Private Attestation requiring Border Control Post (BCP) check - ATTESTNOBCP: Goods with Private Attestation (no Border Control Post check) - VETCERT: Goods with Veterinary Certificate requiring Border Control Post (BCP) check - ORGANIC: Organic goods needing Certificate Of Ingredients (COI) validation in unloading market | CHAR(50) | ATTESTBCP | False |