@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1 2.5.2 → 2.6.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 +58 -58
- package/dist/es/api-model/api/vendor-shipping-api.js +58 -58
- package/dist/types/api-model/api/vendor-shipping-api.d.ts +69 -69
- package/dist/types/api-model/models/customer-invoice-list.d.ts +1 -1
- package/dist/types/api-model/models/customer-invoice.d.ts +1 -1
- package/dist/types/api-model/models/get-customer-invoice-response.d.ts +1 -1
- package/dist/types/api-model/models/get-customer-invoices-response.d.ts +1 -1
- package/dist/types/api-model/models/get-packing-slip-list-response.d.ts +1 -1
- package/dist/types/api-model/models/get-shipping-label-list-response.d.ts +1 -1
- package/dist/types/api-model/models/get-shipping-label-response.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 +1 -1
- package/dist/types/api-model/models/packed-item.d.ts +1 -1
- package/dist/types/api-model/models/pagination.d.ts +1 -1
- package/dist/types/api-model/models/status-update-details-shipment-schedule.d.ts +3 -3
- package/dist/types/api-model/models/status-update-details.d.ts +4 -4
- package/dist/types/api-model/models/submit-shipment-confirmations-request.d.ts +2 -2
- package/dist/types/api-model/models/submit-shipment-confirmations-response.d.ts +1 -1
- package/dist/types/api-model/models/submit-shipment-status-updates-request.d.ts +2 -2
- package/dist/types/api-model/models/submit-shipment-status-updates-response.d.ts +1 -1
- package/dist/types/api-model/models/submit-shipping-labels-request.d.ts +1 -1
- package/dist/types/api-model/models/submit-shipping-labels-response.d.ts +1 -1
- package/package.json +2 -2
|
@@ -31,17 +31,17 @@ import type { SubmitShippingLabelsResponse } from '../models';
|
|
|
31
31
|
*/
|
|
32
32
|
export declare const VendorShippingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
33
33
|
/**
|
|
34
|
-
* Returns a customer invoice based on the
|
|
34
|
+
* Returns a customer invoice based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
35
35
|
* @param {string} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice.
|
|
36
36
|
* @param {*} [options] Override http request option.
|
|
37
37
|
* @throws {RequiredError}
|
|
38
38
|
*/
|
|
39
39
|
getCustomerInvoice: (purchaseOrderNumber: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
40
|
/**
|
|
41
|
-
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the
|
|
42
|
-
* @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in
|
|
43
|
-
* @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in
|
|
44
|
-
* @param {string} [shipFromPartyId] The vendor
|
|
41
|
+
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
42
|
+
* @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
43
|
+
* @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
44
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
45
45
|
* @param {number} [limit] The limit to the number of records returned
|
|
46
46
|
* @param {GetCustomerInvoicesSortOrderEnum} [sortOrder] Sort ASC or DESC by order creation date.
|
|
47
47
|
* @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
|
|
@@ -50,17 +50,17 @@ export declare const VendorShippingApiAxiosParamCreator: (configuration?: Config
|
|
|
50
50
|
*/
|
|
51
51
|
getCustomerInvoices: (createdAfter: string, createdBefore: string, shipFromPartyId?: string, limit?: number, sortOrder?: GetCustomerInvoicesSortOrderEnum, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
52
|
/**
|
|
53
|
-
* Returns a packing slip based on the
|
|
54
|
-
* @param {string} purchaseOrderNumber The
|
|
53
|
+
* Returns a packing slip based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
54
|
+
* @param {string} purchaseOrderNumber The purchaseOrderNumber for the packing slip you want.
|
|
55
55
|
* @param {*} [options] Override http request option.
|
|
56
56
|
* @throws {RequiredError}
|
|
57
57
|
*/
|
|
58
58
|
getPackingSlip: (purchaseOrderNumber: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
59
|
/**
|
|
60
|
-
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information,
|
|
61
|
-
* @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in
|
|
62
|
-
* @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in
|
|
63
|
-
* @param {string} [shipFromPartyId] The vendor
|
|
60
|
+
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
61
|
+
* @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
62
|
+
* @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
63
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
64
64
|
* @param {number} [limit] The limit to the number of records returned
|
|
65
65
|
* @param {GetPackingSlipsSortOrderEnum} [sortOrder] Sort ASC or DESC by packing slip creation date.
|
|
66
66
|
* @param {string} [nextToken] Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.
|
|
@@ -69,17 +69,17 @@ export declare const VendorShippingApiAxiosParamCreator: (configuration?: Config
|
|
|
69
69
|
*/
|
|
70
70
|
getPackingSlips: (createdAfter: string, createdBefore: string, shipFromPartyId?: string, limit?: number, sortOrder?: GetPackingSlipsSortOrderEnum, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71
71
|
/**
|
|
72
|
-
* Returns a shipping label for the
|
|
73
|
-
* @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same
|
|
72
|
+
* Returns a shipping label for the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
73
|
+
* @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
|
|
74
74
|
* @param {*} [options] Override http request option.
|
|
75
75
|
* @throws {RequiredError}
|
|
76
76
|
*/
|
|
77
77
|
getShippingLabel: (purchaseOrderNumber: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
78
|
/**
|
|
79
|
-
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the
|
|
80
|
-
* @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in
|
|
81
|
-
* @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in
|
|
82
|
-
* @param {string} [shipFromPartyId] The vendor
|
|
79
|
+
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
80
|
+
* @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
81
|
+
* @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
82
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
83
83
|
* @param {number} [limit] The limit to the number of records returned.
|
|
84
84
|
* @param {GetShippingLabelsSortOrderEnum} [sortOrder] Sort ASC or DESC by order creation date.
|
|
85
85
|
* @param {string} [nextToken] Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.
|
|
@@ -88,21 +88,21 @@ export declare const VendorShippingApiAxiosParamCreator: (configuration?: Config
|
|
|
88
88
|
*/
|
|
89
89
|
getShippingLabels: (createdAfter: string, createdBefore: string, shipFromPartyId?: string, limit?: number, sortOrder?: GetShippingLabelsSortOrderEnum, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
90
90
|
/**
|
|
91
|
-
* 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,
|
|
91
|
+
* 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).
|
|
92
92
|
* @param {SubmitShipmentConfirmationsRequest} body Request body containing the shipment confirmations data.
|
|
93
93
|
* @param {*} [options] Override http request option.
|
|
94
94
|
* @throws {RequiredError}
|
|
95
95
|
*/
|
|
96
96
|
submitShipmentConfirmations: (body: SubmitShipmentConfirmationsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
97
97
|
/**
|
|
98
|
-
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information,
|
|
98
|
+
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
99
99
|
* @param {SubmitShipmentStatusUpdatesRequest} body Request body containing the shipment status update data.
|
|
100
100
|
* @param {*} [options] Override http request option.
|
|
101
101
|
* @throws {RequiredError}
|
|
102
102
|
*/
|
|
103
103
|
submitShipmentStatusUpdates: (body: SubmitShipmentStatusUpdatesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
104
104
|
/**
|
|
105
|
-
* Creates a shipping label for a purchase order and returns a
|
|
105
|
+
* Creates a shipping label for a purchase order and returns a transactionId for reference. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
106
106
|
* @param {SubmitShippingLabelsRequest} body Request body containing one or more shipping labels data.
|
|
107
107
|
* @param {*} [options] Override http request option.
|
|
108
108
|
* @throws {RequiredError}
|
|
@@ -115,17 +115,17 @@ export declare const VendorShippingApiAxiosParamCreator: (configuration?: Config
|
|
|
115
115
|
*/
|
|
116
116
|
export declare const VendorShippingApiFp: (configuration?: Configuration) => {
|
|
117
117
|
/**
|
|
118
|
-
* Returns a customer invoice based on the
|
|
118
|
+
* Returns a customer invoice based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
119
119
|
* @param {string} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice.
|
|
120
120
|
* @param {*} [options] Override http request option.
|
|
121
121
|
* @throws {RequiredError}
|
|
122
122
|
*/
|
|
123
123
|
getCustomerInvoice(purchaseOrderNumber: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomerInvoiceResponse>>;
|
|
124
124
|
/**
|
|
125
|
-
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the
|
|
126
|
-
* @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in
|
|
127
|
-
* @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in
|
|
128
|
-
* @param {string} [shipFromPartyId] The vendor
|
|
125
|
+
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
126
|
+
* @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
127
|
+
* @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
128
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
129
129
|
* @param {number} [limit] The limit to the number of records returned
|
|
130
130
|
* @param {GetCustomerInvoicesSortOrderEnum} [sortOrder] Sort ASC or DESC by order creation date.
|
|
131
131
|
* @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
|
|
@@ -134,17 +134,17 @@ export declare const VendorShippingApiFp: (configuration?: Configuration) => {
|
|
|
134
134
|
*/
|
|
135
135
|
getCustomerInvoices(createdAfter: string, createdBefore: string, shipFromPartyId?: string, limit?: number, sortOrder?: GetCustomerInvoicesSortOrderEnum, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomerInvoicesResponse>>;
|
|
136
136
|
/**
|
|
137
|
-
* Returns a packing slip based on the
|
|
138
|
-
* @param {string} purchaseOrderNumber The
|
|
137
|
+
* Returns a packing slip based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
138
|
+
* @param {string} purchaseOrderNumber The purchaseOrderNumber for the packing slip you want.
|
|
139
139
|
* @param {*} [options] Override http request option.
|
|
140
140
|
* @throws {RequiredError}
|
|
141
141
|
*/
|
|
142
142
|
getPackingSlip(purchaseOrderNumber: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPackingSlipResponse>>;
|
|
143
143
|
/**
|
|
144
|
-
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information,
|
|
145
|
-
* @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in
|
|
146
|
-
* @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in
|
|
147
|
-
* @param {string} [shipFromPartyId] The vendor
|
|
144
|
+
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
145
|
+
* @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
146
|
+
* @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
147
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
148
148
|
* @param {number} [limit] The limit to the number of records returned
|
|
149
149
|
* @param {GetPackingSlipsSortOrderEnum} [sortOrder] Sort ASC or DESC by packing slip creation date.
|
|
150
150
|
* @param {string} [nextToken] Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.
|
|
@@ -153,17 +153,17 @@ export declare const VendorShippingApiFp: (configuration?: Configuration) => {
|
|
|
153
153
|
*/
|
|
154
154
|
getPackingSlips(createdAfter: string, createdBefore: string, shipFromPartyId?: string, limit?: number, sortOrder?: GetPackingSlipsSortOrderEnum, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPackingSlipListResponse>>;
|
|
155
155
|
/**
|
|
156
|
-
* Returns a shipping label for the
|
|
157
|
-
* @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same
|
|
156
|
+
* Returns a shipping label for the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
157
|
+
* @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
|
|
158
158
|
* @param {*} [options] Override http request option.
|
|
159
159
|
* @throws {RequiredError}
|
|
160
160
|
*/
|
|
161
161
|
getShippingLabel(purchaseOrderNumber: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShippingLabelResponse>>;
|
|
162
162
|
/**
|
|
163
|
-
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the
|
|
164
|
-
* @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in
|
|
165
|
-
* @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in
|
|
166
|
-
* @param {string} [shipFromPartyId] The vendor
|
|
163
|
+
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
164
|
+
* @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
165
|
+
* @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
166
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
167
167
|
* @param {number} [limit] The limit to the number of records returned.
|
|
168
168
|
* @param {GetShippingLabelsSortOrderEnum} [sortOrder] Sort ASC or DESC by order creation date.
|
|
169
169
|
* @param {string} [nextToken] Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.
|
|
@@ -172,21 +172,21 @@ export declare const VendorShippingApiFp: (configuration?: Configuration) => {
|
|
|
172
172
|
*/
|
|
173
173
|
getShippingLabels(createdAfter: string, createdBefore: string, shipFromPartyId?: string, limit?: number, sortOrder?: GetShippingLabelsSortOrderEnum, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShippingLabelListResponse>>;
|
|
174
174
|
/**
|
|
175
|
-
* 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,
|
|
175
|
+
* 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).
|
|
176
176
|
* @param {SubmitShipmentConfirmationsRequest} body Request body containing the shipment confirmations data.
|
|
177
177
|
* @param {*} [options] Override http request option.
|
|
178
178
|
* @throws {RequiredError}
|
|
179
179
|
*/
|
|
180
180
|
submitShipmentConfirmations(body: SubmitShipmentConfirmationsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubmitShipmentConfirmationsResponse>>;
|
|
181
181
|
/**
|
|
182
|
-
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information,
|
|
182
|
+
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
183
183
|
* @param {SubmitShipmentStatusUpdatesRequest} body Request body containing the shipment status update data.
|
|
184
184
|
* @param {*} [options] Override http request option.
|
|
185
185
|
* @throws {RequiredError}
|
|
186
186
|
*/
|
|
187
187
|
submitShipmentStatusUpdates(body: SubmitShipmentStatusUpdatesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubmitShipmentStatusUpdatesResponse>>;
|
|
188
188
|
/**
|
|
189
|
-
* Creates a shipping label for a purchase order and returns a
|
|
189
|
+
* Creates a shipping label for a purchase order and returns a transactionId for reference. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
190
190
|
* @param {SubmitShippingLabelsRequest} body Request body containing one or more shipping labels data.
|
|
191
191
|
* @param {*} [options] Override http request option.
|
|
192
192
|
* @throws {RequiredError}
|
|
@@ -199,63 +199,63 @@ export declare const VendorShippingApiFp: (configuration?: Configuration) => {
|
|
|
199
199
|
*/
|
|
200
200
|
export declare const VendorShippingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
201
201
|
/**
|
|
202
|
-
* Returns a customer invoice based on the
|
|
202
|
+
* Returns a customer invoice based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
203
203
|
* @param {VendorShippingApiGetCustomerInvoiceRequest} requestParameters Request parameters.
|
|
204
204
|
* @param {*} [options] Override http request option.
|
|
205
205
|
* @throws {RequiredError}
|
|
206
206
|
*/
|
|
207
207
|
getCustomerInvoice(requestParameters: VendorShippingApiGetCustomerInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCustomerInvoiceResponse>;
|
|
208
208
|
/**
|
|
209
|
-
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the
|
|
209
|
+
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
210
210
|
* @param {VendorShippingApiGetCustomerInvoicesRequest} requestParameters Request parameters.
|
|
211
211
|
* @param {*} [options] Override http request option.
|
|
212
212
|
* @throws {RequiredError}
|
|
213
213
|
*/
|
|
214
214
|
getCustomerInvoices(requestParameters: VendorShippingApiGetCustomerInvoicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCustomerInvoicesResponse>;
|
|
215
215
|
/**
|
|
216
|
-
* Returns a packing slip based on the
|
|
216
|
+
* Returns a packing slip based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
217
217
|
* @param {VendorShippingApiGetPackingSlipRequest} requestParameters Request parameters.
|
|
218
218
|
* @param {*} [options] Override http request option.
|
|
219
219
|
* @throws {RequiredError}
|
|
220
220
|
*/
|
|
221
221
|
getPackingSlip(requestParameters: VendorShippingApiGetPackingSlipRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPackingSlipResponse>;
|
|
222
222
|
/**
|
|
223
|
-
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information,
|
|
223
|
+
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
224
224
|
* @param {VendorShippingApiGetPackingSlipsRequest} requestParameters Request parameters.
|
|
225
225
|
* @param {*} [options] Override http request option.
|
|
226
226
|
* @throws {RequiredError}
|
|
227
227
|
*/
|
|
228
228
|
getPackingSlips(requestParameters: VendorShippingApiGetPackingSlipsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPackingSlipListResponse>;
|
|
229
229
|
/**
|
|
230
|
-
* Returns a shipping label for the
|
|
230
|
+
* Returns a shipping label for the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
231
231
|
* @param {VendorShippingApiGetShippingLabelRequest} requestParameters Request parameters.
|
|
232
232
|
* @param {*} [options] Override http request option.
|
|
233
233
|
* @throws {RequiredError}
|
|
234
234
|
*/
|
|
235
235
|
getShippingLabel(requestParameters: VendorShippingApiGetShippingLabelRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShippingLabelResponse>;
|
|
236
236
|
/**
|
|
237
|
-
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the
|
|
237
|
+
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
238
238
|
* @param {VendorShippingApiGetShippingLabelsRequest} requestParameters Request parameters.
|
|
239
239
|
* @param {*} [options] Override http request option.
|
|
240
240
|
* @throws {RequiredError}
|
|
241
241
|
*/
|
|
242
242
|
getShippingLabels(requestParameters: VendorShippingApiGetShippingLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShippingLabelListResponse>;
|
|
243
243
|
/**
|
|
244
|
-
* 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,
|
|
244
|
+
* 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).
|
|
245
245
|
* @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
246
246
|
* @param {*} [options] Override http request option.
|
|
247
247
|
* @throws {RequiredError}
|
|
248
248
|
*/
|
|
249
249
|
submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SubmitShipmentConfirmationsResponse>;
|
|
250
250
|
/**
|
|
251
|
-
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information,
|
|
251
|
+
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
252
252
|
* @param {VendorShippingApiSubmitShipmentStatusUpdatesRequest} requestParameters Request parameters.
|
|
253
253
|
* @param {*} [options] Override http request option.
|
|
254
254
|
* @throws {RequiredError}
|
|
255
255
|
*/
|
|
256
256
|
submitShipmentStatusUpdates(requestParameters: VendorShippingApiSubmitShipmentStatusUpdatesRequest, options?: RawAxiosRequestConfig): AxiosPromise<SubmitShipmentStatusUpdatesResponse>;
|
|
257
257
|
/**
|
|
258
|
-
* Creates a shipping label for a purchase order and returns a
|
|
258
|
+
* Creates a shipping label for a purchase order and returns a transactionId for reference. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
259
259
|
* @param {VendorShippingApiSubmitShippingLabelRequestRequest} requestParameters Request parameters.
|
|
260
260
|
* @param {*} [options] Override http request option.
|
|
261
261
|
* @throws {RequiredError}
|
|
@@ -282,19 +282,19 @@ export interface VendorShippingApiGetCustomerInvoiceRequest {
|
|
|
282
282
|
*/
|
|
283
283
|
export interface VendorShippingApiGetCustomerInvoicesRequest {
|
|
284
284
|
/**
|
|
285
|
-
* Orders that became available after this date and time will be included in the result. Must be in
|
|
285
|
+
* Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
286
286
|
* @type {string}
|
|
287
287
|
* @memberof VendorShippingApiGetCustomerInvoices
|
|
288
288
|
*/
|
|
289
289
|
readonly createdAfter: string;
|
|
290
290
|
/**
|
|
291
|
-
* Orders that became available before this date and time will be included in the result. Must be in
|
|
291
|
+
* Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
292
292
|
* @type {string}
|
|
293
293
|
* @memberof VendorShippingApiGetCustomerInvoices
|
|
294
294
|
*/
|
|
295
295
|
readonly createdBefore: string;
|
|
296
296
|
/**
|
|
297
|
-
* The vendor
|
|
297
|
+
* The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
298
298
|
* @type {string}
|
|
299
299
|
* @memberof VendorShippingApiGetCustomerInvoices
|
|
300
300
|
*/
|
|
@@ -325,7 +325,7 @@ export interface VendorShippingApiGetCustomerInvoicesRequest {
|
|
|
325
325
|
*/
|
|
326
326
|
export interface VendorShippingApiGetPackingSlipRequest {
|
|
327
327
|
/**
|
|
328
|
-
* The
|
|
328
|
+
* The purchaseOrderNumber for the packing slip you want.
|
|
329
329
|
* @type {string}
|
|
330
330
|
* @memberof VendorShippingApiGetPackingSlip
|
|
331
331
|
*/
|
|
@@ -338,19 +338,19 @@ export interface VendorShippingApiGetPackingSlipRequest {
|
|
|
338
338
|
*/
|
|
339
339
|
export interface VendorShippingApiGetPackingSlipsRequest {
|
|
340
340
|
/**
|
|
341
|
-
* Packing slips that became available after this date and time will be included in the result. Must be in
|
|
341
|
+
* Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
342
342
|
* @type {string}
|
|
343
343
|
* @memberof VendorShippingApiGetPackingSlips
|
|
344
344
|
*/
|
|
345
345
|
readonly createdAfter: string;
|
|
346
346
|
/**
|
|
347
|
-
* Packing slips that became available before this date and time will be included in the result. Must be in
|
|
347
|
+
* Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
348
348
|
* @type {string}
|
|
349
349
|
* @memberof VendorShippingApiGetPackingSlips
|
|
350
350
|
*/
|
|
351
351
|
readonly createdBefore: string;
|
|
352
352
|
/**
|
|
353
|
-
* The vendor
|
|
353
|
+
* The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
354
354
|
* @type {string}
|
|
355
355
|
* @memberof VendorShippingApiGetPackingSlips
|
|
356
356
|
*/
|
|
@@ -381,7 +381,7 @@ export interface VendorShippingApiGetPackingSlipsRequest {
|
|
|
381
381
|
*/
|
|
382
382
|
export interface VendorShippingApiGetShippingLabelRequest {
|
|
383
383
|
/**
|
|
384
|
-
* The purchase order number for which you want to return the shipping label. It should be the same
|
|
384
|
+
* The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
|
|
385
385
|
* @type {string}
|
|
386
386
|
* @memberof VendorShippingApiGetShippingLabel
|
|
387
387
|
*/
|
|
@@ -394,19 +394,19 @@ export interface VendorShippingApiGetShippingLabelRequest {
|
|
|
394
394
|
*/
|
|
395
395
|
export interface VendorShippingApiGetShippingLabelsRequest {
|
|
396
396
|
/**
|
|
397
|
-
* Shipping labels that became available after this date and time will be included in the result. Must be in
|
|
397
|
+
* Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
398
398
|
* @type {string}
|
|
399
399
|
* @memberof VendorShippingApiGetShippingLabels
|
|
400
400
|
*/
|
|
401
401
|
readonly createdAfter: string;
|
|
402
402
|
/**
|
|
403
|
-
* Shipping labels that became available before this date and time will be included in the result. Must be in
|
|
403
|
+
* Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
404
404
|
* @type {string}
|
|
405
405
|
* @memberof VendorShippingApiGetShippingLabels
|
|
406
406
|
*/
|
|
407
407
|
readonly createdBefore: string;
|
|
408
408
|
/**
|
|
409
|
-
* The vendor
|
|
409
|
+
* The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
410
410
|
* @type {string}
|
|
411
411
|
* @memberof VendorShippingApiGetShippingLabels
|
|
412
412
|
*/
|
|
@@ -477,7 +477,7 @@ export interface VendorShippingApiSubmitShippingLabelRequestRequest {
|
|
|
477
477
|
*/
|
|
478
478
|
export declare class VendorShippingApi extends BaseAPI {
|
|
479
479
|
/**
|
|
480
|
-
* Returns a customer invoice based on the
|
|
480
|
+
* Returns a customer invoice based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
481
481
|
* @param {VendorShippingApiGetCustomerInvoiceRequest} requestParameters Request parameters.
|
|
482
482
|
* @param {*} [options] Override http request option.
|
|
483
483
|
* @throws {RequiredError}
|
|
@@ -485,7 +485,7 @@ export declare class VendorShippingApi extends BaseAPI {
|
|
|
485
485
|
*/
|
|
486
486
|
getCustomerInvoice(requestParameters: VendorShippingApiGetCustomerInvoiceRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetCustomerInvoiceResponse, any>>;
|
|
487
487
|
/**
|
|
488
|
-
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the
|
|
488
|
+
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
489
489
|
* @param {VendorShippingApiGetCustomerInvoicesRequest} requestParameters Request parameters.
|
|
490
490
|
* @param {*} [options] Override http request option.
|
|
491
491
|
* @throws {RequiredError}
|
|
@@ -493,7 +493,7 @@ export declare class VendorShippingApi extends BaseAPI {
|
|
|
493
493
|
*/
|
|
494
494
|
getCustomerInvoices(requestParameters: VendorShippingApiGetCustomerInvoicesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetCustomerInvoicesResponse, any>>;
|
|
495
495
|
/**
|
|
496
|
-
* Returns a packing slip based on the
|
|
496
|
+
* Returns a packing slip based on the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
497
497
|
* @param {VendorShippingApiGetPackingSlipRequest} requestParameters Request parameters.
|
|
498
498
|
* @param {*} [options] Override http request option.
|
|
499
499
|
* @throws {RequiredError}
|
|
@@ -501,7 +501,7 @@ export declare class VendorShippingApi extends BaseAPI {
|
|
|
501
501
|
*/
|
|
502
502
|
getPackingSlip(requestParameters: VendorShippingApiGetPackingSlipRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPackingSlipResponse, any>>;
|
|
503
503
|
/**
|
|
504
|
-
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information,
|
|
504
|
+
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
505
505
|
* @param {VendorShippingApiGetPackingSlipsRequest} requestParameters Request parameters.
|
|
506
506
|
* @param {*} [options] Override http request option.
|
|
507
507
|
* @throws {RequiredError}
|
|
@@ -509,7 +509,7 @@ export declare class VendorShippingApi extends BaseAPI {
|
|
|
509
509
|
*/
|
|
510
510
|
getPackingSlips(requestParameters: VendorShippingApiGetPackingSlipsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPackingSlipListResponse, any>>;
|
|
511
511
|
/**
|
|
512
|
-
* Returns a shipping label for the
|
|
512
|
+
* Returns a shipping label for the purchaseOrderNumber that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
513
513
|
* @param {VendorShippingApiGetShippingLabelRequest} requestParameters Request parameters.
|
|
514
514
|
* @param {*} [options] Override http request option.
|
|
515
515
|
* @throws {RequiredError}
|
|
@@ -517,7 +517,7 @@ export declare class VendorShippingApi extends BaseAPI {
|
|
|
517
517
|
*/
|
|
518
518
|
getShippingLabel(requestParameters: VendorShippingApiGetShippingLabelRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShippingLabelResponse, any>>;
|
|
519
519
|
/**
|
|
520
|
-
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the
|
|
520
|
+
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
521
521
|
* @param {VendorShippingApiGetShippingLabelsRequest} requestParameters Request parameters.
|
|
522
522
|
* @param {*} [options] Override http request option.
|
|
523
523
|
* @throws {RequiredError}
|
|
@@ -525,7 +525,7 @@ export declare class VendorShippingApi extends BaseAPI {
|
|
|
525
525
|
*/
|
|
526
526
|
getShippingLabels(requestParameters: VendorShippingApiGetShippingLabelsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShippingLabelListResponse, any>>;
|
|
527
527
|
/**
|
|
528
|
-
* Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information,
|
|
528
|
+
* Submits one or more shipment confirmations for vendor orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
529
529
|
* @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
530
530
|
* @param {*} [options] Override http request option.
|
|
531
531
|
* @throws {RequiredError}
|
|
@@ -533,7 +533,7 @@ export declare class VendorShippingApi extends BaseAPI {
|
|
|
533
533
|
*/
|
|
534
534
|
submitShipmentConfirmations(requestParameters: VendorShippingApiSubmitShipmentConfirmationsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShipmentConfirmationsResponse, any>>;
|
|
535
535
|
/**
|
|
536
|
-
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information,
|
|
536
|
+
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
537
537
|
* @param {VendorShippingApiSubmitShipmentStatusUpdatesRequest} requestParameters Request parameters.
|
|
538
538
|
* @param {*} [options] Override http request option.
|
|
539
539
|
* @throws {RequiredError}
|
|
@@ -541,7 +541,7 @@ export declare class VendorShippingApi extends BaseAPI {
|
|
|
541
541
|
*/
|
|
542
542
|
submitShipmentStatusUpdates(requestParameters: VendorShippingApiSubmitShipmentStatusUpdatesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShipmentStatusUpdatesResponse, any>>;
|
|
543
543
|
/**
|
|
544
|
-
* Creates a shipping label for a purchase order and returns a
|
|
544
|
+
* Creates a shipping label for a purchase order and returns a transactionId for reference. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
545
545
|
* @param {VendorShippingApiSubmitShippingLabelRequestRequest} requestParameters Request parameters.
|
|
546
546
|
* @param {*} [options] Override http request option.
|
|
547
547
|
* @throws {RequiredError}
|
|
@@ -24,7 +24,7 @@ export interface CustomerInvoiceList {
|
|
|
24
24
|
*/
|
|
25
25
|
'pagination'?: Pagination;
|
|
26
26
|
/**
|
|
27
|
-
* Represents a customer invoice within the
|
|
27
|
+
* Represents a customer invoice within the CustomerInvoiceList.
|
|
28
28
|
* @type {Array<CustomerInvoice>}
|
|
29
29
|
* @memberof CustomerInvoiceList
|
|
30
30
|
*/
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { CustomerInvoice } from './customer-invoice';
|
|
13
13
|
/**
|
|
14
|
-
* The response schema for the
|
|
14
|
+
* The response schema for the getCustomerInvoice operation.
|
|
15
15
|
* @export
|
|
16
16
|
* @interface GetCustomerInvoiceResponse
|
|
17
17
|
*/
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { CustomerInvoiceList } from './customer-invoice-list';
|
|
13
13
|
/**
|
|
14
|
-
* The response schema for the
|
|
14
|
+
* The response schema for the getCustomerInvoices operation.
|
|
15
15
|
* @export
|
|
16
16
|
* @interface GetCustomerInvoicesResponse
|
|
17
17
|
*/
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { ShippingLabelList } from './shipping-label-list';
|
|
13
13
|
/**
|
|
14
|
-
* The response schema for the
|
|
14
|
+
* The response schema for the getShippingLabels operation.
|
|
15
15
|
* @export
|
|
16
16
|
* @interface GetShippingLabelListResponse
|
|
17
17
|
*/
|