@sp-api-sdk/vendor-shipments-api-v1 2.6.0 → 3.0.0
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.
- package/dist/cjs/api-model/api/{vendor-shipments-api.js → vendor-shipping-api.js} +137 -32
- package/dist/cjs/api-model/api.js +2 -2
- package/dist/cjs/api-model/base.js +1 -1
- package/dist/cjs/api-model/common.js +1 -1
- package/dist/cjs/api-model/configuration.js +1 -1
- package/dist/cjs/api-model/index.js +1 -1
- package/dist/cjs/api-model/models/address.js +1 -1
- package/dist/cjs/api-model/models/carrier-details.js +1 -1
- package/dist/cjs/api-model/models/carton-reference-details.js +1 -1
- package/dist/cjs/api-model/models/carton.js +1 -1
- package/dist/cjs/api-model/models/collect-freight-pickup-details.js +1 -1
- package/dist/cjs/api-model/models/container-identification.js +1 -1
- package/dist/cjs/api-model/models/container-item.js +1 -1
- package/dist/cjs/api-model/models/container-sequence-numbers.js +1 -1
- package/dist/cjs/api-model/models/containers.js +1 -1
- package/dist/cjs/api-model/models/dimensions.js +1 -1
- package/dist/cjs/api-model/models/duration.js +1 -1
- package/dist/cjs/api-model/models/expiry.js +1 -1
- package/dist/cjs/api-model/models/get-shipment-details-response.js +1 -1
- package/dist/cjs/api-model/models/get-shipment-labels.js +15 -0
- package/dist/cjs/api-model/models/import-details.js +1 -1
- package/dist/cjs/api-model/models/index.js +8 -0
- package/dist/cjs/api-model/models/inner-containers-details.js +1 -1
- package/dist/cjs/api-model/models/item-details.js +1 -1
- package/dist/cjs/api-model/models/item-quantity.js +1 -1
- package/dist/cjs/api-model/models/item.js +1 -1
- package/dist/cjs/api-model/models/label-data.js +19 -0
- package/dist/cjs/api-model/models/location.js +1 -1
- package/dist/cjs/api-model/models/model-error.js +1 -1
- package/dist/cjs/api-model/models/money.js +1 -1
- package/dist/cjs/api-model/models/package-item-details.js +1 -1
- package/dist/cjs/api-model/models/packed-items.js +1 -1
- package/dist/cjs/api-model/models/packed-quantity.js +20 -0
- package/dist/cjs/api-model/models/pagination.js +1 -1
- package/dist/cjs/api-model/models/pallet.js +1 -1
- package/dist/cjs/api-model/models/party-identification.js +1 -1
- package/dist/cjs/api-model/models/purchase-order-item-details.js +15 -0
- package/dist/cjs/api-model/models/purchase-order-items.js +1 -1
- package/dist/cjs/api-model/models/purchase-orders.js +1 -1
- package/dist/cjs/api-model/models/route.js +1 -1
- package/dist/cjs/api-model/models/shipment-confirmation.js +1 -1
- package/dist/cjs/api-model/models/shipment-details.js +1 -1
- package/dist/cjs/api-model/models/shipment-information.js +20 -0
- package/dist/cjs/api-model/models/shipment-measurements.js +1 -1
- package/dist/cjs/api-model/models/shipment-status-details.js +1 -1
- package/dist/cjs/api-model/models/shipment.js +1 -1
- package/dist/cjs/api-model/models/stop.js +1 -1
- package/dist/cjs/api-model/models/submit-shipment-confirmations-request.js +1 -1
- package/dist/cjs/api-model/models/submit-shipment-confirmations-response.js +1 -1
- package/dist/cjs/api-model/models/submit-shipments.js +1 -1
- package/dist/cjs/api-model/models/tax-registration-details.js +1 -1
- package/dist/cjs/api-model/models/total-weight.js +1 -1
- package/dist/cjs/api-model/models/transaction-reference.js +1 -1
- package/dist/cjs/api-model/models/transport-label.js +15 -0
- package/dist/cjs/api-model/models/transport-shipment-measurements.js +1 -1
- package/dist/cjs/api-model/models/transportation-details-for-shipment-confirmation.js +1 -1
- package/dist/cjs/api-model/models/transportation-details.js +1 -1
- package/dist/cjs/api-model/models/transportation-labels.js +15 -0
- package/dist/cjs/api-model/models/vendor-details.js +15 -0
- package/dist/cjs/api-model/models/volume.js +1 -1
- package/dist/cjs/api-model/models/weight.js +1 -1
- package/dist/cjs/client.js +8 -1
- package/dist/es/api-model/api/{vendor-shipments-api.js → vendor-shipping-api.js} +132 -27
- package/dist/es/api-model/api.js +2 -2
- package/dist/es/api-model/base.js +1 -1
- package/dist/es/api-model/common.js +1 -1
- package/dist/es/api-model/configuration.js +1 -1
- package/dist/es/api-model/index.js +1 -1
- package/dist/es/api-model/models/address.js +1 -1
- package/dist/es/api-model/models/carrier-details.js +1 -1
- package/dist/es/api-model/models/carton-reference-details.js +1 -1
- package/dist/es/api-model/models/carton.js +1 -1
- package/dist/es/api-model/models/collect-freight-pickup-details.js +1 -1
- package/dist/es/api-model/models/container-identification.js +1 -1
- package/dist/es/api-model/models/container-item.js +1 -1
- package/dist/es/api-model/models/container-sequence-numbers.js +1 -1
- package/dist/es/api-model/models/containers.js +1 -1
- package/dist/es/api-model/models/dimensions.js +1 -1
- package/dist/es/api-model/models/duration.js +1 -1
- package/dist/es/api-model/models/expiry.js +1 -1
- package/dist/es/api-model/models/get-shipment-details-response.js +1 -1
- package/dist/es/api-model/models/get-shipment-labels.js +14 -0
- package/dist/es/api-model/models/import-details.js +1 -1
- package/dist/es/api-model/models/index.js +8 -0
- package/dist/es/api-model/models/inner-containers-details.js +1 -1
- package/dist/es/api-model/models/item-details.js +1 -1
- package/dist/es/api-model/models/item-quantity.js +1 -1
- package/dist/es/api-model/models/item.js +1 -1
- package/dist/es/api-model/models/label-data.js +16 -0
- package/dist/es/api-model/models/location.js +1 -1
- package/dist/es/api-model/models/model-error.js +1 -1
- package/dist/es/api-model/models/money.js +1 -1
- package/dist/es/api-model/models/package-item-details.js +1 -1
- package/dist/es/api-model/models/packed-items.js +1 -1
- package/dist/es/api-model/models/packed-quantity.js +17 -0
- package/dist/es/api-model/models/pagination.js +1 -1
- package/dist/es/api-model/models/pallet.js +1 -1
- package/dist/es/api-model/models/party-identification.js +1 -1
- package/dist/es/api-model/models/purchase-order-item-details.js +14 -0
- package/dist/es/api-model/models/purchase-order-items.js +1 -1
- package/dist/es/api-model/models/purchase-orders.js +1 -1
- package/dist/es/api-model/models/route.js +1 -1
- package/dist/es/api-model/models/shipment-confirmation.js +1 -1
- package/dist/es/api-model/models/shipment-details.js +1 -1
- package/dist/es/api-model/models/shipment-information.js +17 -0
- package/dist/es/api-model/models/shipment-measurements.js +1 -1
- package/dist/es/api-model/models/shipment-status-details.js +1 -1
- package/dist/es/api-model/models/shipment.js +1 -1
- package/dist/es/api-model/models/stop.js +1 -1
- package/dist/es/api-model/models/submit-shipment-confirmations-request.js +1 -1
- package/dist/es/api-model/models/submit-shipment-confirmations-response.js +1 -1
- package/dist/es/api-model/models/submit-shipments.js +1 -1
- package/dist/es/api-model/models/tax-registration-details.js +1 -1
- package/dist/es/api-model/models/total-weight.js +1 -1
- package/dist/es/api-model/models/transaction-reference.js +1 -1
- package/dist/es/api-model/models/transport-label.js +14 -0
- package/dist/es/api-model/models/transport-shipment-measurements.js +1 -1
- package/dist/es/api-model/models/transportation-details-for-shipment-confirmation.js +1 -1
- package/dist/es/api-model/models/transportation-details.js +1 -1
- package/dist/es/api-model/models/transportation-labels.js +14 -0
- package/dist/es/api-model/models/vendor-details.js +14 -0
- package/dist/es/api-model/models/volume.js +1 -1
- package/dist/es/api-model/models/weight.js +1 -1
- package/dist/es/client.js +9 -2
- package/dist/types/api-model/api/{vendor-shipments-api.d.ts → vendor-shipping-api.d.ts} +167 -60
- package/dist/types/api-model/api.d.ts +2 -2
- package/dist/types/api-model/base.d.ts +1 -1
- package/dist/types/api-model/common.d.ts +1 -1
- package/dist/types/api-model/configuration.d.ts +1 -1
- package/dist/types/api-model/index.d.ts +1 -1
- package/dist/types/api-model/models/address.d.ts +1 -1
- package/dist/types/api-model/models/carrier-details.d.ts +1 -1
- package/dist/types/api-model/models/carton-reference-details.d.ts +1 -1
- package/dist/types/api-model/models/carton.d.ts +1 -1
- package/dist/types/api-model/models/collect-freight-pickup-details.d.ts +1 -1
- package/dist/types/api-model/models/container-identification.d.ts +1 -1
- package/dist/types/api-model/models/container-item.d.ts +1 -1
- package/dist/types/api-model/models/container-sequence-numbers.d.ts +1 -1
- package/dist/types/api-model/models/containers.d.ts +1 -1
- package/dist/types/api-model/models/dimensions.d.ts +1 -1
- package/dist/types/api-model/models/duration.d.ts +1 -1
- package/dist/types/api-model/models/expiry.d.ts +1 -1
- package/dist/types/api-model/models/get-shipment-details-response.d.ts +1 -1
- package/dist/types/api-model/models/get-shipment-labels.d.ts +31 -0
- package/dist/types/api-model/models/import-details.d.ts +1 -1
- package/dist/types/api-model/models/index.d.ts +8 -0
- package/dist/types/api-model/models/inner-containers-details.d.ts +1 -1
- package/dist/types/api-model/models/item-details.d.ts +1 -1
- package/dist/types/api-model/models/item-quantity.d.ts +1 -1
- package/dist/types/api-model/models/item.d.ts +1 -1
- package/dist/types/api-model/models/label-data.d.ts +52 -0
- package/dist/types/api-model/models/location.d.ts +1 -1
- package/dist/types/api-model/models/model-error.d.ts +1 -1
- package/dist/types/api-model/models/money.d.ts +1 -1
- package/dist/types/api-model/models/package-item-details.d.ts +1 -1
- package/dist/types/api-model/models/packed-items.d.ts +1 -1
- package/dist/types/api-model/models/packed-quantity.d.ts +41 -0
- package/dist/types/api-model/models/pagination.d.ts +1 -1
- package/dist/types/api-model/models/pallet.d.ts +1 -1
- package/dist/types/api-model/models/party-identification.d.ts +1 -1
- package/dist/types/api-model/models/purchase-order-item-details.d.ts +25 -0
- package/dist/types/api-model/models/purchase-order-items.d.ts +1 -1
- package/dist/types/api-model/models/purchase-orders.d.ts +1 -1
- package/dist/types/api-model/models/route.d.ts +1 -1
- package/dist/types/api-model/models/shipment-confirmation.d.ts +1 -1
- package/dist/types/api-model/models/shipment-details.d.ts +1 -1
- package/dist/types/api-model/models/shipment-information.d.ts +73 -0
- package/dist/types/api-model/models/shipment-measurements.d.ts +1 -1
- package/dist/types/api-model/models/shipment-status-details.d.ts +1 -1
- package/dist/types/api-model/models/shipment.d.ts +1 -1
- package/dist/types/api-model/models/stop.d.ts +1 -1
- package/dist/types/api-model/models/submit-shipment-confirmations-request.d.ts +1 -1
- package/dist/types/api-model/models/submit-shipment-confirmations-response.d.ts +1 -1
- package/dist/types/api-model/models/submit-shipments.d.ts +1 -1
- package/dist/types/api-model/models/tax-registration-details.d.ts +1 -1
- package/dist/types/api-model/models/total-weight.d.ts +3 -3
- package/dist/types/api-model/models/transaction-reference.d.ts +1 -1
- package/dist/types/api-model/models/transport-label.d.ts +38 -0
- package/dist/types/api-model/models/transport-shipment-measurements.d.ts +1 -1
- package/dist/types/api-model/models/transportation-details-for-shipment-confirmation.d.ts +1 -1
- package/dist/types/api-model/models/transportation-details.d.ts +1 -1
- package/dist/types/api-model/models/transportation-labels.d.ts +32 -0
- package/dist/types/api-model/models/vendor-details.d.ts +31 -0
- package/dist/types/api-model/models/volume.d.ts +1 -1
- package/dist/types/api-model/models/weight.d.ts +1 -1
- package/dist/types/client.d.ts +2 -2
- package/package.json +3 -3
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* Selling Partner API for Retail Procurement Shipments
|
|
3
3
|
* The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v1
|
|
@@ -14,14 +14,15 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
|
14
14
|
import globalAxios from 'axios';
|
|
15
15
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
16
16
|
import type { GetShipmentDetailsResponse } from '../models';
|
|
17
|
+
import type { GetShipmentLabels } from '../models';
|
|
17
18
|
import type { SubmitShipmentConfirmationsRequest } from '../models';
|
|
18
19
|
import type { SubmitShipmentConfirmationsResponse } from '../models';
|
|
19
20
|
import type { SubmitShipments } from '../models';
|
|
20
21
|
/**
|
|
21
|
-
*
|
|
22
|
+
* VendorShippingApi - axios parameter creator
|
|
22
23
|
* @export
|
|
23
24
|
*/
|
|
24
|
-
export declare const
|
|
25
|
+
export declare const VendorShippingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25
26
|
/**
|
|
26
27
|
* Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value 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).
|
|
27
28
|
* @summary GetShipmentDetails
|
|
@@ -53,6 +54,20 @@ export declare const VendorShipmentsApiAxiosParamCreator: (configuration?: Confi
|
|
|
53
54
|
* @throws {RequiredError}
|
|
54
55
|
*/
|
|
55
56
|
getShipmentDetails: (limit?: number, sortOrder?: GetShipmentDetailsSortOrderEnum, nextToken?: string, createdAfter?: string, createdBefore?: string, shipmentConfirmedBefore?: string, shipmentConfirmedAfter?: string, packageLabelCreatedBefore?: string, packageLabelCreatedAfter?: string, shippedBefore?: string, shippedAfter?: string, estimatedDeliveryBefore?: string, estimatedDeliveryAfter?: string, shipmentDeliveryBefore?: string, shipmentDeliveryAfter?: string, requestedPickUpBefore?: string, requestedPickUpAfter?: string, scheduledPickUpBefore?: string, scheduledPickUpAfter?: string, currentShipmentStatus?: string, vendorShipmentIdentifier?: string, buyerReferenceNumber?: string, buyerWarehouseCode?: string, sellerWarehouseCode?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
57
|
+
/**
|
|
58
|
+
* Returns small parcel shipment labels based on the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
59
|
+
* @param {number} [limit] The limit to the number of records returned. Default value is 50 records.
|
|
60
|
+
* @param {GetShipmentLabelsSortOrderEnum} [sortOrder] Sort the list by shipment label creation date in ascending or descending order.
|
|
61
|
+
* @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
62
|
+
* @param {string} [labelCreatedAfter] Shipment labels created after this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format.
|
|
63
|
+
* @param {string} [labelCreatedBefore] Shipment labels created before this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format.
|
|
64
|
+
* @param {string} [buyerReferenceNumber] Get Shipment labels by passing buyer reference number.
|
|
65
|
+
* @param {string} [vendorShipmentIdentifier] Get Shipment labels by passing vendor shipment identifier.
|
|
66
|
+
* @param {string} [sellerWarehouseCode] Get Shipping labels based on vendor warehouse code. This value must be same as the `sellingParty.partyId` in the shipment.
|
|
67
|
+
* @param {*} [options] Override http request option.
|
|
68
|
+
* @throws {RequiredError}
|
|
69
|
+
*/
|
|
70
|
+
getShipmentLabels: (limit?: number, sortOrder?: GetShipmentLabelsSortOrderEnum, nextToken?: string, labelCreatedAfter?: string, labelCreatedBefore?: string, buyerReferenceNumber?: string, vendorShipmentIdentifier?: string, sellerWarehouseCode?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
71
|
/**
|
|
57
72
|
* 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).
|
|
58
73
|
* @summary SubmitShipmentConfirmations
|
|
@@ -71,10 +86,10 @@ export declare const VendorShipmentsApiAxiosParamCreator: (configuration?: Confi
|
|
|
71
86
|
submitShipments: (body: SubmitShipments, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
87
|
};
|
|
73
88
|
/**
|
|
74
|
-
*
|
|
89
|
+
* VendorShippingApi - functional programming interface
|
|
75
90
|
* @export
|
|
76
91
|
*/
|
|
77
|
-
export declare const
|
|
92
|
+
export declare const VendorShippingApiFp: (configuration?: Configuration) => {
|
|
78
93
|
/**
|
|
79
94
|
* Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value 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).
|
|
80
95
|
* @summary GetShipmentDetails
|
|
@@ -106,6 +121,20 @@ export declare const VendorShipmentsApiFp: (configuration?: Configuration) => {
|
|
|
106
121
|
* @throws {RequiredError}
|
|
107
122
|
*/
|
|
108
123
|
getShipmentDetails(limit?: number, sortOrder?: GetShipmentDetailsSortOrderEnum, nextToken?: string, createdAfter?: string, createdBefore?: string, shipmentConfirmedBefore?: string, shipmentConfirmedAfter?: string, packageLabelCreatedBefore?: string, packageLabelCreatedAfter?: string, shippedBefore?: string, shippedAfter?: string, estimatedDeliveryBefore?: string, estimatedDeliveryAfter?: string, shipmentDeliveryBefore?: string, shipmentDeliveryAfter?: string, requestedPickUpBefore?: string, requestedPickUpAfter?: string, scheduledPickUpBefore?: string, scheduledPickUpAfter?: string, currentShipmentStatus?: string, vendorShipmentIdentifier?: string, buyerReferenceNumber?: string, buyerWarehouseCode?: string, sellerWarehouseCode?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentDetailsResponse>>;
|
|
124
|
+
/**
|
|
125
|
+
* Returns small parcel shipment labels based on the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
126
|
+
* @param {number} [limit] The limit to the number of records returned. Default value is 50 records.
|
|
127
|
+
* @param {GetShipmentLabelsSortOrderEnum} [sortOrder] Sort the list by shipment label creation date in ascending or descending order.
|
|
128
|
+
* @param {string} [nextToken] A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
129
|
+
* @param {string} [labelCreatedAfter] Shipment labels created after this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format.
|
|
130
|
+
* @param {string} [labelCreatedBefore] Shipment labels created before this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format.
|
|
131
|
+
* @param {string} [buyerReferenceNumber] Get Shipment labels by passing buyer reference number.
|
|
132
|
+
* @param {string} [vendorShipmentIdentifier] Get Shipment labels by passing vendor shipment identifier.
|
|
133
|
+
* @param {string} [sellerWarehouseCode] Get Shipping labels based on vendor warehouse code. This value must be same as the `sellingParty.partyId` in the shipment.
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
getShipmentLabels(limit?: number, sortOrder?: GetShipmentLabelsSortOrderEnum, nextToken?: string, labelCreatedAfter?: string, labelCreatedBefore?: string, buyerReferenceNumber?: string, vendorShipmentIdentifier?: string, sellerWarehouseCode?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentLabels>>;
|
|
109
138
|
/**
|
|
110
139
|
* 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).
|
|
111
140
|
* @summary SubmitShipmentConfirmations
|
|
@@ -124,246 +153,316 @@ export declare const VendorShipmentsApiFp: (configuration?: Configuration) => {
|
|
|
124
153
|
submitShipments(body: SubmitShipments, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubmitShipmentConfirmationsResponse>>;
|
|
125
154
|
};
|
|
126
155
|
/**
|
|
127
|
-
*
|
|
156
|
+
* VendorShippingApi - factory interface
|
|
128
157
|
* @export
|
|
129
158
|
*/
|
|
130
|
-
export declare const
|
|
159
|
+
export declare const VendorShippingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
131
160
|
/**
|
|
132
161
|
* Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value 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).
|
|
133
162
|
* @summary GetShipmentDetails
|
|
134
|
-
* @param {
|
|
163
|
+
* @param {VendorShippingApiGetShipmentDetailsRequest} requestParameters Request parameters.
|
|
135
164
|
* @param {*} [options] Override http request option.
|
|
136
165
|
* @throws {RequiredError}
|
|
137
166
|
*/
|
|
138
|
-
getShipmentDetails(requestParameters?:
|
|
167
|
+
getShipmentDetails(requestParameters?: VendorShippingApiGetShipmentDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentDetailsResponse>;
|
|
168
|
+
/**
|
|
169
|
+
* Returns small parcel shipment labels based on the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
170
|
+
* @param {VendorShippingApiGetShipmentLabelsRequest} requestParameters Request parameters.
|
|
171
|
+
* @param {*} [options] Override http request option.
|
|
172
|
+
* @throws {RequiredError}
|
|
173
|
+
*/
|
|
174
|
+
getShipmentLabels(requestParameters?: VendorShippingApiGetShipmentLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentLabels>;
|
|
139
175
|
/**
|
|
140
176
|
* 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).
|
|
141
177
|
* @summary SubmitShipmentConfirmations
|
|
142
|
-
* @param {
|
|
178
|
+
* @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
143
179
|
* @param {*} [options] Override http request option.
|
|
144
180
|
* @throws {RequiredError}
|
|
145
181
|
*/
|
|
146
|
-
submitShipmentConfirmations(requestParameters:
|
|
182
|
+
submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SubmitShipmentConfirmationsResponse>;
|
|
147
183
|
/**
|
|
148
184
|
* Submits one or more shipment request 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).
|
|
149
185
|
* @summary SubmitShipments
|
|
150
|
-
* @param {
|
|
186
|
+
* @param {VendorShippingApiSubmitShipmentsRequest} requestParameters Request parameters.
|
|
151
187
|
* @param {*} [options] Override http request option.
|
|
152
188
|
* @throws {RequiredError}
|
|
153
189
|
*/
|
|
154
|
-
submitShipments(requestParameters:
|
|
190
|
+
submitShipments(requestParameters: VendorShippingApiSubmitShipmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SubmitShipmentConfirmationsResponse>;
|
|
155
191
|
};
|
|
156
192
|
/**
|
|
157
|
-
* Request parameters for getShipmentDetails operation in
|
|
193
|
+
* Request parameters for getShipmentDetails operation in VendorShippingApi.
|
|
158
194
|
* @export
|
|
159
|
-
* @interface
|
|
195
|
+
* @interface VendorShippingApiGetShipmentDetailsRequest
|
|
160
196
|
*/
|
|
161
|
-
export interface
|
|
197
|
+
export interface VendorShippingApiGetShipmentDetailsRequest {
|
|
162
198
|
/**
|
|
163
199
|
* The limit to the number of records returned. Default value is 50 records.
|
|
164
200
|
* @type {number}
|
|
165
|
-
* @memberof
|
|
201
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
166
202
|
*/
|
|
167
203
|
readonly limit?: number;
|
|
168
204
|
/**
|
|
169
205
|
* Sort in ascending or descending order by purchase order creation date.
|
|
170
206
|
* @type {'ASC' | 'DESC'}
|
|
171
|
-
* @memberof
|
|
207
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
172
208
|
*/
|
|
173
209
|
readonly sortOrder?: GetShipmentDetailsSortOrderEnum;
|
|
174
210
|
/**
|
|
175
211
|
* Used for pagination when there are more shipments than the specified result size limit.
|
|
176
212
|
* @type {string}
|
|
177
|
-
* @memberof
|
|
213
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
178
214
|
*/
|
|
179
215
|
readonly nextToken?: string;
|
|
180
216
|
/**
|
|
181
217
|
* Get Shipment Details that became available after this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
182
218
|
* @type {string}
|
|
183
|
-
* @memberof
|
|
219
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
184
220
|
*/
|
|
185
221
|
readonly createdAfter?: string;
|
|
186
222
|
/**
|
|
187
223
|
* Get Shipment Details that became available before this timestamp will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
188
224
|
* @type {string}
|
|
189
|
-
* @memberof
|
|
225
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
190
226
|
*/
|
|
191
227
|
readonly createdBefore?: string;
|
|
192
228
|
/**
|
|
193
229
|
* Get Shipment Details by passing Shipment confirmed create Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
194
230
|
* @type {string}
|
|
195
|
-
* @memberof
|
|
231
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
196
232
|
*/
|
|
197
233
|
readonly shipmentConfirmedBefore?: string;
|
|
198
234
|
/**
|
|
199
235
|
* Get Shipment Details by passing Shipment confirmed create Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
200
236
|
* @type {string}
|
|
201
|
-
* @memberof
|
|
237
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
202
238
|
*/
|
|
203
239
|
readonly shipmentConfirmedAfter?: string;
|
|
204
240
|
/**
|
|
205
241
|
* Get Shipment Details by passing Package label create Date by buyer. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
206
242
|
* @type {string}
|
|
207
|
-
* @memberof
|
|
243
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
208
244
|
*/
|
|
209
245
|
readonly packageLabelCreatedBefore?: string;
|
|
210
246
|
/**
|
|
211
247
|
* Get Shipment Details by passing Package label create Date After by buyer. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
212
248
|
* @type {string}
|
|
213
|
-
* @memberof
|
|
249
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
214
250
|
*/
|
|
215
251
|
readonly packageLabelCreatedAfter?: string;
|
|
216
252
|
/**
|
|
217
253
|
* Get Shipment Details by passing Shipped Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
218
254
|
* @type {string}
|
|
219
|
-
* @memberof
|
|
255
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
220
256
|
*/
|
|
221
257
|
readonly shippedBefore?: string;
|
|
222
258
|
/**
|
|
223
259
|
* Get Shipment Details by passing Shipped Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
224
260
|
* @type {string}
|
|
225
|
-
* @memberof
|
|
261
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
226
262
|
*/
|
|
227
263
|
readonly shippedAfter?: string;
|
|
228
264
|
/**
|
|
229
265
|
* Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
230
266
|
* @type {string}
|
|
231
|
-
* @memberof
|
|
267
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
232
268
|
*/
|
|
233
269
|
readonly estimatedDeliveryBefore?: string;
|
|
234
270
|
/**
|
|
235
271
|
* Get Shipment Details by passing Estimated Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
236
272
|
* @type {string}
|
|
237
|
-
* @memberof
|
|
273
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
238
274
|
*/
|
|
239
275
|
readonly estimatedDeliveryAfter?: string;
|
|
240
276
|
/**
|
|
241
277
|
* Get Shipment Details by passing Shipment Delivery Date Before. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
242
278
|
* @type {string}
|
|
243
|
-
* @memberof
|
|
279
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
244
280
|
*/
|
|
245
281
|
readonly shipmentDeliveryBefore?: string;
|
|
246
282
|
/**
|
|
247
283
|
* Get Shipment Details by passing Shipment Delivery Date After. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
248
284
|
* @type {string}
|
|
249
|
-
* @memberof
|
|
285
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
250
286
|
*/
|
|
251
287
|
readonly shipmentDeliveryAfter?: string;
|
|
252
288
|
/**
|
|
253
289
|
* Get Shipment Details by passing Before Requested pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
254
290
|
* @type {string}
|
|
255
|
-
* @memberof
|
|
291
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
256
292
|
*/
|
|
257
293
|
readonly requestedPickUpBefore?: string;
|
|
258
294
|
/**
|
|
259
295
|
* Get Shipment Details by passing After Requested pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
260
296
|
* @type {string}
|
|
261
|
-
* @memberof
|
|
297
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
262
298
|
*/
|
|
263
299
|
readonly requestedPickUpAfter?: string;
|
|
264
300
|
/**
|
|
265
301
|
* Get Shipment Details by passing Before scheduled pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
266
302
|
* @type {string}
|
|
267
|
-
* @memberof
|
|
303
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
268
304
|
*/
|
|
269
305
|
readonly scheduledPickUpBefore?: string;
|
|
270
306
|
/**
|
|
271
307
|
* Get Shipment Details by passing After Scheduled pickup date. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> format.
|
|
272
308
|
* @type {string}
|
|
273
|
-
* @memberof
|
|
309
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
274
310
|
*/
|
|
275
311
|
readonly scheduledPickUpAfter?: string;
|
|
276
312
|
/**
|
|
277
313
|
* Get Shipment Details by passing Current shipment status.
|
|
278
314
|
* @type {string}
|
|
279
|
-
* @memberof
|
|
315
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
280
316
|
*/
|
|
281
317
|
readonly currentShipmentStatus?: string;
|
|
282
318
|
/**
|
|
283
319
|
* Get Shipment Details by passing Vendor Shipment ID
|
|
284
320
|
* @type {string}
|
|
285
|
-
* @memberof
|
|
321
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
286
322
|
*/
|
|
287
323
|
readonly vendorShipmentIdentifier?: string;
|
|
288
324
|
/**
|
|
289
325
|
* Get Shipment Details by passing buyer Reference ID
|
|
290
326
|
* @type {string}
|
|
291
|
-
* @memberof
|
|
327
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
292
328
|
*/
|
|
293
329
|
readonly buyerReferenceNumber?: string;
|
|
294
330
|
/**
|
|
295
331
|
* Get Shipping Details based on buyer warehouse code. This value should be same as \'shipToParty.partyId\' in the Shipment.
|
|
296
332
|
* @type {string}
|
|
297
|
-
* @memberof
|
|
333
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
298
334
|
*/
|
|
299
335
|
readonly buyerWarehouseCode?: string;
|
|
300
336
|
/**
|
|
301
337
|
* Get Shipping Details based on vendor warehouse code. This value should be same as \'sellingParty.partyId\' in the Shipment.
|
|
302
338
|
* @type {string}
|
|
303
|
-
* @memberof
|
|
339
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
340
|
+
*/
|
|
341
|
+
readonly sellerWarehouseCode?: string;
|
|
342
|
+
}
|
|
343
|
+
/**
|
|
344
|
+
* Request parameters for getShipmentLabels operation in VendorShippingApi.
|
|
345
|
+
* @export
|
|
346
|
+
* @interface VendorShippingApiGetShipmentLabelsRequest
|
|
347
|
+
*/
|
|
348
|
+
export interface VendorShippingApiGetShipmentLabelsRequest {
|
|
349
|
+
/**
|
|
350
|
+
* The limit to the number of records returned. Default value is 50 records.
|
|
351
|
+
* @type {number}
|
|
352
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
353
|
+
*/
|
|
354
|
+
readonly limit?: number;
|
|
355
|
+
/**
|
|
356
|
+
* Sort the list by shipment label creation date in ascending or descending order.
|
|
357
|
+
* @type {'ASC' | 'DESC'}
|
|
358
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
359
|
+
*/
|
|
360
|
+
readonly sortOrder?: GetShipmentLabelsSortOrderEnum;
|
|
361
|
+
/**
|
|
362
|
+
* A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
363
|
+
* @type {string}
|
|
364
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
365
|
+
*/
|
|
366
|
+
readonly nextToken?: string;
|
|
367
|
+
/**
|
|
368
|
+
* Shipment labels created after this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format.
|
|
369
|
+
* @type {string}
|
|
370
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
371
|
+
*/
|
|
372
|
+
readonly labelCreatedAfter?: string;
|
|
373
|
+
/**
|
|
374
|
+
* Shipment labels created before this time will be included in the result. This field must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format.
|
|
375
|
+
* @type {string}
|
|
376
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
377
|
+
*/
|
|
378
|
+
readonly labelCreatedBefore?: string;
|
|
379
|
+
/**
|
|
380
|
+
* Get Shipment labels by passing buyer reference number.
|
|
381
|
+
* @type {string}
|
|
382
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
383
|
+
*/
|
|
384
|
+
readonly buyerReferenceNumber?: string;
|
|
385
|
+
/**
|
|
386
|
+
* Get Shipment labels by passing vendor shipment identifier.
|
|
387
|
+
* @type {string}
|
|
388
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
389
|
+
*/
|
|
390
|
+
readonly vendorShipmentIdentifier?: string;
|
|
391
|
+
/**
|
|
392
|
+
* Get Shipping labels based on vendor warehouse code. This value must be same as the `sellingParty.partyId` in the shipment.
|
|
393
|
+
* @type {string}
|
|
394
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
304
395
|
*/
|
|
305
396
|
readonly sellerWarehouseCode?: string;
|
|
306
397
|
}
|
|
307
398
|
/**
|
|
308
|
-
* Request parameters for submitShipmentConfirmations operation in
|
|
399
|
+
* Request parameters for submitShipmentConfirmations operation in VendorShippingApi.
|
|
309
400
|
* @export
|
|
310
|
-
* @interface
|
|
401
|
+
* @interface VendorShippingApiSubmitShipmentConfirmationsRequest
|
|
311
402
|
*/
|
|
312
|
-
export interface
|
|
403
|
+
export interface VendorShippingApiSubmitShipmentConfirmationsRequest {
|
|
313
404
|
/**
|
|
314
405
|
* A request to submit shipment confirmation.
|
|
315
406
|
* @type {SubmitShipmentConfirmationsRequest}
|
|
316
|
-
* @memberof
|
|
407
|
+
* @memberof VendorShippingApiSubmitShipmentConfirmations
|
|
317
408
|
*/
|
|
318
409
|
readonly body: SubmitShipmentConfirmationsRequest;
|
|
319
410
|
}
|
|
320
411
|
/**
|
|
321
|
-
* Request parameters for submitShipments operation in
|
|
412
|
+
* Request parameters for submitShipments operation in VendorShippingApi.
|
|
322
413
|
* @export
|
|
323
|
-
* @interface
|
|
414
|
+
* @interface VendorShippingApiSubmitShipmentsRequest
|
|
324
415
|
*/
|
|
325
|
-
export interface
|
|
416
|
+
export interface VendorShippingApiSubmitShipmentsRequest {
|
|
326
417
|
/**
|
|
327
418
|
* A request to submit shipment request.
|
|
328
419
|
* @type {SubmitShipments}
|
|
329
|
-
* @memberof
|
|
420
|
+
* @memberof VendorShippingApiSubmitShipments
|
|
330
421
|
*/
|
|
331
422
|
readonly body: SubmitShipments;
|
|
332
423
|
}
|
|
333
424
|
/**
|
|
334
|
-
*
|
|
425
|
+
* VendorShippingApi - object-oriented interface
|
|
335
426
|
* @export
|
|
336
|
-
* @class
|
|
427
|
+
* @class VendorShippingApi
|
|
337
428
|
* @extends {BaseAPI}
|
|
338
429
|
*/
|
|
339
|
-
export declare class
|
|
430
|
+
export declare class VendorShippingApi extends BaseAPI {
|
|
340
431
|
/**
|
|
341
432
|
* Returns the Details about Shipment, Carrier Details, status of the shipment, container details and other details related to shipment based on the filter parameters value 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).
|
|
342
433
|
* @summary GetShipmentDetails
|
|
343
|
-
* @param {
|
|
434
|
+
* @param {VendorShippingApiGetShipmentDetailsRequest} requestParameters Request parameters.
|
|
435
|
+
* @param {*} [options] Override http request option.
|
|
436
|
+
* @throws {RequiredError}
|
|
437
|
+
* @memberof VendorShippingApi
|
|
438
|
+
*/
|
|
439
|
+
getShipmentDetails(requestParameters?: VendorShippingApiGetShipmentDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentDetailsResponse, any>>;
|
|
440
|
+
/**
|
|
441
|
+
* Returns small parcel shipment labels based on the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
442
|
+
* @param {VendorShippingApiGetShipmentLabelsRequest} requestParameters Request parameters.
|
|
344
443
|
* @param {*} [options] Override http request option.
|
|
345
444
|
* @throws {RequiredError}
|
|
346
|
-
* @memberof
|
|
445
|
+
* @memberof VendorShippingApi
|
|
347
446
|
*/
|
|
348
|
-
|
|
447
|
+
getShipmentLabels(requestParameters?: VendorShippingApiGetShipmentLabelsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentLabels, any>>;
|
|
349
448
|
/**
|
|
350
449
|
* 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).
|
|
351
450
|
* @summary SubmitShipmentConfirmations
|
|
352
|
-
* @param {
|
|
451
|
+
* @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
353
452
|
* @param {*} [options] Override http request option.
|
|
354
453
|
* @throws {RequiredError}
|
|
355
|
-
* @memberof
|
|
454
|
+
* @memberof VendorShippingApi
|
|
356
455
|
*/
|
|
357
|
-
submitShipmentConfirmations(requestParameters:
|
|
456
|
+
submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShipmentConfirmationsResponse, any>>;
|
|
358
457
|
/**
|
|
359
458
|
* Submits one or more shipment request 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).
|
|
360
459
|
* @summary SubmitShipments
|
|
361
|
-
* @param {
|
|
460
|
+
* @param {VendorShippingApiSubmitShipmentsRequest} requestParameters Request parameters.
|
|
362
461
|
* @param {*} [options] Override http request option.
|
|
363
462
|
* @throws {RequiredError}
|
|
364
|
-
* @memberof
|
|
463
|
+
* @memberof VendorShippingApi
|
|
365
464
|
*/
|
|
366
|
-
submitShipments(requestParameters:
|
|
465
|
+
submitShipments(requestParameters: VendorShippingApiSubmitShipmentsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShipmentConfirmationsResponse, any>>;
|
|
367
466
|
}
|
|
368
467
|
/**
|
|
369
468
|
* @export
|
|
@@ -373,3 +472,11 @@ export declare const GetShipmentDetailsSortOrderEnum: {
|
|
|
373
472
|
readonly Desc: "DESC";
|
|
374
473
|
};
|
|
375
474
|
export type GetShipmentDetailsSortOrderEnum = typeof GetShipmentDetailsSortOrderEnum[keyof typeof GetShipmentDetailsSortOrderEnum];
|
|
475
|
+
/**
|
|
476
|
+
* @export
|
|
477
|
+
*/
|
|
478
|
+
export declare const GetShipmentLabelsSortOrderEnum: {
|
|
479
|
+
readonly Asc: "ASC";
|
|
480
|
+
readonly Desc: "DESC";
|
|
481
|
+
};
|
|
482
|
+
export type GetShipmentLabelsSortOrderEnum = typeof GetShipmentLabelsSortOrderEnum[keyof typeof GetShipmentLabelsSortOrderEnum];
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* Selling Partner API for Retail Procurement Shipments
|
|
3
3
|
* The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v1
|
|
@@ -9,4 +9,4 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
export * from './api/vendor-
|
|
12
|
+
export * from './api/vendor-shipping-api';
|