@sp-api-sdk/fulfillment-outbound-api-2020-07-01 4.3.1 → 4.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -48,6 +48,7 @@ const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
48
48
  const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
49
49
  const localVarHeaderParameter = {};
50
50
  const localVarQueryParameter = {};
51
+ localVarHeaderParameter['Accept'] = 'application/json';
51
52
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
52
53
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
53
54
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -76,6 +77,7 @@ const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
76
77
  const localVarHeaderParameter = {};
77
78
  const localVarQueryParameter = {};
78
79
  localVarHeaderParameter['Content-Type'] = 'application/json';
80
+ localVarHeaderParameter['Accept'] = 'application/json';
79
81
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
80
82
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
81
83
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -109,6 +111,7 @@ const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
109
111
  const localVarHeaderParameter = {};
110
112
  const localVarQueryParameter = {};
111
113
  localVarHeaderParameter['Content-Type'] = 'application/json';
114
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
112
115
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
113
116
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
114
117
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -138,6 +141,7 @@ const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
138
141
  const localVarHeaderParameter = {};
139
142
  const localVarQueryParameter = {};
140
143
  localVarHeaderParameter['Content-Type'] = 'application/json';
144
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
141
145
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
142
146
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
143
147
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -183,6 +187,7 @@ const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
183
187
  queryStartDate.toISOString() :
184
188
  queryStartDate;
185
189
  }
190
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
186
191
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
187
192
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
188
193
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -221,6 +226,7 @@ const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
221
226
  if (marketplaceId !== undefined) {
222
227
  localVarQueryParameter['marketplaceId'] = marketplaceId;
223
228
  }
229
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
224
230
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
225
231
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
226
232
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -251,6 +257,7 @@ const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
251
257
  if (marketplaceId !== undefined) {
252
258
  localVarQueryParameter['marketplaceId'] = marketplaceId;
253
259
  }
260
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
254
261
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
255
262
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
256
263
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -279,6 +286,7 @@ const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
279
286
  const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
280
287
  const localVarHeaderParameter = {};
281
288
  const localVarQueryParameter = {};
289
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
282
290
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
283
291
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
284
292
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -307,6 +315,7 @@ const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
307
315
  const localVarHeaderParameter = {};
308
316
  const localVarQueryParameter = {};
309
317
  localVarHeaderParameter['Content-Type'] = 'application/json';
318
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
310
319
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
311
320
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
312
321
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -318,12 +327,13 @@ const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
318
327
  },
319
328
  /**
320
329
  * Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
321
- * @param {number} [packageNumber] The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation.
322
- * @param {string} [amazonFulfillmentTrackingNumber] The Amazon fulfillment tracking number. You can obtain this value from the `getFulfillmentOrder` operation.
330
+ * @param {number} packageNumber The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation.
323
331
  * @param {*} [options] Override http request option.
324
332
  * @throws {RequiredError}
325
333
  */
