### Schema: InstallationOptions Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for InstallationOptions ```markdown ## Schema: InstallationOptions Schema definition for InstallationOptions **Type:** object - **quantity** (integer (int32)) (required) ``` -------------------------------- ### GET /transportinstruction/ping Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 API endpoint for GET /transportinstruction/ping ```markdown ### Responses #### 200 - Success ### Example Usage ```bash curl -X GET "https://test-api.freight-logistics.dhl.com/transportinstructionapi/v1//transportinstruction/ping" ``` ``` -------------------------------- ### Security: client-key Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Please insert your client key ```markdown ## Security: client-key **Description:** Please insert your client key **Type:** apiKey ``` -------------------------------- ### Schema: InstallationAdvancedOptions Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for InstallationAdvancedOptions ```markdown ## Schema: InstallationAdvancedOptions Schema definition for InstallationAdvancedOptions **Type:** object - **quantity** (integer (int32)) (required) ``` -------------------------------- ### Schema: AvailablePickupTimeOptions Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for AvailablePickupTimeOptions ```markdown ## Schema: AvailablePickupTimeOptions Schema definition for AvailablePickupTimeOptions **Type:** object - **fromTime** (string) (required) (example: "07:30") - **toTime** (string) (required) (example: "16:30") ``` -------------------------------- ### Schema: M60Options Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for M60Options ```markdown ## Schema: M60Options Schema definition for M60Options **Type:** object - **quantity** (integer (int32)) (required) ``` -------------------------------- ### Schema: M40Options Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for M40Options ```markdown ## Schema: M40Options Schema definition for M40Options **Type:** object - **quantity** (integer (int32)) (required) ``` -------------------------------- ### Schema: PreAdviceByDriverPickupOptions Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for PreAdviceByDriverPickupOptions ```markdown ## Schema: PreAdviceByDriverPickupOptions Schema definition for PreAdviceByDriverPickupOptions **Type:** object - **phone** (string) (required) ``` -------------------------------- ### Schema: Reference Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for Reference ```markdown ## Schema: Reference Schema definition for Reference **Type:** object - **qualifier** (string) (required) - **value** (string) (required) ``` -------------------------------- ### Schema: BookInWithInfoOptions Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for BookInWithInfoOptions ```markdown ## Schema: BookInWithInfoOptions Schema definition for BookInWithInfoOptions **Type:** object - **contactDetails** (string) - **contactDetailsType** (string (email|phonenumber|externalSystem|timeWindow|other)) ("email"|"phonenumber"|"externalSystem"|"timeWindow"|"other") ``` -------------------------------- ### Schema: Party Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for Party ```markdown ## Schema: Party Schema definition for Party **Type:** object - **id** (string): For a consignor, consignee or freight payer the customer/agreement number. Mandatory on the part according to the payer code. For a access point, i.e. parcels shop, parcel station etc, this is the identifier of this location. - **type** (string (Consignor|Pickup|Consignee|Delivery|AccessPoint|FreightPayer)) (required) ("Consignor"|"Pickup"|"Consignee"|"Delivery"|"AccessPoint"|"FreightPayer") - **vatEoriSocialSecurityNumber** (string): EORI (Economic operators registration and identification number) used for customs-related trade within the EU. (example: "") - **name** (string) (required) - **contactName** (string) - **references** (array (string)) - **address** (object) (required) - **street** (string) (required) - **streetNumber** (string) - **additionalAddressInfo** (string) - **cityName** (string) (required) - **postalCode** (string): For Ireland county should be used as postal code, EirCode is not supported. - **countryCode** (string) (required) - **accessCode** (string) - **phone** (string) - **email** (string) - **subType** (string (ParcelShop|ParcelStation)): Use with access point to state if it’s a parcels shop, parcel station etc. For locationType locker, subType should be set to ParcelStation for all others to PracelShop ("ParcelShop"|"ParcelStation") - **vat** (object): According to Greece legislation for all transport to, from, and within Greece VAT or TAX ID is required. - **countryCode** (string): VAT country prefix, in general the country ISO code but deviation exist like CHE foe Switzerland and EL for Greece. (example: "FR") - **number** (string): The 'number' part of the VAT, can include characters depending on the countries specific format. (example: "1X123456789") ``` -------------------------------- ### Schema: SortAndQuantityOptions Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for SortAndQuantityOptions ```markdown ## Schema: SortAndQuantityOptions Schema definition for SortAndQuantityOptions **Type:** object - **sort** (number (double)) (required) - **quantity** (number (double)) (required) ``` -------------------------------- ### Schema: TimeDefiniteLoadingOptions Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for TimeDefiniteLoadingOptions ```markdown ## Schema: TimeDefiniteLoadingOptions Schema definition for TimeDefiniteLoadingOptions **Type:** object - **dateTime** (string (date-time)) (required) ``` -------------------------------- ### Schema: PreAdviceByDriverOptions Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for PreAdviceByDriverOptions ```markdown ## Schema: PreAdviceByDriverOptions Schema definition for PreAdviceByDriverOptions **Type:** object - **phone** (string) ``` -------------------------------- ### Schema: HardcopyProofOfDeliveryOptions Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for HardcopyProofOfDeliveryOptions ```markdown ## Schema: HardcopyProofOfDeliveryOptions Schema definition for HardcopyProofOfDeliveryOptions **Type:** object - **email** (string) ``` -------------------------------- ### Schema: M20Options Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for M20Options ```markdown ## Schema: M20Options Schema definition for M20Options **Type:** object - **quantity** (integer (int32)) (required) ``` -------------------------------- ### Schema: ThermoType Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 **Cold** - the temperature during the transport chain is in the range of +2 to +8 degrees C. Other temperature range after special written agreement (but not more than +15 degrees). Temperature-controlled transport is carried out after special written agreement. **Ambient** - the the temperature during the transport chain is in the range of +15 to +25 degrees C. Other temperature range after special written agreement (but not more than +15 degrees). Temperature-controlled transport is carried out after special written agreement. ```markdown ## Schema: ThermoType **Cold** - the temperature during the transport chain is in the range of +2 to +8 degrees C. Other temperature range after special written agreement (but not more than +15 degrees). Temperature-controlled transport is carried out after special written agreement. **Ambient** - the the temperature during the transport chain is in the range of +15 to +25 degrees C. Other temperature range after special written agreement (but not more than +15 degrees). Temperature-controlled transport is carried out after special written agreement. **Type:** integer ``` -------------------------------- ### Schema: CashOnDeliveryOptions Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for CashOnDeliveryOptions ```markdown ## Schema: CashOnDeliveryOptions Schema definition for CashOnDeliveryOptions **Type:** object - **amount** (integer (int64)) (required) - **bankGiroNumber** (string) - **plusGiroNumber** (string) - **reference** (string) - **currency** (string) (required) ``` -------------------------------- ### Schema: Address Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for Address ```markdown ## Schema: Address Schema definition for Address **Type:** object - **street** (string) (required) - **streetNumber** (string) - **additionalAddressInfo** (string) - **cityName** (string) (required) - **postalCode** (string): For Ireland county should be used as postal code, EirCode is not supported. - **countryCode** (string) (required) - **accessCode** (string) ``` -------------------------------- ### Schema: AvailableDeliveryTimeOptions Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for AvailableDeliveryTimeOptions ```markdown ## Schema: AvailableDeliveryTimeOptions Schema definition for AvailableDeliveryTimeOptions **Type:** object - **fromTime** (string) (required) (example: "07:30") - **toTime** (string) (required) (example: "16:30") ``` -------------------------------- ### Schema: OnlineAppointmentBookingOptions Source: https://test-admin.freight-logistics.dhl.com/apis/docs/swagger/43ea33a4-1882-4701-b830-07d6437d3257 Schema definition for OnlineAppointmentBookingOptions ```markdown ## Schema: OnlineAppointmentBookingOptions Schema definition for OnlineAppointmentBookingOptions **Type:** object - **responseText** (string) ```