@myorb/dhl-express
Version:
DHL Express api client
90 lines (89 loc) • 4.06 kB
TypeScript
/**
* DHL Express APIs (MyDHL API)
* Welcome to the official DHL Express APIs (MyDHL API) below are the published API Documentation to fulfill your shipping needs with DHL Express. Please follow the process described [here](https://developer.dhl.com/api-reference/dhl-express-mydhl-api#get-started-section/user-guide--get-access) to request access to the DHL Express - MyDHL API services In case you already have DHL Express - MyDHL API Service credentials please ensure to use the endpoints/environments listed [here](https://developer.dhl.com/api-reference/dhl-express-mydhl-api#get-started-section/user-guide--environments)
*
* OpenAPI spec version: 2.4.0
*
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
import { SupermodelIoLogisticsExpressAccount } from './supermodel-io-logistics-express-account';
import { SupermodelIoLogisticsExpressPackageRR } from './supermodel-io-logistics-express-package-rr';
import { SupermodelIoLogisticsExpressValueAddedServicesRates } from './supermodel-io-logistics-express-value-added-services-rates';
/**
*
* @export
* @interface SupermodelIoLogisticsExpressPickupRequestShipmentDetails
*/
export interface SupermodelIoLogisticsExpressPickupRequestShipmentDetails {
/**
* Please provide DHL Express Global product code of the shipment
* @type {string}
* @memberof SupermodelIoLogisticsExpressPickupRequestShipmentDetails
*/
productCode: string;
/**
* Please provide DHL Express Local product code of the shipment
* @type {string}
* @memberof SupermodelIoLogisticsExpressPickupRequestShipmentDetails
*/
localProductCode?: string;
/**
* Please enter all the DHL Express accounts related to this shipment
* @type {Array<SupermodelIoLogisticsExpressAccount>}
* @memberof SupermodelIoLogisticsExpressPickupRequestShipmentDetails
*/
accounts?: Array<SupermodelIoLogisticsExpressAccount>;
/**
* This section communicates additional shipping services, such as Insurance (or Shipment Value Protection).
* @type {Array<SupermodelIoLogisticsExpressValueAddedServicesRates>}
* @memberof SupermodelIoLogisticsExpressPickupRequestShipmentDetails
*/
valueAddedServices?: Array<SupermodelIoLogisticsExpressValueAddedServicesRates>;
/**
* For customs purposes please advise if your shipment is dutiable (true) or non dutiable (false)
* @type {boolean}
* @memberof SupermodelIoLogisticsExpressPickupRequestShipmentDetails
*/
isCustomsDeclarable: boolean;
/**
* For customs purposes please advise on declared value of the shipment
* @type {number}
* @memberof SupermodelIoLogisticsExpressPickupRequestShipmentDetails
*/
declaredValue?: number;
/**
* For customs purposes please advise on declared value currency code of the shipment
* @type {string}
* @memberof SupermodelIoLogisticsExpressPickupRequestShipmentDetails
*/
declaredValueCurrency?: string;
/**
* Please enter Unit of measurement - metric,imperial
* @type {string}
* @memberof SupermodelIoLogisticsExpressPickupRequestShipmentDetails
*/
unitOfMeasurement: SupermodelIoLogisticsExpressPickupRequestShipmentDetailsUnitOfMeasurementEnum;
/**
* Please provide Shipment Identification number (AWB number)
* @type {string}
* @memberof SupermodelIoLogisticsExpressPickupRequestShipmentDetails
*/
shipmentTrackingNumber?: string;
/**
* Here you can define properties per package
* @type {Array<SupermodelIoLogisticsExpressPackageRR>}
* @memberof SupermodelIoLogisticsExpressPickupRequestShipmentDetails
*/
packages: Array<SupermodelIoLogisticsExpressPackageRR>;
}
/**
* @export
* @enum {string}
*/
export declare enum SupermodelIoLogisticsExpressPickupRequestShipmentDetailsUnitOfMeasurementEnum {
Metric = "metric",
Imperial = "imperial"
}