@sp-api-sdk/fulfillment-outbound-api-2020-07-01 4.0.1 → 4.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/fulfillment-outbound-api.js +93 -51
- package/dist/cjs/api-model/base.js +0 -19
- package/dist/cjs/api-model/common.js +0 -37
- package/dist/cjs/api-model/configuration.js +0 -17
- package/dist/cjs/api-model/models/additional-location-info.js +0 -2
- package/dist/cjs/api-model/models/current-status.js +0 -2
- package/dist/cjs/api-model/models/delivery-offering.js +15 -0
- package/dist/cjs/api-model/models/delivery-quantity.js +19 -0
- package/dist/cjs/api-model/models/event-code.js +0 -2
- package/dist/cjs/api-model/models/fulfillment-action.js +0 -2
- package/dist/cjs/api-model/models/fulfillment-order-status.js +0 -2
- package/dist/cjs/api-model/models/fulfillment-policy.js +1 -3
- package/dist/cjs/api-model/models/fulfillment-return-item-status.js +0 -2
- package/dist/cjs/api-model/models/get-delivery-offerings-request.js +15 -0
- package/dist/cjs/api-model/models/get-delivery-offerings-response.js +15 -0
- package/dist/cjs/api-model/models/get-delivery-offerings-result.js +15 -0
- package/dist/cjs/api-model/models/index.js +5 -0
- package/dist/cjs/api-model/models/invalid-item-reason-code.js +0 -2
- package/dist/cjs/api-model/models/return-item-disposition.js +0 -2
- package/dist/cjs/api-model/models/shipping-speed-category.js +0 -2
- package/dist/cjs/client.js +7 -0
- package/dist/es/api-model/api/fulfillment-outbound-api.js +93 -51
- package/dist/es/api-model/base.js +0 -19
- package/dist/es/api-model/common.js +0 -37
- package/dist/es/api-model/configuration.js +0 -17
- package/dist/es/api-model/models/additional-location-info.js +0 -2
- package/dist/es/api-model/models/current-status.js +0 -2
- package/dist/es/api-model/models/delivery-offering.js +14 -0
- package/dist/es/api-model/models/delivery-quantity.js +16 -0
- package/dist/es/api-model/models/event-code.js +0 -2
- package/dist/es/api-model/models/fulfillment-action.js +0 -2
- package/dist/es/api-model/models/fulfillment-order-status.js +0 -2
- package/dist/es/api-model/models/fulfillment-policy.js +1 -3
- package/dist/es/api-model/models/fulfillment-return-item-status.js +0 -2
- package/dist/es/api-model/models/get-delivery-offerings-request.js +14 -0
- package/dist/es/api-model/models/get-delivery-offerings-response.js +14 -0
- package/dist/es/api-model/models/get-delivery-offerings-result.js +14 -0
- package/dist/es/api-model/models/index.js +5 -0
- package/dist/es/api-model/models/invalid-item-reason-code.js +0 -2
- package/dist/es/api-model/models/return-item-disposition.js +0 -2
- package/dist/es/api-model/models/shipping-speed-category.js +0 -2
- package/dist/es/client.js +7 -0
- package/dist/types/api-model/api/fulfillment-outbound-api.d.ts +79 -134
- package/dist/types/api-model/base.d.ts +0 -24
- package/dist/types/api-model/common.d.ts +0 -37
- package/dist/types/api-model/configuration.d.ts +0 -17
- package/dist/types/api-model/models/additional-location-info.d.ts +0 -2
- package/dist/types/api-model/models/address.d.ts +0 -22
- package/dist/types/api-model/models/amount.d.ts +0 -6
- package/dist/types/api-model/models/cancel-fulfillment-order-response.d.ts +0 -4
- package/dist/types/api-model/models/codsettings.d.ts +0 -24
- package/dist/types/api-model/models/create-fulfillment-order-item.d.ts +1 -30
- package/dist/types/api-model/models/create-fulfillment-order-request.d.ts +2 -59
- package/dist/types/api-model/models/create-fulfillment-order-response.d.ts +0 -4
- package/dist/types/api-model/models/create-fulfillment-return-request.d.ts +1 -5
- package/dist/types/api-model/models/create-fulfillment-return-response.d.ts +0 -9
- package/dist/types/api-model/models/create-fulfillment-return-result.d.ts +1 -9
- package/dist/types/api-model/models/create-return-item.d.ts +1 -13
- package/dist/types/api-model/models/current-status.d.ts +0 -2
- package/dist/types/api-model/models/date-range.d.ts +0 -6
- package/dist/types/api-model/models/delivery-document.d.ts +0 -6
- package/dist/types/api-model/models/delivery-information.d.ts +0 -9
- package/dist/types/api-model/models/delivery-message.d.ts +1 -7
- package/dist/types/api-model/models/delivery-offer.d.ts +0 -14
- package/dist/types/api-model/models/delivery-offering.d.ts +24 -0
- package/dist/types/api-model/models/delivery-policy.d.ts +0 -7
- package/dist/types/api-model/models/delivery-preferences.d.ts +0 -9
- package/dist/types/api-model/models/delivery-quantity.d.ts +28 -0
- package/dist/types/api-model/models/delivery-window.d.ts +0 -6
- package/dist/types/api-model/models/destination.d.ts +0 -9
- package/dist/types/api-model/models/drop-off-location.d.ts +0 -6
- package/dist/types/api-model/models/event-code.d.ts +0 -2
- package/dist/types/api-model/models/feature-settings.d.ts +1 -7
- package/dist/types/api-model/models/feature-sku.d.ts +0 -12
- package/dist/types/api-model/models/feature.d.ts +0 -8
- package/dist/types/api-model/models/fee.d.ts +0 -9
- package/dist/types/api-model/models/fulfillment-action.d.ts +0 -2
- package/dist/types/api-model/models/fulfillment-order-item.d.ts +0 -39
- package/dist/types/api-model/models/fulfillment-order-status.d.ts +0 -2
- package/dist/types/api-model/models/fulfillment-order.d.ts +0 -55
- package/dist/types/api-model/models/fulfillment-policy.d.ts +1 -3
- package/dist/types/api-model/models/fulfillment-preview-item.d.ts +0 -15
- package/dist/types/api-model/models/fulfillment-preview-shipment.d.ts +0 -14
- package/dist/types/api-model/models/fulfillment-preview.d.ts +0 -33
- package/dist/types/api-model/models/fulfillment-return-item-status.d.ts +0 -2
- package/dist/types/api-model/models/fulfillment-shipment-item.d.ts +0 -14
- package/dist/types/api-model/models/fulfillment-shipment-package.d.ts +4 -20
- package/dist/types/api-model/models/fulfillment-shipment.d.ts +2 -20
- package/dist/types/api-model/models/get-delivery-offerings-request.d.ts +28 -0
- package/dist/types/api-model/models/get-delivery-offerings-response.d.ts +22 -0
- package/dist/types/api-model/models/get-delivery-offerings-result.d.ts +21 -0
- package/dist/types/api-model/models/get-delivery-offers-product.d.ts +0 -12
- package/dist/types/api-model/models/get-delivery-offers-request.d.ts +1 -13
- package/dist/types/api-model/models/get-delivery-offers-response.d.ts +1 -10
- package/dist/types/api-model/models/get-delivery-offers-result.d.ts +0 -4
- package/dist/types/api-model/models/get-delivery-offers-terms.d.ts +0 -12
- package/dist/types/api-model/models/get-feature-inventory-response.d.ts +0 -9
- package/dist/types/api-model/models/get-feature-inventory-result.d.ts +1 -11
- package/dist/types/api-model/models/get-feature-sku-response.d.ts +0 -9
- package/dist/types/api-model/models/get-feature-sku-result.d.ts +1 -16
- package/dist/types/api-model/models/get-features-response.d.ts +0 -9
- package/dist/types/api-model/models/get-features-result.d.ts +0 -4
- package/dist/types/api-model/models/get-fulfillment-order-response.d.ts +0 -9
- package/dist/types/api-model/models/get-fulfillment-order-result.d.ts +1 -18
- package/dist/types/api-model/models/get-fulfillment-preview-item.d.ts +0 -13
- package/dist/types/api-model/models/get-fulfillment-preview-request.d.ts +2 -21
- package/dist/types/api-model/models/get-fulfillment-preview-response.d.ts +0 -9
- package/dist/types/api-model/models/get-fulfillment-preview-result.d.ts +0 -4
- package/dist/types/api-model/models/get-package-tracking-details-response.d.ts +0 -9
- package/dist/types/api-model/models/index.d.ts +5 -0
- package/dist/types/api-model/models/invalid-item-reason-code.d.ts +0 -2
- package/dist/types/api-model/models/invalid-item-reason.d.ts +0 -9
- package/dist/types/api-model/models/invalid-return-item.d.ts +1 -12
- package/dist/types/api-model/models/list-all-fulfillment-orders-response.d.ts +0 -9
- package/dist/types/api-model/models/list-all-fulfillment-orders-result.d.ts +1 -7
- package/dist/types/api-model/models/list-return-reason-codes-response.d.ts +0 -9
- package/dist/types/api-model/models/list-return-reason-codes-result.d.ts +1 -5
- package/dist/types/api-model/models/locker-details.d.ts +0 -6
- package/dist/types/api-model/models/model-error.d.ts +0 -8
- package/dist/types/api-model/models/money.d.ts +0 -6
- package/dist/types/api-model/models/origin.d.ts +0 -4
- package/dist/types/api-model/models/package-tracking-details.d.ts +1 -45
- package/dist/types/api-model/models/payment-information.d.ts +0 -8
- package/dist/types/api-model/models/product-identifier.d.ts +0 -4
- package/dist/types/api-model/models/reason-code-details.d.ts +1 -9
- package/dist/types/api-model/models/return-authorization.d.ts +1 -16
- package/dist/types/api-model/models/return-item-disposition.d.ts +0 -2
- package/dist/types/api-model/models/return-item.d.ts +1 -31
- package/dist/types/api-model/models/scheduled-delivery-info.d.ts +0 -6
- package/dist/types/api-model/models/shipping-speed-category.d.ts +0 -2
- package/dist/types/api-model/models/submit-fulfillment-order-status-update-request.d.ts +0 -7
- package/dist/types/api-model/models/submit-fulfillment-order-status-update-response.d.ts +0 -4
- package/dist/types/api-model/models/tracking-address.d.ts +0 -8
- package/dist/types/api-model/models/tracking-event.d.ts +0 -16
- package/dist/types/api-model/models/unfulfillable-preview-item.d.ts +0 -10
- package/dist/types/api-model/models/update-fulfillment-order-item.d.ts +1 -32
- package/dist/types/api-model/models/update-fulfillment-order-request.d.ts +0 -38
- package/dist/types/api-model/models/update-fulfillment-order-response.d.ts +0 -4
- package/dist/types/api-model/models/variable-precision-address.d.ts +0 -18
- package/dist/types/api-model/models/weight.d.ts +0 -6
- package/package.json +25 -4
|
@@ -18,6 +18,8 @@ import type { CreateFulfillmentOrderRequest } from '../models';
|
|
|
18
18
|
import type { CreateFulfillmentOrderResponse } from '../models';
|
|
19
19
|
import type { CreateFulfillmentReturnRequest } from '../models';
|
|
20
20
|
import type { CreateFulfillmentReturnResponse } from '../models';
|
|
21
|
+
import type { GetDeliveryOfferingsRequest } from '../models';
|
|
22
|
+
import type { GetDeliveryOfferingsResponse } from '../models';
|
|
21
23
|
import type { GetDeliveryOffersRequest } from '../models';
|
|
22
24
|
import type { GetDeliveryOffersResponse } from '../models';
|
|
23
25
|
import type { GetFeatureInventoryResponse } from '../models';
|
|
@@ -35,7 +37,6 @@ import type { UpdateFulfillmentOrderRequest } from '../models';
|
|
|
35
37
|
import type { UpdateFulfillmentOrderResponse } from '../models';
|
|
36
38
|
/**
|
|
37
39
|
* FulfillmentOutboundApi - axios parameter creator
|
|
38
|
-
* @export
|
|
39
40
|
*/
|
|
40
41
|
export declare const FulfillmentOutboundApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
41
42
|
/**
|
|
@@ -54,12 +55,19 @@ export declare const FulfillmentOutboundApiAxiosParamCreator: (configuration?: C
|
|
|
54
55
|
createFulfillmentOrder: (body: CreateFulfillmentOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
56
|
/**
|
|
56
57
|
* Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [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).
|
|
57
|
-
* @param {string} sellerFulfillmentOrderId An identifier
|
|
58
|
-
* @param {CreateFulfillmentReturnRequest} body
|
|
58
|
+
* @param {string} sellerFulfillmentOrderId An identifier the seller assigns to the fulfillment order at the time it was created. The seller uses their own records to find the correct `sellerFulfillmentOrderId` value based on the buyer\'s request to return items.
|
|
59
|
+
* @param {CreateFulfillmentReturnRequest} body The request body of the `createFulfillmentReturn` operation.
|
|
59
60
|
* @param {*} [options] Override http request option.
|
|
60
61
|
* @throws {RequiredError}
|
|
61
62
|
*/
|
|
62
63
|
createFulfillmentReturn: (sellerFulfillmentOrderId: string, body: CreateFulfillmentReturnRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
|
+
/**
|
|
65
|
+
* Returns fast delivery estimates for Product Detail and Collection pages, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [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).
|
|
66
|
+
* @param {GetDeliveryOfferingsRequest} body GetDeliveryOfferingsRequest parameter
|
|
67
|
+
* @param {*} [options] Override http request option.
|
|
68
|
+
* @throws {RequiredError}
|
|
69
|
+
*/
|
|
70
|
+
deliveryOfferings: (body: GetDeliveryOfferingsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63
71
|
/**
|
|
64
72
|
* Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [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).
|
|
65
73
|
* @param {GetDeliveryOffersRequest} body GetDeliveryOffersRequest parameter
|
|
@@ -71,17 +79,17 @@ export declare const FulfillmentOutboundApiAxiosParamCreator: (configuration?: C
|
|
|
71
79
|
* Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [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)..
|
|
72
80
|
* @param {string} marketplaceId The marketplace for which to return a list of the inventory that is eligible for the specified feature.
|
|
73
81
|
* @param {string} featureName The name of the feature for which to return a list of eligible inventory.
|
|
74
|
-
* @param {string} [nextToken] A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page.
|
|
75
|
-
* @param {string} [queryStartDate] A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ
|
|
82
|
+
* @param {string} [nextToken] A string token returned in the response to your previous request that is used to return the next response page. A value of `null` will return the first page.
|
|
83
|
+
* @param {string} [queryStartDate] A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format `yyyy-MM-ddTHH:mm:ss.sssZ`
|
|
76
84
|
* @param {*} [options] Override http request option.
|
|
77
85
|
* @throws {RequiredError}
|
|
78
86
|
*/
|
|
79
87
|
getFeatureInventory: (marketplaceId: string, featureName: string, nextToken?: string, queryStartDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
80
88
|
/**
|
|
81
|
-
* Returns the number of items with the
|
|
89
|
+
* Returns the number of items with the `sellerSku` you specify that can have orders fulfilled using the specified feature. Note that if the `sellerSku` isn\'t eligible, the response will contain an empty `skuInfo` object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
82
90
|
* @param {string} marketplaceId The marketplace for which to return the count.
|
|
83
91
|
* @param {string} featureName The name of the feature.
|
|
84
|
-
* @param {string} sellerSku Used to identify an item in the given marketplace. `
|
|
92
|
+
* @param {string} sellerSku Used to identify an item in the given marketplace. `sellerSku` is qualified by the seller\'s `sellerId`, which is included with every operation that you submit.
|
|
85
93
|
* @param {*} [options] Override http request option.
|
|
86
94
|
* @throws {RequiredError}
|
|
87
95
|
*/
|
|
@@ -109,13 +117,14 @@ export declare const FulfillmentOutboundApiAxiosParamCreator: (configuration?: C
|
|
|
109
117
|
getFulfillmentPreview: (body: GetFulfillmentPreviewRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
110
118
|
/**
|
|
111
119
|
* Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [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).
|
|
112
|
-
* @param {number} packageNumber The unencrypted package identifier
|
|
120
|
+
* @param {number} [packageNumber] The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation.
|
|
121
|
+
* @param {string} [amazonFulfillmentTrackingNumber] The Amazon fulfillment tracking number. You can obtain this value from the `getFulfillmentOrder` operation.
|
|
113
122
|
* @param {*} [options] Override http request option.
|
|
114
123
|
* @throws {RequiredError}
|
|
115
124
|
*/
|
|
116
|
-
getPackageTrackingDetails: (packageNumber
|
|
125
|
+
getPackageTrackingDetails: (packageNumber?: number, amazonFulfillmentTrackingNumber?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
117
126
|
/**
|
|
118
|
-
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the
|
|
127
|
+
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table 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
128
|
* @param {string} [queryStartDate] A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order.
|
|
120
129
|
* @param {string} [nextToken] A string token returned in the response to your previous request.
|
|
121
130
|
* @param {*} [options] Override http request option.
|
|
@@ -143,7 +152,7 @@ export declare const FulfillmentOutboundApiAxiosParamCreator: (configuration?: C
|
|
|
143
152
|
/**
|
|
144
153
|
* Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [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
154
|
* @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
146
|
-
* @param {UpdateFulfillmentOrderRequest} body
|
|
155
|
+
* @param {UpdateFulfillmentOrderRequest} body The request body of the `updateFulfillmentOrder` operation.
|
|
147
156
|
* @param {*} [options] Override http request option.
|
|
148
157
|
* @throws {RequiredError}
|
|
149
158
|
*/
|
|
@@ -151,7 +160,6 @@ export declare const FulfillmentOutboundApiAxiosParamCreator: (configuration?: C
|
|
|
151
160
|
};
|
|
152
161
|
/**
|
|
153
162
|
* FulfillmentOutboundApi - functional programming interface
|
|
154
|
-
* @export
|
|
155
163
|
*/
|
|
156
164
|
export declare const FulfillmentOutboundApiFp: (configuration?: Configuration) => {
|
|
157
165
|
/**
|
|
@@ -170,12 +178,19 @@ export declare const FulfillmentOutboundApiFp: (configuration?: Configuration) =
|
|
|
170
178
|
createFulfillmentOrder(body: CreateFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFulfillmentOrderResponse>>;
|
|
171
179
|
/**
|
|
172
180
|
* Creates a fulfillment return. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [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).
|
|
173
|
-
* @param {string} sellerFulfillmentOrderId An identifier
|
|
174
|
-
* @param {CreateFulfillmentReturnRequest} body
|
|
181
|
+
* @param {string} sellerFulfillmentOrderId An identifier the seller assigns to the fulfillment order at the time it was created. The seller uses their own records to find the correct `sellerFulfillmentOrderId` value based on the buyer\'s request to return items.
|
|
182
|
+
* @param {CreateFulfillmentReturnRequest} body The request body of the `createFulfillmentReturn` operation.
|
|
175
183
|
* @param {*} [options] Override http request option.
|
|
176
184
|
* @throws {RequiredError}
|
|
177
185
|
*/
|
|
178
186
|
createFulfillmentReturn(sellerFulfillmentOrderId: string, body: CreateFulfillmentReturnRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFulfillmentReturnResponse>>;
|
|
187
|
+
/**
|
|
188
|
+
* Returns fast delivery estimates for Product Detail and Collection pages, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [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
|
+
* @param {GetDeliveryOfferingsRequest} body GetDeliveryOfferingsRequest parameter
|
|
190
|
+
* @param {*} [options] Override http request option.
|
|
191
|
+
* @throws {RequiredError}
|
|
192
|
+
*/
|
|
193
|
+
deliveryOfferings(body: GetDeliveryOfferingsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDeliveryOfferingsResponse>>;
|
|
179
194
|
/**
|
|
180
195
|
* Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [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).
|
|
181
196
|
* @param {GetDeliveryOffersRequest} body GetDeliveryOffersRequest parameter
|
|
@@ -187,17 +202,17 @@ export declare const FulfillmentOutboundApiFp: (configuration?: Configuration) =
|
|
|
187
202
|
* Returns a list of inventory items that are eligible for the fulfillment feature you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)..
|
|
188
203
|
* @param {string} marketplaceId The marketplace for which to return a list of the inventory that is eligible for the specified feature.
|
|
189
204
|
* @param {string} featureName The name of the feature for which to return a list of eligible inventory.
|
|
190
|
-
* @param {string} [nextToken] A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page.
|
|
191
|
-
* @param {string} [queryStartDate] A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ
|
|
205
|
+
* @param {string} [nextToken] A string token returned in the response to your previous request that is used to return the next response page. A value of `null` will return the first page.
|
|
206
|
+
* @param {string} [queryStartDate] A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format `yyyy-MM-ddTHH:mm:ss.sssZ`
|
|
192
207
|
* @param {*} [options] Override http request option.
|
|
193
208
|
* @throws {RequiredError}
|
|
194
209
|
*/
|
|
195
210
|
getFeatureInventory(marketplaceId: string, featureName: string, nextToken?: string, queryStartDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFeatureInventoryResponse>>;
|
|
196
211
|
/**
|
|
197
|
-
* Returns the number of items with the
|
|
212
|
+
* Returns the number of items with the `sellerSku` you specify that can have orders fulfilled using the specified feature. Note that if the `sellerSku` isn\'t eligible, the response will contain an empty `skuInfo` object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table 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).
|
|
198
213
|
* @param {string} marketplaceId The marketplace for which to return the count.
|
|
199
214
|
* @param {string} featureName The name of the feature.
|
|
200
|
-
* @param {string} sellerSku Used to identify an item in the given marketplace. `
|
|
215
|
+
* @param {string} sellerSku Used to identify an item in the given marketplace. `sellerSku` is qualified by the seller\'s `sellerId`, which is included with every operation that you submit.
|
|
201
216
|
* @param {*} [options] Override http request option.
|
|
202
217
|
* @throws {RequiredError}
|
|
203
218
|
*/
|
|
@@ -225,13 +240,14 @@ export declare const FulfillmentOutboundApiFp: (configuration?: Configuration) =
|
|
|
225
240
|
getFulfillmentPreview(body: GetFulfillmentPreviewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFulfillmentPreviewResponse>>;
|
|
226
241
|
/**
|
|
227
242
|
* Returns delivery tracking information for a package in an outbound shipment for a Multi-Channel Fulfillment order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [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).
|
|
228
|
-
* @param {number} packageNumber The unencrypted package identifier
|
|
243
|
+
* @param {number} [packageNumber] The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation.
|
|
244
|
+
* @param {string} [amazonFulfillmentTrackingNumber] The Amazon fulfillment tracking number. You can obtain this value from the `getFulfillmentOrder` operation.
|
|
229
245
|
* @param {*} [options] Override http request option.
|
|
230
246
|
* @throws {RequiredError}
|
|
231
247
|
*/
|
|
232
|
-
getPackageTrackingDetails(packageNumber
|
|
248
|
+
getPackageTrackingDetails(packageNumber?: number, amazonFulfillmentTrackingNumber?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPackageTrackingDetailsResponse>>;
|
|
233
249
|
/**
|
|
234
|
-
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the
|
|
250
|
+
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table 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)
|
|
235
251
|
* @param {string} [queryStartDate] A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order.
|
|
236
252
|
* @param {string} [nextToken] A string token returned in the response to your previous request.
|
|
237
253
|
* @param {*} [options] Override http request option.
|
|
@@ -259,7 +275,7 @@ export declare const FulfillmentOutboundApiFp: (configuration?: Configuration) =
|
|
|
259
275
|
/**
|
|
260
276
|
* Updates and/or requests shipment for a fulfillment order with an order hold on it. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [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).
|
|
261
277
|
* @param {string} sellerFulfillmentOrderId The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
262
|
-
* @param {UpdateFulfillmentOrderRequest} body
|
|
278
|
+
* @param {UpdateFulfillmentOrderRequest} body The request body of the `updateFulfillmentOrder` operation.
|
|
263
279
|
* @param {*} [options] Override http request option.
|
|
264
280
|
* @throws {RequiredError}
|
|
265
281
|
*/
|
|
@@ -267,7 +283,6 @@ export declare const FulfillmentOutboundApiFp: (configuration?: Configuration) =
|
|
|
267
283
|
};
|
|
268
284
|
/**
|
|
269
285
|
* FulfillmentOutboundApi - factory interface
|
|
270
|
-
* @export
|
|
271
286
|
*/
|
|
272
287
|
export declare const FulfillmentOutboundApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
273
288
|
/**
|
|
@@ -291,6 +306,13 @@ export declare const FulfillmentOutboundApiFactory: (configuration?: Configurati
|
|
|
291
306
|
* @throws {RequiredError}
|
|
292
307
|
*/
|
|
293
308
|
createFulfillmentReturn(requestParameters: FulfillmentOutboundApiCreateFulfillmentReturnRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateFulfillmentReturnResponse>;
|
|
309
|
+
/**
|
|
310
|
+
* Returns fast delivery estimates for Product Detail and Collection pages, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [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).
|
|
311
|
+
* @param {FulfillmentOutboundApiDeliveryOfferingsRequest} requestParameters Request parameters.
|
|
312
|
+
* @param {*} [options] Override http request option.
|
|
313
|
+
* @throws {RequiredError}
|
|
314
|
+
*/
|
|
315
|
+
deliveryOfferings(requestParameters: FulfillmentOutboundApiDeliveryOfferingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDeliveryOfferingsResponse>;
|
|
294
316
|
/**
|
|
295
317
|
* Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [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).
|
|
296
318
|
* @param {FulfillmentOutboundApiDeliveryOffersRequest} requestParameters Request parameters.
|
|
@@ -306,7 +328,7 @@ export declare const FulfillmentOutboundApiFactory: (configuration?: Configurati
|
|
|
306
328
|
*/
|
|
307
329
|
getFeatureInventory(requestParameters: FulfillmentOutboundApiGetFeatureInventoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetFeatureInventoryResponse>;
|
|
308
330
|
/**
|
|
309
|
-
* Returns the number of items with the
|
|
331
|
+
* Returns the number of items with the `sellerSku` you specify that can have orders fulfilled using the specified feature. Note that if the `sellerSku` isn\'t eligible, the response will contain an empty `skuInfo` object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table 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).
|
|
310
332
|
* @param {FulfillmentOutboundApiGetFeatureSKURequest} requestParameters Request parameters.
|
|
311
333
|
* @param {*} [options] Override http request option.
|
|
312
334
|
* @throws {RequiredError}
|
|
@@ -339,9 +361,9 @@ export declare const FulfillmentOutboundApiFactory: (configuration?: Configurati
|
|
|
339
361
|
* @param {*} [options] Override http request option.
|
|
340
362
|
* @throws {RequiredError}
|
|
341
363
|
*/
|
|
342
|
-
getPackageTrackingDetails(requestParameters
|
|
364
|
+
getPackageTrackingDetails(requestParameters?: FulfillmentOutboundApiGetPackageTrackingDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPackageTrackingDetailsResponse>;
|
|
343
365
|
/**
|
|
344
|
-
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the
|
|
366
|
+
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table 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)
|
|
345
367
|
* @param {FulfillmentOutboundApiListAllFulfillmentOrdersRequest} requestParameters Request parameters.
|
|
346
368
|
* @param {*} [options] Override http request option.
|
|
347
369
|
* @throws {RequiredError}
|
|
@@ -371,263 +393,193 @@ export declare const FulfillmentOutboundApiFactory: (configuration?: Configurati
|
|
|
371
393
|
};
|
|
372
394
|
/**
|
|
373
395
|
* Request parameters for cancelFulfillmentOrder operation in FulfillmentOutboundApi.
|
|
374
|
-
* @export
|
|
375
|
-
* @interface FulfillmentOutboundApiCancelFulfillmentOrderRequest
|
|
376
396
|
*/
|
|
377
397
|
export interface FulfillmentOutboundApiCancelFulfillmentOrderRequest {
|
|
378
398
|
/**
|
|
379
399
|
* The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
380
|
-
* @type {string}
|
|
381
|
-
* @memberof FulfillmentOutboundApiCancelFulfillmentOrder
|
|
382
400
|
*/
|
|
383
401
|
readonly sellerFulfillmentOrderId: string;
|
|
384
402
|
}
|
|
385
403
|
/**
|
|
386
404
|
* Request parameters for createFulfillmentOrder operation in FulfillmentOutboundApi.
|
|
387
|
-
* @export
|
|
388
|
-
* @interface FulfillmentOutboundApiCreateFulfillmentOrderRequest
|
|
389
405
|
*/
|
|
390
406
|
export interface FulfillmentOutboundApiCreateFulfillmentOrderRequest {
|
|
391
407
|
/**
|
|
392
408
|
* CreateFulfillmentOrderRequest parameter
|
|
393
|
-
* @type {CreateFulfillmentOrderRequest}
|
|
394
|
-
* @memberof FulfillmentOutboundApiCreateFulfillmentOrder
|
|
395
409
|
*/
|
|
396
410
|
readonly body: CreateFulfillmentOrderRequest;
|
|
397
411
|
}
|
|
398
412
|
/**
|
|
399
413
|
* Request parameters for createFulfillmentReturn operation in FulfillmentOutboundApi.
|
|
400
|
-
* @export
|
|
401
|
-
* @interface FulfillmentOutboundApiCreateFulfillmentReturnRequest
|
|
402
414
|
*/
|
|
403
415
|
export interface FulfillmentOutboundApiCreateFulfillmentReturnRequest {
|
|
404
416
|
/**
|
|
405
|
-
* An identifier
|
|
406
|
-
* @type {string}
|
|
407
|
-
* @memberof FulfillmentOutboundApiCreateFulfillmentReturn
|
|
417
|
+
* An identifier the seller assigns to the fulfillment order at the time it was created. The seller uses their own records to find the correct `sellerFulfillmentOrderId` value based on the buyer\'s request to return items.
|
|
408
418
|
*/
|
|
409
419
|
readonly sellerFulfillmentOrderId: string;
|
|
410
420
|
/**
|
|
411
|
-
*
|
|
412
|
-
* @type {CreateFulfillmentReturnRequest}
|
|
413
|
-
* @memberof FulfillmentOutboundApiCreateFulfillmentReturn
|
|
421
|
+
* The request body of the `createFulfillmentReturn` operation.
|
|
414
422
|
*/
|
|
415
423
|
readonly body: CreateFulfillmentReturnRequest;
|
|
416
424
|
}
|
|
425
|
+
/**
|
|
426
|
+
* Request parameters for deliveryOfferings operation in FulfillmentOutboundApi.
|
|
427
|
+
*/
|
|
428
|
+
export interface FulfillmentOutboundApiDeliveryOfferingsRequest {
|
|
429
|
+
/**
|
|
430
|
+
* GetDeliveryOfferingsRequest parameter
|
|
431
|
+
*/
|
|
432
|
+
readonly body: GetDeliveryOfferingsRequest;
|
|
433
|
+
}
|
|
417
434
|
/**
|
|
418
435
|
* Request parameters for deliveryOffers operation in FulfillmentOutboundApi.
|
|
419
|
-
* @export
|
|
420
|
-
* @interface FulfillmentOutboundApiDeliveryOffersRequest
|
|
421
436
|
*/
|
|
422
437
|
export interface FulfillmentOutboundApiDeliveryOffersRequest {
|
|
423
438
|
/**
|
|
424
439
|
* GetDeliveryOffersRequest parameter
|
|
425
|
-
* @type {GetDeliveryOffersRequest}
|
|
426
|
-
* @memberof FulfillmentOutboundApiDeliveryOffers
|
|
427
440
|
*/
|
|
428
441
|
readonly body: GetDeliveryOffersRequest;
|
|
429
442
|
}
|
|
430
443
|
/**
|
|
431
444
|
* Request parameters for getFeatureInventory operation in FulfillmentOutboundApi.
|
|
432
|
-
* @export
|
|
433
|
-
* @interface FulfillmentOutboundApiGetFeatureInventoryRequest
|
|
434
445
|
*/
|
|
435
446
|
export interface FulfillmentOutboundApiGetFeatureInventoryRequest {
|
|
436
447
|
/**
|
|
437
448
|
* The marketplace for which to return a list of the inventory that is eligible for the specified feature.
|
|
438
|
-
* @type {string}
|
|
439
|
-
* @memberof FulfillmentOutboundApiGetFeatureInventory
|
|
440
449
|
*/
|
|
441
450
|
readonly marketplaceId: string;
|
|
442
451
|
/**
|
|
443
452
|
* The name of the feature for which to return a list of eligible inventory.
|
|
444
|
-
* @type {string}
|
|
445
|
-
* @memberof FulfillmentOutboundApiGetFeatureInventory
|
|
446
453
|
*/
|
|
447
454
|
readonly featureName: string;
|
|
448
455
|
/**
|
|
449
|
-
* A string token returned in the response to your previous request that is used to return the next response page. A value of null will return the first page.
|
|
450
|
-
* @type {string}
|
|
451
|
-
* @memberof FulfillmentOutboundApiGetFeatureInventory
|
|
456
|
+
* A string token returned in the response to your previous request that is used to return the next response page. A value of `null` will return the first page.
|
|
452
457
|
*/
|
|
453
458
|
readonly nextToken?: string;
|
|
454
459
|
/**
|
|
455
|
-
* A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format yyyy-MM-ddTHH:mm:ss.sssZ
|
|
456
|
-
* @type {string}
|
|
457
|
-
* @memberof FulfillmentOutboundApiGetFeatureInventory
|
|
460
|
+
* A date that you can use to select inventory that has been updated since a specified date. An update is defined as any change in feature-enabled inventory availability. The date must be in the format `yyyy-MM-ddTHH:mm:ss.sssZ`
|
|
458
461
|
*/
|
|
459
462
|
readonly queryStartDate?: string;
|
|
460
463
|
}
|
|
461
464
|
/**
|
|
462
465
|
* Request parameters for getFeatureSKU operation in FulfillmentOutboundApi.
|
|
463
|
-
* @export
|
|
464
|
-
* @interface FulfillmentOutboundApiGetFeatureSKURequest
|
|
465
466
|
*/
|
|
466
467
|
export interface FulfillmentOutboundApiGetFeatureSKURequest {
|
|
467
468
|
/**
|
|
468
469
|
* The marketplace for which to return the count.
|
|
469
|
-
* @type {string}
|
|
470
|
-
* @memberof FulfillmentOutboundApiGetFeatureSKU
|
|
471
470
|
*/
|
|
472
471
|
readonly marketplaceId: string;
|
|
473
472
|
/**
|
|
474
473
|
* The name of the feature.
|
|
475
|
-
* @type {string}
|
|
476
|
-
* @memberof FulfillmentOutboundApiGetFeatureSKU
|
|
477
474
|
*/
|
|
478
475
|
readonly featureName: string;
|
|
479
476
|
/**
|
|
480
|
-
* Used to identify an item in the given marketplace. `
|
|
481
|
-
* @type {string}
|
|
482
|
-
* @memberof FulfillmentOutboundApiGetFeatureSKU
|
|
477
|
+
* Used to identify an item in the given marketplace. `sellerSku` is qualified by the seller\'s `sellerId`, which is included with every operation that you submit.
|
|
483
478
|
*/
|
|
484
479
|
readonly sellerSku: string;
|
|
485
480
|
}
|
|
486
481
|
/**
|
|
487
482
|
* Request parameters for getFeatures operation in FulfillmentOutboundApi.
|
|
488
|
-
* @export
|
|
489
|
-
* @interface FulfillmentOutboundApiGetFeaturesRequest
|
|
490
483
|
*/
|
|
491
484
|
export interface FulfillmentOutboundApiGetFeaturesRequest {
|
|
492
485
|
/**
|
|
493
486
|
* The marketplace for which to return the list of features.
|
|
494
|
-
* @type {string}
|
|
495
|
-
* @memberof FulfillmentOutboundApiGetFeatures
|
|
496
487
|
*/
|
|
497
488
|
readonly marketplaceId: string;
|
|
498
489
|
}
|
|
499
490
|
/**
|
|
500
491
|
* Request parameters for getFulfillmentOrder operation in FulfillmentOutboundApi.
|
|
501
|
-
* @export
|
|
502
|
-
* @interface FulfillmentOutboundApiGetFulfillmentOrderRequest
|
|
503
492
|
*/
|
|
504
493
|
export interface FulfillmentOutboundApiGetFulfillmentOrderRequest {
|
|
505
494
|
/**
|
|
506
495
|
* The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
507
|
-
* @type {string}
|
|
508
|
-
* @memberof FulfillmentOutboundApiGetFulfillmentOrder
|
|
509
496
|
*/
|
|
510
497
|
readonly sellerFulfillmentOrderId: string;
|
|
511
498
|
}
|
|
512
499
|
/**
|
|
513
500
|
* Request parameters for getFulfillmentPreview operation in FulfillmentOutboundApi.
|
|
514
|
-
* @export
|
|
515
|
-
* @interface FulfillmentOutboundApiGetFulfillmentPreviewRequest
|
|
516
501
|
*/
|
|
517
502
|
export interface FulfillmentOutboundApiGetFulfillmentPreviewRequest {
|
|
518
503
|
/**
|
|
519
504
|
* GetFulfillmentPreviewRequest parameter
|
|
520
|
-
* @type {GetFulfillmentPreviewRequest}
|
|
521
|
-
* @memberof FulfillmentOutboundApiGetFulfillmentPreview
|
|
522
505
|
*/
|
|
523
506
|
readonly body: GetFulfillmentPreviewRequest;
|
|
524
507
|
}
|
|
525
508
|
/**
|
|
526
509
|
* Request parameters for getPackageTrackingDetails operation in FulfillmentOutboundApi.
|
|
527
|
-
* @export
|
|
528
|
-
* @interface FulfillmentOutboundApiGetPackageTrackingDetailsRequest
|
|
529
510
|
*/
|
|
530
511
|
export interface FulfillmentOutboundApiGetPackageTrackingDetailsRequest {
|
|
531
512
|
/**
|
|
532
|
-
* The unencrypted package identifier
|
|
533
|
-
* @type {number}
|
|
534
|
-
* @memberof FulfillmentOutboundApiGetPackageTrackingDetails
|
|
513
|
+
* The unencrypted package identifier. You can obtain this value from the `getFulfillmentOrder` operation.
|
|
535
514
|
*/
|
|
536
|
-
readonly packageNumber
|
|
515
|
+
readonly packageNumber?: number;
|
|
516
|
+
/**
|
|
517
|
+
* The Amazon fulfillment tracking number. You can obtain this value from the `getFulfillmentOrder` operation.
|
|
518
|
+
*/
|
|
519
|
+
readonly amazonFulfillmentTrackingNumber?: string;
|
|
537
520
|
}
|
|
538
521
|
/**
|
|
539
522
|
* Request parameters for listAllFulfillmentOrders operation in FulfillmentOutboundApi.
|
|
540
|
-
* @export
|
|
541
|
-
* @interface FulfillmentOutboundApiListAllFulfillmentOrdersRequest
|
|
542
523
|
*/
|
|
543
524
|
export interface FulfillmentOutboundApiListAllFulfillmentOrdersRequest {
|
|
544
525
|
/**
|
|
545
526
|
* A date used to select fulfillment orders that were last updated after (or at) a specified time. An update is defined as any change in fulfillment order status, including the creation of a new fulfillment order.
|
|
546
|
-
* @type {string}
|
|
547
|
-
* @memberof FulfillmentOutboundApiListAllFulfillmentOrders
|
|
548
527
|
*/
|
|
549
528
|
readonly queryStartDate?: string;
|
|
550
529
|
/**
|
|
551
530
|
* A string token returned in the response to your previous request.
|
|
552
|
-
* @type {string}
|
|
553
|
-
* @memberof FulfillmentOutboundApiListAllFulfillmentOrders
|
|
554
531
|
*/
|
|
555
532
|
readonly nextToken?: string;
|
|
556
533
|
}
|
|
557
534
|
/**
|
|
558
535
|
* Request parameters for listReturnReasonCodes operation in FulfillmentOutboundApi.
|
|
559
|
-
* @export
|
|
560
|
-
* @interface FulfillmentOutboundApiListReturnReasonCodesRequest
|
|
561
536
|
*/
|
|
562
537
|
export interface FulfillmentOutboundApiListReturnReasonCodesRequest {
|
|
563
538
|
/**
|
|
564
539
|
* The seller SKU for which return reason codes are required.
|
|
565
|
-
* @type {string}
|
|
566
|
-
* @memberof FulfillmentOutboundApiListReturnReasonCodes
|
|
567
540
|
*/
|
|
568
541
|
readonly sellerSku: string;
|
|
569
542
|
/**
|
|
570
543
|
* The marketplace for which the seller wants return reason codes.
|
|
571
|
-
* @type {string}
|
|
572
|
-
* @memberof FulfillmentOutboundApiListReturnReasonCodes
|
|
573
544
|
*/
|
|
574
545
|
readonly marketplaceId?: string;
|
|
575
546
|
/**
|
|
576
547
|
* The identifier assigned to the item by the seller when the fulfillment order was created. The service uses this value to determine the marketplace for which the seller wants return reason codes.
|
|
577
|
-
* @type {string}
|
|
578
|
-
* @memberof FulfillmentOutboundApiListReturnReasonCodes
|
|
579
548
|
*/
|
|
580
549
|
readonly sellerFulfillmentOrderId?: string;
|
|
581
550
|
/**
|
|
582
551
|
* The language that the `TranslatedDescription` property of the `ReasonCodeDetails` response object should be translated into.
|
|
583
|
-
* @type {string}
|
|
584
|
-
* @memberof FulfillmentOutboundApiListReturnReasonCodes
|
|
585
552
|
*/
|
|
586
553
|
readonly language?: string;
|
|
587
554
|
}
|
|
588
555
|
/**
|
|
589
556
|
* Request parameters for submitFulfillmentOrderStatusUpdate operation in FulfillmentOutboundApi.
|
|
590
|
-
* @export
|
|
591
|
-
* @interface FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest
|
|
592
557
|
*/
|
|
593
558
|
export interface FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest {
|
|
594
559
|
/**
|
|
595
560
|
* The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
596
|
-
* @type {string}
|
|
597
|
-
* @memberof FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdate
|
|
598
561
|
*/
|
|
599
562
|
readonly sellerFulfillmentOrderId: string;
|
|
600
563
|
/**
|
|
601
564
|
* The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
602
|
-
* @type {SubmitFulfillmentOrderStatusUpdateRequest}
|
|
603
|
-
* @memberof FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdate
|
|
604
565
|
*/
|
|
605
566
|
readonly body: SubmitFulfillmentOrderStatusUpdateRequest;
|
|
606
567
|
}
|
|
607
568
|
/**
|
|
608
569
|
* Request parameters for updateFulfillmentOrder operation in FulfillmentOutboundApi.
|
|
609
|
-
* @export
|
|
610
|
-
* @interface FulfillmentOutboundApiUpdateFulfillmentOrderRequest
|
|
611
570
|
*/
|
|
612
571
|
export interface FulfillmentOutboundApiUpdateFulfillmentOrderRequest {
|
|
613
572
|
/**
|
|
614
573
|
* The identifier assigned to the item by the seller when the fulfillment order was created.
|
|
615
|
-
* @type {string}
|
|
616
|
-
* @memberof FulfillmentOutboundApiUpdateFulfillmentOrder
|
|
617
574
|
*/
|
|
618
575
|
readonly sellerFulfillmentOrderId: string;
|
|
619
576
|
/**
|
|
620
|
-
*
|
|
621
|
-
* @type {UpdateFulfillmentOrderRequest}
|
|
622
|
-
* @memberof FulfillmentOutboundApiUpdateFulfillmentOrder
|
|
577
|
+
* The request body of the `updateFulfillmentOrder` operation.
|
|
623
578
|
*/
|
|
624
579
|
readonly body: UpdateFulfillmentOrderRequest;
|
|
625
580
|
}
|
|
626
581
|
/**
|
|
627
582
|
* FulfillmentOutboundApi - object-oriented interface
|
|
628
|
-
* @export
|
|
629
|
-
* @class FulfillmentOutboundApi
|
|
630
|
-
* @extends {BaseAPI}
|
|
631
583
|
*/
|
|
632
584
|
export declare class FulfillmentOutboundApi extends BaseAPI {
|
|
633
585
|
/**
|
|
@@ -635,7 +587,6 @@ export declare class FulfillmentOutboundApi extends BaseAPI {
|
|
|
635
587
|
* @param {FulfillmentOutboundApiCancelFulfillmentOrderRequest} requestParameters Request parameters.
|
|
636
588
|
* @param {*} [options] Override http request option.
|
|
637
589
|
* @throws {RequiredError}
|
|
638
|
-
* @memberof FulfillmentOutboundApi
|
|
639
590
|
*/
|
|
640
591
|
cancelFulfillmentOrder(requestParameters: FulfillmentOutboundApiCancelFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CancelFulfillmentOrderResponse, any>>;
|
|
641
592
|
/**
|
|
@@ -643,7 +594,6 @@ export declare class FulfillmentOutboundApi extends BaseAPI {
|
|
|
643
594
|
* @param {FulfillmentOutboundApiCreateFulfillmentOrderRequest} requestParameters Request parameters.
|
|
644
595
|
* @param {*} [options] Override http request option.
|
|
645
596
|
* @throws {RequiredError}
|
|
646
|
-
* @memberof FulfillmentOutboundApi
|
|
647
597
|
*/
|
|
648
598
|
createFulfillmentOrder(requestParameters: FulfillmentOutboundApiCreateFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateFulfillmentOrderResponse, any>>;
|
|
649
599
|
/**
|
|
@@ -651,15 +601,20 @@ export declare class FulfillmentOutboundApi extends BaseAPI {
|
|
|
651
601
|
* @param {FulfillmentOutboundApiCreateFulfillmentReturnRequest} requestParameters Request parameters.
|
|
652
602
|
* @param {*} [options] Override http request option.
|
|
653
603
|
* @throws {RequiredError}
|
|
654
|
-
* @memberof FulfillmentOutboundApi
|
|
655
604
|
*/
|
|
656
605
|
createFulfillmentReturn(requestParameters: FulfillmentOutboundApiCreateFulfillmentReturnRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateFulfillmentReturnResponse, any>>;
|
|
606
|
+
/**
|
|
607
|
+
* Returns fast delivery estimates for Product Detail and Collection pages, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [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).
|
|
608
|
+
* @param {FulfillmentOutboundApiDeliveryOfferingsRequest} requestParameters Request parameters.
|
|
609
|
+
* @param {*} [options] Override http request option.
|
|
610
|
+
* @throws {RequiredError}
|
|
611
|
+
*/
|
|
612
|
+
deliveryOfferings(requestParameters: FulfillmentOutboundApiDeliveryOfferingsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDeliveryOfferingsResponse, any>>;
|
|
657
613
|
/**
|
|
658
614
|
* Returns delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 30 | 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 have higher rate and burst values than those shown here. For more information, refer to [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).
|
|
659
615
|
* @param {FulfillmentOutboundApiDeliveryOffersRequest} requestParameters Request parameters.
|
|
660
616
|
* @param {*} [options] Override http request option.
|
|
661
617
|
* @throws {RequiredError}
|
|
662
|
-
* @memberof FulfillmentOutboundApi
|
|
663
618
|
*/
|
|
664
619
|
deliveryOffers(requestParameters: FulfillmentOutboundApiDeliveryOffersRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDeliveryOffersResponse, any>>;
|
|
665
620
|
/**
|
|
@@ -667,15 +622,13 @@ export declare class FulfillmentOutboundApi extends BaseAPI {
|
|
|
667
622
|
* @param {FulfillmentOutboundApiGetFeatureInventoryRequest} requestParameters Request parameters.
|
|
668
623
|
* @param {*} [options] Override http request option.
|
|
669
624
|
* @throws {RequiredError}
|
|
670
|
-
* @memberof FulfillmentOutboundApi
|
|
671
625
|
*/
|
|
672
626
|
getFeatureInventory(requestParameters: FulfillmentOutboundApiGetFeatureInventoryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFeatureInventoryResponse, any>>;
|
|
673
627
|
/**
|
|
674
|
-
* Returns the number of items with the
|
|
628
|
+
* Returns the number of items with the `sellerSku` you specify that can have orders fulfilled using the specified feature. Note that if the `sellerSku` isn\'t eligible, the response will contain an empty `skuInfo` object. The parameters for this operation may contain special characters that require URL encoding. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table 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).
|
|
675
629
|
* @param {FulfillmentOutboundApiGetFeatureSKURequest} requestParameters Request parameters.
|
|
676
630
|
* @param {*} [options] Override http request option.
|
|
677
631
|
* @throws {RequiredError}
|
|
678
|
-
* @memberof FulfillmentOutboundApi
|
|
679
632
|
*/
|
|
680
633
|
getFeatureSKU(requestParameters: FulfillmentOutboundApiGetFeatureSKURequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFeatureSkuResponse, any>>;
|
|
681
634
|
/**
|
|
@@ -683,7 +636,6 @@ export declare class FulfillmentOutboundApi extends BaseAPI {
|
|
|
683
636
|
* @param {FulfillmentOutboundApiGetFeaturesRequest} requestParameters Request parameters.
|
|
684
637
|
* @param {*} [options] Override http request option.
|
|
685
638
|
* @throws {RequiredError}
|
|
686
|
-
* @memberof FulfillmentOutboundApi
|
|
687
639
|
*/
|
|
688
640
|
getFeatures(requestParameters: FulfillmentOutboundApiGetFeaturesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFeaturesResponse, any>>;
|
|
689
641
|
/**
|
|
@@ -691,7 +643,6 @@ export declare class FulfillmentOutboundApi extends BaseAPI {
|
|
|
691
643
|
* @param {FulfillmentOutboundApiGetFulfillmentOrderRequest} requestParameters Request parameters.
|
|
692
644
|
* @param {*} [options] Override http request option.
|
|
693
645
|
* @throws {RequiredError}
|
|
694
|
-
* @memberof FulfillmentOutboundApi
|
|
695
646
|
*/
|
|
696
647
|
getFulfillmentOrder(requestParameters: FulfillmentOutboundApiGetFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFulfillmentOrderResponse, any>>;
|
|
697
648
|
/**
|
|
@@ -699,7 +650,6 @@ export declare class FulfillmentOutboundApi extends BaseAPI {
|
|
|
699
650
|
* @param {FulfillmentOutboundApiGetFulfillmentPreviewRequest} requestParameters Request parameters.
|
|
700
651
|
* @param {*} [options] Override http request option.
|
|
701
652
|
* @throws {RequiredError}
|
|
702
|
-
* @memberof FulfillmentOutboundApi
|
|
703
653
|
*/
|
|
704
654
|
getFulfillmentPreview(requestParameters: FulfillmentOutboundApiGetFulfillmentPreviewRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetFulfillmentPreviewResponse, any>>;
|
|
705
655
|
/**
|
|
@@ -707,15 +657,13 @@ export declare class FulfillmentOutboundApi extends BaseAPI {
|
|
|
707
657
|
* @param {FulfillmentOutboundApiGetPackageTrackingDetailsRequest} requestParameters Request parameters.
|
|
708
658
|
* @param {*} [options] Override http request option.
|
|
709
659
|
* @throws {RequiredError}
|
|
710
|
-
* @memberof FulfillmentOutboundApi
|
|
711
660
|
*/
|
|
712
|
-
getPackageTrackingDetails(requestParameters
|
|
661
|
+
getPackageTrackingDetails(requestParameters?: FulfillmentOutboundApiGetPackageTrackingDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPackageTrackingDetailsResponse, any>>;
|
|
713
662
|
/**
|
|
714
|
-
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the
|
|
663
|
+
* Returns a list of fulfillment orders fulfilled after (or at) a specified date-time, or indicated by the `nextToken` parameter. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table 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)
|
|
715
664
|
* @param {FulfillmentOutboundApiListAllFulfillmentOrdersRequest} requestParameters Request parameters.
|
|
716
665
|
* @param {*} [options] Override http request option.
|
|
717
666
|
* @throws {RequiredError}
|
|
718
|
-
* @memberof FulfillmentOutboundApi
|
|
719
667
|
*/
|
|
720
668
|
listAllFulfillmentOrders(requestParameters?: FulfillmentOutboundApiListAllFulfillmentOrdersRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListAllFulfillmentOrdersResponse, any>>;
|
|
721
669
|
/**
|
|
@@ -723,7 +671,6 @@ export declare class FulfillmentOutboundApi extends BaseAPI {
|
|
|
723
671
|
* @param {FulfillmentOutboundApiListReturnReasonCodesRequest} requestParameters Request parameters.
|
|
724
672
|
* @param {*} [options] Override http request option.
|
|
725
673
|
* @throws {RequiredError}
|
|
726
|
-
* @memberof FulfillmentOutboundApi
|
|
727
674
|
*/
|
|
728
675
|
listReturnReasonCodes(requestParameters: FulfillmentOutboundApiListReturnReasonCodesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListReturnReasonCodesResponse, any>>;
|
|
729
676
|
/**
|
|
@@ -731,7 +678,6 @@ export declare class FulfillmentOutboundApi extends BaseAPI {
|
|
|
731
678
|
* @param {FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest} requestParameters Request parameters.
|
|
732
679
|
* @param {*} [options] Override http request option.
|
|
733
680
|
* @throws {RequiredError}
|
|
734
|
-
* @memberof FulfillmentOutboundApi
|
|
735
681
|
*/
|
|
736
682
|
submitFulfillmentOrderStatusUpdate(requestParameters: FulfillmentOutboundApiSubmitFulfillmentOrderStatusUpdateRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitFulfillmentOrderStatusUpdateResponse, any>>;
|
|
737
683
|
/**
|
|
@@ -739,7 +685,6 @@ export declare class FulfillmentOutboundApi extends BaseAPI {
|
|
|
739
685
|
* @param {FulfillmentOutboundApiUpdateFulfillmentOrderRequest} requestParameters Request parameters.
|
|
740
686
|
* @param {*} [options] Override http request option.
|
|
741
687
|
* @throws {RequiredError}
|
|
742
|
-
* @memberof FulfillmentOutboundApi
|
|
743
688
|
*/
|
|
744
689
|
updateFulfillmentOrder(requestParameters: FulfillmentOutboundApiUpdateFulfillmentOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<UpdateFulfillmentOrderResponse, any>>;
|
|
745
690
|
}
|