@myorb/dhl-express
Version:
DHL Express api client
627 lines • 81.7 kB
JavaScript
"use strict";
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ShipmentApi = exports.ShipmentApiFactory = exports.ShipmentApiFp = exports.ShipmentApiAxiosParamCreator = void 0;
/* tslint:disable */
/* eslint-disable */
/**
* 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.
*/
var axios_1 = require("axios");
// Some imports not used depending on template conditions
// @ts-ignore
var base_1 = require("../base");
/**
* ShipmentApi - axios parameter creator
* @export
*/
var ShipmentApiAxiosParamCreator = function (configuration) {
var _this = this;
return {
/**
* ## Create Shipment The ShipmentRequest Operation will allow you to generate an AWB number and piece IDs, generate a shipping label, transmit manifest shipment detail to DHL, and optionally book a courier for the pickup of a shipment. The key elements in the response of the Shipment Request will be a base64 encoded PDF label and the Shipment and Piece identification numbers, which you can use for tracking on the DHL web site. While the RateRequest and ShipmentRequest services can be used independently, DHL recommends the use of RateRequest to first validate the products available for the shipper/receiver. The global product codes which are output during the RateResponse can be used directly as input into the Shipment Request, as both perform similar validations in terms of service capability.
* @summary Create Shipment
* @param {SupermodelIoLogisticsExpressCreateShipmentRequest} body Details about the shipment to be created
* @param {string} [messageReference] Please provide message reference
* @param {string} [messageReferenceDate] Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2
* @param {string} [pluginName] Please provide name of the plugin (applicable to 3PV only)
* @param {string} [pluginVersion] Please provide version of the plugin (applicable to 3PV only)
* @param {string} [shippingSystemPlatformName] Please provide name of the shipping platform(applicable to 3PV only)
* @param {string} [shippingSystemPlatformVersion] Please provide version of the shipping platform (applicable to 3PV only)
* @param {string} [webstorePlatformName] Please provide name of the webstore platform (applicable to 3PV only)
* @param {string} [webstorePlatformVersion] Please provide version of the webstore platform (applicable to 3PV only)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
expApiShipments: function (body, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions, needsSerialization;
return __generator(this, function (_a) {
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new base_1.RequiredError('body', 'Required parameter body was null or undefined when calling expApiShipments.');
}
localVarPath = "/shipments";
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
if (messageReference !== undefined && messageReference !== null) {
localVarHeaderParameter['Message-Reference'] = String(messageReference);
}
if (messageReferenceDate !== undefined && messageReferenceDate !== null) {
localVarHeaderParameter['Message-Reference-Date'] = String(messageReferenceDate);
}
if (pluginName !== undefined && pluginName !== null) {
localVarHeaderParameter['Plugin-Name'] = String(pluginName);
}
if (pluginVersion !== undefined && pluginVersion !== null) {
localVarHeaderParameter['Plugin-Version'] = String(pluginVersion);
}
if (shippingSystemPlatformName !== undefined && shippingSystemPlatformName !== null) {
localVarHeaderParameter['Shipping-System-Platform-Name'] = String(shippingSystemPlatformName);
}
if (shippingSystemPlatformVersion !== undefined && shippingSystemPlatformVersion !== null) {
localVarHeaderParameter['Shipping-System-Platform-Version'] = String(shippingSystemPlatformVersion);
}
if (webstorePlatformName !== undefined && webstorePlatformName !== null) {
localVarHeaderParameter['Webstore-Platform-Name'] = String(webstorePlatformName);
}
if (webstorePlatformVersion !== undefined && webstorePlatformVersion !== null) {
localVarHeaderParameter['Webstore-Platform-Version'] = String(webstorePlatformVersion);
}
localVarHeaderParameter['Content-Type'] = 'application/json';
query = new URLSearchParams(localVarUrlObj.search);
for (key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
return [2 /*return*/, {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
}];
});
});
},
/**
* The Get Image service can be used to retrieve customer's own uploaded Commercial Invoice, Waybill Document or supporting documents that uploaded during shipment creation.
* @summary Get Image
* @param {string} shipmentTrackingNumber DHL Express shipment identification number
* @param {string} shipperAccountNumber DHL Express customer shipper account number
* @param {string} typeCode Please provide correct document type.
* @param {string} pickupYearAndMonth Please provide the pickup's date in YYYY-MM format
* @param {string} [encodingFormat] Please provide the document image encoding format in pdf or tiff format
* @param {boolean} [allInOnePDF] Option to return all the document images in a single PDF file
* @param {boolean} [compressedPackage] Option to return all the document images in a compressed package
* @param {string} [messageReference] Please provide message reference
* @param {string} [messageReferenceDate] Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2
* @param {string} [pluginName] Please provide name of the plugin (applicable to 3PV only)
* @param {string} [pluginVersion] Please provide version of the plugin (applicable to 3PV only)
* @param {string} [shippingSystemPlatformName] Please provide name of the shipping platform(applicable to 3PV only)
* @param {string} [shippingSystemPlatformVersion] Please provide version of the shipping platform (applicable to 3PV only)
* @param {string} [webstorePlatformName] Please provide name of the webstore platform (applicable to 3PV only)
* @param {string} [webstorePlatformVersion] Please provide version of the webstore platform (applicable to 3PV only)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
expApiShipmentsDocumentimage: function (shipmentTrackingNumber, shipperAccountNumber, typeCode, pickupYearAndMonth, encodingFormat, allInOnePDF, compressedPackage, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions;
return __generator(this, function (_a) {
// verify required parameter 'shipmentTrackingNumber' is not null or undefined
if (shipmentTrackingNumber === null || shipmentTrackingNumber === undefined) {
throw new base_1.RequiredError('shipmentTrackingNumber', 'Required parameter shipmentTrackingNumber was null or undefined when calling expApiShipmentsDocumentimage.');
}
// verify required parameter 'shipperAccountNumber' is not null or undefined
if (shipperAccountNumber === null || shipperAccountNumber === undefined) {
throw new base_1.RequiredError('shipperAccountNumber', 'Required parameter shipperAccountNumber was null or undefined when calling expApiShipmentsDocumentimage.');
}
// verify required parameter 'typeCode' is not null or undefined
if (typeCode === null || typeCode === undefined) {
throw new base_1.RequiredError('typeCode', 'Required parameter typeCode was null or undefined when calling expApiShipmentsDocumentimage.');
}
// verify required parameter 'pickupYearAndMonth' is not null or undefined
if (pickupYearAndMonth === null || pickupYearAndMonth === undefined) {
throw new base_1.RequiredError('pickupYearAndMonth', 'Required parameter pickupYearAndMonth was null or undefined when calling expApiShipmentsDocumentimage.');
}
localVarPath = "/shipments/{shipmentTrackingNumber}/get-image"
.replace("{".concat("shipmentTrackingNumber", "}"), encodeURIComponent(String(shipmentTrackingNumber)));
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
if (shipperAccountNumber !== undefined) {
localVarQueryParameter['shipperAccountNumber'] = shipperAccountNumber;
}
if (typeCode !== undefined) {
localVarQueryParameter['typeCode'] = typeCode;
}
if (pickupYearAndMonth !== undefined) {
localVarQueryParameter['pickupYearAndMonth'] = pickupYearAndMonth;
}
if (encodingFormat !== undefined) {
localVarQueryParameter['encodingFormat'] = encodingFormat;
}
if (allInOnePDF !== undefined) {
localVarQueryParameter['allInOnePDF'] = allInOnePDF;
}
if (compressedPackage !== undefined) {
localVarQueryParameter['compressedPackage'] = compressedPackage;
}
if (messageReference !== undefined && messageReference !== null) {
localVarHeaderParameter['Message-Reference'] = String(messageReference);
}
if (messageReferenceDate !== undefined && messageReferenceDate !== null) {
localVarHeaderParameter['Message-Reference-Date'] = String(messageReferenceDate);
}
if (pluginName !== undefined && pluginName !== null) {
localVarHeaderParameter['Plugin-Name'] = String(pluginName);
}
if (pluginVersion !== undefined && pluginVersion !== null) {
localVarHeaderParameter['Plugin-Version'] = String(pluginVersion);
}
if (shippingSystemPlatformName !== undefined && shippingSystemPlatformName !== null) {
localVarHeaderParameter['Shipping-System-Platform-Name'] = String(shippingSystemPlatformName);
}
if (shippingSystemPlatformVersion !== undefined && shippingSystemPlatformVersion !== null) {
localVarHeaderParameter['Shipping-System-Platform-Version'] = String(shippingSystemPlatformVersion);
}
if (webstorePlatformName !== undefined && webstorePlatformName !== null) {
localVarHeaderParameter['Webstore-Platform-Name'] = String(webstorePlatformName);
}
if (webstorePlatformVersion !== undefined && webstorePlatformVersion !== null) {
localVarHeaderParameter['Webstore-Platform-Version'] = String(webstorePlatformVersion);
}
query = new URLSearchParams(localVarUrlObj.search);
for (key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
}];
});
});
},
/**
* The electronic proof of delivery service can be used to retrieve proof of delivery for certain delivered DHL Express shipments
* @summary Electronic Proof of Delivery
* @param {string} shipmentTrackingNumber DHL Express shipment identification number
* @param {string} [shipperAccountNumber] DHL Express customer shipper account number
* @param {string} [content]
* @param {string} [messageReference] Please provide message reference
* @param {string} [messageReferenceDate] Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2
* @param {string} [pluginName] Please provide name of the plugin (applicable to 3PV only)
* @param {string} [pluginVersion] Please provide version of the plugin (applicable to 3PV only)
* @param {string} [shippingSystemPlatformName] Please provide name of the shipping platform(applicable to 3PV only)
* @param {string} [shippingSystemPlatformVersion] Please provide version of the shipping platform (applicable to 3PV only)
* @param {string} [webstorePlatformName] Please provide name of the webstore platform (applicable to 3PV only)
* @param {string} [webstorePlatformVersion] Please provide version of the webstore platform (applicable to 3PV only)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
expApiShipmentsEpod: function (shipmentTrackingNumber, shipperAccountNumber, content, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions;
return __generator(this, function (_a) {
// verify required parameter 'shipmentTrackingNumber' is not null or undefined
if (shipmentTrackingNumber === null || shipmentTrackingNumber === undefined) {
throw new base_1.RequiredError('shipmentTrackingNumber', 'Required parameter shipmentTrackingNumber was null or undefined when calling expApiShipmentsEpod.');
}
localVarPath = "/shipments/{shipmentTrackingNumber}/proof-of-delivery"
.replace("{".concat("shipmentTrackingNumber", "}"), encodeURIComponent(String(shipmentTrackingNumber)));
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
if (shipperAccountNumber !== undefined) {
localVarQueryParameter['shipperAccountNumber'] = shipperAccountNumber;
}
if (content !== undefined) {
localVarQueryParameter['content'] = content;
}
if (messageReference !== undefined && messageReference !== null) {
localVarHeaderParameter['Message-Reference'] = String(messageReference);
}
if (messageReferenceDate !== undefined && messageReferenceDate !== null) {
localVarHeaderParameter['Message-Reference-Date'] = String(messageReferenceDate);
}
if (pluginName !== undefined && pluginName !== null) {
localVarHeaderParameter['Plugin-Name'] = String(pluginName);
}
if (pluginVersion !== undefined && pluginVersion !== null) {
localVarHeaderParameter['Plugin-Version'] = String(pluginVersion);
}
if (shippingSystemPlatformName !== undefined && shippingSystemPlatformName !== null) {
localVarHeaderParameter['Shipping-System-Platform-Name'] = String(shippingSystemPlatformName);
}
if (shippingSystemPlatformVersion !== undefined && shippingSystemPlatformVersion !== null) {
localVarHeaderParameter['Shipping-System-Platform-Version'] = String(shippingSystemPlatformVersion);
}
if (webstorePlatformName !== undefined && webstorePlatformName !== null) {
localVarHeaderParameter['Webstore-Platform-Name'] = String(webstorePlatformName);
}
if (webstorePlatformVersion !== undefined && webstorePlatformVersion !== null) {
localVarHeaderParameter['Webstore-Platform-Version'] = String(webstorePlatformVersion);
}
query = new URLSearchParams(localVarUrlObj.search);
for (key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
}];
});
});
},
/**
* The update shipment service can be used to upload updated customs documentation for your DHL Express shipment that has not been picked up yet.
* @summary Upload updated customs documentation for your DHL Express shipment
* @param {SupermodelIoLogisticsExpressImageUploadRequest} body Details about the shipment images
* @param {string} shipmentTrackingNumber DHL Express shipment identification number
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
expApiShipmentsImgUpload: function (body, shipmentTrackingNumber, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions, needsSerialization;
return __generator(this, function (_a) {
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new base_1.RequiredError('body', 'Required parameter body was null or undefined when calling expApiShipmentsImgUpload.');
}
// verify required parameter 'shipmentTrackingNumber' is not null or undefined
if (shipmentTrackingNumber === null || shipmentTrackingNumber === undefined) {
throw new base_1.RequiredError('shipmentTrackingNumber', 'Required parameter shipmentTrackingNumber was null or undefined when calling expApiShipmentsImgUpload.');
}
localVarPath = "/shipments/{shipmentTrackingNumber}/upload-image"
.replace("{".concat("shipmentTrackingNumber", "}"), encodeURIComponent(String(shipmentTrackingNumber)));
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
localVarHeaderParameter['Content-Type'] = 'application/json';
query = new URLSearchParams(localVarUrlObj.search);
for (key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
return [2 /*return*/, {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
}];
});
});
},
/**
* ## Upload Invoice Data with Shipment ID The upload invoice data service can be used to upload Commerical Invoice data with Shipment Identification Number for your DHL Express shipment.Customer can provide Commercial Invoice data before Shipment Data via Create Shipment flow or vice versa. Important Note: UploadInvoiceData service is not enabled by default and must be requested per customer. Use of this service is only enabled on exceptional basis and DHL Express recommends to submit shipment requests together with a commercial invoice data.To enable use of UploadInvoiceData service, please contact your DHL Express IT representative. To use UploadInvoiceData service, it is required that \"PM\" service code is provided in MyDHL API Create Shipment request. \"PM\" service code is not enabled by default for the customers, and needs to be enabled upon request. When Shipment is created via MyDHL API Create Shipment service before uploading the Commercial Invoice (CIN) data,it is mandatory to provide the Shipment Identification Number as received in MyDHL API Create Shipment service Response. When Commercial Invoice (CIN) data is uploaded prior to creating a shipment via MyDHL API Create Shipment service, it is mandatory to provide Invoice Reference Number with Invoice Reference Type value \"CU\" and Shipper Account Number. These elements are mandatory to facilitate an effective data merge of the Commercial Invoice (CIN) data with Shipment Data. As an output customer will receive Notification element value '0' on successful upload of Commercial Invoice (CIN) data. DHL backend application performs the subsequent data merging process of the Shipment Data and Commercial Invoice data.
* @summary Upload Commercial Invoice data for your DHL Express shipment
* @param {SupermodelIoLogisticsExpressUploadInvoiceDataRequest} body Details about the invoice data
* @param {string} shipmentTrackingNumber DHL Express shipment identification number
* @param {string} [messageReference] Please provide message reference
* @param {string} [messageReferenceDate] Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2
* @param {string} [pluginName] Please provide name of the plugin (applicable to 3PV only)
* @param {string} [pluginVersion] Please provide version of the plugin (applicable to 3PV only)
* @param {string} [shippingSystemPlatformName] Please provide name of the shipping platform(applicable to 3PV only)
* @param {string} [shippingSystemPlatformVersion] Please provide version of the shipping platform (applicable to 3PV only)
* @param {string} [webstorePlatformName] Please provide name of the webstore platform (applicable to 3PV only)
* @param {string} [webstorePlatformVersion] Please provide version of the webstore platform (applicable to 3PV only)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
expApiShipmentsInvoiceDataAwb: function (body, shipmentTrackingNumber, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions, needsSerialization;
return __generator(this, function (_a) {
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new base_1.RequiredError('body', 'Required parameter body was null or undefined when calling expApiShipmentsInvoiceDataAwb.');
}
// verify required parameter 'shipmentTrackingNumber' is not null or undefined
if (shipmentTrackingNumber === null || shipmentTrackingNumber === undefined) {
throw new base_1.RequiredError('shipmentTrackingNumber', 'Required parameter shipmentTrackingNumber was null or undefined when calling expApiShipmentsInvoiceDataAwb.');
}
localVarPath = "/shipments/{shipmentTrackingNumber}/upload-invoice-data"
.replace("{".concat("shipmentTrackingNumber", "}"), encodeURIComponent(String(shipmentTrackingNumber)));
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
if (messageReference !== undefined && messageReference !== null) {
localVarHeaderParameter['Message-Reference'] = String(messageReference);
}
if (messageReferenceDate !== undefined && messageReferenceDate !== null) {
localVarHeaderParameter['Message-Reference-Date'] = String(messageReferenceDate);
}
if (pluginName !== undefined && pluginName !== null) {
localVarHeaderParameter['Plugin-Name'] = String(pluginName);
}
if (pluginVersion !== undefined && pluginVersion !== null) {
localVarHeaderParameter['Plugin-Version'] = String(pluginVersion);
}
if (shippingSystemPlatformName !== undefined && shippingSystemPlatformName !== null) {
localVarHeaderParameter['Shipping-System-Platform-Name'] = String(shippingSystemPlatformName);
}
if (shippingSystemPlatformVersion !== undefined && shippingSystemPlatformVersion !== null) {
localVarHeaderParameter['Shipping-System-Platform-Version'] = String(shippingSystemPlatformVersion);
}
if (webstorePlatformName !== undefined && webstorePlatformName !== null) {
localVarHeaderParameter['Webstore-Platform-Name'] = String(webstorePlatformName);
}
if (webstorePlatformVersion !== undefined && webstorePlatformVersion !== null) {
localVarHeaderParameter['Webstore-Platform-Version'] = String(webstorePlatformVersion);
}
localVarHeaderParameter['Content-Type'] = 'application/json';
query = new URLSearchParams(localVarUrlObj.search);
for (key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
return [2 /*return*/, {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
}];
});
});
},
};
};
exports.ShipmentApiAxiosParamCreator = ShipmentApiAxiosParamCreator;
/**
* ShipmentApi - functional programming interface
* @export
*/
var ShipmentApiFp = function (configuration) {
return {
/**
* ## Create Shipment The ShipmentRequest Operation will allow you to generate an AWB number and piece IDs, generate a shipping label, transmit manifest shipment detail to DHL, and optionally book a courier for the pickup of a shipment. The key elements in the response of the Shipment Request will be a base64 encoded PDF label and the Shipment and Piece identification numbers, which you can use for tracking on the DHL web site. While the RateRequest and ShipmentRequest services can be used independently, DHL recommends the use of RateRequest to first validate the products available for the shipper/receiver. The global product codes which are output during the RateResponse can be used directly as input into the Shipment Request, as both perform similar validations in terms of service capability.
* @summary Create Shipment
* @param {SupermodelIoLogisticsExpressCreateShipmentRequest} body Details about the shipment to be created
* @param {string} [messageReference] Please provide message reference
* @param {string} [messageReferenceDate] Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2
* @param {string} [pluginName] Please provide name of the plugin (applicable to 3PV only)
* @param {string} [pluginVersion] Please provide version of the plugin (applicable to 3PV only)
* @param {string} [shippingSystemPlatformName] Please provide name of the shipping platform(applicable to 3PV only)
* @param {string} [shippingSystemPlatformVersion] Please provide version of the shipping platform (applicable to 3PV only)
* @param {string} [webstorePlatformName] Please provide name of the webstore platform (applicable to 3PV only)
* @param {string} [webstorePlatformVersion] Please provide version of the webstore platform (applicable to 3PV only)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
expApiShipments: function (body, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, exports.ShipmentApiAxiosParamCreator)(configuration).expApiShipments(body, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, function (axios, basePath) {
if (axios === void 0) { axios = axios_1.default; }
if (basePath === void 0) { basePath = base_1.BASE_PATH; }
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url });
return axios.request(axiosRequestArgs);
}];
}
});
});
},
/**
* The Get Image service can be used to retrieve customer's own uploaded Commercial Invoice, Waybill Document or supporting documents that uploaded during shipment creation.
* @summary Get Image
* @param {string} shipmentTrackingNumber DHL Express shipment identification number
* @param {string} shipperAccountNumber DHL Express customer shipper account number
* @param {string} typeCode Please provide correct document type.
* @param {string} pickupYearAndMonth Please provide the pickup's date in YYYY-MM format
* @param {string} [encodingFormat] Please provide the document image encoding format in pdf or tiff format
* @param {boolean} [allInOnePDF] Option to return all the document images in a single PDF file
* @param {boolean} [compressedPackage] Option to return all the document images in a compressed package
* @param {string} [messageReference] Please provide message reference
* @param {string} [messageReferenceDate] Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2
* @param {string} [pluginName] Please provide name of the plugin (applicable to 3PV only)
* @param {string} [pluginVersion] Please provide version of the plugin (applicable to 3PV only)
* @param {string} [shippingSystemPlatformName] Please provide name of the shipping platform(applicable to 3PV only)
* @param {string} [shippingSystemPlatformVersion] Please provide version of the shipping platform (applicable to 3PV only)
* @param {string} [webstorePlatformName] Please provide name of the webstore platform (applicable to 3PV only)
* @param {string} [webstorePlatformVersion] Please provide version of the webstore platform (applicable to 3PV only)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
expApiShipmentsDocumentimage: function (shipmentTrackingNumber, shipperAccountNumber, typeCode, pickupYearAndMonth, encodingFormat, allInOnePDF, compressedPackage, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, exports.ShipmentApiAxiosParamCreator)(configuration).expApiShipmentsDocumentimage(shipmentTrackingNumber, shipperAccountNumber, typeCode, pickupYearAndMonth, encodingFormat, allInOnePDF, compressedPackage, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, function (axios, basePath) {
if (axios === void 0) { axios = axios_1.default; }
if (basePath === void 0) { basePath = base_1.BASE_PATH; }
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url });
return axios.request(axiosRequestArgs);
}];
}
});
});
},
/**
* The electronic proof of delivery service can be used to retrieve proof of delivery for certain delivered DHL Express shipments
* @summary Electronic Proof of Delivery
* @param {string} shipmentTrackingNumber DHL Express shipment identification number
* @param {string} [shipperAccountNumber] DHL Express customer shipper account number
* @param {string} [content]
* @param {string} [messageReference] Please provide message reference
* @param {string} [messageReferenceDate] Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2
* @param {string} [pluginName] Please provide name of the plugin (applicable to 3PV only)
* @param {string} [pluginVersion] Please provide version of the plugin (applicable to 3PV only)
* @param {string} [shippingSystemPlatformName] Please provide name of the shipping platform(applicable to 3PV only)
* @param {string} [shippingSystemPlatformVersion] Please provide version of the shipping platform (applicable to 3PV only)
* @param {string} [webstorePlatformName] Please provide name of the webstore platform (applicable to 3PV only)
* @param {string} [webstorePlatformVersion] Please provide version of the webstore platform (applicable to 3PV only)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
expApiShipmentsEpod: function (shipmentTrackingNumber, shipperAccountNumber, content, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, exports.ShipmentApiAxiosParamCreator)(configuration).expApiShipmentsEpod(shipmentTrackingNumber, shipperAccountNumber, content, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, function (axios, basePath) {
if (axios === void 0) { axios = axios_1.default; }
if (basePath === void 0) { basePath = base_1.BASE_PATH; }
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url });
return axios.request(axiosRequestArgs);
}];
}
});
});
},
/**
* The update shipment service can be used to upload updated customs documentation for your DHL Express shipment that has not been picked up yet.
* @summary Upload updated customs documentation for your DHL Express shipment
* @param {SupermodelIoLogisticsExpressImageUploadRequest} body Details about the shipment images
* @param {string} shipmentTrackingNumber DHL Express shipment identification number
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
expApiShipmentsImgUpload: function (body, shipmentTrackingNumber, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, exports.ShipmentApiAxiosParamCreator)(configuration).expApiShipmentsImgUpload(body, shipmentTrackingNumber, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, function (axios,