@sp-api-sdk/fba-inbound-eligibility-api-v1 5.0.0 → 5.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/README.md +3 -4
- package/dist/index.cjs +314 -344
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +231 -249
- package/dist/index.d.ts +231 -249
- package/dist/index.js +288 -305
- package/dist/index.js.map +1 -1
- package/package.json +7 -4
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import { ClientConfiguration, RateLimit } from
|
|
2
|
-
import
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
|
|
2
|
+
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
|
+
//#region src/api-model/configuration.d.ts
|
|
5
4
|
/**
|
|
6
5
|
* Selling Partner API for FBA Inbound Eligibilty
|
|
7
6
|
* With the FBA Inbound Eligibility API, you can build applications that let sellers get eligibility previews for items before shipping them to Amazon\'s fulfillment centers. With this API you can find out if an item is eligible for inbound shipment to Amazon\'s fulfillment centers in a specific marketplace. You can also find out if an item is eligible for using the manufacturer barcode for FBA inventory tracking. Sellers can use this information to inform their decisions about which items to ship Amazon\'s fulfillment centers.
|
|
@@ -14,115 +13,105 @@ import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
|
|
|
14
13
|
* Do not edit the class manually.
|
|
15
14
|
*/
|
|
16
15
|
interface AWSv4Configuration {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
16
|
+
options?: {
|
|
17
|
+
region?: string;
|
|
18
|
+
service?: string;
|
|
19
|
+
};
|
|
20
|
+
credentials?: {
|
|
21
|
+
accessKeyId?: string;
|
|
22
|
+
secretAccessKey?: string;
|
|
23
|
+
sessionToken?: string;
|
|
24
|
+
};
|
|
26
25
|
}
|
|
27
26
|
interface ConfigurationParameters {
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
27
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
28
|
+
username?: string;
|
|
29
|
+
password?: string;
|
|
30
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
31
|
+
awsv4?: AWSv4Configuration;
|
|
32
|
+
basePath?: string;
|
|
33
|
+
serverIndex?: number;
|
|
34
|
+
baseOptions?: any;
|
|
35
|
+
formDataCtor?: new () => any;
|
|
37
36
|
}
|
|
38
37
|
declare class Configuration {
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
38
|
+
/**
|
|
39
|
+
* parameter for apiKey security
|
|
40
|
+
* @param name security name
|
|
41
|
+
*/
|
|
42
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
43
|
+
/**
|
|
44
|
+
* parameter for basic security
|
|
45
|
+
*/
|
|
46
|
+
username?: string;
|
|
47
|
+
/**
|
|
48
|
+
* parameter for basic security
|
|
49
|
+
*/
|
|
50
|
+
password?: string;
|
|
51
|
+
/**
|
|
52
|
+
* parameter for oauth2 security
|
|
53
|
+
* @param name security name
|
|
54
|
+
* @param scopes oauth2 scope
|
|
55
|
+
*/
|
|
56
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
57
|
+
/**
|
|
58
|
+
* parameter for aws4 signature security
|
|
59
|
+
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
60
|
+
* @param {string} options.region - aws region
|
|
61
|
+
* @param {string} options.service - name of the service.
|
|
62
|
+
* @param {string} credentials.accessKeyId - aws access key id
|
|
63
|
+
* @param {string} credentials.secretAccessKey - aws access key
|
|
64
|
+
* @param {string} credentials.sessionToken - aws session token
|
|
65
|
+
* @memberof Configuration
|
|
66
|
+
*/
|
|
67
|
+
awsv4?: AWSv4Configuration;
|
|
68
|
+
/**
|
|
69
|
+
* override base path
|
|
70
|
+
*/
|
|
71
|
+
basePath?: string;
|
|
72
|
+
/**
|
|
73
|
+
* override server index
|
|
74
|
+
*/
|
|
75
|
+
serverIndex?: number;
|
|
76
|
+
/**
|
|
77
|
+
* base options for axios calls
|
|
78
|
+
*/
|
|
79
|
+
baseOptions?: any;
|
|
80
|
+
/**
|
|
81
|
+
* The FormData constructor that will be used to create multipart form data
|
|
82
|
+
* requests. You can inject this here so that execution environments that
|
|
83
|
+
* do not support the FormData class can still run the generated client.
|
|
84
|
+
*
|
|
85
|
+
* @type {new () => FormData}
|
|
86
|
+
*/
|
|
87
|
+
formDataCtor?: new () => any;
|
|
88
|
+
constructor(param?: ConfigurationParameters);
|
|
89
|
+
/**
|
|
90
|
+
* Check if the given MIME is a JSON MIME.
|
|
91
|
+
* JSON MIME examples:
|
|
92
|
+
* application/json
|
|
93
|
+
* application/json; charset=UTF8
|
|
94
|
+
* APPLICATION/JSON
|
|
95
|
+
* application/vnd.company+json
|
|
96
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
97
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
98
|
+
*/
|
|
99
|
+
isJsonMime(mime: string): boolean;
|
|
101
100
|
}
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
* Selling Partner API for FBA Inbound Eligibilty
|
|
105
|
-
* With the FBA Inbound Eligibility API, you can build applications that let sellers get eligibility previews for items before shipping them to Amazon\'s fulfillment centers. With this API you can find out if an item is eligible for inbound shipment to Amazon\'s fulfillment centers in a specific marketplace. You can also find out if an item is eligible for using the manufacturer barcode for FBA inventory tracking. Sellers can use this information to inform their decisions about which items to ship Amazon\'s fulfillment centers.
|
|
106
|
-
*
|
|
107
|
-
* The version of the OpenAPI document: v1
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
111
|
-
* https://openapi-generator.tech
|
|
112
|
-
* Do not edit the class manually.
|
|
113
|
-
*/
|
|
114
|
-
|
|
101
|
+
//#endregion
|
|
102
|
+
//#region src/api-model/base.d.ts
|
|
115
103
|
interface RequestArgs {
|
|
116
|
-
|
|
117
|
-
|
|
104
|
+
url: string;
|
|
105
|
+
options: RawAxiosRequestConfig;
|
|
118
106
|
}
|
|
119
107
|
declare class BaseAPI {
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
108
|
+
protected basePath: string;
|
|
109
|
+
protected axios: AxiosInstance;
|
|
110
|
+
protected configuration: Configuration | undefined;
|
|
111
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
124
112
|
}
|
|
125
|
-
|
|
113
|
+
//#endregion
|
|
114
|
+
//#region src/api-model/models/item-eligibility-preview.d.ts
|
|
126
115
|
/**
|
|
127
116
|
* Selling Partner API for FBA Inbound Eligibilty
|
|
128
117
|
* With the FBA Inbound Eligibility API, you can build applications that let sellers get eligibility previews for items before shipping them to Amazon\'s fulfillment centers. With this API you can find out if an item is eligible for inbound shipment to Amazon\'s fulfillment centers in a specific marketplace. You can also find out if an item is eligible for using the manufacturer barcode for FBA inventory tracking. Sellers can use this information to inform their decisions about which items to ship Amazon\'s fulfillment centers.
|
|
@@ -138,100 +127,90 @@ declare class BaseAPI {
|
|
|
138
127
|
* The response object which contains the ASIN, marketplaceId if required, eligibility program, the eligibility status (boolean), and a list of ineligibility reason codes.
|
|
139
128
|
*/
|
|
140
129
|
interface ItemEligibilityPreview {
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
130
|
+
/**
|
|
131
|
+
* The ASIN for which eligibility was determined.
|
|
132
|
+
*/
|
|
133
|
+
'asin': string;
|
|
134
|
+
/**
|
|
135
|
+
* The marketplace for which eligibility was determined.
|
|
136
|
+
*/
|
|
137
|
+
'marketplaceId'?: string;
|
|
138
|
+
/**
|
|
139
|
+
* The program for which eligibility was determined.
|
|
140
|
+
*/
|
|
141
|
+
'program': ItemEligibilityPreviewProgramEnum;
|
|
142
|
+
/**
|
|
143
|
+
* Indicates if the item is eligible for the program.
|
|
144
|
+
*/
|
|
145
|
+
'isEligibleForProgram': boolean;
|
|
146
|
+
/**
|
|
147
|
+
* Potential Ineligibility Reason Codes.
|
|
148
|
+
*/
|
|
149
|
+
'ineligibilityReasonList'?: Array<ItemEligibilityPreviewIneligibilityReasonListEnum>;
|
|
161
150
|
}
|
|
162
151
|
declare const ItemEligibilityPreviewProgramEnum: {
|
|
163
|
-
|
|
164
|
-
|
|
152
|
+
readonly Inbound: "INBOUND";
|
|
153
|
+
readonly Commingling: "COMMINGLING";
|
|
165
154
|
};
|
|
166
155
|
type ItemEligibilityPreviewProgramEnum = typeof ItemEligibilityPreviewProgramEnum[keyof typeof ItemEligibilityPreviewProgramEnum];
|
|
167
156
|
declare const ItemEligibilityPreviewIneligibilityReasonListEnum: {
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
157
|
+
readonly FbaInb0004: "FBA_INB_0004";
|
|
158
|
+
readonly FbaInb0006: "FBA_INB_0006";
|
|
159
|
+
readonly FbaInb0007: "FBA_INB_0007";
|
|
160
|
+
readonly FbaInb0008: "FBA_INB_0008";
|
|
161
|
+
readonly FbaInb0009: "FBA_INB_0009";
|
|
162
|
+
readonly FbaInb0010: "FBA_INB_0010";
|
|
163
|
+
readonly FbaInb0011: "FBA_INB_0011";
|
|
164
|
+
readonly FbaInb0012: "FBA_INB_0012";
|
|
165
|
+
readonly FbaInb0013: "FBA_INB_0013";
|
|
166
|
+
readonly FbaInb0014: "FBA_INB_0014";
|
|
167
|
+
readonly FbaInb0015: "FBA_INB_0015";
|
|
168
|
+
readonly FbaInb0016: "FBA_INB_0016";
|
|
169
|
+
readonly FbaInb0017: "FBA_INB_0017";
|
|
170
|
+
readonly FbaInb0018: "FBA_INB_0018";
|
|
171
|
+
readonly FbaInb0019: "FBA_INB_0019";
|
|
172
|
+
readonly FbaInb0034: "FBA_INB_0034";
|
|
173
|
+
readonly FbaInb0035: "FBA_INB_0035";
|
|
174
|
+
readonly FbaInb0036: "FBA_INB_0036";
|
|
175
|
+
readonly FbaInb0037: "FBA_INB_0037";
|
|
176
|
+
readonly FbaInb0038: "FBA_INB_0038";
|
|
177
|
+
readonly FbaInb0050: "FBA_INB_0050";
|
|
178
|
+
readonly FbaInb0051: "FBA_INB_0051";
|
|
179
|
+
readonly FbaInb0053: "FBA_INB_0053";
|
|
180
|
+
readonly FbaInb0055: "FBA_INB_0055";
|
|
181
|
+
readonly FbaInb0056: "FBA_INB_0056";
|
|
182
|
+
readonly FbaInb0059: "FBA_INB_0059";
|
|
183
|
+
readonly FbaInb0065: "FBA_INB_0065";
|
|
184
|
+
readonly FbaInb0066: "FBA_INB_0066";
|
|
185
|
+
readonly FbaInb0067: "FBA_INB_0067";
|
|
186
|
+
readonly FbaInb0068: "FBA_INB_0068";
|
|
187
|
+
readonly FbaInb0095: "FBA_INB_0095";
|
|
188
|
+
readonly FbaInb0097: "FBA_INB_0097";
|
|
189
|
+
readonly FbaInb0098: "FBA_INB_0098";
|
|
190
|
+
readonly FbaInb0099: "FBA_INB_0099";
|
|
191
|
+
readonly FbaInb0100: "FBA_INB_0100";
|
|
192
|
+
readonly FbaInb0103: "FBA_INB_0103";
|
|
193
|
+
readonly FbaInb0104: "FBA_INB_0104";
|
|
194
|
+
readonly FbaInb0197: "FBA_INB_0197";
|
|
195
|
+
readonly FbaInb0342: "FBA_INB_0342";
|
|
196
|
+
readonly FbaInb0465: "FBA_INB_0465";
|
|
197
|
+
readonly UnknownInbErrorCode: "UNKNOWN_INB_ERROR_CODE";
|
|
209
198
|
};
|
|
210
199
|
type ItemEligibilityPreviewIneligibilityReasonListEnum = typeof ItemEligibilityPreviewIneligibilityReasonListEnum[keyof typeof ItemEligibilityPreviewIneligibilityReasonListEnum];
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
* Selling Partner API for FBA Inbound Eligibilty
|
|
214
|
-
* With the FBA Inbound Eligibility API, you can build applications that let sellers get eligibility previews for items before shipping them to Amazon\'s fulfillment centers. With this API you can find out if an item is eligible for inbound shipment to Amazon\'s fulfillment centers in a specific marketplace. You can also find out if an item is eligible for using the manufacturer barcode for FBA inventory tracking. Sellers can use this information to inform their decisions about which items to ship Amazon\'s fulfillment centers.
|
|
215
|
-
*
|
|
216
|
-
* The version of the OpenAPI document: v1
|
|
217
|
-
*
|
|
218
|
-
*
|
|
219
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
220
|
-
* https://openapi-generator.tech
|
|
221
|
-
* Do not edit the class manually.
|
|
222
|
-
*/
|
|
223
|
-
|
|
200
|
+
//#endregion
|
|
201
|
+
//#region src/api-model/models/get-item-eligibility-preview-response.d.ts
|
|
224
202
|
/**
|
|
225
203
|
* The response schema for the getItemEligibilityPreview operation.
|
|
226
204
|
*/
|
|
227
205
|
interface GetItemEligibilityPreviewResponse {
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
206
|
+
'payload'?: ItemEligibilityPreview;
|
|
207
|
+
/**
|
|
208
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
209
|
+
*/
|
|
210
|
+
'errors'?: Array<Error>;
|
|
233
211
|
}
|
|
234
|
-
|
|
212
|
+
//#endregion
|
|
213
|
+
//#region src/api-model/models/model-error.d.ts
|
|
235
214
|
/**
|
|
236
215
|
* Selling Partner API for FBA Inbound Eligibilty
|
|
237
216
|
* With the FBA Inbound Eligibility API, you can build applications that let sellers get eligibility previews for items before shipping them to Amazon\'s fulfillment centers. With this API you can find out if an item is eligible for inbound shipment to Amazon\'s fulfillment centers in a specific marketplace. You can also find out if an item is eligible for using the manufacturer barcode for FBA inventory tracking. Sellers can use this information to inform their decisions about which items to ship Amazon\'s fulfillment centers.
|
|
@@ -247,98 +226,101 @@ interface GetItemEligibilityPreviewResponse {
|
|
|
247
226
|
* Error response returned when the request is unsuccessful.
|
|
248
227
|
*/
|
|
249
228
|
interface ModelError {
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
229
|
+
/**
|
|
230
|
+
* An error code that identifies the type of error that occurred.
|
|
231
|
+
*/
|
|
232
|
+
'code': string;
|
|
233
|
+
/**
|
|
234
|
+
* A message that describes the error condition in a human-readable form.
|
|
235
|
+
*/
|
|
236
|
+
'message'?: string;
|
|
237
|
+
/**
|
|
238
|
+
* Additional information that can help the caller understand or fix the issue.
|
|
239
|
+
*/
|
|
240
|
+
'details'?: string;
|
|
262
241
|
}
|
|
263
|
-
|
|
242
|
+
//#endregion
|
|
243
|
+
//#region src/api-model/api/fba-inbound-eligibility-api.d.ts
|
|
264
244
|
/**
|
|
265
245
|
* FbaInboundEligibilityApi - axios parameter creator
|
|
266
246
|
*/
|
|
267
247
|
declare const FbaInboundEligibilityApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
248
|
+
/**
|
|
249
|
+
* This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item\'s eligibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
250
|
+
* @param {string} asin The ASIN of the item for which you want an eligibility preview.
|
|
251
|
+
* @param {GetItemEligibilityPreviewProgramEnum} program The program that you want to check eligibility against.
|
|
252
|
+
* @param {Array<string>} [marketplaceIds] The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND.
|
|
253
|
+
* @param {*} [options] Override http request option.
|
|
254
|
+
* @throws {RequiredError}
|
|
255
|
+
*/
|
|
256
|
+
getItemEligibilityPreview: (asin: string, program: GetItemEligibilityPreviewProgramEnum, marketplaceIds?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
277
257
|
};
|
|
278
258
|
/**
|
|
279
259
|
* FbaInboundEligibilityApi - functional programming interface
|
|
280
260
|
*/
|
|
281
261
|
declare const FbaInboundEligibilityApiFp: (configuration?: Configuration) => {
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
262
|
+
/**
|
|
263
|
+
* This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item\'s eligibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
264
|
+
* @param {string} asin The ASIN of the item for which you want an eligibility preview.
|
|
265
|
+
* @param {GetItemEligibilityPreviewProgramEnum} program The program that you want to check eligibility against.
|
|
266
|
+
* @param {Array<string>} [marketplaceIds] The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND.
|
|
267
|
+
* @param {*} [options] Override http request option.
|
|
268
|
+
* @throws {RequiredError}
|
|
269
|
+
*/
|
|
270
|
+
getItemEligibilityPreview(asin: string, program: GetItemEligibilityPreviewProgramEnum, marketplaceIds?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetItemEligibilityPreviewResponse>>;
|
|
291
271
|
};
|
|
292
272
|
/**
|
|
293
273
|
* FbaInboundEligibilityApi - factory interface
|
|
294
274
|
*/
|
|
295
275
|
declare const FbaInboundEligibilityApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
276
|
+
/**
|
|
277
|
+
* This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item\'s eligibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
278
|
+
* @param {FbaInboundEligibilityApiGetItemEligibilityPreviewRequest} requestParameters Request parameters.
|
|
279
|
+
* @param {*} [options] Override http request option.
|
|
280
|
+
* @throws {RequiredError}
|
|
281
|
+
*/
|
|
282
|
+
getItemEligibilityPreview(requestParameters: FbaInboundEligibilityApiGetItemEligibilityPreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetItemEligibilityPreviewResponse>;
|
|
303
283
|
};
|
|
304
284
|
/**
|
|
305
285
|
* Request parameters for getItemEligibilityPreview operation in FbaInboundEligibilityApi.
|
|
306
286
|
*/
|
|
307
287
|
interface FbaInboundEligibilityApiGetItemEligibilityPreviewRequest {
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
288
|
+
/**
|
|
289
|
+
* The ASIN of the item for which you want an eligibility preview.
|
|
290
|
+
*/
|
|
291
|
+
readonly asin: string;
|
|
292
|
+
/**
|
|
293
|
+
* The program that you want to check eligibility against.
|
|
294
|
+
*/
|
|
295
|
+
readonly program: GetItemEligibilityPreviewProgramEnum;
|
|
296
|
+
/**
|
|
297
|
+
* The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND.
|
|
298
|
+
*/
|
|
299
|
+
readonly marketplaceIds?: Array<string>;
|
|
320
300
|
}
|
|
321
301
|
/**
|
|
322
302
|
* FbaInboundEligibilityApi - object-oriented interface
|
|
323
303
|
*/
|
|
324
304
|
declare class FbaInboundEligibilityApi extends BaseAPI {
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
305
|
+
/**
|
|
306
|
+
* This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item\'s eligibility. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
307
|
+
* @param {FbaInboundEligibilityApiGetItemEligibilityPreviewRequest} requestParameters Request parameters.
|
|
308
|
+
* @param {*} [options] Override http request option.
|
|
309
|
+
* @throws {RequiredError}
|
|
310
|
+
*/
|
|
311
|
+
getItemEligibilityPreview(requestParameters: FbaInboundEligibilityApiGetItemEligibilityPreviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetItemEligibilityPreviewResponse, any, {}>>;
|
|
332
312
|
}
|
|
333
313
|
declare const GetItemEligibilityPreviewProgramEnum: {
|
|
334
|
-
|
|
335
|
-
|
|
314
|
+
readonly Inbound: "INBOUND";
|
|
315
|
+
readonly Commingling: "COMMINGLING";
|
|
336
316
|
};
|
|
337
317
|
type GetItemEligibilityPreviewProgramEnum = typeof GetItemEligibilityPreviewProgramEnum[keyof typeof GetItemEligibilityPreviewProgramEnum];
|
|
338
|
-
|
|
318
|
+
//#endregion
|
|
319
|
+
//#region src/client.d.ts
|
|
339
320
|
declare const clientRateLimits: RateLimit[];
|
|
340
321
|
declare class FbaInboundEligibilityApiClient extends FbaInboundEligibilityApi {
|
|
341
|
-
|
|
322
|
+
constructor(configuration: ClientConfiguration);
|
|
342
323
|
}
|
|
343
|
-
|
|
344
|
-
export { FbaInboundEligibilityApi, FbaInboundEligibilityApiAxiosParamCreator, FbaInboundEligibilityApiClient, FbaInboundEligibilityApiFactory, FbaInboundEligibilityApiFp,
|
|
324
|
+
//#endregion
|
|
325
|
+
export { FbaInboundEligibilityApi, FbaInboundEligibilityApiAxiosParamCreator, FbaInboundEligibilityApiClient, FbaInboundEligibilityApiFactory, FbaInboundEligibilityApiFp, FbaInboundEligibilityApiGetItemEligibilityPreviewRequest, GetItemEligibilityPreviewProgramEnum, GetItemEligibilityPreviewResponse, ItemEligibilityPreview, ItemEligibilityPreviewIneligibilityReasonListEnum, ItemEligibilityPreviewProgramEnum, ModelError, clientRateLimits };
|
|
326
|
+
//# sourceMappingURL=index.d.ts.map
|