@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1 2.1.1 → 2.1.3

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.
@@ -11,6 +11,7 @@
11
11
  */
12
12
  import type { Configuration } from '../configuration';
13
13
  import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
14
+ import globalAxios from 'axios';
14
15
  import { RequestArgs, BaseAPI } from '../base';
15
16
  import { GetCustomerInvoiceResponse } from '../models';
16
17
  import { GetCustomerInvoicesResponse } from '../models';
@@ -482,7 +483,7 @@ export declare class VendorShippingApi extends BaseAPI {
482
483
  * @throws {RequiredError}
483
484
  * @memberof VendorShippingApi
484
485
  */
485
- getCustomerInvoice(requestParameters: VendorShippingApiGetCustomerInvoiceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerInvoiceResponse, any>>;
486
+ getCustomerInvoice(requestParameters: VendorShippingApiGetCustomerInvoiceRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetCustomerInvoiceResponse, any>>;
486
487
  /**
487
488
  * Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 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).
488
489
  * @param {VendorShippingApiGetCustomerInvoicesRequest} requestParameters Request parameters.
@@ -490,7 +491,7 @@ export declare class VendorShippingApi extends BaseAPI {
490
491
  * @throws {RequiredError}
491
492
  * @memberof VendorShippingApi
492
493
  */
493
- getCustomerInvoices(requestParameters: VendorShippingApiGetCustomerInvoicesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerInvoicesResponse, any>>;
494
+ getCustomerInvoices(requestParameters: VendorShippingApiGetCustomerInvoicesRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetCustomerInvoicesResponse, any>>;
494
495
  /**
495
496
  * Returns a packing slip based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 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).
496
497
  * @param {VendorShippingApiGetPackingSlipRequest} requestParameters Request parameters.
@@ -498,7 +499,7 @@ export declare class VendorShippingApi extends BaseAPI {
498
499
  * @throws {RequiredError}
499
500
  * @memberof VendorShippingApi
500
501
  */
501
- getPackingSlip(requestParameters: VendorShippingApiGetPackingSlipRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPackingSlipResponse, any>>;
502
+ getPackingSlip(requestParameters: VendorShippingApiGetPackingSlipRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPackingSlipResponse, any>>;
502
503
  /**
503
504
  * Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 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).
504
505
  * @param {VendorShippingApiGetPackingSlipsRequest} requestParameters Request parameters.
@@ -506,7 +507,7 @@ export declare class VendorShippingApi extends BaseAPI {
506
507
  * @throws {RequiredError}
507
508
  * @memberof VendorShippingApi
508
509
  */
509
- getPackingSlips(requestParameters: VendorShippingApiGetPackingSlipsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPackingSlipListResponse, any>>;
510
+ getPackingSlips(requestParameters: VendorShippingApiGetPackingSlipsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPackingSlipListResponse, any>>;
510
511
  /**
511
512
  * Returns a shipping label for the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 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).
512
513
  * @param {VendorShippingApiGetShippingLabelRequest} requestParameters Request parameters.
@@ -514,7 +515,7 @@ export declare class VendorShippingApi extends BaseAPI {
514
515
  * @throws {RequiredError}
515
516
  * @memberof VendorShippingApi
516
517
  */
517
- getShippingLabel(requestParameters: VendorShippingApiGetShippingLabelRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetShippingLabelResponse, any>>;
518
+ getShippingLabel(requestParameters: VendorShippingApiGetShippingLabelRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShippingLabelResponse, any>>;
518
519
  /**
519
520
  * Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 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).
520
521
  * @param {VendorShippingApiGetShippingLabelsRequest} requestParameters Request parameters.
@@ -522,7 +523,7 @@ export declare class VendorShippingApi extends BaseAPI {
522
523
  * @throws {RequiredError}
523
524
  * @memberof VendorShippingApi
524
525
  */
525
- getShippingLabels(requestParameters: VendorShippingApiGetShippingLabelsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetShippingLabelListResponse, any>>;
526
+ getShippingLabels(requestParameters: VendorShippingApiGetShippingLabelsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShippingLabelListResponse, any>>;
526
527
  /**
527
528
  * Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 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).
528
529
  * @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
@@ -530,7 +531,7 @@ export declare class VendorShippingApi extends BaseAPI {
530
531
  * @throws {RequiredError}
531
532
  * @memberof VendorShippingApi
532
533
  */
533
- submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubmitShipmentConfirmationsResponse, any>>;
534
+ submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShipmentConfirmationsResponse, any>>;
534
535
  /**
535
536
  * This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 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).
536
537
  * @param {VendorShippingApiSubmitShipmentStatusUpdatesRequest} requestParameters Request parameters.
@@ -538,7 +539,7 @@ export declare class VendorShippingApi extends BaseAPI {
538
539
  * @throws {RequiredError}
539
540
  * @memberof VendorShippingApi
540
541
  */
541
- submitShipmentStatusUpdates(requestParameters: VendorShippingApiSubmitShipmentStatusUpdatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubmitShipmentStatusUpdatesResponse, any>>;
542
+ submitShipmentStatusUpdates(requestParameters: VendorShippingApiSubmitShipmentStatusUpdatesRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShipmentStatusUpdatesResponse, any>>;
542
543
  /**
543
544
  * Creates a shipping label for a purchase order and returns a transactionId for reference. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 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).
544
545
  * @param {VendorShippingApiSubmitShippingLabelRequestRequest} requestParameters Request parameters.
@@ -546,5 +547,5 @@ export declare class VendorShippingApi extends BaseAPI {
546
547
  * @throws {RequiredError}
547
548
  * @memberof VendorShippingApi
548
549
  */
549
- submitShippingLabelRequest(requestParameters: VendorShippingApiSubmitShippingLabelRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubmitShippingLabelsResponse, any>>;
550
+ submitShippingLabelRequest(requestParameters: VendorShippingApiSubmitShippingLabelRequestRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShippingLabelsResponse, any>>;
550
551
  }
@@ -24,13 +24,13 @@ export interface StatusUpdateDetails {
24
24
  */
25
25
  'trackingNumber': string;
26
26
  /**
27
- * Indicates the shipment status code of the package that provides transportation information for Amazon tracking systems and ultimately for the final customer.
27
+ * Indicates the shipment status code of the package that provides transportation information for Amazon tracking systems and ultimately for the final customer. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation).
28
28
  * @type {string}
29
29
  * @memberof StatusUpdateDetails
30
30
  */
31
31
  'statusCode': string;
32
32
  /**
33
- * Provides a reason code for the status of the package that will provide additional information about the transportation status.
33
+ * Provides a reason code for the status of the package that will provide additional information about the transportation status. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation).
34
34
  * @type {string}
35
35
  * @memberof StatusUpdateDetails
36
36
  */
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1",
3
3
  "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor's shipping data.",
5
- "version": "2.1.1",
5
+ "version": "2.1.3",
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.0.3",
22
- "axios": "^1.6.2"
21
+ "@sp-api-sdk/common": "2.0.5",
22
+ "axios": "^1.6.7"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "vendor direct fulfillment shipping api"
42
42
  ],
43
- "gitHead": "c81279baeb662780ae3cb42fb60fa11670fed191"
43
+ "gitHead": "014aad96509aba433e07461efbe936a6062cc66a"
44
44
  }