@sp-api-sdk/vendor-shipments-api-v1 2.5.3 → 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/README.md +1 -1
- package/dist/cjs/api-model/api/{vendor-shipments-api.js → vendor-shipping-api.js} +63 -67
- 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 +1 -1
- package/dist/cjs/api-model/models/import-details.js +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- package/dist/cjs/api-model/models/vendor-details.js +1 -1
- 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 +1 -1
- package/dist/es/api-model/api/{vendor-shipments-api.js → vendor-shipping-api.js} +58 -62
- 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 +1 -1
- package/dist/es/api-model/models/import-details.js +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- package/dist/es/api-model/models/vendor-details.js +1 -1
- 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 +2 -2
- package/dist/types/api-model/api/{vendor-shipments-api.d.ts → vendor-shipping-api.d.ts} +104 -108
- 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 +1 -1
- package/dist/types/api-model/models/import-details.d.ts +1 -1
- 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 +5 -5
- 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 +1 -1
- 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 +1 -1
- 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 +2 -2
- 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 +1 -1
- 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 +1 -1
- package/dist/types/api-model/models/vendor-details.d.ts +2 -2
- 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 +4 -4
|
@@ -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
|
|
@@ -19,10 +19,10 @@ import type { SubmitShipmentConfirmationsRequest } from '../models';
|
|
|
19
19
|
import type { SubmitShipmentConfirmationsResponse } from '../models';
|
|
20
20
|
import type { SubmitShipments } from '../models';
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* VendorShippingApi - axios parameter creator
|
|
23
23
|
* @export
|
|
24
24
|
*/
|
|
25
|
-
export declare const
|
|
25
|
+
export declare const VendorShippingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
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).
|
|
28
28
|
* @summary GetShipmentDetails
|
|
@@ -55,20 +55,19 @@ export declare const VendorShipmentsApiAxiosParamCreator: (configuration?: Confi
|
|
|
55
55
|
*/
|
|
56
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
57
|
/**
|
|
58
|
-
* Returns
|
|
59
|
-
* @summary GetShipmentLabels
|
|
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).
|
|
60
59
|
* @param {number} [limit] The limit to the number of records returned. Default value is 50 records.
|
|
61
|
-
* @param {GetShipmentLabelsSortOrderEnum} [sortOrder] Sort
|
|
62
|
-
* @param {string} [nextToken]
|
|
63
|
-
* @param {string} [labelCreatedAfter]
|
|
64
|
-
* @param {string} [
|
|
65
|
-
* @param {string} [buyerReferenceNumber] Get
|
|
66
|
-
* @param {string} [vendorShipmentIdentifier] Get
|
|
67
|
-
* @param {string} [sellerWarehouseCode] Get Shipping labels based
|
|
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.
|
|
68
67
|
* @param {*} [options] Override http request option.
|
|
69
68
|
* @throws {RequiredError}
|
|
70
69
|
*/
|
|
71
|
-
getShipmentLabels: (limit?: number, sortOrder?: GetShipmentLabelsSortOrderEnum, nextToken?: string, labelCreatedAfter?: string,
|
|
70
|
+
getShipmentLabels: (limit?: number, sortOrder?: GetShipmentLabelsSortOrderEnum, nextToken?: string, labelCreatedAfter?: string, labelCreatedBefore?: string, buyerReferenceNumber?: string, vendorShipmentIdentifier?: string, sellerWarehouseCode?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
71
|
/**
|
|
73
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).
|
|
74
73
|
* @summary SubmitShipmentConfirmations
|
|
@@ -87,10 +86,10 @@ export declare const VendorShipmentsApiAxiosParamCreator: (configuration?: Confi
|
|
|
87
86
|
submitShipments: (body: SubmitShipments, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
88
87
|
};
|
|
89
88
|
/**
|
|
90
|
-
*
|
|
89
|
+
* VendorShippingApi - functional programming interface
|
|
91
90
|
* @export
|
|
92
91
|
*/
|
|
93
|
-
export declare const
|
|
92
|
+
export declare const VendorShippingApiFp: (configuration?: Configuration) => {
|
|
94
93
|
/**
|
|
95
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).
|
|
96
95
|
* @summary GetShipmentDetails
|
|
@@ -123,20 +122,19 @@ export declare const VendorShipmentsApiFp: (configuration?: Configuration) => {
|
|
|
123
122
|
*/
|
|
124
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>>;
|
|
125
124
|
/**
|
|
126
|
-
* Returns
|
|
127
|
-
* @summary GetShipmentLabels
|
|
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).
|
|
128
126
|
* @param {number} [limit] The limit to the number of records returned. Default value is 50 records.
|
|
129
|
-
* @param {GetShipmentLabelsSortOrderEnum} [sortOrder] Sort
|
|
130
|
-
* @param {string} [nextToken]
|
|
131
|
-
* @param {string} [labelCreatedAfter]
|
|
132
|
-
* @param {string} [
|
|
133
|
-
* @param {string} [buyerReferenceNumber] Get
|
|
134
|
-
* @param {string} [vendorShipmentIdentifier] Get
|
|
135
|
-
* @param {string} [sellerWarehouseCode] Get Shipping labels based
|
|
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.
|
|
136
134
|
* @param {*} [options] Override http request option.
|
|
137
135
|
* @throws {RequiredError}
|
|
138
136
|
*/
|
|
139
|
-
getShipmentLabels(limit?: number, sortOrder?: GetShipmentLabelsSortOrderEnum, nextToken?: string, labelCreatedAfter?: string,
|
|
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>>;
|
|
140
138
|
/**
|
|
141
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).
|
|
142
140
|
* @summary SubmitShipmentConfirmations
|
|
@@ -155,318 +153,316 @@ export declare const VendorShipmentsApiFp: (configuration?: Configuration) => {
|
|
|
155
153
|
submitShipments(body: SubmitShipments, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubmitShipmentConfirmationsResponse>>;
|
|
156
154
|
};
|
|
157
155
|
/**
|
|
158
|
-
*
|
|
156
|
+
* VendorShippingApi - factory interface
|
|
159
157
|
* @export
|
|
160
158
|
*/
|
|
161
|
-
export declare const
|
|
159
|
+
export declare const VendorShippingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
162
160
|
/**
|
|
163
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).
|
|
164
162
|
* @summary GetShipmentDetails
|
|
165
|
-
* @param {
|
|
163
|
+
* @param {VendorShippingApiGetShipmentDetailsRequest} requestParameters Request parameters.
|
|
166
164
|
* @param {*} [options] Override http request option.
|
|
167
165
|
* @throws {RequiredError}
|
|
168
166
|
*/
|
|
169
|
-
getShipmentDetails(requestParameters?:
|
|
167
|
+
getShipmentDetails(requestParameters?: VendorShippingApiGetShipmentDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentDetailsResponse>;
|
|
170
168
|
/**
|
|
171
|
-
* Returns
|
|
172
|
-
* @
|
|
173
|
-
* @param {VendorShipmentsApiGetShipmentLabelsRequest} requestParameters Request parameters.
|
|
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.
|
|
174
171
|
* @param {*} [options] Override http request option.
|
|
175
172
|
* @throws {RequiredError}
|
|
176
173
|
*/
|
|
177
|
-
getShipmentLabels(requestParameters?:
|
|
174
|
+
getShipmentLabels(requestParameters?: VendorShippingApiGetShipmentLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentLabels>;
|
|
178
175
|
/**
|
|
179
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).
|
|
180
177
|
* @summary SubmitShipmentConfirmations
|
|
181
|
-
* @param {
|
|
178
|
+
* @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
182
179
|
* @param {*} [options] Override http request option.
|
|
183
180
|
* @throws {RequiredError}
|
|
184
181
|
*/
|
|
185
|
-
submitShipmentConfirmations(requestParameters:
|
|
182
|
+
submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SubmitShipmentConfirmationsResponse>;
|
|
186
183
|
/**
|
|
187
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).
|
|
188
185
|
* @summary SubmitShipments
|
|
189
|
-
* @param {
|
|
186
|
+
* @param {VendorShippingApiSubmitShipmentsRequest} requestParameters Request parameters.
|
|
190
187
|
* @param {*} [options] Override http request option.
|
|
191
188
|
* @throws {RequiredError}
|
|
192
189
|
*/
|
|
193
|
-
submitShipments(requestParameters:
|
|
190
|
+
submitShipments(requestParameters: VendorShippingApiSubmitShipmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SubmitShipmentConfirmationsResponse>;
|
|
194
191
|
};
|
|
195
192
|
/**
|
|
196
|
-
* Request parameters for getShipmentDetails operation in
|
|
193
|
+
* Request parameters for getShipmentDetails operation in VendorShippingApi.
|
|
197
194
|
* @export
|
|
198
|
-
* @interface
|
|
195
|
+
* @interface VendorShippingApiGetShipmentDetailsRequest
|
|
199
196
|
*/
|
|
200
|
-
export interface
|
|
197
|
+
export interface VendorShippingApiGetShipmentDetailsRequest {
|
|
201
198
|
/**
|
|
202
199
|
* The limit to the number of records returned. Default value is 50 records.
|
|
203
200
|
* @type {number}
|
|
204
|
-
* @memberof
|
|
201
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
205
202
|
*/
|
|
206
203
|
readonly limit?: number;
|
|
207
204
|
/**
|
|
208
205
|
* Sort in ascending or descending order by purchase order creation date.
|
|
209
206
|
* @type {'ASC' | 'DESC'}
|
|
210
|
-
* @memberof
|
|
207
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
211
208
|
*/
|
|
212
209
|
readonly sortOrder?: GetShipmentDetailsSortOrderEnum;
|
|
213
210
|
/**
|
|
214
211
|
* Used for pagination when there are more shipments than the specified result size limit.
|
|
215
212
|
* @type {string}
|
|
216
|
-
* @memberof
|
|
213
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
217
214
|
*/
|
|
218
215
|
readonly nextToken?: string;
|
|
219
216
|
/**
|
|
220
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.
|
|
221
218
|
* @type {string}
|
|
222
|
-
* @memberof
|
|
219
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
223
220
|
*/
|
|
224
221
|
readonly createdAfter?: string;
|
|
225
222
|
/**
|
|
226
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.
|
|
227
224
|
* @type {string}
|
|
228
|
-
* @memberof
|
|
225
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
229
226
|
*/
|
|
230
227
|
readonly createdBefore?: string;
|
|
231
228
|
/**
|
|
232
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.
|
|
233
230
|
* @type {string}
|
|
234
|
-
* @memberof
|
|
231
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
235
232
|
*/
|
|
236
233
|
readonly shipmentConfirmedBefore?: string;
|
|
237
234
|
/**
|
|
238
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.
|
|
239
236
|
* @type {string}
|
|
240
|
-
* @memberof
|
|
237
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
241
238
|
*/
|
|
242
239
|
readonly shipmentConfirmedAfter?: string;
|
|
243
240
|
/**
|
|
244
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.
|
|
245
242
|
* @type {string}
|
|
246
|
-
* @memberof
|
|
243
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
247
244
|
*/
|
|
248
245
|
readonly packageLabelCreatedBefore?: string;
|
|
249
246
|
/**
|
|
250
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.
|
|
251
248
|
* @type {string}
|
|
252
|
-
* @memberof
|
|
249
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
253
250
|
*/
|
|
254
251
|
readonly packageLabelCreatedAfter?: string;
|
|
255
252
|
/**
|
|
256
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.
|
|
257
254
|
* @type {string}
|
|
258
|
-
* @memberof
|
|
255
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
259
256
|
*/
|
|
260
257
|
readonly shippedBefore?: string;
|
|
261
258
|
/**
|
|
262
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.
|
|
263
260
|
* @type {string}
|
|
264
|
-
* @memberof
|
|
261
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
265
262
|
*/
|
|
266
263
|
readonly shippedAfter?: string;
|
|
267
264
|
/**
|
|
268
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.
|
|
269
266
|
* @type {string}
|
|
270
|
-
* @memberof
|
|
267
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
271
268
|
*/
|
|
272
269
|
readonly estimatedDeliveryBefore?: string;
|
|
273
270
|
/**
|
|
274
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.
|
|
275
272
|
* @type {string}
|
|
276
|
-
* @memberof
|
|
273
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
277
274
|
*/
|
|
278
275
|
readonly estimatedDeliveryAfter?: string;
|
|
279
276
|
/**
|
|
280
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.
|
|
281
278
|
* @type {string}
|
|
282
|
-
* @memberof
|
|
279
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
283
280
|
*/
|
|
284
281
|
readonly shipmentDeliveryBefore?: string;
|
|
285
282
|
/**
|
|
286
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.
|
|
287
284
|
* @type {string}
|
|
288
|
-
* @memberof
|
|
285
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
289
286
|
*/
|
|
290
287
|
readonly shipmentDeliveryAfter?: string;
|
|
291
288
|
/**
|
|
292
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.
|
|
293
290
|
* @type {string}
|
|
294
|
-
* @memberof
|
|
291
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
295
292
|
*/
|
|
296
293
|
readonly requestedPickUpBefore?: string;
|
|
297
294
|
/**
|
|
298
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.
|
|
299
296
|
* @type {string}
|
|
300
|
-
* @memberof
|
|
297
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
301
298
|
*/
|
|
302
299
|
readonly requestedPickUpAfter?: string;
|
|
303
300
|
/**
|
|
304
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.
|
|
305
302
|
* @type {string}
|
|
306
|
-
* @memberof
|
|
303
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
307
304
|
*/
|
|
308
305
|
readonly scheduledPickUpBefore?: string;
|
|
309
306
|
/**
|
|
310
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.
|
|
311
308
|
* @type {string}
|
|
312
|
-
* @memberof
|
|
309
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
313
310
|
*/
|
|
314
311
|
readonly scheduledPickUpAfter?: string;
|
|
315
312
|
/**
|
|
316
313
|
* Get Shipment Details by passing Current shipment status.
|
|
317
314
|
* @type {string}
|
|
318
|
-
* @memberof
|
|
315
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
319
316
|
*/
|
|
320
317
|
readonly currentShipmentStatus?: string;
|
|
321
318
|
/**
|
|
322
319
|
* Get Shipment Details by passing Vendor Shipment ID
|
|
323
320
|
* @type {string}
|
|
324
|
-
* @memberof
|
|
321
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
325
322
|
*/
|
|
326
323
|
readonly vendorShipmentIdentifier?: string;
|
|
327
324
|
/**
|
|
328
325
|
* Get Shipment Details by passing buyer Reference ID
|
|
329
326
|
* @type {string}
|
|
330
|
-
* @memberof
|
|
327
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
331
328
|
*/
|
|
332
329
|
readonly buyerReferenceNumber?: string;
|
|
333
330
|
/**
|
|
334
331
|
* Get Shipping Details based on buyer warehouse code. This value should be same as \'shipToParty.partyId\' in the Shipment.
|
|
335
332
|
* @type {string}
|
|
336
|
-
* @memberof
|
|
333
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
337
334
|
*/
|
|
338
335
|
readonly buyerWarehouseCode?: string;
|
|
339
336
|
/**
|
|
340
337
|
* Get Shipping Details based on vendor warehouse code. This value should be same as \'sellingParty.partyId\' in the Shipment.
|
|
341
338
|
* @type {string}
|
|
342
|
-
* @memberof
|
|
339
|
+
* @memberof VendorShippingApiGetShipmentDetails
|
|
343
340
|
*/
|
|
344
341
|
readonly sellerWarehouseCode?: string;
|
|
345
342
|
}
|
|
346
343
|
/**
|
|
347
|
-
* Request parameters for getShipmentLabels operation in
|
|
344
|
+
* Request parameters for getShipmentLabels operation in VendorShippingApi.
|
|
348
345
|
* @export
|
|
349
|
-
* @interface
|
|
346
|
+
* @interface VendorShippingApiGetShipmentLabelsRequest
|
|
350
347
|
*/
|
|
351
|
-
export interface
|
|
348
|
+
export interface VendorShippingApiGetShipmentLabelsRequest {
|
|
352
349
|
/**
|
|
353
350
|
* The limit to the number of records returned. Default value is 50 records.
|
|
354
351
|
* @type {number}
|
|
355
|
-
* @memberof
|
|
352
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
356
353
|
*/
|
|
357
354
|
readonly limit?: number;
|
|
358
355
|
/**
|
|
359
|
-
* Sort
|
|
356
|
+
* Sort the list by shipment label creation date in ascending or descending order.
|
|
360
357
|
* @type {'ASC' | 'DESC'}
|
|
361
|
-
* @memberof
|
|
358
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
362
359
|
*/
|
|
363
360
|
readonly sortOrder?: GetShipmentLabelsSortOrderEnum;
|
|
364
361
|
/**
|
|
365
|
-
*
|
|
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.
|
|
366
363
|
* @type {string}
|
|
367
|
-
* @memberof
|
|
364
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
368
365
|
*/
|
|
369
366
|
readonly nextToken?: string;
|
|
370
367
|
/**
|
|
371
|
-
*
|
|
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.
|
|
372
369
|
* @type {string}
|
|
373
|
-
* @memberof
|
|
370
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
374
371
|
*/
|
|
375
372
|
readonly labelCreatedAfter?: string;
|
|
376
373
|
/**
|
|
377
|
-
*
|
|
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.
|
|
378
375
|
* @type {string}
|
|
379
|
-
* @memberof
|
|
376
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
380
377
|
*/
|
|
381
|
-
readonly
|
|
378
|
+
readonly labelCreatedBefore?: string;
|
|
382
379
|
/**
|
|
383
|
-
* Get
|
|
380
|
+
* Get Shipment labels by passing buyer reference number.
|
|
384
381
|
* @type {string}
|
|
385
|
-
* @memberof
|
|
382
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
386
383
|
*/
|
|
387
384
|
readonly buyerReferenceNumber?: string;
|
|
388
385
|
/**
|
|
389
|
-
* Get
|
|
386
|
+
* Get Shipment labels by passing vendor shipment identifier.
|
|
390
387
|
* @type {string}
|
|
391
|
-
* @memberof
|
|
388
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
392
389
|
*/
|
|
393
390
|
readonly vendorShipmentIdentifier?: string;
|
|
394
391
|
/**
|
|
395
|
-
* Get Shipping labels based
|
|
392
|
+
* Get Shipping labels based on vendor warehouse code. This value must be same as the `sellingParty.partyId` in the shipment.
|
|
396
393
|
* @type {string}
|
|
397
|
-
* @memberof
|
|
394
|
+
* @memberof VendorShippingApiGetShipmentLabels
|
|
398
395
|
*/
|
|
399
396
|
readonly sellerWarehouseCode?: string;
|
|
400
397
|
}
|
|
401
398
|
/**
|
|
402
|
-
* Request parameters for submitShipmentConfirmations operation in
|
|
399
|
+
* Request parameters for submitShipmentConfirmations operation in VendorShippingApi.
|
|
403
400
|
* @export
|
|
404
|
-
* @interface
|
|
401
|
+
* @interface VendorShippingApiSubmitShipmentConfirmationsRequest
|
|
405
402
|
*/
|
|
406
|
-
export interface
|
|
403
|
+
export interface VendorShippingApiSubmitShipmentConfirmationsRequest {
|
|
407
404
|
/**
|
|
408
405
|
* A request to submit shipment confirmation.
|
|
409
406
|
* @type {SubmitShipmentConfirmationsRequest}
|
|
410
|
-
* @memberof
|
|
407
|
+
* @memberof VendorShippingApiSubmitShipmentConfirmations
|
|
411
408
|
*/
|
|
412
409
|
readonly body: SubmitShipmentConfirmationsRequest;
|
|
413
410
|
}
|
|
414
411
|
/**
|
|
415
|
-
* Request parameters for submitShipments operation in
|
|
412
|
+
* Request parameters for submitShipments operation in VendorShippingApi.
|
|
416
413
|
* @export
|
|
417
|
-
* @interface
|
|
414
|
+
* @interface VendorShippingApiSubmitShipmentsRequest
|
|
418
415
|
*/
|
|
419
|
-
export interface
|
|
416
|
+
export interface VendorShippingApiSubmitShipmentsRequest {
|
|
420
417
|
/**
|
|
421
418
|
* A request to submit shipment request.
|
|
422
419
|
* @type {SubmitShipments}
|
|
423
|
-
* @memberof
|
|
420
|
+
* @memberof VendorShippingApiSubmitShipments
|
|
424
421
|
*/
|
|
425
422
|
readonly body: SubmitShipments;
|
|
426
423
|
}
|
|
427
424
|
/**
|
|
428
|
-
*
|
|
425
|
+
* VendorShippingApi - object-oriented interface
|
|
429
426
|
* @export
|
|
430
|
-
* @class
|
|
427
|
+
* @class VendorShippingApi
|
|
431
428
|
* @extends {BaseAPI}
|
|
432
429
|
*/
|
|
433
|
-
export declare class
|
|
430
|
+
export declare class VendorShippingApi extends BaseAPI {
|
|
434
431
|
/**
|
|
435
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).
|
|
436
433
|
* @summary GetShipmentDetails
|
|
437
|
-
* @param {
|
|
434
|
+
* @param {VendorShippingApiGetShipmentDetailsRequest} requestParameters Request parameters.
|
|
438
435
|
* @param {*} [options] Override http request option.
|
|
439
436
|
* @throws {RequiredError}
|
|
440
|
-
* @memberof
|
|
437
|
+
* @memberof VendorShippingApi
|
|
441
438
|
*/
|
|
442
|
-
getShipmentDetails(requestParameters?:
|
|
439
|
+
getShipmentDetails(requestParameters?: VendorShippingApiGetShipmentDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentDetailsResponse, any>>;
|
|
443
440
|
/**
|
|
444
|
-
* Returns
|
|
445
|
-
* @
|
|
446
|
-
* @param {VendorShipmentsApiGetShipmentLabelsRequest} requestParameters Request parameters.
|
|
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.
|
|
447
443
|
* @param {*} [options] Override http request option.
|
|
448
444
|
* @throws {RequiredError}
|
|
449
|
-
* @memberof
|
|
445
|
+
* @memberof VendorShippingApi
|
|
450
446
|
*/
|
|
451
|
-
getShipmentLabels(requestParameters?:
|
|
447
|
+
getShipmentLabels(requestParameters?: VendorShippingApiGetShipmentLabelsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentLabels, any>>;
|
|
452
448
|
/**
|
|
453
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).
|
|
454
450
|
* @summary SubmitShipmentConfirmations
|
|
455
|
-
* @param {
|
|
451
|
+
* @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
456
452
|
* @param {*} [options] Override http request option.
|
|
457
453
|
* @throws {RequiredError}
|
|
458
|
-
* @memberof
|
|
454
|
+
* @memberof VendorShippingApi
|
|
459
455
|
*/
|
|
460
|
-
submitShipmentConfirmations(requestParameters:
|
|
456
|
+
submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShipmentConfirmationsResponse, any>>;
|
|
461
457
|
/**
|
|
462
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).
|
|
463
459
|
* @summary SubmitShipments
|
|
464
|
-
* @param {
|
|
460
|
+
* @param {VendorShippingApiSubmitShipmentsRequest} requestParameters Request parameters.
|
|
465
461
|
* @param {*} [options] Override http request option.
|
|
466
462
|
* @throws {RequiredError}
|
|
467
|
-
* @memberof
|
|
463
|
+
* @memberof VendorShippingApi
|
|
468
464
|
*/
|
|
469
|
-
submitShipments(requestParameters:
|
|
465
|
+
submitShipments(requestParameters: VendorShippingApiSubmitShipmentsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShipmentConfirmationsResponse, any>>;
|
|
470
466
|
}
|
|
471
467
|
/**
|
|
472
468
|
* @export
|
|
@@ -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';
|