326
- getPackageTrackingDetails: async (packageNumber, amazonFulfillmentTrackingNumber, options = {}) => {
334
+ getPackageTrackingDetails: async (packageNumber, options = {}) => {
335
+ // verify required parameter 'packageNumber' is not null or undefined
336
+ (0, common_1.assertParamExists)('getPackageTrackingDetails', 'packageNumber', packageNumber);
327
337
  const localVarPath = `/fba/outbound/2020-07-01/tracking`;
328
338
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
329
339
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -337,9 +347,7 @@ const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
337
347
  if (packageNumber !== undefined) {
338
348
  localVarQueryParameter['packageNumber'] = packageNumber;
339
349
  }
340
- if (amazonFulfillmentTrackingNumber !== undefined) {
341
- localVarQueryParameter['amazonFulfillmentTrackingNumber'] = amazonFulfillmentTrackingNumber;
342
- }
350
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
343
351
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
344
352
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
345
353
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -374,6 +382,7 @@ const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
374
382
  if (nextToken !== undefined) {
375
383
  localVarQueryParameter['nextToken'] = nextToken;
376
384
  }
385
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
377
386
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
378
387
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
379
388
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -416,6 +425,7 @@ const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
416
425
  if (language !== undefined) {
417
426
  localVarQueryParameter['language'] = language;
418
427
  }
428
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
419
429
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
420
430
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
421
431
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -448,6 +458,7 @@ const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
448
458
  const localVarHeaderParameter = {};
449
459
  const localVarQueryParameter = {};
450
460
  localVarHeaderParameter['Content-Type'] = 'application/json';
461
+ localVarHeaderParameter['Accept'] = 'application/json';
451
462
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
452
463
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
453
464
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -481,6 +492,7 @@ const FulfillmentOutboundApiAxiosParamCreator = function (configuration) {
481
492
  const localVarHeaderParameter = {};
482
493
  const localVarQueryParameter = {};
483
494
  localVarHeaderParameter['Content-Type'] = 'application/json';
495
+ localVarHeaderParameter['Accept'] = 'application/json';
484
496
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
485
497
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
486
498
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -615,13 +627,12 @@ const FulfillmentOutboundApiFp = function (configuration) {
615
627
  },
616
628
  /**
617
629
  * Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
618
- * @param {number} [packageNumber] The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation.
619
- * @param {string} [amazonFulfillmentTrackingNumber] The Amazon fulfillment tracking number. You can obtain this value from the `getFulfillmentOrder` operation.
630
+ * @param {number} packageNumber The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation.
620
631
  * @param {*} [options] Override http request option.
621
632
  * @throws {RequiredError}
622
633
  */
623
- async getPackageTrackingDetails(packageNumber, amazonFulfillmentTrackingNumber, options) {
624
- const localVarAxiosArgs = await localVarAxiosParamCreator.getPackageTrackingDetails(packageNumber, amazonFulfillmentTrackingNumber, options);
634
+ async getPackageTrackingDetails(packageNumber, options) {
635
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPackageTrackingDetails(packageNumber, options);
625
636
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
626
637
  const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentOutboundApi.getPackageTrackingDetails']?.[localVarOperationServerIndex]?.url;
627
638
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -776,8 +787,8 @@ const FulfillmentOutboundApiFactory = function (configuration, basePath, axios)
776
787
  * @param {*} [options] Override http request option.
777
788
  * @throws {RequiredError}
778
789
  */
779
- getPackageTrackingDetails(requestParameters = {}, options) {
780
- return localVarFp.getPackageTrackingDetails(requestParameters.packageNumber, requestParameters.amazonFulfillmentTrackingNumber, options).then((request) => request(axios, basePath));
790
+ getPackageTrackingDetails(requestParameters, options) {
791
+ return localVarFp.getPackageTrackingDetails(requestParameters.packageNumber, options).then((request) => request(axios, basePath));
781
792
  },
782
793
  /**
783
794
  * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
@@ -909,8 +920,8 @@ class FulfillmentOutboundApi extends base_1.BaseAPI {
909
920
  * @param {*} [options] Override http request option.
910
921
  * @throws {RequiredError}
911
922
  */
912
- getPackageTrackingDetails(requestParameters = {}, options) {
913
- return (0, exports.FulfillmentOutboundApiFp)(this.configuration).getPackageTrackingDetails(requestParameters.packageNumber, requestParameters.amazonFulfillmentTrackingNumber, options).then((request) => request(this.axios, this.basePath));
923
+ getPackageTrackingDetails(requestParameters, options) {
924
+ return (0, exports.FulfillmentOutboundApiFp)(this.configuration).getPackageTrackingDetails(requestParameters.packageNumber, options).then((request) => request(this.axios, this.basePath));
914
925
  }
915
926
  /**
916
927
  * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
@@ -1,6 +1,5 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
- /* eslint-disable */
4
3
  /**
5
4
  * Selling Partner APIs for Fulfillment Outbound
6
5
  * The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon\'s fulfillment network. You can get information on both potential and existing fulfillment orders.
@@ -34,6 +33,17 @@ class Configuration {
34
33
  * @param scopes oauth2 scope
35
34
  */
36
35
  accessToken;
36
+ /**
37
+ * parameter for aws4 signature security
38
+ * @param {Object} AWS4Signature - AWS4 Signature security
39
+ * @param {string} options.region - aws region
40
+ * @param {string} options.service - name of the service.
41
+ * @param {string} credentials.accessKeyId - aws access key id
42
+ * @param {string} credentials.secretAccessKey - aws access key
43
+ * @param {string} credentials.sessionToken - aws session token
44
+ * @memberof Configuration
45
+ */
46
+ awsv4;
37
47
  /**
38
48
  * override base path
39
49
  */
@@ -59,6 +69,7 @@ class Configuration {
59
69
  this.username = param.username;
60
70
  this.password = param.password;
61
71
  this.accessToken = param.accessToken;
72
+ this.awsv4 = param.awsv4;
62
73
  this.basePath = param.basePath;
63
74
  this.serverIndex = param.serverIndex;
64
75
  this.baseOptions = {
@@ -42,6 +42,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
42
42
  const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
43
43
  const localVarHeaderParameter = {};
44
44
  const localVarQueryParameter = {};
45
+ localVarHeaderParameter['Accept'] = 'application/json';
45
46
  setSearchParams(localVarUrlObj, localVarQueryParameter);
46
47
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
47
48
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -70,6 +71,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
70
71
  const localVarHeaderParameter = {};
71
72
  const localVarQueryParameter = {};
72
73
  localVarHeaderParameter['Content-Type'] = 'application/json';
74
+ localVarHeaderParameter['Accept'] = 'application/json';
73
75
  setSearchParams(localVarUrlObj, localVarQueryParameter);
74
76
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
75
77
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -103,6 +105,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
103
105
  const localVarHeaderParameter = {};
104
106
  const localVarQueryParameter = {};
105
107
  localVarHeaderParameter['Content-Type'] = 'application/json';
108
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
106
109
  setSearchParams(localVarUrlObj, localVarQueryParameter);
107
110
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
108
111
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -132,6 +135,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
132
135
  const localVarHeaderParameter = {};
133
136
  const localVarQueryParameter = {};
134
137
  localVarHeaderParameter['Content-Type'] = 'application/json';
138
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
135
139
  setSearchParams(localVarUrlObj, localVarQueryParameter);
136
140
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
137
141
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -177,6 +181,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
177
181
  queryStartDate.toISOString() :
178
182
  queryStartDate;
179
183
  }
184
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
180
185
  setSearchParams(localVarUrlObj, localVarQueryParameter);
181
186
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
182
187
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -215,6 +220,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
215
220
  if (marketplaceId !== undefined) {
216
221
  localVarQueryParameter['marketplaceId'] = marketplaceId;
217
222
  }
223
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
218
224
  setSearchParams(localVarUrlObj, localVarQueryParameter);
219
225
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
220
226
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -245,6 +251,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
245
251
  if (marketplaceId !== undefined) {
246
252
  localVarQueryParameter['marketplaceId'] = marketplaceId;
247
253
  }
254
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
248
255
  setSearchParams(localVarUrlObj, localVarQueryParameter);
249
256
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
250
257
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -273,6 +280,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
273
280
  const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
274
281
  const localVarHeaderParameter = {};
275
282
  const localVarQueryParameter = {};
283
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
276
284
  setSearchParams(localVarUrlObj, localVarQueryParameter);
277
285
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
278
286
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -301,6 +309,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
301
309
  const localVarHeaderParameter = {};
302
310
  const localVarQueryParameter = {};
303
311
  localVarHeaderParameter['Content-Type'] = 'application/json';
312
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
304
313
  setSearchParams(localVarUrlObj, localVarQueryParameter);
305
314
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
306
315
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -312,12 +321,13 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
312
321
  },
313
322
  /**
314
323
  * Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
315
- * @param {number} [packageNumber] The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation.
316
- * @param {string} [amazonFulfillmentTrackingNumber] The Amazon fulfillment tracking number. You can obtain this value from the `getFulfillmentOrder` operation.
324
+ * @param {number} packageNumber The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation.
317
325
  * @param {*} [options] Override http request option.
318
326
  * @throws {RequiredError}
319
327
  */
320
- getPackageTrackingDetails: async (packageNumber, amazonFulfillmentTrackingNumber, options = {}) => {
328
+ getPackageTrackingDetails: async (packageNumber, options = {}) => {
329
+ // verify required parameter 'packageNumber' is not null or undefined
330
+ assertParamExists('getPackageTrackingDetails', 'packageNumber', packageNumber);
321
331
  const localVarPath = `/fba/outbound/2020-07-01/tracking`;
322
332
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
323
333
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -331,9 +341,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
331
341
  if (packageNumber !== undefined) {
332
342
  localVarQueryParameter['packageNumber'] = packageNumber;
333
343
  }
334
- if (amazonFulfillmentTrackingNumber !== undefined) {
335
- localVarQueryParameter['amazonFulfillmentTrackingNumber'] = amazonFulfillmentTrackingNumber;
336
- }
344
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
337
345
  setSearchParams(localVarUrlObj, localVarQueryParameter);
338
346
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
339
347
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -368,6 +376,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
368
376
  if (nextToken !== undefined) {
369
377
  localVarQueryParameter['nextToken'] = nextToken;
370
378
  }
379
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
371
380
  setSearchParams(localVarUrlObj, localVarQueryParameter);
372
381
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
373
382
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -410,6 +419,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
410
419
  if (language !== undefined) {
411
420
  localVarQueryParameter['language'] = language;
412
421
  }
422
+ localVarHeaderParameter['Accept'] = 'application/json,payload';
413
423
  setSearchParams(localVarUrlObj, localVarQueryParameter);
414
424
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
415
425
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -442,6 +452,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
442
452
  const localVarHeaderParameter = {};
443
453
  const localVarQueryParameter = {};
444
454
  localVarHeaderParameter['Content-Type'] = 'application/json';
455
+ localVarHeaderParameter['Accept'] = 'application/json';
445
456
  setSearchParams(localVarUrlObj, localVarQueryParameter);
446
457
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
447
458
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -475,6 +486,7 @@ export const FulfillmentOutboundApiAxiosParamCreator = function (configuration)
475
486
  const localVarHeaderParameter = {};
476
487
  const localVarQueryParameter = {};
477
488
  localVarHeaderParameter['Content-Type'] = 'application/json';
489
+ localVarHeaderParameter['Accept'] = 'application/json';
478
490
  setSearchParams(localVarUrlObj, localVarQueryParameter);
479
491
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
480
492
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -608,13 +620,12 @@ export const FulfillmentOutboundApiFp = function (configuration) {
608
620
  },
609
621
  /**
610
622
  * Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
611
- * @param {number} [packageNumber] The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation.
612
- * @param {string} [amazonFulfillmentTrackingNumber] The Amazon fulfillment tracking number. You can obtain this value from the `getFulfillmentOrder` operation.
623
+ * @param {number} packageNumber The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation.
613
624
  * @param {*} [options] Override http request option.
614
625
  * @throws {RequiredError}
615
626
  */
616
- async getPackageTrackingDetails(packageNumber, amazonFulfillmentTrackingNumber, options) {
617
- const localVarAxiosArgs = await localVarAxiosParamCreator.getPackageTrackingDetails(packageNumber, amazonFulfillmentTrackingNumber, options);
627
+ async getPackageTrackingDetails(packageNumber, options) {
628
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPackageTrackingDetails(packageNumber, options);
618
629
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
619
630
  const localVarOperationServerBasePath = operationServerMap['FulfillmentOutboundApi.getPackageTrackingDetails']?.[localVarOperationServerIndex]?.url;
620
631
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -768,8 +779,8 @@ export const FulfillmentOutboundApiFactory = function (configuration, basePath,
768
779
  * @param {*} [options] Override http request option.
769
780
  * @throws {RequiredError}
770
781
  */
771
- getPackageTrackingDetails(requestParameters = {}, options) {
772
- return localVarFp.getPackageTrackingDetails(requestParameters.packageNumber, requestParameters.amazonFulfillmentTrackingNumber, options).then((request) => request(axios, basePath));
782
+ getPackageTrackingDetails(requestParameters, options) {
783
+ return localVarFp.getPackageTrackingDetails(requestParameters.packageNumber, options).then((request) => request(axios, basePath));
773
784
  },
774
785
  /**
775
786
  * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
@@ -900,8 +911,8 @@ export class FulfillmentOutboundApi extends BaseAPI {
900
911
  * @param {*} [options] Override http request option.
901
912
  * @throws {RequiredError}
902
913
  */
903
- getPackageTrackingDetails(requestParameters = {}, options) {
904
- return FulfillmentOutboundApiFp(this.configuration).getPackageTrackingDetails(requestParameters.packageNumber, requestParameters.amazonFulfillmentTrackingNumber, options).then((request) => request(this.axios, this.basePath));
914
+ getPackageTrackingDetails(requestParameters, options) {
915
+ return FulfillmentOutboundApiFp(this.configuration).getPackageTrackingDetails(requestParameters.packageNumber, options).then((request) => request(this.axios, this.basePath));
905
916
  }
906
917
  /**
907
918
  * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
@@ -1,5 +1,4 @@
1
1
  /* tslint:disable */
2
- /* eslint-disable */
3
2
  /**
4
3
  * Selling Partner APIs for Fulfillment Outbound
5
4
  * The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon\'s fulfillment network. You can get information on both potential and existing fulfillment orders.
@@ -31,6 +30,17 @@ export class Configuration {
31
30
  * @param scopes oauth2 scope
32
31
  */
33
32
  accessToken;
33
+ /**
34
+ * parameter for aws4 signature security
35
+ * @param {Object} AWS4Signature - AWS4 Signature security
36
+ * @param {string} options.region - aws region
37
+ * @param {string} options.service - name of the service.
38
+ * @param {string} credentials.accessKeyId - aws access key id
39
+ * @param {string} credentials.secretAccessKey - aws access key
40
+ * @param {string} credentials.sessionToken - aws session token
41
+ * @memberof Configuration
42
+ */
43
+ awsv4;
34
44
  /**
35
45
  * override base path
36
46
  */
@@ -56,6 +66,7 @@ export class Configuration {
56
66
  this.username = param.username;
57
67
  this.password = param.password;
58
68
  this.accessToken = param.accessToken;
69
+ this.awsv4 = param.awsv4;
59
70
  this.basePath = param.basePath;
60
71
  this.serverIndex = param.serverIndex;
61
72
  this.baseOptions = {
@@ -108,12 +108,11 @@ export declare const FulfillmentOutboundApiAxiosParamCreator: (configuration?: C
108
108
  getFulfillmentPreview: (body: GetFulfillmentPreviewRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
109
109
  /**
110
110
  * Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
111
- * @param {number} [packageNumber] The unencrypted package identifier. You can obtain this value from the &#x60;getFulfillmentOrder&#x60; operation.
112
- * @param {string} [amazonFulfillmentTrackingNumber] The Amazon fulfillment tracking number. You can obtain this value from the &#x60;getFulfillmentOrder&#x60; operation.
111
+ * @param {number} packageNumber The unencrypted package identifier. You can obtain this value from the &#x60;getFulfillmentOrder&#x60; operation.
113
112
  * @param {*} [options] Override http request option.
114
113
  * @throws {RequiredError}
115
114
  */
116
- getPackageTrackingDetails: (packageNumber?: number, amazonFulfillmentTrackingNumber?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
115
+ getPackageTrackingDetails: (packageNumber: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
117
116
  /**
118
117
  * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
119
118
  * @param {string} [queryStartDate] A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order.
@@ -224,12 +223,11 @@ export declare const FulfillmentOutboundApiFp: (configuration?: Configuration) =
224
223
  getFulfillmentPreview(body: GetFulfillmentPreviewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFulfillmentPreviewResponse>>;
225
224
  /**
226
225
  * Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
227
- * @param {number} [packageNumber] The unencrypted package identifier. You can obtain this value from the &#x60;getFulfillmentOrder&#x60; operation.
228
- * @param {string} [amazonFulfillmentTrackingNumber] The Amazon fulfillment tracking number. You can obtain this value from the &#x60;getFulfillmentOrder&#x60; operation.
226
+ * @param {number} packageNumber The unencrypted package identifier. You can obtain this value from the &#x60;getFulfillmentOrder&#x60; operation.
229
227
  * @param {*} [options] Override http request option.
230
228
  * @throws {RequiredError}
231
229
  */
232
- getPackageTrackingDetails(packageNumber?: number, amazonFulfillmentTrackingNumber?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPackageTrackingDetailsResponse>>;
230
+ getPackageTrackingDetails(packageNumber: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPackageTrackingDetailsResponse>>;
233
231
  /**
234
232
  * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
235
233
  * @param {string} [queryStartDate] A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order.
@@ -338,7 +336,7 @@ export declare const FulfillmentOutboundApiFactory: (configuration?: Configurati
338
336
  * @param {*} [options] Override http request option.
339
337
  * @throws {RequiredError}
340
338
  */
341
- getPackageTrackingDetails(requestParameters?: FulfillmentOutboundApiGetPackageTrackingDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPackageTrackingDetailsResponse>;
339
+ getPackageTrackingDetails(requestParameters: FulfillmentOutboundApiGetPackageTrackingDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPackageTrackingDetailsResponse>;
342
340
  /**
343
341
  * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
344
342
  * @param {FulfillmentOutboundApiListAllFulfillmentOrdersRequest} requestParameters Request parameters.
@@ -480,11 +478,7 @@ export interface FulfillmentOutboundApiGetPackageTrackingDetailsRequest {
480
478
  /**
481
479
  * The unencrypted package identifier. You can obtain this value from the &#x60;getFulfillmentOrder&#x60; operation.
482
480
  */
483
- readonly packageNumber?: number;
484
- /**
485
- * The Amazon fulfillment tracking number. You can obtain this value from the &#x60;getFulfillmentOrder&#x60; operation.
486
- */
487
- readonly amazonFulfillmentTrackingNumber?: string;
481
+ readonly packageNumber: number;
488
482
  }
489
483
  /**
490
484
  * Request parameters for listAllFulfillmentOrders operation in FulfillmentOutboundApi.
@@ -619,7 +613,7 @@ export declare class FulfillmentOutboundApi extends BaseAPI {
619
613
  * @param {*} [options] Override http request option.
620
614
  * @throws {RequiredError}
621
615
  */
622
- getPackageTrackingDetails(requestParameters?: FulfillmentOutboundApiGetPackageTrackingDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPackageTrackingDetailsResponse, any, {}>>;
616
+ getPackageTrackingDetails(requestParameters: FulfillmentOutboundApiGetPackageTrackingDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPackageTrackingDetailsResponse, any, {}>>;
623
617
  /**
624
618
  * Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)
625
619
  * @param {FulfillmentOutboundApiListAllFulfillmentOrdersRequest} requestParameters Request parameters.
@@ -9,11 +9,23 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ interface AWSv4Configuration {
13
+ options?: {
14
+ region?: string;
15
+ service?: string;
16
+ };
17
+ credentials?: {
18
+ accessKeyId?: string;
19
+ secretAccessKey?: string;
20
+ sessionToken?: string;
21
+ };
22
+ }
12
23
  export interface ConfigurationParameters {
13
24
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
14
25
  username?: string;
15
26
  password?: string;
16
27
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
28
+ awsv4?: AWSv4Configuration;
17
29
  basePath?: string;
18
30
  serverIndex?: number;
19
31
  baseOptions?: any;
@@ -39,6 +51,17 @@ export declare class Configuration {
39
51
  * @param scopes oauth2 scope
40
52
  */
41
53
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
54
+ /**
55
+ * parameter for aws4 signature security
56
+ * @param {Object} AWS4Signature - AWS4 Signature security
57
+ * @param {string} options.region - aws region
58
+ * @param {string} options.service - name of the service.
59
+ * @param {string} credentials.accessKeyId - aws access key id
60
+ * @param {string} credentials.secretAccessKey - aws access key
61
+ * @param {string} credentials.sessionToken - aws session token
62
+ * @memberof Configuration
63
+ */
64
+ awsv4?: AWSv4Configuration;
42
65
  /**
43
66
  * override base path
44
67
  */
@@ -72,3 +95,4 @@ export declare class Configuration {
72
95
  */
73
96
  isJsonMime(mime: string): boolean;
74
97
  }
98
+ export {};
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/fulfillment-outbound-api-2020-07-01",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon's fulfillment network. You can get information on both potential and existing fulfillment orders.",
5
- "version": "4.3.1",
5
+ "version": "4.5.2",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.1.20",
22
- "axios": "^1.12.2"
21
+ "@sp-api-sdk/common": "2.1.24",
22
+ "axios": "^1.13.2"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "fulfillment outbound api"
42
42
  ],
43
- "gitHead": "03484c02930fb24976769bd4688b4750908169b6"
43
+ "gitHead": "b3fe13460a11917282a12b5bdbcfaf565b9b773e"
44
44
  }