-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.js
338 lines (278 loc) · 10.6 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
const cache = require('memory-cache');
const createError = require('http-errors');
const request = require('request');
function DhlEcommerceSolutions(args) {
const options = Object.assign({
environment_url: 'https://api-sandbox.dhlecs.com'
}, args);
/**
* Applies dimensional weight (instead of physical weight) to a rate request if the specified weight and dimensions qualify for dimensional weight.
*/
this.applyDimensionalWeight = function(rateRequest, divisor = 166) {
let weight = rateRequest?.packageDetail?.weight?.value;
// Convert weight to LB
switch (rateRequest?.packageDetail?.weight?.unitOfMeasure) {
case 'G':
weight /= 453.592;
break;
case 'KG':
weight *= 2.205;
break;
case 'LB':
break;
case 'OZ':
weight /= 16;
break;
default:
return;
}
// Don't use dimensional weight if the physical weight is less than or equal to 1 pound
if (!weight || weight <= 1) {
return;
}
if (!rateRequest?.packageDetail?.dimension?.height || !rateRequest?.packageDetail?.dimension?.length || !rateRequest?.packageDetail?.dimension?.width || !rateRequest?.packageDetail?.dimension?.unitOfMeasure) {
return;
}
let height = rateRequest.packageDetail.dimension.height;
let length = rateRequest.packageDetail.dimension.length;
let width = rateRequest.packageDetail.dimension.width;
// Convert dimensions to inches
if (rateRequest.packageDetail.dimension.unitOfMeasure === 'CM') {
height /= 2.54;
length /= 2.54;
width /= 2.54;
}
// Calculate girth: https://www.dhl.com/us-en/home/ecommerce-solutions/shipping-services.html
const girth = (2 * width) + (2 * height);
// Don't use dimensional weight if the length + girth is less than or equal to 50 inches
if (length + girth <= 50) {
return;
}
const volume = length * width * height;
// Don't use dimensional weight if the volume is less than or equal to one cubic foot
if (volume <= 1728) {
return;
}
// Use dimensional weight (if it's larger than physical weight)
rateRequest.packageDetail.weight.value = Number(Math.max(weight, (volume / divisor)).toFixed(2));
rateRequest.packageDetail.weight.unitOfMeasure = 'LB';
};
/**
* The Label endpoint can generate a US Domestic or an International label.
*/
this.createLabel = function(_request, _options, callback) {
// Options are optional
if (typeof _options === 'function') {
callback = _options;
_options = {};
}
// Default format is ZPL
if (!_options.format) {
_options.format = 'ZPL';
}
this.getAccessToken(function(err, accessToken) {
if (err) {
return callback(err);
}
const req = {
auth: {
bearer: accessToken.access_token
},
json: _request,
url: `${options.environment_url}/shipping/v4/label?format=${_options.format}`
};
request.post(req, function(err, res, response) {
if (err) {
return callback(err);
}
if (res.statusCode !== 200) {
const err = createError(res.statusCode);
err.response = response;
return callback(err);
}
callback(null, response);
});
});
};
/**
* Manifest specific open packages (recommended): Only packages specified in the request are added to a request id and only those items will be manifested.
* Manifest all open items: The last 20,000 labels generated for the given pickup location are added to a request id and will be manifested.
*/
this.createManifest = function(_request, callback) {
this.getAccessToken(function(err, accessToken) {
if (err) {
return callback(err);
}
const req = {
auth: {
bearer: accessToken.access_token
},
json: _request,
url: `${options.environment_url}/shipping/v4/manifest`
};
request.post(req, function(err, res, response) {
if (err) {
return callback(err);
}
if (res.statusCode !== 200) {
const err = createError(res.statusCode);
err.response = response;
return callback(err);
}
callback(null, response);
});
});
};
/**
* The Dowload Manifest API is used to retrieve and download the manifests that were created using the Create Manifest API.
* @param {string} pickup DHL eCommerce pickup account number. You will receive this after doing the onboarding with DHL sales
* @param {string} requestId DHL eCommerce manifest request ID that was provided in the POST manifest response object
*/
this.downloadManifest = function(pickup, requestId, callback) {
this.getAccessToken(function(err, accessToken) {
if (err) {
return callback(err);
}
const req = {
auth: {
bearer: accessToken.access_token
},
json: true,
url: `${options.environment_url}/shipping/v4/manifest/${pickup}/${requestId}`
};
request.get(req, function(err, res, response) {
if (err) {
return callback(err);
}
if (res.statusCode !== 200) {
const err = createError(res.statusCode);
err.response = response;
return callback(err);
}
callback(null, response);
});
});
};
/**
* DHL eCommerce Americas Product Finder API enables clients to determine which DHL shipping products are suitable for a given shipping request including associated rates and estimated delivery dates.
*/
this.findProducts = function(_request, callback) {
this.getAccessToken(function(err, accessToken) {
if (err) {
return callback(err);
}
const req = {
auth: {
bearer: accessToken.access_token
},
json: _request,
url: `${options.environment_url}/shipping/v4/products`
};
request.post(req, function(err, res, response) {
if (err) {
return callback(err);
}
if (res.statusCode !== 200) {
const err = createError(res.statusCode);
err.response = response;
return callback(err);
}
callback(null, response);
});
});
};
/**
* To access any of DHL eCommerce's API resources, client credentials (clientId and clientSecret) are required which must be exchanged for an access token.
*/
this.getAccessToken = function(callback) {
const url = `${options.environment_url}/auth/v4/accesstoken`;
const key = `${url}?client_id=${options.client_id}`;
// Try to get the access token from memory cache
const accessToken = cache.get(key);
if (accessToken) {
return callback(null, accessToken);
}
const req = {
form: {
client_id: options.client_id,
client_secret: options.client_secret,
grant_type: 'client_credentials'
},
headers: {
'Content-Type': 'application/x-www-form-urlencoded'
},
json: true,
url
};
request.post(req, function(err, res, response) {
if (err) {
return callback(err);
}
if (res.statusCode !== 200) {
const err = createError(res.statusCode);
err.response = response;
return callback(err);
}
// Put the access token in memory cache
cache.put(key, response, response.expires_in * 1000 / 2);
callback(null, response);
});
};
/**
* Track using a single packageId.
*/
this.getTrackingByPackageId = function(packageId, callback) {
this.getAccessToken(function(err, accessToken) {
if (err) {
return callback(err);
}
const req = {
auth: {
bearer: accessToken.access_token
},
json: true,
url: `${options.environment_url}/tracking/v4/package?packageId=${packageId}`
};
request.get(req, function(err, res, response) {
if (err) {
return callback(err);
}
if (res.statusCode !== 200) {
const err = createError(res.statusCode);
err.response = response;
return callback(err);
}
callback(null, response);
});
});
};
/**
* Track using a single trackingId.
*/
this.getTrackingByTrackingId = function(trackingId, callback) {
this.getAccessToken(function(err, accessToken) {
if (err) {
return callback(err);
}
const req = {
auth: {
bearer: accessToken.access_token
},
json: true,
url: `${options.environment_url}/tracking/v4/package?trackingId=${trackingId}`
};
request.get(req, function(err, res, response) {
if (err) {
return callback(err);
}
if (res.statusCode !== 200) {
const err = createError(res.statusCode);
err.response = response;
return callback(err);
}
callback(null, response);
});
});
};
}
module.exports = DhlEcommerceSolutions;