@myorb/dhl-express/dist/models/supermodel-io-logistics-express-create-shipment-response.d.ts

DHL Express api client

/**
 * 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 { SupermodelIoLogisticsExpressCreateShipmentResponseBarcodeInfo } from './supermodel-io-logistics-express-create-shipment-response-barcode-info';
import { SupermodelIoLogisticsExpressCreateShipmentResponseDocuments1 } from './supermodel-io-logistics-express-create-shipment-response-documents1';
import { SupermodelIoLogisticsExpressCreateShipmentResponseEstimatedDeliveryDate } from './supermodel-io-logistics-express-create-shipment-response-estimated-delivery-date';
import { SupermodelIoLogisticsExpressCreateShipmentResponsePackages } from './supermodel-io-logistics-express-create-shipment-response-packages';
import { SupermodelIoLogisticsExpressCreateShipmentResponseShipmentCharges } from './supermodel-io-logistics-express-create-shipment-response-shipment-charges';
import { SupermodelIoLogisticsExpressCreateShipmentResponseShipmentDetails } from './supermodel-io-logistics-express-create-shipment-response-shipment-details';
/**
 * MyDHL API REST /shipments response schema
 * @export
 * @interface SupermodelIoLogisticsExpressCreateShipmentResponse
 */
export interface SupermodelIoLogisticsExpressCreateShipmentResponse {
    /**
     * URL where the request has been sent to
     * @type {string}
     * @memberof SupermodelIoLogisticsExpressCreateShipmentResponse
     */
    url?: string;
    /**
     * Here you will receive Shipment Identification Number of your package
     * @type {string}
     * @memberof SupermodelIoLogisticsExpressCreateShipmentResponse
     */
    shipmentTrackingNumber?: string;
    /**
     * If you requested pickup for your shipment you can use this URL to cancel the pickup
     * @type {string}
     * @memberof SupermodelIoLogisticsExpressCreateShipmentResponse
     */
    cancelPickupUrl?: string;
    /**
     * You can use ths URL to track your shipment
     * @type {string}
     * @memberof SupermodelIoLogisticsExpressCreateShipmentResponse
     */
    trackingUrl?: string;
    /**
     * If you asked for pickup service here you will find Dispach Confirmation Number which identifies your pickup booking
     * @type {string}
     * @memberof SupermodelIoLogisticsExpressCreateShipmentResponse
     */
    dispatchConfirmationNumber?: string;
    /**
     * Here you can find information for all pieces your shipment is having like Piece Identification Number
     * @type {Array<SupermodelIoLogisticsExpressCreateShipmentResponsePackages>}
     * @memberof SupermodelIoLogisticsExpressCreateShipmentResponse
     */
    packages?: Array<SupermodelIoLogisticsExpressCreateShipmentResponsePackages>;
    /**
     * Here you can find all documents created for the shipment like Transport and WaybillDoc labels, Invoice, Receipt
     * @type {Array<SupermodelIoLogisticsExpressCreateShipmentResponseDocuments1>}
     * @memberof SupermodelIoLogisticsExpressCreateShipmentResponse
     */
    documents?: Array<SupermodelIoLogisticsExpressCreateShipmentResponseDocuments1>;
    /**
     * In this field you will find the On Demand Delivery (ODD) URL link if requested
     * @type {string}
     * @memberof SupermodelIoLogisticsExpressCreateShipmentResponse
     */
    onDemandDeliveryURL?: string;
    /**
     * Here you can find additional information related to your shipment when you ask for it in the request
     * @type {Array<SupermodelIoLogisticsExpressCreateShipmentResponseShipmentDetails>}
     * @memberof SupermodelIoLogisticsExpressCreateShipmentResponse
     */
    shipmentDetails?: Array<SupermodelIoLogisticsExpressCreateShipmentResponseShipmentDetails>;
    /**
     * Here you can find rates related to your shipment
     * @type {Array<SupermodelIoLogisticsExpressCreateShipmentResponseShipmentCharges>}
     * @memberof SupermodelIoLogisticsExpressCreateShipmentResponse
     */
    shipmentCharges?: Array<SupermodelIoLogisticsExpressCreateShipmentResponseShipmentCharges>;
    /**
     *
     * @type {SupermodelIoLogisticsExpressCreateShipmentResponseBarcodeInfo}
     * @memberof SupermodelIoLogisticsExpressCreateShipmentResponse
     */
    barcodeInfo?: SupermodelIoLogisticsExpressCreateShipmentResponseBarcodeInfo;
    /**
     *
     * @type {SupermodelIoLogisticsExpressCreateShipmentResponseEstimatedDeliveryDate}
     * @memberof SupermodelIoLogisticsExpressCreateShipmentResponse
     */
    estimatedDeliveryDate?: SupermodelIoLogisticsExpressCreateShipmentResponseEstimatedDeliveryDate;
    /**
     *
     * @type {Array<string>}
     * @memberof SupermodelIoLogisticsExpressCreateShipmentResponse
     */
    warnings?: Array<string>;
}