@sp-api-sdk/vendor-shipments-api-v1 2.4.1 → 2.5.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-shipping-api.js → vendor-shipments-api.js} +153 -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 +9 -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 +22 -0
- 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-shipping-api.js → vendor-shipments-api.js} +148 -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 +9 -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 +19 -0
- 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-shipping-api.d.ts → vendor-shipments-api.d.ts} +183 -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 +9 -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 +8 -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 +37 -0
- 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
|
+
* Vendor Shipments v1
|
|
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,16 +14,18 @@ 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
|
+
* VendorShipmentsApi - axios parameter creator
|
|
22
23
|
* @export
|
|
23
24
|
*/
|
|
24
|
-
export declare const
|
|
25
|
+
export declare const VendorShipmentsApiAxiosParamCreator: (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).
|
|
28
|
+
* @summary GetShipmentDetails
|
|
27
29
|
* @param {number} [limit] The limit to the number of records returned. Default value is 50 records.
|
|
28
30
|
* @param {GetShipmentDetailsSortOrderEnum} [sortOrder] Sort in ascending or descending order by purchase order creation date.
|
|
29
31
|
* @param {string} [nextToken] Used for pagination when there are more shipments than the specified result size limit.
|
|
@@ -52,8 +54,24 @@ export declare const VendorShippingApiAxiosParamCreator: (configuration?: Config
|
|
|
52
54
|
* @throws {RequiredError}
|
|
53
55
|
*/
|
|
54
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 transport Labels based on the filters 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).
|
|
59
|
+
* @summary GetShipmentLabels
|
|
60
|
+
* @param {number} [limit] The limit to the number of records returned. Default value is 50 records.
|
|
61
|
+
* @param {GetShipmentLabelsSortOrderEnum} [sortOrder] Sort in ascending or descending order by transport label creation date.
|
|
62
|
+
* @param {string} [nextToken] Used for pagination when there are more transport label than the specified result size limit.
|
|
63
|
+
* @param {string} [labelCreatedAfter] transport Labels that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
64
|
+
* @param {string} [labelcreatedBefore] transport Labels that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
65
|
+
* @param {string} [buyerReferenceNumber] Get transport labels by passing Buyer Reference Number to retreive the corresponding transport label.
|
|
66
|
+
* @param {string} [vendorShipmentIdentifier] Get transport labels by passing Vendor Shipment ID to retreive the corresponding transport label.
|
|
67
|
+
* @param {string} [sellerWarehouseCode] Get Shipping labels based Vendor Warehouse code. This value should be same as \'shipFromParty.partyId\' in the Shipment.
|
|
68
|
+
* @param {*} [options] Override http request option.
|
|
69
|
+
* @throws {RequiredError}
|
|
70
|
+
*/
|
|
71
|
+
getShipmentLabels: (limit?: number, sortOrder?: GetShipmentLabelsSortOrderEnum, nextToken?: string, labelCreatedAfter?: string, labelcreatedBefore?: string, buyerReferenceNumber?: string, vendorShipmentIdentifier?: string, sellerWarehouseCode?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
72
|
/**
|
|
56
73
|
* 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
|
+
* @summary SubmitShipmentConfirmations
|
|
57
75
|
* @param {SubmitShipmentConfirmationsRequest} body A request to submit shipment confirmation.
|
|
58
76
|
* @param {*} [options] Override http request option.
|
|
59
77
|
* @throws {RequiredError}
|
|
@@ -61,6 +79,7 @@ export declare const VendorShippingApiAxiosParamCreator: (configuration?: Config
|
|
|
61
79
|
submitShipmentConfirmations: (body: SubmitShipmentConfirmationsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62
80
|
/**
|
|
63
81
|
* 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).
|
|
82
|
+
* @summary SubmitShipments
|
|
64
83
|
* @param {SubmitShipments} body A request to submit shipment request.
|
|
65
84
|
* @param {*} [options] Override http request option.
|
|
66
85
|
* @throws {RequiredError}
|
|
@@ -68,12 +87,13 @@ export declare const VendorShippingApiAxiosParamCreator: (configuration?: Config
|
|
|
68
87
|
submitShipments: (body: SubmitShipments, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
88
|
};
|
|
70
89
|
/**
|
|
71
|
-
*
|
|
90
|
+
* VendorShipmentsApi - functional programming interface
|
|
72
91
|
* @export
|
|
73
92
|
*/
|
|
74
|
-
export declare const
|
|
93
|
+
export declare const VendorShipmentsApiFp: (configuration?: Configuration) => {
|
|
75
94
|
/**
|
|
76
95
|
* 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
|
+
* @summary GetShipmentDetails
|
|
77
97
|
* @param {number} [limit] The limit to the number of records returned. Default value is 50 records.
|
|
78
98
|
* @param {GetShipmentDetailsSortOrderEnum} [sortOrder] Sort in ascending or descending order by purchase order creation date.
|
|
79
99
|
* @param {string} [nextToken] Used for pagination when there are more shipments than the specified result size limit.
|
|
@@ -102,8 +122,24 @@ export declare const VendorShippingApiFp: (configuration?: Configuration) => {
|
|
|
102
122
|
* @throws {RequiredError}
|
|
103
123
|
*/
|
|
104
124
|
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
|
+
/**
|
|
126
|
+
* Returns transport Labels based on the filters 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).
|
|
127
|
+
* @summary GetShipmentLabels
|
|
128
|
+
* @param {number} [limit] The limit to the number of records returned. Default value is 50 records.
|
|
129
|
+
* @param {GetShipmentLabelsSortOrderEnum} [sortOrder] Sort in ascending or descending order by transport label creation date.
|
|
130
|
+
* @param {string} [nextToken] Used for pagination when there are more transport label than the specified result size limit.
|
|
131
|
+
* @param {string} [labelCreatedAfter] transport Labels that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
132
|
+
* @param {string} [labelcreatedBefore] transport Labels that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
133
|
+
* @param {string} [buyerReferenceNumber] Get transport labels by passing Buyer Reference Number to retreive the corresponding transport label.
|
|
134
|
+
* @param {string} [vendorShipmentIdentifier] Get transport labels by passing Vendor Shipment ID to retreive the corresponding transport label.
|
|
135
|
+
* @param {string} [sellerWarehouseCode] Get Shipping labels based Vendor Warehouse code. This value should be same as \'shipFromParty.partyId\' in the Shipment.
|
|
136
|
+
* @param {*} [options] Override http request option.
|
|
137
|
+
* @throws {RequiredError}
|
|
138
|
+
*/
|
|
139
|
+
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>>;
|
|
105
140
|
/**
|
|
106
141
|
* 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
|
+
* @summary SubmitShipmentConfirmations
|
|
107
143
|
* @param {SubmitShipmentConfirmationsRequest} body A request to submit shipment confirmation.
|
|
108
144
|
* @param {*} [options] Override http request option.
|
|
109
145
|
* @throws {RequiredError}
|
|
@@ -111,6 +147,7 @@ export declare const VendorShippingApiFp: (configuration?: Configuration) => {
|
|
|
111
147
|
submitShipmentConfirmations(body: SubmitShipmentConfirmationsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubmitShipmentConfirmationsResponse>>;
|
|
112
148
|
/**
|
|
113
149
|
* 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).
|
|
150
|
+
* @summary SubmitShipments
|
|
114
151
|
* @param {SubmitShipments} body A request to submit shipment request.
|
|
115
152
|
* @param {*} [options] Override http request option.
|
|
116
153
|
* @throws {RequiredError}
|
|
@@ -118,240 +155,318 @@ export declare const VendorShippingApiFp: (configuration?: Configuration) => {
|
|
|
118
155
|
submitShipments(body: SubmitShipments, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubmitShipmentConfirmationsResponse>>;
|
|
119
156
|
};
|
|
120
157
|
/**
|
|
121
|
-
*
|
|
158
|
+
* VendorShipmentsApi - factory interface
|
|
122
159
|
* @export
|
|
123
160
|
*/
|
|
124
|
-
export declare const
|
|
161
|
+
export declare const VendorShipmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
125
162
|
/**
|
|
126
163
|
* 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).
|
|
127
|
-
* @
|
|
164
|
+
* @summary GetShipmentDetails
|
|
165
|
+
* @param {VendorShipmentsApiGetShipmentDetailsRequest} requestParameters Request parameters.
|
|
128
166
|
* @param {*} [options] Override http request option.
|
|
129
167
|
* @throws {RequiredError}
|
|
130
168
|
*/
|
|
131
|
-
getShipmentDetails(requestParameters?:
|
|
169
|
+
getShipmentDetails(requestParameters?: VendorShipmentsApiGetShipmentDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentDetailsResponse>;
|
|
170
|
+
/**
|
|
171
|
+
* Returns transport Labels based on the filters 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).
|
|
172
|
+
* @summary GetShipmentLabels
|
|
173
|
+
* @param {VendorShipmentsApiGetShipmentLabelsRequest} requestParameters Request parameters.
|
|
174
|
+
* @param {*} [options] Override http request option.
|
|
175
|
+
* @throws {RequiredError}
|
|
176
|
+
*/
|
|
177
|
+
getShipmentLabels(requestParameters?: VendorShipmentsApiGetShipmentLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentLabels>;
|
|
132
178
|
/**
|
|
133
179
|
* 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).
|
|
134
|
-
* @
|
|
180
|
+
* @summary SubmitShipmentConfirmations
|
|
181
|
+
* @param {VendorShipmentsApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
135
182
|
* @param {*} [options] Override http request option.
|
|
136
183
|
* @throws {RequiredError}
|
|
137
184
|
*/
|
|
138
|
-
submitShipmentConfirmations(requestParameters:
|
|
185
|
+
submitShipmentConfirmations(requestParameters: VendorShipmentsApiSubmitShipmentConfirmationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SubmitShipmentConfirmationsResponse>;
|
|
139
186
|
/**
|
|
140
187
|
* 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).
|
|
141
|
-
* @
|
|
188
|
+
* @summary SubmitShipments
|
|
189
|
+
* @param {VendorShipmentsApiSubmitShipmentsRequest} requestParameters Request parameters.
|
|
142
190
|
* @param {*} [options] Override http request option.
|
|
143
191
|
* @throws {RequiredError}
|
|
144
192
|
*/
|
|
145
|
-
submitShipments(requestParameters:
|
|
193
|
+
submitShipments(requestParameters: VendorShipmentsApiSubmitShipmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SubmitShipmentConfirmationsResponse>;
|
|
146
194
|
};
|
|
147
195
|
/**
|
|
148
|
-
* Request parameters for getShipmentDetails operation in
|
|
196
|
+
* Request parameters for getShipmentDetails operation in VendorShipmentsApi.
|
|
149
197
|
* @export
|
|
150
|
-
* @interface
|
|
198
|
+
* @interface VendorShipmentsApiGetShipmentDetailsRequest
|
|
151
199
|
*/
|
|
152
|
-
export interface
|
|
200
|
+
export interface VendorShipmentsApiGetShipmentDetailsRequest {
|
|
153
201
|
/**
|
|
154
202
|
* The limit to the number of records returned. Default value is 50 records.
|
|
155
203
|
* @type {number}
|
|
156
|
-
* @memberof
|
|
204
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
157
205
|
*/
|
|
158
206
|
readonly limit?: number;
|
|
159
207
|
/**
|
|
160
208
|
* Sort in ascending or descending order by purchase order creation date.
|
|
161
209
|
* @type {'ASC' | 'DESC'}
|
|
162
|
-
* @memberof
|
|
210
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
163
211
|
*/
|
|
164
212
|
readonly sortOrder?: GetShipmentDetailsSortOrderEnum;
|
|
165
213
|
/**
|
|
166
214
|
* Used for pagination when there are more shipments than the specified result size limit.
|
|
167
215
|
* @type {string}
|
|
168
|
-
* @memberof
|
|
216
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
169
217
|
*/
|
|
170
218
|
readonly nextToken?: string;
|
|
171
219
|
/**
|
|
172
220
|
* 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.
|
|
173
221
|
* @type {string}
|
|
174
|
-
* @memberof
|
|
222
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
175
223
|
*/
|
|
176
224
|
readonly createdAfter?: string;
|
|
177
225
|
/**
|
|
178
226
|
* 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.
|
|
179
227
|
* @type {string}
|
|
180
|
-
* @memberof
|
|
228
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
181
229
|
*/
|
|
182
230
|
readonly createdBefore?: string;
|
|
183
231
|
/**
|
|
184
232
|
* 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.
|
|
185
233
|
* @type {string}
|
|
186
|
-
* @memberof
|
|
234
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
187
235
|
*/
|
|
188
236
|
readonly shipmentConfirmedBefore?: string;
|
|
189
237
|
/**
|
|
190
238
|
* 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.
|
|
191
239
|
* @type {string}
|
|
192
|
-
* @memberof
|
|
240
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
193
241
|
*/
|
|
194
242
|
readonly shipmentConfirmedAfter?: string;
|
|
195
243
|
/**
|
|
196
244
|
* 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.
|
|
197
245
|
* @type {string}
|
|
198
|
-
* @memberof
|
|
246
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
199
247
|
*/
|
|
200
248
|
readonly packageLabelCreatedBefore?: string;
|
|
201
249
|
/**
|
|
202
250
|
* 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.
|
|
203
251
|
* @type {string}
|
|
204
|
-
* @memberof
|
|
252
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
205
253
|
*/
|
|
206
254
|
readonly packageLabelCreatedAfter?: string;
|
|
207
255
|
/**
|
|
208
256
|
* 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.
|
|
209
257
|
* @type {string}
|
|
210
|
-
* @memberof
|
|
258
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
211
259
|
*/
|
|
212
260
|
readonly shippedBefore?: string;
|
|
213
261
|
/**
|
|
214
262
|
* 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.
|
|
215
263
|
* @type {string}
|
|
216
|
-
* @memberof
|
|
264
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
217
265
|
*/
|
|
218
266
|
readonly shippedAfter?: string;
|
|
219
267
|
/**
|
|
220
268
|
* 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.
|
|
221
269
|
* @type {string}
|
|
222
|
-
* @memberof
|
|
270
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
223
271
|
*/
|
|
224
272
|
readonly estimatedDeliveryBefore?: string;
|
|
225
273
|
/**
|
|
226
274
|
* 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.
|
|
227
275
|
* @type {string}
|
|
228
|
-
* @memberof
|
|
276
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
229
277
|
*/
|
|
230
278
|
readonly estimatedDeliveryAfter?: string;
|
|
231
279
|
/**
|
|
232
280
|
* 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.
|
|
233
281
|
* @type {string}
|
|
234
|
-
* @memberof
|
|
282
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
235
283
|
*/
|
|
236
284
|
readonly shipmentDeliveryBefore?: string;
|
|
237
285
|
/**
|
|
238
286
|
* 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.
|
|
239
287
|
* @type {string}
|
|
240
|
-
* @memberof
|
|
288
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
241
289
|
*/
|
|
242
290
|
readonly shipmentDeliveryAfter?: string;
|
|
243
291
|
/**
|
|
244
292
|
* 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.
|
|
245
293
|
* @type {string}
|
|
246
|
-
* @memberof
|
|
294
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
247
295
|
*/
|
|
248
296
|
readonly requestedPickUpBefore?: string;
|
|
249
297
|
/**
|
|
250
298
|
* 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.
|
|
251
299
|
* @type {string}
|
|
252
|
-
* @memberof
|
|
300
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
253
301
|
*/
|
|
254
302
|
readonly requestedPickUpAfter?: string;
|
|
255
303
|
/**
|
|
256
304
|
* 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.
|
|
257
305
|
* @type {string}
|
|
258
|
-
* @memberof
|
|
306
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
259
307
|
*/
|
|
260
308
|
readonly scheduledPickUpBefore?: string;
|
|
261
309
|
/**
|
|
262
310
|
* 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.
|
|
263
311
|
* @type {string}
|
|
264
|
-
* @memberof
|
|
312
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
265
313
|
*/
|
|
266
314
|
readonly scheduledPickUpAfter?: string;
|
|
267
315
|
/**
|
|
268
316
|
* Get Shipment Details by passing Current shipment status.
|
|
269
317
|
* @type {string}
|
|
270
|
-
* @memberof
|
|
318
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
271
319
|
*/
|
|
272
320
|
readonly currentShipmentStatus?: string;
|
|
273
321
|
/**
|
|
274
322
|
* Get Shipment Details by passing Vendor Shipment ID
|
|
275
323
|
* @type {string}
|
|
276
|
-
* @memberof
|
|
324
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
277
325
|
*/
|
|
278
326
|
readonly vendorShipmentIdentifier?: string;
|
|
279
327
|
/**
|
|
280
328
|
* Get Shipment Details by passing buyer Reference ID
|
|
281
329
|
* @type {string}
|
|
282
|
-
* @memberof
|
|
330
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
283
331
|
*/
|
|
284
332
|
readonly buyerReferenceNumber?: string;
|
|
285
333
|
/**
|
|
286
334
|
* Get Shipping Details based on buyer warehouse code. This value should be same as \'shipToParty.partyId\' in the Shipment.
|
|
287
335
|
* @type {string}
|
|
288
|
-
* @memberof
|
|
336
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
289
337
|
*/
|
|
290
338
|
readonly buyerWarehouseCode?: string;
|
|
291
339
|
/**
|
|
292
340
|
* Get Shipping Details based on vendor warehouse code. This value should be same as \'sellingParty.partyId\' in the Shipment.
|
|
293
341
|
* @type {string}
|
|
294
|
-
* @memberof
|
|
342
|
+
* @memberof VendorShipmentsApiGetShipmentDetails
|
|
343
|
+
*/
|
|
344
|
+
readonly sellerWarehouseCode?: string;
|
|
345
|
+
}
|
|
346
|
+
/**
|
|
347
|
+
* Request parameters for getShipmentLabels operation in VendorShipmentsApi.
|
|
348
|
+
* @export
|
|
349
|
+
* @interface VendorShipmentsApiGetShipmentLabelsRequest
|
|
350
|
+
*/
|
|
351
|
+
export interface VendorShipmentsApiGetShipmentLabelsRequest {
|
|
352
|
+
/**
|
|
353
|
+
* The limit to the number of records returned. Default value is 50 records.
|
|
354
|
+
* @type {number}
|
|
355
|
+
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
356
|
+
*/
|
|
357
|
+
readonly limit?: number;
|
|
358
|
+
/**
|
|
359
|
+
* Sort in ascending or descending order by transport label creation date.
|
|
360
|
+
* @type {'ASC' | 'DESC'}
|
|
361
|
+
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
362
|
+
*/
|
|
363
|
+
readonly sortOrder?: GetShipmentLabelsSortOrderEnum;
|
|
364
|
+
/**
|
|
365
|
+
* Used for pagination when there are more transport label than the specified result size limit.
|
|
366
|
+
* @type {string}
|
|
367
|
+
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
368
|
+
*/
|
|
369
|
+
readonly nextToken?: string;
|
|
370
|
+
/**
|
|
371
|
+
* transport Labels that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
372
|
+
* @type {string}
|
|
373
|
+
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
374
|
+
*/
|
|
375
|
+
readonly labelCreatedAfter?: string;
|
|
376
|
+
/**
|
|
377
|
+
* transport Labels that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
378
|
+
* @type {string}
|
|
379
|
+
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
380
|
+
*/
|
|
381
|
+
readonly labelcreatedBefore?: string;
|
|
382
|
+
/**
|
|
383
|
+
* Get transport labels by passing Buyer Reference Number to retreive the corresponding transport label.
|
|
384
|
+
* @type {string}
|
|
385
|
+
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
386
|
+
*/
|
|
387
|
+
readonly buyerReferenceNumber?: string;
|
|
388
|
+
/**
|
|
389
|
+
* Get transport labels by passing Vendor Shipment ID to retreive the corresponding transport label.
|
|
390
|
+
* @type {string}
|
|
391
|
+
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
392
|
+
*/
|
|
393
|
+
readonly vendorShipmentIdentifier?: string;
|
|
394
|
+
/**
|
|
395
|
+
* Get Shipping labels based Vendor Warehouse code. This value should be same as \'shipFromParty.partyId\' in the Shipment.
|
|
396
|
+
* @type {string}
|
|
397
|
+
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
295
398
|
*/
|
|
296
399
|
readonly sellerWarehouseCode?: string;
|
|
297
400
|
}
|
|
298
401
|
/**
|
|
299
|
-
* Request parameters for submitShipmentConfirmations operation in
|
|
402
|
+
* Request parameters for submitShipmentConfirmations operation in VendorShipmentsApi.
|
|
300
403
|
* @export
|
|
301
|
-
* @interface
|
|
404
|
+
* @interface VendorShipmentsApiSubmitShipmentConfirmationsRequest
|
|
302
405
|
*/
|
|
303
|
-
export interface
|
|
406
|
+
export interface VendorShipmentsApiSubmitShipmentConfirmationsRequest {
|
|
304
407
|
/**
|
|
305
408
|
* A request to submit shipment confirmation.
|
|
306
409
|
* @type {SubmitShipmentConfirmationsRequest}
|
|
307
|
-
* @memberof
|
|
410
|
+
* @memberof VendorShipmentsApiSubmitShipmentConfirmations
|
|
308
411
|
*/
|
|
309
412
|
readonly body: SubmitShipmentConfirmationsRequest;
|
|
310
413
|
}
|
|
311
414
|
/**
|
|
312
|
-
* Request parameters for submitShipments operation in
|
|
415
|
+
* Request parameters for submitShipments operation in VendorShipmentsApi.
|
|
313
416
|
* @export
|
|
314
|
-
* @interface
|
|
417
|
+
* @interface VendorShipmentsApiSubmitShipmentsRequest
|
|
315
418
|
*/
|
|
316
|
-
export interface
|
|
419
|
+
export interface VendorShipmentsApiSubmitShipmentsRequest {
|
|
317
420
|
/**
|
|
318
421
|
* A request to submit shipment request.
|
|
319
422
|
* @type {SubmitShipments}
|
|
320
|
-
* @memberof
|
|
423
|
+
* @memberof VendorShipmentsApiSubmitShipments
|
|
321
424
|
*/
|
|
322
425
|
readonly body: SubmitShipments;
|
|
323
426
|
}
|
|
324
427
|
/**
|
|
325
|
-
*
|
|
428
|
+
* VendorShipmentsApi - object-oriented interface
|
|
326
429
|
* @export
|
|
327
|
-
* @class
|
|
430
|
+
* @class VendorShipmentsApi
|
|
328
431
|
* @extends {BaseAPI}
|
|
329
432
|
*/
|
|
330
|
-
export declare class
|
|
433
|
+
export declare class VendorShipmentsApi extends BaseAPI {
|
|
331
434
|
/**
|
|
332
435
|
* 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).
|
|
333
|
-
* @
|
|
436
|
+
* @summary GetShipmentDetails
|
|
437
|
+
* @param {VendorShipmentsApiGetShipmentDetailsRequest} requestParameters Request parameters.
|
|
438
|
+
* @param {*} [options] Override http request option.
|
|
439
|
+
* @throws {RequiredError}
|
|
440
|
+
* @memberof VendorShipmentsApi
|
|
441
|
+
*/
|
|
442
|
+
getShipmentDetails(requestParameters?: VendorShipmentsApiGetShipmentDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentDetailsResponse, any>>;
|
|
443
|
+
/**
|
|
444
|
+
* Returns transport Labels based on the filters 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).
|
|
445
|
+
* @summary GetShipmentLabels
|
|
446
|
+
* @param {VendorShipmentsApiGetShipmentLabelsRequest} requestParameters Request parameters.
|
|
334
447
|
* @param {*} [options] Override http request option.
|
|
335
448
|
* @throws {RequiredError}
|
|
336
|
-
* @memberof
|
|
449
|
+
* @memberof VendorShipmentsApi
|
|
337
450
|
*/
|
|
338
|
-
|
|
451
|
+
getShipmentLabels(requestParameters?: VendorShipmentsApiGetShipmentLabelsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentLabels, any>>;
|
|
339
452
|
/**
|
|
340
453
|
* 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).
|
|
341
|
-
* @
|
|
454
|
+
* @summary SubmitShipmentConfirmations
|
|
455
|
+
* @param {VendorShipmentsApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
342
456
|
* @param {*} [options] Override http request option.
|
|
343
457
|
* @throws {RequiredError}
|
|
344
|
-
* @memberof
|
|
458
|
+
* @memberof VendorShipmentsApi
|
|
345
459
|
*/
|
|
346
|
-
submitShipmentConfirmations(requestParameters:
|
|
460
|
+
submitShipmentConfirmations(requestParameters: VendorShipmentsApiSubmitShipmentConfirmationsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShipmentConfirmationsResponse, any>>;
|
|
347
461
|
/**
|
|
348
462
|
* 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).
|
|
349
|
-
* @
|
|
463
|
+
* @summary SubmitShipments
|
|
464
|
+
* @param {VendorShipmentsApiSubmitShipmentsRequest} requestParameters Request parameters.
|
|
350
465
|
* @param {*} [options] Override http request option.
|
|
351
466
|
* @throws {RequiredError}
|
|
352
|
-
* @memberof
|
|
467
|
+
* @memberof VendorShipmentsApi
|
|
353
468
|
*/
|
|
354
|
-
submitShipments(requestParameters:
|
|
469
|
+
submitShipments(requestParameters: VendorShipmentsApiSubmitShipmentsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShipmentConfirmationsResponse, any>>;
|
|
355
470
|
}
|
|
356
471
|
/**
|
|
357
472
|
* @export
|
|
@@ -361,3 +476,11 @@ export declare const GetShipmentDetailsSortOrderEnum: {
|
|
|
361
476
|
readonly Desc: "DESC";
|
|
362
477
|
};
|
|
363
478
|
export type GetShipmentDetailsSortOrderEnum = typeof GetShipmentDetailsSortOrderEnum[keyof typeof GetShipmentDetailsSortOrderEnum];
|
|
479
|
+
/**
|
|
480
|
+
* @export
|
|
481
|
+
*/
|
|
482
|
+
export declare const GetShipmentLabelsSortOrderEnum: {
|
|
483
|
+
readonly Asc: "ASC";
|
|
484
|
+
readonly Desc: "DESC";
|
|
485
|
+
};
|
|
486
|
+
export type GetShipmentLabelsSortOrderEnum = typeof GetShipmentLabelsSortOrderEnum[keyof typeof GetShipmentLabelsSortOrderEnum];
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* Vendor Shipments v1
|
|
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-shipments-api';
|