@amazon-sp-api-release/amazon-sp-api-sdk-js 1.1.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -3
- package/helper/DefaultRateLimitMap.mjs +13 -1
- package/index.js +1 -0
- package/package.json +1 -1
- package/src/apluscontent_v2020_11_01/ApiClient.js +5 -1
- package/src/appintegrations_v2024_04_01/ApiClient.js +5 -1
- package/src/applications_v2023_11_30/ApiClient.js +5 -1
- package/src/awd_v2024_05_09/ApiClient.js +5 -1
- package/src/catalogitems_v2022_04_01/ApiClient.js +5 -1
- package/src/datakiosk_v2023_11_15/ApiClient.js +5 -1
- package/src/easyship_v2022_03_23/ApiClient.js +5 -1
- package/src/fbaeligibility_v1/ApiClient.js +5 -1
- package/src/fbainventory_v1/ApiClient.js +5 -1
- package/src/feeds_v2021_06_30/ApiClient.js +5 -1
- package/src/finances_v0/ApiClient.js +5 -1
- package/src/fulfillmentinbound_v0/ApiClient.js +5 -1
- package/src/fulfillmentinbound_v2024_03_20/ApiClient.js +5 -1
- package/src/fulfillmentoutbound_v2020_07_01/ApiClient.js +5 -1
- package/src/invoices_v2024_06_19/ApiClient.js +5 -1
- package/src/invoicing_v0/ApiClient.js +5 -1
- package/src/listingsitems_v2021_08_01/ApiClient.js +5 -1
- package/src/listingsitems_v2021_08_01/api/ListingsApi.js +6 -6
- package/src/listingsitems_v2021_08_01/model/FulfillmentAvailability.js +2 -2
- package/src/listingsitems_v2021_08_01/model/Issue.js +2 -2
- package/src/listingsitems_v2021_08_01/model/IssueExemption.js +1 -1
- package/src/listingsitems_v2021_08_01/model/ItemRelationship.js +1 -1
- package/src/listingsitems_v2021_08_01/model/ItemSearchResults.js +2 -2
- package/src/listingsitems_v2021_08_01/model/Pagination.js +1 -1
- package/src/listingsitems_v2021_08_01/model/PatchOperation.js +9 -3
- package/src/listingsrestrictions_v2021_08_01/ApiClient.js +5 -1
- package/src/merchantfulfillment_v0/ApiClient.js +5 -1
- package/src/messaging_v1/ApiClient.js +5 -1
- package/src/notifications_v1/ApiClient.js +5 -1
- package/src/orders_v0/ApiClient.js +5 -1
- package/src/orders_v0/api/OrdersV0Api.js +26 -26
- package/src/orders_v0/api/ShipmentApi.js +2 -2
- package/src/orders_v0/index.js +0 -7
- package/src/orders_v0/model/AmazonPrograms.js +3 -3
- package/src/orders_v0/model/OrderItem.js +0 -7
- package/src/orders_v0/model/OrdersList.js +1 -1
- package/src/orders_v0/model/PackageDetail.js +1 -1
- package/src/pricing_v0/ApiClient.js +5 -1
- package/src/pricing_v2022_05_01/ApiClient.js +5 -1
- package/src/pricing_v2022_05_01/model/CompetitiveSummaryRequest.js +2 -2
- package/src/pricing_v2022_05_01/model/CompetitiveSummaryResponseBody.js +2 -2
- package/src/pricing_v2022_05_01/model/FeaturedOfferExpectedPriceRequest.js +3 -3
- package/src/pricing_v2022_05_01/model/FeaturedOfferExpectedPriceRequestParams.js +2 -2
- package/src/pricing_v2022_05_01/model/FeaturedOfferSegment.js +7 -1
- package/src/pricing_v2022_05_01/model/LowestPricedOffersInput.js +2 -2
- package/src/pricing_v2022_05_01/model/OfferIdentifier.js +2 -2
- package/src/pricing_v2022_05_01/model/ReferencePrice.js +2 -2
- package/src/productfees_v0/ApiClient.js +5 -1
- package/src/producttypedefinitions_v2020_09_01/ApiClient.js +5 -1
- package/src/replenishment_v2022_11_07/ApiClient.js +5 -1
- package/src/reports_v2021_06_30/ApiClient.js +5 -1
- package/src/sales_v1/ApiClient.js +5 -1
- package/src/sales_v1/api/SalesApi.js +4 -1
- package/src/sellerWallet_2024_03_01/ApiClient.js +827 -0
- package/src/sellerWallet_2024_03_01/api/AccountsApi.js +212 -0
- package/src/sellerWallet_2024_03_01/api/TransactionsApi.js +233 -0
- package/src/sellerWallet_2024_03_01/api/TransferPreviewApi.js +144 -0
- package/src/sellerWallet_2024_03_01/api/TransferScheduleApi.js +347 -0
- package/src/sellerWallet_2024_03_01/index.js +322 -0
- package/src/sellerWallet_2024_03_01/model/AccountHolderAddress.js +114 -0
- package/src/sellerWallet_2024_03_01/model/Balance.js +98 -0
- package/src/sellerWallet_2024_03_01/model/BalanceListing.js +63 -0
- package/src/sellerWallet_2024_03_01/model/BalanceType.js +54 -0
- package/src/sellerWallet_2024_03_01/model/BankAccount.js +148 -0
- package/src/sellerWallet_2024_03_01/model/BankAccountHolderStatus.js +54 -0
- package/src/sellerWallet_2024_03_01/model/BankAccountListing.js +65 -0
- package/src/sellerWallet_2024_03_01/model/BankAccountNumberFormat.js +42 -0
- package/src/sellerWallet_2024_03_01/model/BankAccountOwnershipType.js +48 -0
- package/src/sellerWallet_2024_03_01/model/BankNumberFormat.js +42 -0
- package/src/sellerWallet_2024_03_01/model/Currency.js +69 -0
- package/src/sellerWallet_2024_03_01/model/DeleteTransferSchedule.js +80 -0
- package/src/sellerWallet_2024_03_01/model/Error.js +80 -0
- package/src/sellerWallet_2024_03_01/model/ErrorList.js +65 -0
- package/src/sellerWallet_2024_03_01/model/Fee.js +91 -0
- package/src/sellerWallet_2024_03_01/model/FeeType.js +48 -0
- package/src/sellerWallet_2024_03_01/model/FxRateDetails.js +91 -0
- package/src/sellerWallet_2024_03_01/model/PaymentPreference.js +73 -0
- package/src/sellerWallet_2024_03_01/model/PaymentPreferencePaymentType.js +42 -0
- package/src/sellerWallet_2024_03_01/model/RateDirection.js +42 -0
- package/src/sellerWallet_2024_03_01/model/RecurringFrequency.js +54 -0
- package/src/sellerWallet_2024_03_01/model/ScheduleExpression.js +71 -0
- package/src/sellerWallet_2024_03_01/model/ScheduleExpressionType.js +42 -0
- package/src/sellerWallet_2024_03_01/model/ScheduleTransferType.js +36 -0
- package/src/sellerWallet_2024_03_01/model/Transaction.js +187 -0
- package/src/sellerWallet_2024_03_01/model/TransactionAccount.js +112 -0
- package/src/sellerWallet_2024_03_01/model/TransactionInitiationRequest.js +121 -0
- package/src/sellerWallet_2024_03_01/model/TransactionInstrumentDetails.js +73 -0
- package/src/sellerWallet_2024_03_01/model/TransactionListing.js +72 -0
- package/src/sellerWallet_2024_03_01/model/TransactionStatus.js +66 -0
- package/src/sellerWallet_2024_03_01/model/TransactionType.js +42 -0
- package/src/sellerWallet_2024_03_01/model/TransferRatePreview.js +91 -0
- package/src/sellerWallet_2024_03_01/model/TransferSchedule.js +123 -0
- package/src/sellerWallet_2024_03_01/model/TransferScheduleFailures.js +73 -0
- package/src/sellerWallet_2024_03_01/model/TransferScheduleInformation.js +83 -0
- package/src/sellerWallet_2024_03_01/model/TransferScheduleListing.js +72 -0
- package/src/sellerWallet_2024_03_01/model/TransferScheduleRequest.js +125 -0
- package/src/sellerWallet_2024_03_01/model/TransferScheduleStatus.js +54 -0
- package/src/sellers_v1/ApiClient.js +5 -1
- package/src/services_v1/ApiClient.js +5 -1
- package/src/shipping_v2/ApiClient.js +5 -1
- package/src/solicitations_v1/ApiClient.js +5 -1
- package/src/supplysources_v2020_07_01/ApiClient.js +5 -1
- package/src/tokens_v2021_03_01/ApiClient.js +5 -1
- package/src/transfers_v2024_06_01/ApiClient.js +5 -1
- package/src/uploads_v2020_11_01/ApiClient.js +5 -1
- package/src/vehicles_v2024_11_01/ApiClient.js +5 -1
- package/src/vendordfinventory_v1/ApiClient.js +5 -1
- package/src/vendordforders_v2021_12_28/ApiClient.js +5 -1
- package/src/vendordfpayments_v1/ApiClient.js +5 -1
- package/src/vendordfshipping_v2021_12_28/ApiClient.js +5 -1
- package/src/vendordftransactions_v2021_12_28/ApiClient.js +5 -1
- package/src/vendorinvoices_v1/ApiClient.js +5 -1
- package/src/vendororders_v1/ApiClient.js +5 -1
- package/src/vendorshipments_v1/ApiClient.js +5 -1
- package/src/vendorshipments_v1/api/VendorShippingApi.js +2 -2
- package/src/vendorshipments_v1/model/Shipment.js +3 -3
- package/src/vendortransactionstatus_v1/ApiClient.js +5 -1
- package/src/orders_v0/model/ExportInfo.js +0 -69
|
@@ -26,7 +26,7 @@ export class ItemSearchResults {
|
|
|
26
26
|
* Selling partner listings items and search related metadata.
|
|
27
27
|
* @alias module:listingsitems_v2021_08_01/model/ItemSearchResults
|
|
28
28
|
* @class
|
|
29
|
-
* @param numberOfResults {Number} The total number of selling partner listings items found for the search criteria (only results up to the page count limit
|
|
29
|
+
* @param numberOfResults {Number} The total number of selling partner listings items found for the search criteria (only results up to the page count limit is returned per request regardless of the number found). Note: The maximum number of items (SKUs) that can be returned and paged through is 1000.
|
|
30
30
|
* @param items {Array.<module:listingsitems_v2021_08_01/model/Item>} A list of listings items.
|
|
31
31
|
*/
|
|
32
32
|
constructor (numberOfResults, items) {
|
|
@@ -64,7 +64,7 @@ export class ItemSearchResults {
|
|
|
64
64
|
}
|
|
65
65
|
|
|
66
66
|
/**
|
|
67
|
-
* The total number of selling partner listings items found for the search criteria (only results up to the page count limit
|
|
67
|
+
* The total number of selling partner listings items found for the search criteria (only results up to the page count limit is returned per request regardless of the number found). Note: The maximum number of items (SKUs) that can be returned and paged through is 1000.
|
|
68
68
|
* @member {Number} numberOfResults
|
|
69
69
|
*/
|
|
70
70
|
ItemSearchResults.prototype.numberOfResults = undefined
|
|
@@ -21,7 +21,7 @@ import { ApiClient } from '../ApiClient.js'
|
|
|
21
21
|
export class Pagination {
|
|
22
22
|
/**
|
|
23
23
|
* Constructs a new <code>Pagination</code>.
|
|
24
|
-
* When a request produces a response that exceeds the `pageSize`, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. When you receive the last page, there
|
|
24
|
+
* When a request produces a response that exceeds the `pageSize`, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. When you receive the last page, there is no `nextToken` key in the pagination object.
|
|
25
25
|
* @alias module:listingsitems_v2021_08_01/model/Pagination
|
|
26
26
|
* @class
|
|
27
27
|
*/
|
|
@@ -24,7 +24,7 @@ export class PatchOperation {
|
|
|
24
24
|
* Individual JSON Patch operation for an HTTP PATCH request.
|
|
25
25
|
* @alias module:listingsitems_v2021_08_01/model/PatchOperation
|
|
26
26
|
* @class
|
|
27
|
-
* @param op {module:listingsitems_v2021_08_01/model/PatchOperation.OpEnum} Type of JSON Patch operation. Supported JSON Patch operations include add
|
|
27
|
+
* @param op {module:listingsitems_v2021_08_01/model/PatchOperation.OpEnum} Type of JSON Patch operation. Supported JSON Patch operations include `add`, `replace`, `merge` and `delete`. Refer to <https://tools.ietf.org/html/rfc6902>.
|
|
28
28
|
* @param path {String} JSON Pointer path of the element to patch. Refer to [JavaScript Object Notation (JSON) Patch](https://tools.ietf.org/html/rfc6902) for more information.
|
|
29
29
|
*/
|
|
30
30
|
constructor (op, path) {
|
|
@@ -80,6 +80,12 @@ PatchOperation.OpEnum = {
|
|
|
80
80
|
*/
|
|
81
81
|
replace: 'replace',
|
|
82
82
|
|
|
83
|
+
/**
|
|
84
|
+
* value: "merge"
|
|
85
|
+
* @const
|
|
86
|
+
*/
|
|
87
|
+
merge: 'merge',
|
|
88
|
+
|
|
83
89
|
/**
|
|
84
90
|
* value: "delete"
|
|
85
91
|
* @const
|
|
@@ -88,7 +94,7 @@ PatchOperation.OpEnum = {
|
|
|
88
94
|
}
|
|
89
95
|
|
|
90
96
|
/**
|
|
91
|
-
* Type of JSON Patch operation. Supported JSON Patch operations include add
|
|
97
|
+
* Type of JSON Patch operation. Supported JSON Patch operations include `add`, `replace`, `merge` and `delete`. Refer to <https://tools.ietf.org/html/rfc6902>.
|
|
92
98
|
* @member {module:listingsitems_v2021_08_01/model/PatchOperation.OpEnum} op
|
|
93
99
|
*/
|
|
94
100
|
PatchOperation.prototype.op = undefined
|
|
@@ -100,7 +106,7 @@ PatchOperation.prototype.op = undefined
|
|
|
100
106
|
PatchOperation.prototype.path = undefined
|
|
101
107
|
|
|
102
108
|
/**
|
|
103
|
-
* JSON value to add
|
|
109
|
+
* JSON value to `add`, `replace`, `merge` or `delete`.
|
|
104
110
|
* @member {Array.<Object.<String, Object>>} value
|
|
105
111
|
*/
|
|
106
112
|
PatchOperation.prototype.value = undefined
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
import superagent from 'superagent'
|
|
15
15
|
import querystring from 'querystring'
|
|
16
|
+
import { readFileSync } from 'node:fs'
|
|
16
17
|
import { URL } from 'node:url'
|
|
17
18
|
import { RateLimitConfiguration } from '../../helper/RateLimitConfiguration.mjs'
|
|
18
19
|
import { SuperagentRateLimiter } from '../../helper/SuperagentRateLimiter.mjs'
|
|
@@ -214,13 +215,16 @@ export class ApiClient {
|
|
|
214
215
|
this.authentications = {
|
|
215
216
|
}
|
|
216
217
|
|
|
218
|
+
const pkg = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)))
|
|
219
|
+
const version = pkg.version ? pkg.version : 'undefined'
|
|
220
|
+
|
|
217
221
|
/**
|
|
218
222
|
* The default HTTP headers to be included for all API calls.
|
|
219
223
|
* @type {Array<String>}
|
|
220
224
|
* @default {}
|
|
221
225
|
*/
|
|
222
226
|
this.defaultHeaders = {
|
|
223
|
-
'User-Agent':
|
|
227
|
+
'User-Agent': `amazon-selling-partner-api-sdk/${version}/JavaScript`
|
|
224
228
|
}
|
|
225
229
|
|
|
226
230
|
/**
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
import superagent from 'superagent'
|
|
15
15
|
import querystring from 'querystring'
|
|
16
|
+
import { readFileSync } from 'node:fs'
|
|
16
17
|
import { URL } from 'node:url'
|
|
17
18
|
import { RateLimitConfiguration } from '../../helper/RateLimitConfiguration.mjs'
|
|
18
19
|
import { SuperagentRateLimiter } from '../../helper/SuperagentRateLimiter.mjs'
|
|
@@ -214,13 +215,16 @@ export class ApiClient {
|
|
|
214
215
|
this.authentications = {
|
|
215
216
|
}
|
|
216
217
|
|
|
218
|
+
const pkg = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)))
|
|
219
|
+
const version = pkg.version ? pkg.version : 'undefined'
|
|
220
|
+
|
|
217
221
|
/**
|
|
218
222
|
* The default HTTP headers to be included for all API calls.
|
|
219
223
|
* @type {Array<String>}
|
|
220
224
|
* @default {}
|
|
221
225
|
*/
|
|
222
226
|
this.defaultHeaders = {
|
|
223
|
-
'User-Agent':
|
|
227
|
+
'User-Agent': `amazon-selling-partner-api-sdk/${version}/JavaScript`
|
|
224
228
|
}
|
|
225
229
|
|
|
226
230
|
/**
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
import superagent from 'superagent'
|
|
15
15
|
import querystring from 'querystring'
|
|
16
|
+
import { readFileSync } from 'node:fs'
|
|
16
17
|
import { URL } from 'node:url'
|
|
17
18
|
import { RateLimitConfiguration } from '../../helper/RateLimitConfiguration.mjs'
|
|
18
19
|
import { SuperagentRateLimiter } from '../../helper/SuperagentRateLimiter.mjs'
|
|
@@ -214,13 +215,16 @@ export class ApiClient {
|
|
|
214
215
|
this.authentications = {
|
|
215
216
|
}
|
|
216
217
|
|
|
218
|
+
const pkg = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)))
|
|
219
|
+
const version = pkg.version ? pkg.version : 'undefined'
|
|
220
|
+
|
|
217
221
|
/**
|
|
218
222
|
* The default HTTP headers to be included for all API calls.
|
|
219
223
|
* @type {Array<String>}
|
|
220
224
|
* @default {}
|
|
221
225
|
*/
|
|
222
226
|
this.defaultHeaders = {
|
|
223
|
-
'User-Agent':
|
|
227
|
+
'User-Agent': `amazon-selling-partner-api-sdk/${version}/JavaScript`
|
|
224
228
|
}
|
|
225
229
|
|
|
226
230
|
/**
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
import superagent from 'superagent'
|
|
15
15
|
import querystring from 'querystring'
|
|
16
|
+
import { readFileSync } from 'node:fs'
|
|
16
17
|
import { URL } from 'node:url'
|
|
17
18
|
import { RateLimitConfiguration } from '../../helper/RateLimitConfiguration.mjs'
|
|
18
19
|
import { SuperagentRateLimiter } from '../../helper/SuperagentRateLimiter.mjs'
|
|
@@ -214,13 +215,16 @@ export class ApiClient {
|
|
|
214
215
|
this.authentications = {
|
|
215
216
|
}
|
|
216
217
|
|
|
218
|
+
const pkg = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)))
|
|
219
|
+
const version = pkg.version ? pkg.version : 'undefined'
|
|
220
|
+
|
|
217
221
|
/**
|
|
218
222
|
* The default HTTP headers to be included for all API calls.
|
|
219
223
|
* @type {Array<String>}
|
|
220
224
|
* @default {}
|
|
221
225
|
*/
|
|
222
226
|
this.defaultHeaders = {
|
|
223
|
-
'User-Agent':
|
|
227
|
+
'User-Agent': `amazon-selling-partner-api-sdk/${version}/JavaScript`
|
|
224
228
|
}
|
|
225
229
|
|
|
226
230
|
/**
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
import superagent from 'superagent'
|
|
15
15
|
import querystring from 'querystring'
|
|
16
|
+
import { readFileSync } from 'node:fs'
|
|
16
17
|
import { URL } from 'node:url'
|
|
17
18
|
import { RateLimitConfiguration } from '../../helper/RateLimitConfiguration.mjs'
|
|
18
19
|
import { SuperagentRateLimiter } from '../../helper/SuperagentRateLimiter.mjs'
|
|
@@ -214,13 +215,16 @@ export class ApiClient {
|
|
|
214
215
|
this.authentications = {
|
|
215
216
|
}
|
|
216
217
|
|
|
218
|
+
const pkg = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)))
|
|
219
|
+
const version = pkg.version ? pkg.version : 'undefined'
|
|
220
|
+
|
|
217
221
|
/**
|
|
218
222
|
* The default HTTP headers to be included for all API calls.
|
|
219
223
|
* @type {Array<String>}
|
|
220
224
|
* @default {}
|
|
221
225
|
*/
|
|
222
226
|
this.defaultHeaders = {
|
|
223
|
-
'User-Agent':
|
|
227
|
+
'User-Agent': `amazon-selling-partner-api-sdk/${version}/JavaScript`
|
|
224
228
|
}
|
|
225
229
|
|
|
226
230
|
/**
|
|
@@ -80,7 +80,7 @@ export class OrdersV0Api {
|
|
|
80
80
|
}
|
|
81
81
|
|
|
82
82
|
/**
|
|
83
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
83
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
84
84
|
* @param {String} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
85
85
|
* @param {module:orders_v0/model/ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
86
86
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
@@ -120,7 +120,7 @@ export class OrdersV0Api {
|
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
123
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
124
124
|
* @param {String} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
125
125
|
* @param {module:orders_v0/model/ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
126
126
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
@@ -133,7 +133,7 @@ export class OrdersV0Api {
|
|
|
133
133
|
}
|
|
134
134
|
|
|
135
135
|
/**
|
|
136
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
136
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
137
137
|
* @param {String} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
138
138
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:orders_v0/model/GetOrderResponse} and HTTP response
|
|
139
139
|
*/
|
|
@@ -167,7 +167,7 @@ export class OrdersV0Api {
|
|
|
167
167
|
}
|
|
168
168
|
|
|
169
169
|
/**
|
|
170
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
170
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
171
171
|
* @param {String} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
172
172
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:orders_v0/model/GetOrderResponse}
|
|
173
173
|
*/
|
|
@@ -179,8 +179,8 @@ export class OrdersV0Api {
|
|
|
179
179
|
}
|
|
180
180
|
|
|
181
181
|
/**
|
|
182
|
-
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
183
|
-
* @param {String} orderId
|
|
182
|
+
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
183
|
+
* @param {String} orderId The Amazon order identifier in 3-7-7 format.
|
|
184
184
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:orders_v0/model/GetOrderAddressResponse} and HTTP response
|
|
185
185
|
*/
|
|
186
186
|
getOrderAddressWithHttpInfo (orderId) {
|
|
@@ -213,8 +213,8 @@ export class OrdersV0Api {
|
|
|
213
213
|
}
|
|
214
214
|
|
|
215
215
|
/**
|
|
216
|
-
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
217
|
-
* @param {String} orderId
|
|
216
|
+
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
217
|
+
* @param {String} orderId The Amazon order identifier in 3-7-7 format.
|
|
218
218
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:orders_v0/model/GetOrderAddressResponse}
|
|
219
219
|
*/
|
|
220
220
|
getOrderAddress (orderId) {
|
|
@@ -225,8 +225,8 @@ export class OrdersV0Api {
|
|
|
225
225
|
}
|
|
226
226
|
|
|
227
227
|
/**
|
|
228
|
-
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
229
|
-
* @param {String} orderId
|
|
228
|
+
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
229
|
+
* @param {String} orderId The Amazon order identifier in 3-7-7 format.
|
|
230
230
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:orders_v0/model/GetOrderBuyerInfoResponse} and HTTP response
|
|
231
231
|
*/
|
|
232
232
|
getOrderBuyerInfoWithHttpInfo (orderId) {
|
|
@@ -259,8 +259,8 @@ export class OrdersV0Api {
|
|
|
259
259
|
}
|
|
260
260
|
|
|
261
261
|
/**
|
|
262
|
-
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
263
|
-
* @param {String} orderId
|
|
262
|
+
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
263
|
+
* @param {String} orderId The Amazon order identifier in 3-7-7 format.
|
|
264
264
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:orders_v0/model/GetOrderBuyerInfoResponse}
|
|
265
265
|
*/
|
|
266
266
|
getOrderBuyerInfo (orderId) {
|
|
@@ -271,7 +271,7 @@ export class OrdersV0Api {
|
|
|
271
271
|
}
|
|
272
272
|
|
|
273
273
|
/**
|
|
274
|
-
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it's used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
274
|
+
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it's used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
275
275
|
* @param {String} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
276
276
|
* @param {Object} opts Optional parameters
|
|
277
277
|
* @param {String} opts.nextToken A string token returned in the response of your previous request.
|
|
@@ -309,7 +309,7 @@ export class OrdersV0Api {
|
|
|
309
309
|
}
|
|
310
310
|
|
|
311
311
|
/**
|
|
312
|
-
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it's used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
312
|
+
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it's used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
313
313
|
* @param {String} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
314
314
|
* @param {Object} opts Optional parameters
|
|
315
315
|
* @param {String} opts.nextToken A string token returned in the response of your previous request.
|
|
@@ -323,7 +323,7 @@ export class OrdersV0Api {
|
|
|
323
323
|
}
|
|
324
324
|
|
|
325
325
|
/**
|
|
326
|
-
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
326
|
+
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
327
327
|
* @param {String} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
328
328
|
* @param {Object} opts Optional parameters
|
|
329
329
|
* @param {String} opts.nextToken A string token returned in the response of your previous request.
|
|
@@ -361,7 +361,7 @@ export class OrdersV0Api {
|
|
|
361
361
|
}
|
|
362
362
|
|
|
363
363
|
/**
|
|
364
|
-
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
364
|
+
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
365
365
|
* @param {String} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
366
366
|
* @param {Object} opts Optional parameters
|
|
367
367
|
* @param {String} opts.nextToken A string token returned in the response of your previous request.
|
|
@@ -375,8 +375,8 @@ export class OrdersV0Api {
|
|
|
375
375
|
}
|
|
376
376
|
|
|
377
377
|
/**
|
|
378
|
-
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
379
|
-
* @param {String} orderId
|
|
378
|
+
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
379
|
+
* @param {String} orderId The Amazon order identifier in 3-7-7 format.
|
|
380
380
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:orders_v0/model/GetOrderRegulatedInfoResponse} and HTTP response
|
|
381
381
|
*/
|
|
382
382
|
getOrderRegulatedInfoWithHttpInfo (orderId) {
|
|
@@ -409,8 +409,8 @@ export class OrdersV0Api {
|
|
|
409
409
|
}
|
|
410
410
|
|
|
411
411
|
/**
|
|
412
|
-
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
413
|
-
* @param {String} orderId
|
|
412
|
+
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
413
|
+
* @param {String} orderId The Amazon order identifier in 3-7-7 format.
|
|
414
414
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:orders_v0/model/GetOrderRegulatedInfoResponse}
|
|
415
415
|
*/
|
|
416
416
|
getOrderRegulatedInfo (orderId) {
|
|
@@ -421,7 +421,7 @@ export class OrdersV0Api {
|
|
|
421
421
|
}
|
|
422
422
|
|
|
423
423
|
/**
|
|
424
|
-
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn't affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header
|
|
424
|
+
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn't affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
425
425
|
* @param {Array.<String>} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.
|
|
426
426
|
* @param {Object} opts Optional parameters
|
|
427
427
|
* @param {String} opts.createdAfter Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.
|
|
@@ -499,7 +499,7 @@ export class OrdersV0Api {
|
|
|
499
499
|
}
|
|
500
500
|
|
|
501
501
|
/**
|
|
502
|
-
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn't affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header
|
|
502
|
+
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn't affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
503
503
|
* @param {Array.<String>} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.
|
|
504
504
|
* @param {Object} opts Optional parameters
|
|
505
505
|
* @param {String} opts.createdAfter Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.
|
|
@@ -533,8 +533,8 @@ export class OrdersV0Api {
|
|
|
533
533
|
}
|
|
534
534
|
|
|
535
535
|
/**
|
|
536
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
537
|
-
* @param {String} orderId
|
|
536
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
537
|
+
* @param {String} orderId The Amazon order identifier in 3-7-7 format.
|
|
538
538
|
* @param {module:orders_v0/model/UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
539
539
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
540
540
|
*/
|
|
@@ -573,8 +573,8 @@ export class OrdersV0Api {
|
|
|
573
573
|
}
|
|
574
574
|
|
|
575
575
|
/**
|
|
576
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
577
|
-
* @param {String} orderId
|
|
576
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
577
|
+
* @param {String} orderId The Amazon order identifier in 3-7-7 format.
|
|
578
578
|
* @param {module:orders_v0/model/UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
579
579
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
580
580
|
*/
|
|
@@ -63,7 +63,7 @@ export class ShipmentApi {
|
|
|
63
63
|
}
|
|
64
64
|
|
|
65
65
|
/**
|
|
66
|
-
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header
|
|
66
|
+
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
67
67
|
* @param {String} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
68
68
|
* @param {module:orders_v0/model/UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
69
69
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
@@ -103,7 +103,7 @@ export class ShipmentApi {
|
|
|
103
103
|
}
|
|
104
104
|
|
|
105
105
|
/**
|
|
106
|
-
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header
|
|
106
|
+
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
107
107
|
* @param {String} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
108
108
|
* @param {module:orders_v0/model/UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
109
109
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
package/src/orders_v0/index.js
CHANGED
|
@@ -33,7 +33,6 @@ import { EasyShipShipmentStatus } from './model/EasyShipShipmentStatus.js'
|
|
|
33
33
|
import { ElectronicInvoiceStatus } from './model/ElectronicInvoiceStatus.js'
|
|
34
34
|
import { Error } from './model/Error.js'
|
|
35
35
|
import { ExceptionDates } from './model/ExceptionDates.js'
|
|
36
|
-
import { ExportInfo } from './model/ExportInfo.js'
|
|
37
36
|
import { FulfillmentInstruction } from './model/FulfillmentInstruction.js'
|
|
38
37
|
import { GetOrderAddressResponse } from './model/GetOrderAddressResponse.js'
|
|
39
38
|
import { GetOrderBuyerInfoResponse } from './model/GetOrderBuyerInfoResponse.js'
|
|
@@ -225,12 +224,6 @@ export {
|
|
|
225
224
|
*/
|
|
226
225
|
ExceptionDates,
|
|
227
226
|
|
|
228
|
-
/**
|
|
229
|
-
* The ExportInfo model constructor.
|
|
230
|
-
* @property {module:orders_v0/model/ExportInfo}
|
|
231
|
-
*/
|
|
232
|
-
ExportInfo,
|
|
233
|
-
|
|
234
227
|
/**
|
|
235
228
|
* The FulfillmentInstruction model constructor.
|
|
236
229
|
* @property {module:orders_v0/model/FulfillmentInstruction}
|
|
@@ -21,10 +21,10 @@ import { ApiClient } from '../ApiClient.js'
|
|
|
21
21
|
export class AmazonPrograms {
|
|
22
22
|
/**
|
|
23
23
|
* Constructs a new <code>AmazonPrograms</code>.
|
|
24
|
-
* Contains the list of programs that
|
|
24
|
+
* Contains the list of programs that Amazon associates with an item. Possible programs are: - **Subscribe and Save**: Offers recurring, scheduled deliveries to Amazon customers and Amazon Business customers for their frequently ordered products. - **FBM Ship+**: Unlocks expedited shipping without the extra cost. Helps you to provide accurate and fast delivery dates to Amazon customers. You also receive protection from late deliveries, a discount on expedited shipping rates, and cash back when you ship.
|
|
25
25
|
* @alias module:orders_v0/model/AmazonPrograms
|
|
26
26
|
* @class
|
|
27
|
-
* @param programs {Array.<String>} A list of the programs that
|
|
27
|
+
* @param programs {Array.<String>} A list of the programs that Amazon associates with the order item. **Possible values**: `SUBSCRIBE_AND_SAVE`, `FBM_SHIP_PLUS`
|
|
28
28
|
*/
|
|
29
29
|
constructor (programs) {
|
|
30
30
|
this.programs = programs
|
|
@@ -58,7 +58,7 @@ export class AmazonPrograms {
|
|
|
58
58
|
}
|
|
59
59
|
|
|
60
60
|
/**
|
|
61
|
-
* A list of the programs that
|
|
61
|
+
* A list of the programs that Amazon associates with the order item. **Possible values**: `SUBSCRIBE_AND_SAVE`, `FBM_SHIP_PLUS`
|
|
62
62
|
* @member {Array.<String>} programs
|
|
63
63
|
*/
|
|
64
64
|
AmazonPrograms.prototype.programs = undefined
|
|
@@ -15,7 +15,6 @@ import { ApiClient } from '../ApiClient.js'
|
|
|
15
15
|
import { AmazonPrograms } from './AmazonPrograms.js'
|
|
16
16
|
import { AssociatedItem } from './AssociatedItem.js'
|
|
17
17
|
import { BuyerRequestedCancel } from './BuyerRequestedCancel.js'
|
|
18
|
-
import { ExportInfo } from './ExportInfo.js'
|
|
19
18
|
import { ItemBuyerInfo } from './ItemBuyerInfo.js'
|
|
20
19
|
import { Measurement } from './Measurement.js'
|
|
21
20
|
import { Money } from './Money.js'
|
|
@@ -107,7 +106,6 @@ export class OrderItem {
|
|
|
107
106
|
if (data.hasOwnProperty('Measurement')) { obj.measurement = Measurement.constructFromObject(data.Measurement) }
|
|
108
107
|
if (data.hasOwnProperty('ShippingConstraints')) { obj.shippingConstraints = ShippingConstraints.constructFromObject(data.ShippingConstraints) }
|
|
109
108
|
if (data.hasOwnProperty('AmazonPrograms')) { obj.amazonPrograms = AmazonPrograms.constructFromObject(data.AmazonPrograms) }
|
|
110
|
-
if (data.hasOwnProperty('ExportInfo')) { obj.exportInfo = ExportInfo.constructFromObject(data.ExportInfo) }
|
|
111
109
|
}
|
|
112
110
|
return obj
|
|
113
111
|
}
|
|
@@ -353,8 +351,3 @@ OrderItem.prototype.shippingConstraints = undefined
|
|
|
353
351
|
* @member {module:orders_v0/model/AmazonPrograms} amazonPrograms
|
|
354
352
|
*/
|
|
355
353
|
OrderItem.prototype.amazonPrograms = undefined
|
|
356
|
-
|
|
357
|
-
/**
|
|
358
|
-
* @member {module:orders_v0/model/ExportInfo} exportInfo
|
|
359
|
-
*/
|
|
360
|
-
OrderItem.prototype.exportInfo = undefined
|
|
@@ -74,7 +74,7 @@ OrdersList.prototype.orders = undefined
|
|
|
74
74
|
OrdersList.prototype.nextToken = undefined
|
|
75
75
|
|
|
76
76
|
/**
|
|
77
|
-
* Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller.
|
|
77
|
+
* Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. Use [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format for all dates.
|
|
78
78
|
* @member {String} lastUpdatedBefore
|
|
79
79
|
*/
|
|
80
80
|
OrdersList.prototype.lastUpdatedBefore = undefined
|
|
@@ -86,7 +86,7 @@ PackageDetail.prototype.packageReferenceId = undefined
|
|
|
86
86
|
PackageDetail.prototype.carrierCode = undefined
|
|
87
87
|
|
|
88
88
|
/**
|
|
89
|
-
* Carrier
|
|
89
|
+
* Carrier name that will deliver the package. Required when `carrierCode` is \"Other\"
|
|
90
90
|
* @member {String} carrierName
|
|
91
91
|
*/
|
|
92
92
|
PackageDetail.prototype.carrierName = undefined
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
import superagent from 'superagent'
|
|
15
15
|
import querystring from 'querystring'
|
|
16
|
+
import { readFileSync } from 'node:fs'
|
|
16
17
|
import { URL } from 'node:url'
|
|
17
18
|
import { RateLimitConfiguration } from '../../helper/RateLimitConfiguration.mjs'
|
|
18
19
|
import { SuperagentRateLimiter } from '../../helper/SuperagentRateLimiter.mjs'
|
|
@@ -214,13 +215,16 @@ export class ApiClient {
|
|
|
214
215
|
this.authentications = {
|
|
215
216
|
}
|
|
216
217
|
|
|
218
|
+
const pkg = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)))
|
|
219
|
+
const version = pkg.version ? pkg.version : 'undefined'
|
|
220
|
+
|
|
217
221
|
/**
|
|
218
222
|
* The default HTTP headers to be included for all API calls.
|
|
219
223
|
* @type {Array<String>}
|
|
220
224
|
* @default {}
|
|
221
225
|
*/
|
|
222
226
|
this.defaultHeaders = {
|
|
223
|
-
'User-Agent':
|
|
227
|
+
'User-Agent': `amazon-selling-partner-api-sdk/${version}/JavaScript`
|
|
224
228
|
}
|
|
225
229
|
|
|
226
230
|
/**
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
import superagent from 'superagent'
|
|
15
15
|
import querystring from 'querystring'
|
|
16
|
+
import { readFileSync } from 'node:fs'
|
|
16
17
|
import { URL } from 'node:url'
|
|
17
18
|
import { RateLimitConfiguration } from '../../helper/RateLimitConfiguration.mjs'
|
|
18
19
|
import { SuperagentRateLimiter } from '../../helper/SuperagentRateLimiter.mjs'
|
|
@@ -214,13 +215,16 @@ export class ApiClient {
|
|
|
214
215
|
this.authentications = {
|
|
215
216
|
}
|
|
216
217
|
|
|
218
|
+
const pkg = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)))
|
|
219
|
+
const version = pkg.version ? pkg.version : 'undefined'
|
|
220
|
+
|
|
217
221
|
/**
|
|
218
222
|
* The default HTTP headers to be included for all API calls.
|
|
219
223
|
* @type {Array<String>}
|
|
220
224
|
* @default {}
|
|
221
225
|
*/
|
|
222
226
|
this.defaultHeaders = {
|
|
223
|
-
'User-Agent':
|
|
227
|
+
'User-Agent': `amazon-selling-partner-api-sdk/${version}/JavaScript`
|
|
224
228
|
}
|
|
225
229
|
|
|
226
230
|
/**
|
|
@@ -28,7 +28,7 @@ export class CompetitiveSummaryRequest {
|
|
|
28
28
|
* @alias module:pricing_v2022_05_01/model/CompetitiveSummaryRequest
|
|
29
29
|
* @class
|
|
30
30
|
* @param asin {String} The ASIN of the item.
|
|
31
|
-
* @param marketplaceId {String}
|
|
31
|
+
* @param marketplaceId {String} The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
32
32
|
* @param includedData {Array.<module:pricing_v2022_05_01/model/CompetitiveSummaryIncludedData>} The list of requested competitive pricing data for the product.
|
|
33
33
|
* @param method {module:pricing_v2022_05_01/model/HttpMethod}
|
|
34
34
|
* @param uri {String} The URI associated with the individual APIs that are called as part of the batch request.
|
|
@@ -80,7 +80,7 @@ export class CompetitiveSummaryRequest {
|
|
|
80
80
|
CompetitiveSummaryRequest.prototype.asin = undefined
|
|
81
81
|
|
|
82
82
|
/**
|
|
83
|
-
*
|
|
83
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
84
84
|
* @member {String} marketplaceId
|
|
85
85
|
*/
|
|
86
86
|
CompetitiveSummaryRequest.prototype.marketplaceId = undefined
|