@sp-api-sdk/shipping-api-v2 2.0.1 → 2.1.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/shipping-api.js +274 -29
- package/dist/cjs/api-model/configuration.js +1 -2
- package/dist/cjs/api-model/models/carrier-account.js +15 -0
- package/dist/cjs/api-model/models/claim-reason.js +28 -0
- package/dist/cjs/api-model/models/create-claim-request.js +15 -0
- package/dist/cjs/api-model/models/create-claim-response.js +15 -0
- package/dist/cjs/api-model/models/detail-codes.js +53 -0
- package/dist/cjs/api-model/models/event-code.js +4 -1
- package/dist/cjs/api-model/models/goods-owner.js +15 -0
- package/dist/cjs/api-model/models/index.js +13 -0
- package/dist/cjs/api-model/models/label-attribute.js +26 -0
- package/dist/cjs/api-model/models/ndr-action.js +26 -0
- package/dist/cjs/api-model/models/ndr-request-data.js +15 -0
- package/dist/cjs/api-model/models/rate-item-id.js +6 -1
- package/dist/cjs/api-model/models/requested-label-customization.js +15 -0
- package/dist/cjs/api-model/models/settlement-type.js +25 -0
- package/dist/cjs/api-model/models/status.js +2 -1
- package/dist/cjs/api-model/models/submit-ndr-feedback-request.js +15 -0
- package/dist/cjs/api-model/models/tracking-detail-codes.js +15 -0
- package/dist/cjs/client.js +21 -0
- package/dist/es/api-model/api/shipping-api.js +273 -28
- package/dist/es/api-model/configuration.js +1 -2
- package/dist/es/api-model/models/carrier-account.js +14 -0
- package/dist/es/api-model/models/claim-reason.js +25 -0
- package/dist/es/api-model/models/create-claim-request.js +14 -0
- package/dist/es/api-model/models/create-claim-response.js +14 -0
- package/dist/es/api-model/models/detail-codes.js +50 -0
- package/dist/es/api-model/models/event-code.js +4 -1
- package/dist/es/api-model/models/goods-owner.js +14 -0
- package/dist/es/api-model/models/index.js +13 -0
- package/dist/es/api-model/models/label-attribute.js +23 -0
- package/dist/es/api-model/models/ndr-action.js +23 -0
- package/dist/es/api-model/models/ndr-request-data.js +14 -0
- package/dist/es/api-model/models/rate-item-id.js +6 -1
- package/dist/es/api-model/models/requested-label-customization.js +14 -0
- package/dist/es/api-model/models/settlement-type.js +22 -0
- package/dist/es/api-model/models/status.js +2 -1
- package/dist/es/api-model/models/submit-ndr-feedback-request.js +14 -0
- package/dist/es/api-model/models/tracking-detail-codes.js +14 -0
- package/dist/es/client.js +21 -0
- package/dist/types/api-model/api/shipping-api.d.ts +251 -42
- package/dist/types/api-model/common.d.ts +1 -1
- package/dist/types/api-model/models/access-point-details.d.ts +1 -1
- package/dist/types/api-model/models/access-point.d.ts +2 -2
- package/dist/types/api-model/models/active-account.d.ts +1 -1
- package/dist/types/api-model/models/benefits.d.ts +1 -1
- package/dist/types/api-model/models/carrier-account.d.ts +30 -0
- package/dist/types/api-model/models/claim-reason.d.ts +24 -0
- package/dist/types/api-model/models/create-claim-request.d.ts +57 -0
- package/dist/types/api-model/models/create-claim-response.d.ts +24 -0
- package/dist/types/api-model/models/detail-codes.d.ts +49 -0
- package/dist/types/api-model/models/error-list.d.ts +1 -1
- package/dist/types/api-model/models/event-code.d.ts +3 -0
- package/dist/types/api-model/models/event.d.ts +7 -0
- package/dist/types/api-model/models/excluded-benefit.d.ts +5 -5
- package/dist/types/api-model/models/get-rates-request.d.ts +7 -0
- package/dist/types/api-model/models/get-shipment-documents-result.d.ts +7 -0
- package/dist/types/api-model/models/goods-owner.d.ts +24 -0
- package/dist/types/api-model/models/index.d.ts +13 -0
- package/dist/types/api-model/models/label-attribute.d.ts +22 -0
- package/dist/types/api-model/models/link-carrier-account-response.d.ts +6 -0
- package/dist/types/api-model/models/ndr-action.d.ts +22 -0
- package/dist/types/api-model/models/ndr-request-data.d.ts +30 -0
- package/dist/types/api-model/models/one-click-shipment-request.d.ts +7 -0
- package/dist/types/api-model/models/operating-hours.d.ts +1 -1
- package/dist/types/api-model/models/purchase-shipment-result.d.ts +7 -0
- package/dist/types/api-model/models/rate-item-id.d.ts +5 -0
- package/dist/types/api-model/models/requested-document-specification.d.ts +7 -0
- package/dist/types/api-model/models/requested-label-customization.d.ts +25 -0
- package/dist/types/api-model/models/settlement-type.d.ts +21 -0
- package/dist/types/api-model/models/status.d.ts +1 -0
- package/dist/types/api-model/models/submit-ndr-feedback-request.d.ts +38 -0
- package/dist/types/api-model/models/time-of-day.d.ts +3 -3
- package/dist/types/api-model/models/tracking-detail-codes.d.ts +31 -0
- package/dist/types/api-model/models/tracking-summary.d.ts +7 -0
- package/dist/types/api-model/models/unlink-carrier-account-request.d.ts +6 -0
- package/package.json +4 -4
|
@@ -14,6 +14,8 @@ 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 { CancelShipmentResponse } from '../models';
|
|
17
|
+
import type { CreateClaimRequest } from '../models';
|
|
18
|
+
import type { CreateClaimResponse } from '../models';
|
|
17
19
|
import type { DirectPurchaseRequest } from '../models';
|
|
18
20
|
import type { DirectPurchaseResponse } from '../models';
|
|
19
21
|
import type { GenerateCollectionFormRequest } from '../models';
|
|
@@ -38,6 +40,7 @@ import type { OneClickShipmentRequest } from '../models';
|
|
|
38
40
|
import type { OneClickShipmentResponse } from '../models';
|
|
39
41
|
import type { PurchaseShipmentRequest } from '../models';
|
|
40
42
|
import type { PurchaseShipmentResponse } from '../models';
|
|
43
|
+
import type { SubmitNdrFeedbackRequest } from '../models';
|
|
41
44
|
import type { UnlinkCarrierAccountRequest } from '../models';
|
|
42
45
|
import type { UnlinkCarrierAccountResponse } from '../models';
|
|
43
46
|
/**
|
|
@@ -53,9 +56,17 @@ export declare const ShippingApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
53
56
|
* @throws {RequiredError}
|
|
54
57
|
*/
|
|
55
58
|
cancelShipment: (shipmentId: string, xAmznShippingBusinessId?: CancelShipmentXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
|
+
/**
|
|
60
|
+
* This API will be used to create claim for single eligible shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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 {CreateClaimRequest} body Request body for the createClaim operation
|
|
62
|
+
* @param {CreateClaimXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
63
|
+
* @param {*} [options] Override http request option.
|
|
64
|
+
* @throws {RequiredError}
|
|
65
|
+
*/
|
|
66
|
+
createClaim: (body: CreateClaimRequest, xAmznShippingBusinessId?: CreateClaimXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
67
|
/**
|
|
57
68
|
* Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
58
|
-
* @param {DirectPurchaseRequest} body
|
|
69
|
+
* @param {DirectPurchaseRequest} body DirectPurchaseRequest body
|
|
59
70
|
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
60
71
|
* @param {string} [locale] The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA). The secondary language subtag is almost always a regional designation. This does not support additional subtags beyond the primary and secondary language subtags.
|
|
61
72
|
* @param {DirectPurchaseShipmentXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
@@ -65,7 +76,7 @@ export declare const ShippingApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
65
76
|
directPurchaseShipment: (body: DirectPurchaseRequest, xAmznIdempotencyKey?: string, locale?: string, xAmznShippingBusinessId?: DirectPurchaseShipmentXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
77
|
/**
|
|
67
78
|
* This API Call to generate the collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
68
|
-
* @param {GenerateCollectionFormRequest} body
|
|
79
|
+
* @param {GenerateCollectionFormRequest} body GenerateCollectionFormRequest body
|
|
69
80
|
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
70
81
|
* @param {GenerateCollectionFormXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
71
82
|
* @param {*} [options] Override http request option.
|
|
@@ -74,9 +85,9 @@ export declare const ShippingApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
74
85
|
generateCollectionForm: (body: GenerateCollectionFormRequest, xAmznIdempotencyKey?: string, xAmznShippingBusinessId?: GenerateCollectionFormXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
75
86
|
/**
|
|
76
87
|
* Returns a list of access points in proximity of input postal code. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
77
|
-
* @param {Array<GetAccessPointsAccessPointTypesEnum>} accessPointTypes
|
|
78
|
-
* @param {string} countryCode
|
|
79
|
-
* @param {string} postalCode
|
|
88
|
+
* @param {Array<GetAccessPointsAccessPointTypesEnum>} accessPointTypes Access point types
|
|
89
|
+
* @param {string} countryCode Country code for access point
|
|
90
|
+
* @param {string} postalCode postal code for access point
|
|
80
91
|
* @param {GetAccessPointsXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
81
92
|
* @param {*} [options] Override http request option.
|
|
82
93
|
* @throws {RequiredError}
|
|
@@ -100,7 +111,7 @@ export declare const ShippingApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
100
111
|
getCarrierAccountFormInputs: (xAmznShippingBusinessId?: GetCarrierAccountFormInputsXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
101
112
|
/**
|
|
102
113
|
* This API will return Get all carrier accounts for a merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
103
|
-
* @param {GetCarrierAccountsRequest} body
|
|
114
|
+
* @param {GetCarrierAccountsRequest} body GetCarrierAccountsRequest body
|
|
104
115
|
* @param {GetCarrierAccountsXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
105
116
|
* @param {*} [options] Override http request option.
|
|
106
117
|
* @throws {RequiredError}
|
|
@@ -116,7 +127,7 @@ export declare const ShippingApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
116
127
|
getCollectionForm: (collectionFormId: string, xAmznShippingBusinessId?: GetCollectionFormXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
117
128
|
/**
|
|
118
129
|
* This API Call to get the history of the previously generated collection forms. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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
|
-
* @param {GetCollectionFormHistoryRequest} body
|
|
130
|
+
* @param {GetCollectionFormHistoryRequest} body GetCollectionFormHistoryRequest body
|
|
120
131
|
* @param {GetCollectionFormHistoryXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
121
132
|
* @param {*} [options] Override http request option.
|
|
122
133
|
* @throws {RequiredError}
|
|
@@ -124,7 +135,7 @@ export declare const ShippingApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
124
135
|
getCollectionFormHistory: (body: GetCollectionFormHistoryRequest, xAmznShippingBusinessId?: GetCollectionFormHistoryXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
125
136
|
/**
|
|
126
137
|
* Returns the available shipping service offerings. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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
|
-
* @param {GetRatesRequest} body
|
|
138
|
+
* @param {GetRatesRequest} body GetRatesRequest body
|
|
128
139
|
* @param {GetRatesXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
129
140
|
* @param {*} [options] Override http request option.
|
|
130
141
|
* @throws {RequiredError}
|
|
@@ -152,7 +163,7 @@ export declare const ShippingApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
152
163
|
getTracking: (trackingId: string, carrierId: string, xAmznShippingBusinessId?: GetTrackingXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
153
164
|
/**
|
|
154
165
|
* This API Get all unmanifested carriers with shipment locations. Any locations which has unmanifested shipments with an eligible carrier for manifesting shall be returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
155
|
-
* @param {GetUnmanifestedShipmentsRequest} body
|
|
166
|
+
* @param {GetUnmanifestedShipmentsRequest} body GetUmanifestedShipmentsRequest body
|
|
156
167
|
* @param {GetUnmanifestedShipmentsXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
157
168
|
* @param {*} [options] Override http request option.
|
|
158
169
|
* @throws {RequiredError}
|
|
@@ -160,16 +171,25 @@ export declare const ShippingApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
160
171
|
getUnmanifestedShipments: (body: GetUnmanifestedShipmentsRequest, xAmznShippingBusinessId?: GetUnmanifestedShipmentsXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
161
172
|
/**
|
|
162
173
|
* This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
163
|
-
* @param {string} carrierId
|
|
164
|
-
* @param {LinkCarrierAccountRequest} body
|
|
174
|
+
* @param {string} carrierId An identifier for the carrier with which the seller\'s account is being linked.
|
|
175
|
+
* @param {LinkCarrierAccountRequest} body LinkCarrierAccountRequest body
|
|
165
176
|
* @param {LinkCarrierAccountXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
166
177
|
* @param {*} [options] Override http request option.
|
|
167
178
|
* @throws {RequiredError}
|
|
168
179
|
*/
|
|
169
180
|
linkCarrierAccount: (carrierId: string, body: LinkCarrierAccountRequest, xAmznShippingBusinessId?: LinkCarrierAccountXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
181
|
+
/**
|
|
182
|
+
* This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 then 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
|
+
* @param {string} carrierId An identifier for the carrier with which the seller\'s account is being linked.
|
|
184
|
+
* @param {LinkCarrierAccountRequest} body LinkCarrierAccountRequest body
|
|
185
|
+
* @param {LinkCarrierAccount0XAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
186
|
+
* @param {*} [options] Override http request option.
|
|
187
|
+
* @throws {RequiredError}
|
|
188
|
+
*/
|
|
189
|
+
linkCarrierAccount_1: (carrierId: string, body: LinkCarrierAccountRequest, xAmznShippingBusinessId?: LinkCarrierAccount0XAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
170
190
|
/**
|
|
171
191
|
* Purchases a shipping service identifier and returns purchase-related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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
|
-
* @param {OneClickShipmentRequest} body
|
|
192
|
+
* @param {OneClickShipmentRequest} body OneClickShipmentRequest body
|
|
173
193
|
* @param {OneClickShipmentXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
174
194
|
* @param {*} [options] Override http request option.
|
|
175
195
|
* @throws {RequiredError}
|
|
@@ -177,17 +197,25 @@ export declare const ShippingApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
177
197
|
oneClickShipment: (body: OneClickShipmentRequest, xAmznShippingBusinessId?: OneClickShipmentXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
178
198
|
/**
|
|
179
199
|
* Purchases a shipping service and returns purchase related details and documents. Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to \"TOKEN_EXPIRED\". If you receive this error response, you must get the rates for the shipment again. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
180
|
-
* @param {PurchaseShipmentRequest} body
|
|
200
|
+
* @param {PurchaseShipmentRequest} body PurchaseShipmentRequest body
|
|
181
201
|
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
182
202
|
* @param {PurchaseShipmentXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
183
203
|
* @param {*} [options] Override http request option.
|
|
184
204
|
* @throws {RequiredError}
|
|
185
205
|
*/
|
|
186
206
|
purchaseShipment: (body: PurchaseShipmentRequest, xAmznIdempotencyKey?: string, xAmznShippingBusinessId?: PurchaseShipmentXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
207
|
+
/**
|
|
208
|
+
* This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
209
|
+
* @param {SubmitNdrFeedbackRequest} body Request body for ndrFeedback operation
|
|
210
|
+
* @param {SubmitNdrFeedbackXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
211
|
+
* @param {*} [options] Override http request option.
|
|
212
|
+
* @throws {RequiredError}
|
|
213
|
+
*/
|
|
214
|
+
submitNdrFeedback: (body: SubmitNdrFeedbackRequest, xAmznShippingBusinessId?: SubmitNdrFeedbackXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
187
215
|
/**
|
|
188
216
|
* This API Unlink the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
189
217
|
* @param {string} carrierId carrier Id to unlink with merchant.
|
|
190
|
-
* @param {UnlinkCarrierAccountRequest} body
|
|
218
|
+
* @param {UnlinkCarrierAccountRequest} body UnlinkCarrierAccountRequest body
|
|
191
219
|
* @param {UnlinkCarrierAccountXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
192
220
|
* @param {*} [options] Override http request option.
|
|
193
221
|
* @throws {RequiredError}
|
|
@@ -207,9 +235,17 @@ export declare const ShippingApiFp: (configuration?: Configuration) => {
|
|
|
207
235
|
* @throws {RequiredError}
|
|
208
236
|
*/
|
|
209
237
|
cancelShipment(shipmentId: string, xAmznShippingBusinessId?: CancelShipmentXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelShipmentResponse>>;
|
|
238
|
+
/**
|
|
239
|
+
* This API will be used to create claim for single eligible shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
240
|
+
* @param {CreateClaimRequest} body Request body for the createClaim operation
|
|
241
|
+
* @param {CreateClaimXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
242
|
+
* @param {*} [options] Override http request option.
|
|
243
|
+
* @throws {RequiredError}
|
|
244
|
+
*/
|
|
245
|
+
createClaim(body: CreateClaimRequest, xAmznShippingBusinessId?: CreateClaimXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateClaimResponse>>;
|
|
210
246
|
/**
|
|
211
247
|
* Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
212
|
-
* @param {DirectPurchaseRequest} body
|
|
248
|
+
* @param {DirectPurchaseRequest} body DirectPurchaseRequest body
|
|
213
249
|
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
214
250
|
* @param {string} [locale] The IETF Language Tag. Note that this only supports the primary language subtag with one secondary language subtag (i.e. en-US, fr-CA). The secondary language subtag is almost always a regional designation. This does not support additional subtags beyond the primary and secondary language subtags.
|
|
215
251
|
* @param {DirectPurchaseShipmentXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
@@ -219,7 +255,7 @@ export declare const ShippingApiFp: (configuration?: Configuration) => {
|
|
|
219
255
|
directPurchaseShipment(body: DirectPurchaseRequest, xAmznIdempotencyKey?: string, locale?: string, xAmznShippingBusinessId?: DirectPurchaseShipmentXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DirectPurchaseResponse>>;
|
|
220
256
|
/**
|
|
221
257
|
* This API Call to generate the collection form. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
222
|
-
* @param {GenerateCollectionFormRequest} body
|
|
258
|
+
* @param {GenerateCollectionFormRequest} body GenerateCollectionFormRequest body
|
|
223
259
|
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
224
260
|
* @param {GenerateCollectionFormXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
225
261
|
* @param {*} [options] Override http request option.
|
|
@@ -228,9 +264,9 @@ export declare const ShippingApiFp: (configuration?: Configuration) => {
|
|
|
228
264
|
generateCollectionForm(body: GenerateCollectionFormRequest, xAmznIdempotencyKey?: string, xAmznShippingBusinessId?: GenerateCollectionFormXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateCollectionFormResponse>>;
|
|
229
265
|
/**
|
|
230
266
|
* Returns a list of access points in proximity of input postal code. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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
|
-
* @param {Array<GetAccessPointsAccessPointTypesEnum>} accessPointTypes
|
|
232
|
-
* @param {string} countryCode
|
|
233
|
-
* @param {string} postalCode
|
|
267
|
+
* @param {Array<GetAccessPointsAccessPointTypesEnum>} accessPointTypes Access point types
|
|
268
|
+
* @param {string} countryCode Country code for access point
|
|
269
|
+
* @param {string} postalCode postal code for access point
|
|
234
270
|
* @param {GetAccessPointsXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
235
271
|
* @param {*} [options] Override http request option.
|
|
236
272
|
* @throws {RequiredError}
|
|
@@ -254,7 +290,7 @@ export declare const ShippingApiFp: (configuration?: Configuration) => {
|
|
|
254
290
|
getCarrierAccountFormInputs(xAmznShippingBusinessId?: GetCarrierAccountFormInputsXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCarrierAccountFormInputsResponse>>;
|
|
255
291
|
/**
|
|
256
292
|
* This API will return Get all carrier accounts for a merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
257
|
-
* @param {GetCarrierAccountsRequest} body
|
|
293
|
+
* @param {GetCarrierAccountsRequest} body GetCarrierAccountsRequest body
|
|
258
294
|
* @param {GetCarrierAccountsXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
259
295
|
* @param {*} [options] Override http request option.
|
|
260
296
|
* @throws {RequiredError}
|
|
@@ -270,7 +306,7 @@ export declare const ShippingApiFp: (configuration?: Configuration) => {
|
|
|
270
306
|
getCollectionForm(collectionFormId: string, xAmznShippingBusinessId?: GetCollectionFormXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCollectionFormResponse>>;
|
|
271
307
|
/**
|
|
272
308
|
* This API Call to get the history of the previously generated collection forms. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
273
|
-
* @param {GetCollectionFormHistoryRequest} body
|
|
309
|
+
* @param {GetCollectionFormHistoryRequest} body GetCollectionFormHistoryRequest body
|
|
274
310
|
* @param {GetCollectionFormHistoryXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
275
311
|
* @param {*} [options] Override http request option.
|
|
276
312
|
* @throws {RequiredError}
|
|
@@ -278,7 +314,7 @@ export declare const ShippingApiFp: (configuration?: Configuration) => {
|
|
|
278
314
|
getCollectionFormHistory(body: GetCollectionFormHistoryRequest, xAmznShippingBusinessId?: GetCollectionFormHistoryXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCollectionFormHistoryResponse>>;
|
|
279
315
|
/**
|
|
280
316
|
* Returns the available shipping service offerings. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
281
|
-
* @param {GetRatesRequest} body
|
|
317
|
+
* @param {GetRatesRequest} body GetRatesRequest body
|
|
282
318
|
* @param {GetRatesXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
283
319
|
* @param {*} [options] Override http request option.
|
|
284
320
|
* @throws {RequiredError}
|
|
@@ -306,7 +342,7 @@ export declare const ShippingApiFp: (configuration?: Configuration) => {
|
|
|
306
342
|
getTracking(trackingId: string, carrierId: string, xAmznShippingBusinessId?: GetTrackingXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrackingResponse>>;
|
|
307
343
|
/**
|
|
308
344
|
* This API Get all unmanifested carriers with shipment locations. Any locations which has unmanifested shipments with an eligible carrier for manifesting shall be returned. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
309
|
-
* @param {GetUnmanifestedShipmentsRequest} body
|
|
345
|
+
* @param {GetUnmanifestedShipmentsRequest} body GetUmanifestedShipmentsRequest body
|
|
310
346
|
* @param {GetUnmanifestedShipmentsXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
311
347
|
* @param {*} [options] Override http request option.
|
|
312
348
|
* @throws {RequiredError}
|
|
@@ -314,16 +350,25 @@ export declare const ShippingApiFp: (configuration?: Configuration) => {
|
|
|
314
350
|
getUnmanifestedShipments(body: GetUnmanifestedShipmentsRequest, xAmznShippingBusinessId?: GetUnmanifestedShipmentsXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUnmanifestedShipmentsResponse>>;
|
|
315
351
|
/**
|
|
316
352
|
* This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
317
|
-
* @param {string} carrierId
|
|
318
|
-
* @param {LinkCarrierAccountRequest} body
|
|
353
|
+
* @param {string} carrierId An identifier for the carrier with which the seller\'s account is being linked.
|
|
354
|
+
* @param {LinkCarrierAccountRequest} body LinkCarrierAccountRequest body
|
|
319
355
|
* @param {LinkCarrierAccountXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
320
356
|
* @param {*} [options] Override http request option.
|
|
321
357
|
* @throws {RequiredError}
|
|
322
358
|
*/
|
|
323
359
|
linkCarrierAccount(carrierId: string, body: LinkCarrierAccountRequest, xAmznShippingBusinessId?: LinkCarrierAccountXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkCarrierAccountResponse>>;
|
|
360
|
+
/**
|
|
361
|
+
* This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 then 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).
|
|
362
|
+
* @param {string} carrierId An identifier for the carrier with which the seller\'s account is being linked.
|
|
363
|
+
* @param {LinkCarrierAccountRequest} body LinkCarrierAccountRequest body
|
|
364
|
+
* @param {LinkCarrierAccount0XAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
365
|
+
* @param {*} [options] Override http request option.
|
|
366
|
+
* @throws {RequiredError}
|
|
367
|
+
*/
|
|
368
|
+
linkCarrierAccount_1(carrierId: string, body: LinkCarrierAccountRequest, xAmznShippingBusinessId?: LinkCarrierAccount0XAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkCarrierAccountResponse>>;
|
|
324
369
|
/**
|
|
325
370
|
* Purchases a shipping service identifier and returns purchase-related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
326
|
-
* @param {OneClickShipmentRequest} body
|
|
371
|
+
* @param {OneClickShipmentRequest} body OneClickShipmentRequest body
|
|
327
372
|
* @param {OneClickShipmentXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
328
373
|
* @param {*} [options] Override http request option.
|
|
329
374
|
* @throws {RequiredError}
|
|
@@ -331,17 +376,25 @@ export declare const ShippingApiFp: (configuration?: Configuration) => {
|
|
|
331
376
|
oneClickShipment(body: OneClickShipmentRequest, xAmznShippingBusinessId?: OneClickShipmentXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OneClickShipmentResponse>>;
|
|
332
377
|
/**
|
|
333
378
|
* Purchases a shipping service and returns purchase related details and documents. Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to \"TOKEN_EXPIRED\". If you receive this error response, you must get the rates for the shipment again. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
334
|
-
* @param {PurchaseShipmentRequest} body
|
|
379
|
+
* @param {PurchaseShipmentRequest} body PurchaseShipmentRequest body
|
|
335
380
|
* @param {string} [xAmznIdempotencyKey] A unique value which the server uses to recognize subsequent retries of the same request.
|
|
336
381
|
* @param {PurchaseShipmentXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
337
382
|
* @param {*} [options] Override http request option.
|
|
338
383
|
* @throws {RequiredError}
|
|
339
384
|
*/
|
|
340
385
|
purchaseShipment(body: PurchaseShipmentRequest, xAmznIdempotencyKey?: string, xAmznShippingBusinessId?: PurchaseShipmentXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PurchaseShipmentResponse>>;
|
|
386
|
+
/**
|
|
387
|
+
* This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
388
|
+
* @param {SubmitNdrFeedbackRequest} body Request body for ndrFeedback operation
|
|
389
|
+
* @param {SubmitNdrFeedbackXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
390
|
+
* @param {*} [options] Override http request option.
|
|
391
|
+
* @throws {RequiredError}
|
|
392
|
+
*/
|
|
393
|
+
submitNdrFeedback(body: SubmitNdrFeedbackRequest, xAmznShippingBusinessId?: SubmitNdrFeedbackXAmznShippingBusinessIdEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
341
394
|
/**
|
|
342
395
|
* This API Unlink the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
343
396
|
* @param {string} carrierId carrier Id to unlink with merchant.
|
|
344
|
-
* @param {UnlinkCarrierAccountRequest} body
|
|
397
|
+
* @param {UnlinkCarrierAccountRequest} body UnlinkCarrierAccountRequest body
|
|
345
398
|
* @param {UnlinkCarrierAccountXAmznShippingBusinessIdEnum} [xAmznShippingBusinessId] Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
346
399
|
* @param {*} [options] Override http request option.
|
|
347
400
|
* @throws {RequiredError}
|
|
@@ -360,6 +413,13 @@ export declare const ShippingApiFactory: (configuration?: Configuration, basePat
|
|
|
360
413
|
* @throws {RequiredError}
|
|
361
414
|
*/
|
|
362
415
|
cancelShipment(requestParameters: ShippingApiCancelShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<CancelShipmentResponse>;
|
|
416
|
+
/**
|
|
417
|
+
* This API will be used to create claim for single eligible shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
418
|
+
* @param {ShippingApiCreateClaimRequest} requestParameters Request parameters.
|
|
419
|
+
* @param {*} [options] Override http request option.
|
|
420
|
+
* @throws {RequiredError}
|
|
421
|
+
*/
|
|
422
|
+
createClaim(requestParameters: ShippingApiCreateClaimRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateClaimResponse>;
|
|
363
423
|
/**
|
|
364
424
|
* Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
365
425
|
* @param {ShippingApiDirectPurchaseShipmentRequest} requestParameters Request parameters.
|
|
@@ -451,6 +511,13 @@ export declare const ShippingApiFactory: (configuration?: Configuration, basePat
|
|
|
451
511
|
* @throws {RequiredError}
|
|
452
512
|
*/
|
|
453
513
|
linkCarrierAccount(requestParameters: ShippingApiLinkCarrierAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise<LinkCarrierAccountResponse>;
|
|
514
|
+
/**
|
|
515
|
+
* This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 then 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).
|
|
516
|
+
* @param {ShippingApiLinkCarrierAccount0Request} requestParameters Request parameters.
|
|
517
|
+
* @param {*} [options] Override http request option.
|
|
518
|
+
* @throws {RequiredError}
|
|
519
|
+
*/
|
|
520
|
+
linkCarrierAccount_1(requestParameters: ShippingApiLinkCarrierAccount0Request, options?: RawAxiosRequestConfig): AxiosPromise<LinkCarrierAccountResponse>;
|
|
454
521
|
/**
|
|
455
522
|
* Purchases a shipping service identifier and returns purchase-related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
456
523
|
* @param {ShippingApiOneClickShipmentRequest} requestParameters Request parameters.
|
|
@@ -465,6 +532,13 @@ export declare const ShippingApiFactory: (configuration?: Configuration, basePat
|
|
|
465
532
|
* @throws {RequiredError}
|
|
466
533
|
*/
|
|
467
534
|
purchaseShipment(requestParameters: ShippingApiPurchaseShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<PurchaseShipmentResponse>;
|
|
535
|
+
/**
|
|
536
|
+
* This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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
|
+
* @param {ShippingApiSubmitNdrFeedbackRequest} requestParameters Request parameters.
|
|
538
|
+
* @param {*} [options] Override http request option.
|
|
539
|
+
* @throws {RequiredError}
|
|
540
|
+
*/
|
|
541
|
+
submitNdrFeedback(requestParameters: ShippingApiSubmitNdrFeedbackRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
468
542
|
/**
|
|
469
543
|
* This API Unlink the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
470
544
|
* @param {ShippingApiUnlinkCarrierAccountRequest} requestParameters Request parameters.
|
|
@@ -492,6 +566,25 @@ export interface ShippingApiCancelShipmentRequest {
|
|
|
492
566
|
*/
|
|
493
567
|
readonly xAmznShippingBusinessId?: CancelShipmentXAmznShippingBusinessIdEnum;
|
|
494
568
|
}
|
|
569
|
+
/**
|
|
570
|
+
* Request parameters for createClaim operation in ShippingApi.
|
|
571
|
+
* @export
|
|
572
|
+
* @interface ShippingApiCreateClaimRequest
|
|
573
|
+
*/
|
|
574
|
+
export interface ShippingApiCreateClaimRequest {
|
|
575
|
+
/**
|
|
576
|
+
* Request body for the createClaim operation
|
|
577
|
+
* @type {CreateClaimRequest}
|
|
578
|
+
* @memberof ShippingApiCreateClaim
|
|
579
|
+
*/
|
|
580
|
+
readonly body: CreateClaimRequest;
|
|
581
|
+
/**
|
|
582
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
583
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
584
|
+
* @memberof ShippingApiCreateClaim
|
|
585
|
+
*/
|
|
586
|
+
readonly xAmznShippingBusinessId?: CreateClaimXAmznShippingBusinessIdEnum;
|
|
587
|
+
}
|
|
495
588
|
/**
|
|
496
589
|
* Request parameters for directPurchaseShipment operation in ShippingApi.
|
|
497
590
|
* @export
|
|
@@ -499,7 +592,7 @@ export interface ShippingApiCancelShipmentRequest {
|
|
|
499
592
|
*/
|
|
500
593
|
export interface ShippingApiDirectPurchaseShipmentRequest {
|
|
501
594
|
/**
|
|
502
|
-
*
|
|
595
|
+
* DirectPurchaseRequest body
|
|
503
596
|
* @type {DirectPurchaseRequest}
|
|
504
597
|
* @memberof ShippingApiDirectPurchaseShipment
|
|
505
598
|
*/
|
|
@@ -530,7 +623,7 @@ export interface ShippingApiDirectPurchaseShipmentRequest {
|
|
|
530
623
|
*/
|
|
531
624
|
export interface ShippingApiGenerateCollectionFormRequest {
|
|
532
625
|
/**
|
|
533
|
-
*
|
|
626
|
+
* GenerateCollectionFormRequest body
|
|
534
627
|
* @type {GenerateCollectionFormRequest}
|
|
535
628
|
* @memberof ShippingApiGenerateCollectionForm
|
|
536
629
|
*/
|
|
@@ -555,19 +648,19 @@ export interface ShippingApiGenerateCollectionFormRequest {
|
|
|
555
648
|
*/
|
|
556
649
|
export interface ShippingApiGetAccessPointsRequest {
|
|
557
650
|
/**
|
|
558
|
-
*
|
|
651
|
+
* Access point types
|
|
559
652
|
* @type {Array<'HELIX' | 'CAMPUS_LOCKER' | 'OMNI_LOCKER' | 'ODIN_LOCKER' | 'DOBBY_LOCKER' | 'CORE_LOCKER' | '3P' | 'CAMPUS_ROOM'>}
|
|
560
653
|
* @memberof ShippingApiGetAccessPoints
|
|
561
654
|
*/
|
|
562
655
|
readonly accessPointTypes: Array<GetAccessPointsAccessPointTypesEnum>;
|
|
563
656
|
/**
|
|
564
|
-
*
|
|
657
|
+
* Country code for access point
|
|
565
658
|
* @type {string}
|
|
566
659
|
* @memberof ShippingApiGetAccessPoints
|
|
567
660
|
*/
|
|
568
661
|
readonly countryCode: string;
|
|
569
662
|
/**
|
|
570
|
-
*
|
|
663
|
+
* postal code for access point
|
|
571
664
|
* @type {string}
|
|
572
665
|
* @memberof ShippingApiGetAccessPoints
|
|
573
666
|
*/
|
|
@@ -624,7 +717,7 @@ export interface ShippingApiGetCarrierAccountFormInputsRequest {
|
|
|
624
717
|
*/
|
|
625
718
|
export interface ShippingApiGetCarrierAccountsRequest {
|
|
626
719
|
/**
|
|
627
|
-
*
|
|
720
|
+
* GetCarrierAccountsRequest body
|
|
628
721
|
* @type {GetCarrierAccountsRequest}
|
|
629
722
|
* @memberof ShippingApiGetCarrierAccounts
|
|
630
723
|
*/
|
|
@@ -662,7 +755,7 @@ export interface ShippingApiGetCollectionFormRequest {
|
|
|
662
755
|
*/
|
|
663
756
|
export interface ShippingApiGetCollectionFormHistoryRequest {
|
|
664
757
|
/**
|
|
665
|
-
*
|
|
758
|
+
* GetCollectionFormHistoryRequest body
|
|
666
759
|
* @type {GetCollectionFormHistoryRequest}
|
|
667
760
|
* @memberof ShippingApiGetCollectionFormHistory
|
|
668
761
|
*/
|
|
@@ -681,7 +774,7 @@ export interface ShippingApiGetCollectionFormHistoryRequest {
|
|
|
681
774
|
*/
|
|
682
775
|
export interface ShippingApiGetRatesRequest {
|
|
683
776
|
/**
|
|
684
|
-
*
|
|
777
|
+
* GetRatesRequest body
|
|
685
778
|
* @type {GetRatesRequest}
|
|
686
779
|
* @memberof ShippingApiGetRates
|
|
687
780
|
*/
|
|
@@ -762,7 +855,7 @@ export interface ShippingApiGetTrackingRequest {
|
|
|
762
855
|
*/
|
|
763
856
|
export interface ShippingApiGetUnmanifestedShipmentsRequest {
|
|
764
857
|
/**
|
|
765
|
-
*
|
|
858
|
+
* GetUmanifestedShipmentsRequest body
|
|
766
859
|
* @type {GetUnmanifestedShipmentsRequest}
|
|
767
860
|
* @memberof ShippingApiGetUnmanifestedShipments
|
|
768
861
|
*/
|
|
@@ -781,13 +874,13 @@ export interface ShippingApiGetUnmanifestedShipmentsRequest {
|
|
|
781
874
|
*/
|
|
782
875
|
export interface ShippingApiLinkCarrierAccountRequest {
|
|
783
876
|
/**
|
|
784
|
-
*
|
|
877
|
+
* An identifier for the carrier with which the seller\'s account is being linked.
|
|
785
878
|
* @type {string}
|
|
786
879
|
* @memberof ShippingApiLinkCarrierAccount
|
|
787
880
|
*/
|
|
788
881
|
readonly carrierId: string;
|
|
789
882
|
/**
|
|
790
|
-
*
|
|
883
|
+
* LinkCarrierAccountRequest body
|
|
791
884
|
* @type {LinkCarrierAccountRequest}
|
|
792
885
|
* @memberof ShippingApiLinkCarrierAccount
|
|
793
886
|
*/
|
|
@@ -799,6 +892,31 @@ export interface ShippingApiLinkCarrierAccountRequest {
|
|
|
799
892
|
*/
|
|
800
893
|
readonly xAmznShippingBusinessId?: LinkCarrierAccountXAmznShippingBusinessIdEnum;
|
|
801
894
|
}
|
|
895
|
+
/**
|
|
896
|
+
* Request parameters for linkCarrierAccount_1 operation in ShippingApi.
|
|
897
|
+
* @export
|
|
898
|
+
* @interface ShippingApiLinkCarrierAccount0Request
|
|
899
|
+
*/
|
|
900
|
+
export interface ShippingApiLinkCarrierAccount0Request {
|
|
901
|
+
/**
|
|
902
|
+
* An identifier for the carrier with which the seller\'s account is being linked.
|
|
903
|
+
* @type {string}
|
|
904
|
+
* @memberof ShippingApiLinkCarrierAccount0
|
|
905
|
+
*/
|
|
906
|
+
readonly carrierId: string;
|
|
907
|
+
/**
|
|
908
|
+
* LinkCarrierAccountRequest body
|
|
909
|
+
* @type {LinkCarrierAccountRequest}
|
|
910
|
+
* @memberof ShippingApiLinkCarrierAccount0
|
|
911
|
+
*/
|
|
912
|
+
readonly body: LinkCarrierAccountRequest;
|
|
913
|
+
/**
|
|
914
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
915
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
916
|
+
* @memberof ShippingApiLinkCarrierAccount0
|
|
917
|
+
*/
|
|
918
|
+
readonly xAmznShippingBusinessId?: LinkCarrierAccount0XAmznShippingBusinessIdEnum;
|
|
919
|
+
}
|
|
802
920
|
/**
|
|
803
921
|
* Request parameters for oneClickShipment operation in ShippingApi.
|
|
804
922
|
* @export
|
|
@@ -806,7 +924,7 @@ export interface ShippingApiLinkCarrierAccountRequest {
|
|
|
806
924
|
*/
|
|
807
925
|
export interface ShippingApiOneClickShipmentRequest {
|
|
808
926
|
/**
|
|
809
|
-
*
|
|
927
|
+
* OneClickShipmentRequest body
|
|
810
928
|
* @type {OneClickShipmentRequest}
|
|
811
929
|
* @memberof ShippingApiOneClickShipment
|
|
812
930
|
*/
|
|
@@ -825,7 +943,7 @@ export interface ShippingApiOneClickShipmentRequest {
|
|
|
825
943
|
*/
|
|
826
944
|
export interface ShippingApiPurchaseShipmentRequest {
|
|
827
945
|
/**
|
|
828
|
-
*
|
|
946
|
+
* PurchaseShipmentRequest body
|
|
829
947
|
* @type {PurchaseShipmentRequest}
|
|
830
948
|
* @memberof ShippingApiPurchaseShipment
|
|
831
949
|
*/
|
|
@@ -843,6 +961,25 @@ export interface ShippingApiPurchaseShipmentRequest {
|
|
|
843
961
|
*/
|
|
844
962
|
readonly xAmznShippingBusinessId?: PurchaseShipmentXAmznShippingBusinessIdEnum;
|
|
845
963
|
}
|
|
964
|
+
/**
|
|
965
|
+
* Request parameters for submitNdrFeedback operation in ShippingApi.
|
|
966
|
+
* @export
|
|
967
|
+
* @interface ShippingApiSubmitNdrFeedbackRequest
|
|
968
|
+
*/
|
|
969
|
+
export interface ShippingApiSubmitNdrFeedbackRequest {
|
|
970
|
+
/**
|
|
971
|
+
* Request body for ndrFeedback operation
|
|
972
|
+
* @type {SubmitNdrFeedbackRequest}
|
|
973
|
+
* @memberof ShippingApiSubmitNdrFeedback
|
|
974
|
+
*/
|
|
975
|
+
readonly body: SubmitNdrFeedbackRequest;
|
|
976
|
+
/**
|
|
977
|
+
* Amazon shipping business to assume for this request. The default is AmazonShipping_UK.
|
|
978
|
+
* @type {'AmazonShipping_US' | 'AmazonShipping_IN' | 'AmazonShipping_UK' | 'AmazonShipping_UAE' | 'AmazonShipping_SA' | 'AmazonShipping_EG' | 'AmazonShipping_IT' | 'AmazonShipping_ES' | 'AmazonShipping_FR' | 'AmazonShipping_JP'}
|
|
979
|
+
* @memberof ShippingApiSubmitNdrFeedback
|
|
980
|
+
*/
|
|
981
|
+
readonly xAmznShippingBusinessId?: SubmitNdrFeedbackXAmznShippingBusinessIdEnum;
|
|
982
|
+
}
|
|
846
983
|
/**
|
|
847
984
|
* Request parameters for unlinkCarrierAccount operation in ShippingApi.
|
|
848
985
|
* @export
|
|
@@ -856,7 +993,7 @@ export interface ShippingApiUnlinkCarrierAccountRequest {
|
|
|
856
993
|
*/
|
|
857
994
|
readonly carrierId: string;
|
|
858
995
|
/**
|
|
859
|
-
*
|
|
996
|
+
* UnlinkCarrierAccountRequest body
|
|
860
997
|
* @type {UnlinkCarrierAccountRequest}
|
|
861
998
|
* @memberof ShippingApiUnlinkCarrierAccount
|
|
862
999
|
*/
|
|
@@ -883,6 +1020,14 @@ export declare class ShippingApi extends BaseAPI {
|
|
|
883
1020
|
* @memberof ShippingApi
|
|
884
1021
|
*/
|
|
885
1022
|
cancelShipment(requestParameters: ShippingApiCancelShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CancelShipmentResponse, any>>;
|
|
1023
|
+
/**
|
|
1024
|
+
* This API will be used to create claim for single eligible shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
1025
|
+
* @param {ShippingApiCreateClaimRequest} requestParameters Request parameters.
|
|
1026
|
+
* @param {*} [options] Override http request option.
|
|
1027
|
+
* @throws {RequiredError}
|
|
1028
|
+
* @memberof ShippingApi
|
|
1029
|
+
*/
|
|
1030
|
+
createClaim(requestParameters: ShippingApiCreateClaimRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateClaimResponse, any>>;
|
|
886
1031
|
/**
|
|
887
1032
|
* Purchases the shipping service for a shipment using the best fit service offering. Returns purchase related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
888
1033
|
* @param {ShippingApiDirectPurchaseShipmentRequest} requestParameters Request parameters.
|
|
@@ -987,6 +1132,14 @@ export declare class ShippingApi extends BaseAPI {
|
|
|
987
1132
|
* @memberof ShippingApi
|
|
988
1133
|
*/
|
|
989
1134
|
linkCarrierAccount(requestParameters: ShippingApiLinkCarrierAccountRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<LinkCarrierAccountResponse, any>>;
|
|
1135
|
+
/**
|
|
1136
|
+
* This API associates/links the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 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 then 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).
|
|
1137
|
+
* @param {ShippingApiLinkCarrierAccount0Request} requestParameters Request parameters.
|
|
1138
|
+
* @param {*} [options] Override http request option.
|
|
1139
|
+
* @throws {RequiredError}
|
|
1140
|
+
* @memberof ShippingApi
|
|
1141
|
+
*/
|
|
1142
|
+
linkCarrierAccount_1(requestParameters: ShippingApiLinkCarrierAccount0Request, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<LinkCarrierAccountResponse, any>>;
|
|
990
1143
|
/**
|
|
991
1144
|
* Purchases a shipping service identifier and returns purchase-related details and documents. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
992
1145
|
* @param {ShippingApiOneClickShipmentRequest} requestParameters Request parameters.
|
|
@@ -1003,6 +1156,14 @@ export declare class ShippingApi extends BaseAPI {
|
|
|
1003
1156
|
* @memberof ShippingApi
|
|
1004
1157
|
*/
|
|
1005
1158
|
purchaseShipment(requestParameters: ShippingApiPurchaseShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PurchaseShipmentResponse, any>>;
|
|
1159
|
+
/**
|
|
1160
|
+
* This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
1161
|
+
* @param {ShippingApiSubmitNdrFeedbackRequest} requestParameters Request parameters.
|
|
1162
|
+
* @param {*} [options] Override http request option.
|
|
1163
|
+
* @throws {RequiredError}
|
|
1164
|
+
* @memberof ShippingApi
|
|
1165
|
+
*/
|
|
1166
|
+
submitNdrFeedback(requestParameters: ShippingApiSubmitNdrFeedbackRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
|
|
1006
1167
|
/**
|
|
1007
1168
|
* This API Unlink the specified carrier account with the merchant. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 80 | 100 | 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 then 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).
|
|
1008
1169
|
* @param {ShippingApiUnlinkCarrierAccountRequest} requestParameters Request parameters.
|
|
@@ -1028,6 +1189,22 @@ export declare const CancelShipmentXAmznShippingBusinessIdEnum: {
|
|
|
1028
1189
|
readonly AmazonShippingJp: "AmazonShipping_JP";
|
|
1029
1190
|
};
|
|
1030
1191
|
export type CancelShipmentXAmznShippingBusinessIdEnum = typeof CancelShipmentXAmznShippingBusinessIdEnum[keyof typeof CancelShipmentXAmznShippingBusinessIdEnum];
|
|
1192
|
+
/**
|
|
1193
|
+
* @export
|
|
1194
|
+
*/
|
|
1195
|
+
export declare const CreateClaimXAmznShippingBusinessIdEnum: {
|
|
1196
|
+
readonly AmazonShippingUs: "AmazonShipping_US";
|
|
1197
|
+
readonly AmazonShippingIn: "AmazonShipping_IN";
|
|
1198
|
+
readonly AmazonShippingUk: "AmazonShipping_UK";
|
|
1199
|
+
readonly AmazonShippingUae: "AmazonShipping_UAE";
|
|
1200
|
+
readonly AmazonShippingSa: "AmazonShipping_SA";
|
|
1201
|
+
readonly AmazonShippingEg: "AmazonShipping_EG";
|
|
1202
|
+
readonly AmazonShippingIt: "AmazonShipping_IT";
|
|
1203
|
+
readonly AmazonShippingEs: "AmazonShipping_ES";
|
|
1204
|
+
readonly AmazonShippingFr: "AmazonShipping_FR";
|
|
1205
|
+
readonly AmazonShippingJp: "AmazonShipping_JP";
|
|
1206
|
+
};
|
|
1207
|
+
export type CreateClaimXAmznShippingBusinessIdEnum = typeof CreateClaimXAmznShippingBusinessIdEnum[keyof typeof CreateClaimXAmznShippingBusinessIdEnum];
|
|
1031
1208
|
/**
|
|
1032
1209
|
* @export
|
|
1033
1210
|
*/
|
|
@@ -1250,6 +1427,22 @@ export declare const LinkCarrierAccountXAmznShippingBusinessIdEnum: {
|
|
|
1250
1427
|
readonly AmazonShippingJp: "AmazonShipping_JP";
|
|
1251
1428
|
};
|
|
1252
1429
|
export type LinkCarrierAccountXAmznShippingBusinessIdEnum = typeof LinkCarrierAccountXAmznShippingBusinessIdEnum[keyof typeof LinkCarrierAccountXAmznShippingBusinessIdEnum];
|
|
1430
|
+
/**
|
|
1431
|
+
* @export
|
|
1432
|
+
*/
|
|
1433
|
+
export declare const LinkCarrierAccount0XAmznShippingBusinessIdEnum: {
|
|
1434
|
+
readonly AmazonShippingUs: "AmazonShipping_US";
|
|
1435
|
+
readonly AmazonShippingIn: "AmazonShipping_IN";
|
|
1436
|
+
readonly AmazonShippingUk: "AmazonShipping_UK";
|
|
1437
|
+
readonly AmazonShippingUae: "AmazonShipping_UAE";
|
|
1438
|
+
readonly AmazonShippingSa: "AmazonShipping_SA";
|
|
1439
|
+
readonly AmazonShippingEg: "AmazonShipping_EG";
|
|
1440
|
+
readonly AmazonShippingIt: "AmazonShipping_IT";
|
|
1441
|
+
readonly AmazonShippingEs: "AmazonShipping_ES";
|
|
1442
|
+
readonly AmazonShippingFr: "AmazonShipping_FR";
|
|
1443
|
+
readonly AmazonShippingJp: "AmazonShipping_JP";
|
|
1444
|
+
};
|
|
1445
|
+
export type LinkCarrierAccount0XAmznShippingBusinessIdEnum = typeof LinkCarrierAccount0XAmznShippingBusinessIdEnum[keyof typeof LinkCarrierAccount0XAmznShippingBusinessIdEnum];
|
|
1253
1446
|
/**
|
|
1254
1447
|
* @export
|
|
1255
1448
|
*/
|
|
@@ -1282,6 +1475,22 @@ export declare const PurchaseShipmentXAmznShippingBusinessIdEnum: {
|
|
|
1282
1475
|
readonly AmazonShippingJp: "AmazonShipping_JP";
|
|
1283
1476
|
};
|
|
1284
1477
|
export type PurchaseShipmentXAmznShippingBusinessIdEnum = typeof PurchaseShipmentXAmznShippingBusinessIdEnum[keyof typeof PurchaseShipmentXAmznShippingBusinessIdEnum];
|
|
1478
|
+
/**
|
|
1479
|
+
* @export
|
|
1480
|
+
*/
|
|
1481
|
+
export declare const SubmitNdrFeedbackXAmznShippingBusinessIdEnum: {
|
|
1482
|
+
readonly AmazonShippingUs: "AmazonShipping_US";
|
|
1483
|
+
readonly AmazonShippingIn: "AmazonShipping_IN";
|
|
1484
|
+
readonly AmazonShippingUk: "AmazonShipping_UK";
|
|
1485
|
+
readonly AmazonShippingUae: "AmazonShipping_UAE";
|
|
1486
|
+
readonly AmazonShippingSa: "AmazonShipping_SA";
|
|
1487
|
+
readonly AmazonShippingEg: "AmazonShipping_EG";
|
|
1488
|
+
readonly AmazonShippingIt: "AmazonShipping_IT";
|
|
1489
|
+
readonly AmazonShippingEs: "AmazonShipping_ES";
|
|
1490
|
+
readonly AmazonShippingFr: "AmazonShipping_FR";
|
|
1491
|
+
readonly AmazonShippingJp: "AmazonShipping_JP";
|
|
1492
|
+
};
|
|
1493
|
+
export type SubmitNdrFeedbackXAmznShippingBusinessIdEnum = typeof SubmitNdrFeedbackXAmznShippingBusinessIdEnum[keyof typeof SubmitNdrFeedbackXAmznShippingBusinessIdEnum];
|
|
1285
1494
|
/**
|
|
1286
1495
|
* @export
|
|
1287
1496
|
*/
|