@sp-api-sdk/finances-api-v0 5.0.0 → 5.1.1
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 +4 -5
- package/dist/index.cjs +491 -521
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1398 -1932
- package/dist/index.d.ts +1398 -1932
- package/dist/index.js +468 -485
- package/dist/index.js.map +1 -1
- package/package.json +14 -6
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 Finances
|
|
7
6
|
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
@@ -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 Finances
|
|
105
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
106
|
-
*
|
|
107
|
-
* The version of the OpenAPI document: v0
|
|
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/currency.d.ts
|
|
126
115
|
/**
|
|
127
116
|
* Selling Partner API for Finances
|
|
128
117
|
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
@@ -138,1503 +127,1064 @@ declare class BaseAPI {
|
|
|
138
127
|
* A currency type and amount.
|
|
139
128
|
*/
|
|
140
129
|
interface Currency {
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
130
|
+
/**
|
|
131
|
+
* The three-digit currency code in ISO 4217 format.
|
|
132
|
+
*/
|
|
133
|
+
'CurrencyCode'?: string;
|
|
134
|
+
/**
|
|
135
|
+
* A signed decimal number.
|
|
136
|
+
*/
|
|
137
|
+
'CurrencyAmount'?: number;
|
|
149
138
|
}
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
* Selling Partner API for Finances
|
|
153
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
154
|
-
*
|
|
155
|
-
* The version of the OpenAPI document: v0
|
|
156
|
-
*
|
|
157
|
-
*
|
|
158
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
159
|
-
* https://openapi-generator.tech
|
|
160
|
-
* Do not edit the class manually.
|
|
161
|
-
*/
|
|
162
|
-
|
|
139
|
+
//#endregion
|
|
140
|
+
//#region src/api-model/models/adhoc-disbursement-event.d.ts
|
|
163
141
|
/**
|
|
164
142
|
* An event related to an Adhoc Disbursement.
|
|
165
143
|
*/
|
|
166
144
|
interface AdhocDisbursementEvent {
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
145
|
+
/**
|
|
146
|
+
* The type of transaction. For example, \"Disbursed to Amazon Gift Card balance\".
|
|
147
|
+
*/
|
|
148
|
+
'TransactionType'?: string;
|
|
149
|
+
/**
|
|
150
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
151
|
+
*/
|
|
152
|
+
'PostedDate'?: string;
|
|
153
|
+
/**
|
|
154
|
+
* The identifier for the transaction.
|
|
155
|
+
*/
|
|
156
|
+
'TransactionId'?: string;
|
|
157
|
+
'TransactionAmount'?: Currency;
|
|
180
158
|
}
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
* Selling Partner API for Finances
|
|
184
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
185
|
-
*
|
|
186
|
-
* The version of the OpenAPI document: v0
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
190
|
-
* https://openapi-generator.tech
|
|
191
|
-
* Do not edit the class manually.
|
|
192
|
-
*/
|
|
193
|
-
|
|
159
|
+
//#endregion
|
|
160
|
+
//#region src/api-model/models/adjustment-item.d.ts
|
|
194
161
|
/**
|
|
195
162
|
* An item in an adjustment to the seller\'s account.
|
|
196
163
|
*/
|
|
197
164
|
interface AdjustmentItem {
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
165
|
+
/**
|
|
166
|
+
* Represents the number of units in the seller\'s inventory when the `AdjustmentType` is `FBAInventoryReimbursement`.
|
|
167
|
+
*/
|
|
168
|
+
'Quantity'?: string;
|
|
169
|
+
'PerUnitAmount'?: Currency;
|
|
170
|
+
'TotalAmount'?: Currency;
|
|
171
|
+
/**
|
|
172
|
+
* The seller SKU of the item. The seller SKU is qualified by the seller\'s seller ID, which is included with every call to the Selling Partner API.
|
|
173
|
+
*/
|
|
174
|
+
'SellerSKU'?: string;
|
|
175
|
+
/**
|
|
176
|
+
* A unique identifier assigned to products stored in and fulfilled from a fulfillment center.
|
|
177
|
+
*/
|
|
178
|
+
'FnSKU'?: string;
|
|
179
|
+
/**
|
|
180
|
+
* A short description of the item.
|
|
181
|
+
*/
|
|
182
|
+
'ProductDescription'?: string;
|
|
183
|
+
/**
|
|
184
|
+
* The Amazon Standard Identification Number (ASIN) of the item.
|
|
185
|
+
*/
|
|
186
|
+
'ASIN'?: string;
|
|
187
|
+
/**
|
|
188
|
+
* The transaction number that is related to the adjustment.
|
|
189
|
+
*/
|
|
190
|
+
'TransactionNumber'?: string;
|
|
224
191
|
}
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
* Selling Partner API for Finances
|
|
228
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
229
|
-
*
|
|
230
|
-
* The version of the OpenAPI document: v0
|
|
231
|
-
*
|
|
232
|
-
*
|
|
233
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
234
|
-
* https://openapi-generator.tech
|
|
235
|
-
* Do not edit the class manually.
|
|
236
|
-
*/
|
|
237
|
-
|
|
192
|
+
//#endregion
|
|
193
|
+
//#region src/api-model/models/adjustment-event.d.ts
|
|
238
194
|
/**
|
|
239
195
|
* An adjustment to the seller\'s account.
|
|
240
196
|
*/
|
|
241
197
|
interface AdjustmentEvent {
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
198
|
+
/**
|
|
199
|
+
* The type of adjustment. Possible values: * `FBAInventoryReimbursement`: An FBA inventory reimbursement to a seller\'s account. This occurs if a seller\'s inventory is damaged. * `ReserveEvent`: A reserve event that is generated at the time a settlement period closes. This occurs when some money from a seller\'s account is held back. * `PostageBilling`: The amount paid by a seller for shipping labels. * `PostageRefund`: The reimbursement of shipping labels purchased for orders that were canceled or refunded. * `LostOrDamagedReimbursement`: An Amazon Easy Ship reimbursement to a seller\'s account for a package that we lost or damaged. * `CanceledButPickedUpReimbursement`: An Amazon Easy Ship reimbursement to a seller\'s account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace. * `ReimbursementClawback`: An Amazon Easy Ship reimbursement clawback from a seller\'s account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace. * `SellerRewards`: An award credited to a seller\'s account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace.
|
|
200
|
+
*/
|
|
201
|
+
'AdjustmentType'?: string;
|
|
202
|
+
/**
|
|
203
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
204
|
+
*/
|
|
205
|
+
'PostedDate'?: string;
|
|
206
|
+
/**
|
|
207
|
+
* The name of the store where the event occurred.
|
|
208
|
+
*/
|
|
209
|
+
'StoreName'?: string;
|
|
210
|
+
'AdjustmentAmount'?: Currency;
|
|
211
|
+
/**
|
|
212
|
+
* A list of information about items in an adjustment to the seller\'s account.
|
|
213
|
+
*/
|
|
214
|
+
'AdjustmentItemList'?: Array<AdjustmentItem>;
|
|
259
215
|
}
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
* Selling Partner API for Finances
|
|
263
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
264
|
-
*
|
|
265
|
-
* The version of the OpenAPI document: v0
|
|
266
|
-
*
|
|
267
|
-
*
|
|
268
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
269
|
-
* https://openapi-generator.tech
|
|
270
|
-
* Do not edit the class manually.
|
|
271
|
-
*/
|
|
272
|
-
|
|
216
|
+
//#endregion
|
|
217
|
+
//#region src/api-model/models/affordability-expense-event.d.ts
|
|
273
218
|
/**
|
|
274
219
|
* An expense related to an affordability promotion.
|
|
275
220
|
*/
|
|
276
221
|
interface AffordabilityExpenseEvent {
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
222
|
+
/**
|
|
223
|
+
* An Amazon-defined identifier for an order.
|
|
224
|
+
*/
|
|
225
|
+
'AmazonOrderId'?: string;
|
|
226
|
+
/**
|
|
227
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
228
|
+
*/
|
|
229
|
+
'PostedDate'?: string;
|
|
230
|
+
/**
|
|
231
|
+
* The Amazon-defined marketplace identifier.
|
|
232
|
+
*/
|
|
233
|
+
'MarketplaceId'?: string;
|
|
234
|
+
/**
|
|
235
|
+
* The type of transaction. Possible values: * `Charge`: an affordability promotion expense. * `Refund`: an affordability promotion expense reversal.
|
|
236
|
+
*/
|
|
237
|
+
'TransactionType'?: string;
|
|
238
|
+
'BaseExpense'?: Currency;
|
|
239
|
+
'TaxTypeCGST': Currency;
|
|
240
|
+
'TaxTypeSGST': Currency;
|
|
241
|
+
'TaxTypeIGST': Currency;
|
|
242
|
+
'TotalExpense'?: Currency;
|
|
298
243
|
}
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
* Selling Partner API for Finances
|
|
302
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
303
|
-
*
|
|
304
|
-
* The version of the OpenAPI document: v0
|
|
305
|
-
*
|
|
306
|
-
*
|
|
307
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
308
|
-
* https://openapi-generator.tech
|
|
309
|
-
* Do not edit the class manually.
|
|
310
|
-
*/
|
|
311
|
-
|
|
244
|
+
//#endregion
|
|
245
|
+
//#region src/api-model/models/capacity-reservation-billing-event.d.ts
|
|
312
246
|
/**
|
|
313
247
|
* An event related to a capacity reservation billing charge.
|
|
314
248
|
*/
|
|
315
249
|
interface CapacityReservationBillingEvent {
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
250
|
+
/**
|
|
251
|
+
* The transaction type. For example, FBA Inventory Fee.
|
|
252
|
+
*/
|
|
253
|
+
'TransactionType'?: string;
|
|
254
|
+
/**
|
|
255
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
256
|
+
*/
|
|
257
|
+
'PostedDate'?: string;
|
|
258
|
+
/**
|
|
259
|
+
* A short description of the capacity reservation billing event.
|
|
260
|
+
*/
|
|
261
|
+
'Description'?: string;
|
|
262
|
+
'TransactionAmount'?: Currency;
|
|
329
263
|
}
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
* Selling Partner API for Finances
|
|
333
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
334
|
-
*
|
|
335
|
-
* The version of the OpenAPI document: v0
|
|
336
|
-
*
|
|
337
|
-
*
|
|
338
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
339
|
-
* https://openapi-generator.tech
|
|
340
|
-
* Do not edit the class manually.
|
|
341
|
-
*/
|
|
342
|
-
|
|
264
|
+
//#endregion
|
|
265
|
+
//#region src/api-model/models/charge-component.d.ts
|
|
343
266
|
/**
|
|
344
267
|
* A charge on the seller\'s account. Possible values: * `Principal`: The selling price of the order item, which is equal to the selling price of the item multiplied by the quantity ordered. * `Tax`: The tax on the principal that is collected by the seller. * `MarketplaceFacilitatorTax-Principal`: The tax that is withheld on the principal. * `MarketplaceFacilitatorTax-Shipping`: The tax that is withheld on the `ShippingCharge`. * `MarketplaceFacilitatorTax-Giftwrap`: The tax that is withheld on the Giftwrap charge. * `MarketplaceFacilitatorTax-Other`: The tax that is withheld on other miscellaneous charges. * `Discount`: The promotional discount for an order item. * `TaxDiscount`: The tax that is deducted for promotional rebates. * `CODItemCharge`: The COD charge for an order item. * `CODItemTaxCharge`: The tax that is collected by the seller on a `CODItemCharge`. * `CODOrderCharge`: The COD charge for an order. * `CODOrderTaxCharge`: The tax that is collected by the seller on a `CODOrderCharge`. * `CODShippingCharge`: Shipping charges for a COD order. * `CODShippingTaxCharge`: The tax that is collected by the seller on a `CODShippingCharge`. * `ShippingCharge`: The shipping charge. * `ShippingTax`: The tax that is collected by the seller on a `ShippingCharge`. * `Goodwill`: The amount of money that is given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the buying experience. * `Giftwrap`: The gift wrap charge. * `GiftwrapTax`: The tax that is collected by the seller on a gift wrap charge. * `RestockingFee`: The charge that is applied to the buyer when returning a product in certain categories. * `ReturnShipping`: The amount of money that is given to the buyer to compensate for shipping the item back if we are at fault. * `PointsFee`: The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon Points to cover the deduction. * `GenericDeduction`: A generic bad debt deduction. * `FreeReplacementReturnShipping`: The compensation for return shipping when a buyer receives the wrong item, requests a free replacement, and returns the incorrect item. * `PaymentMethodFee`: The fee that is collected for certain payment methods in certain marketplaces. * `ExportCharge`: The export duty that is charged when an item is shipped to an international destination as part of the Amazon Global program. * `SAFE-TReimbursement`: The SAFE-T claim amount for the item. * `TCS-CGST`: Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST). * `TCS-SGST`: Tax Collected at Source for State Goods and Services Tax (SGST). * `TCS-IGST`: Tax Collected at Source for Integrated Goods and Services Tax (IGST). * `TCS-UTGST`: Tax Collected at Source for Union Territories Goods and Services Tax (UTGST). * `PaidthroughEBT`: The amount of money paid with EBT for any order or shipment items.
|
|
345
268
|
*/
|
|
346
269
|
interface ChargeComponent {
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
270
|
+
/**
|
|
271
|
+
* The type of charge.
|
|
272
|
+
*/
|
|
273
|
+
'ChargeType'?: string;
|
|
274
|
+
'ChargeAmount'?: Currency;
|
|
352
275
|
}
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
* Selling Partner API for Finances
|
|
356
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
357
|
-
*
|
|
358
|
-
* The version of the OpenAPI document: v0
|
|
359
|
-
*
|
|
360
|
-
*
|
|
361
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
362
|
-
* https://openapi-generator.tech
|
|
363
|
-
* Do not edit the class manually.
|
|
364
|
-
*/
|
|
365
|
-
|
|
276
|
+
//#endregion
|
|
277
|
+
//#region src/api-model/models/charge-instrument.d.ts
|
|
366
278
|
/**
|
|
367
279
|
* A payment instrument.
|
|
368
280
|
*/
|
|
369
281
|
interface ChargeInstrument {
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
282
|
+
/**
|
|
283
|
+
* A short description of the charge instrument.
|
|
284
|
+
*/
|
|
285
|
+
'Description'?: string;
|
|
286
|
+
/**
|
|
287
|
+
* The account tail (trailing digits) of the charge instrument.
|
|
288
|
+
*/
|
|
289
|
+
'Tail'?: string;
|
|
290
|
+
'Amount'?: Currency;
|
|
379
291
|
}
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
* Selling Partner API for Finances
|
|
383
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
384
|
-
*
|
|
385
|
-
* The version of the OpenAPI document: v0
|
|
386
|
-
*
|
|
387
|
-
*
|
|
388
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
389
|
-
* https://openapi-generator.tech
|
|
390
|
-
* Do not edit the class manually.
|
|
391
|
-
*/
|
|
392
|
-
|
|
292
|
+
//#endregion
|
|
293
|
+
//#region src/api-model/models/charge-refund-transaction.d.ts
|
|
393
294
|
/**
|
|
394
295
|
* The charge refund transaction.
|
|
395
296
|
*/
|
|
396
297
|
interface ChargeRefundTransaction {
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
298
|
+
'ChargeAmount'?: Currency;
|
|
299
|
+
/**
|
|
300
|
+
* The type of charge.
|
|
301
|
+
*/
|
|
302
|
+
'ChargeType'?: string;
|
|
402
303
|
}
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
* Selling Partner API for Finances
|
|
406
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
407
|
-
*
|
|
408
|
-
* The version of the OpenAPI document: v0
|
|
409
|
-
*
|
|
410
|
-
*
|
|
411
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
412
|
-
* https://openapi-generator.tech
|
|
413
|
-
* Do not edit the class manually.
|
|
414
|
-
*/
|
|
415
|
-
|
|
304
|
+
//#endregion
|
|
305
|
+
//#region src/api-model/models/charge-refund-event.d.ts
|
|
416
306
|
/**
|
|
417
307
|
* An event related to charge refund.
|
|
418
308
|
*/
|
|
419
309
|
interface ChargeRefundEvent {
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
310
|
+
/**
|
|
311
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
312
|
+
*/
|
|
313
|
+
'PostedDate'?: string;
|
|
314
|
+
/**
|
|
315
|
+
* The reason given for a charge refund. For example, `SubscriptionFeeCorrection`.
|
|
316
|
+
*/
|
|
317
|
+
'ReasonCode'?: string;
|
|
318
|
+
/**
|
|
319
|
+
* A description of the Reason Code. For example, `SubscriptionFeeCorrection`.
|
|
320
|
+
*/
|
|
321
|
+
'ReasonCodeDescription'?: string;
|
|
322
|
+
/**
|
|
323
|
+
* A list of `ChargeRefund` transactions
|
|
324
|
+
*/
|
|
325
|
+
'ChargeRefundTransactions'?: Array<ChargeRefundTransaction>;
|
|
436
326
|
}
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
* Selling Partner API for Finances
|
|
440
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
441
|
-
*
|
|
442
|
-
* The version of the OpenAPI document: v0
|
|
443
|
-
*
|
|
444
|
-
*
|
|
445
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
446
|
-
* https://openapi-generator.tech
|
|
447
|
-
* Do not edit the class manually.
|
|
448
|
-
*/
|
|
449
|
-
|
|
327
|
+
//#endregion
|
|
328
|
+
//#region src/api-model/models/fee-component.d.ts
|
|
450
329
|
/**
|
|
451
330
|
* A fee associated with the event.
|
|
452
331
|
*/
|
|
453
332
|
interface FeeComponent {
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
333
|
+
/**
|
|
334
|
+
* The type of fee. For more information about Selling on Amazon fees, see [Selling on Amazon Fee Schedule](https://sellercentral.amazon.com/gp/help/200336920) on Seller Central. For more information about Fulfillment by Amazon fees, see [FBA features, services and fees](https://sellercentral.amazon.com/gp/help/201074400) on Seller Central.
|
|
335
|
+
*/
|
|
336
|
+
'FeeType'?: string;
|
|
337
|
+
'FeeAmount'?: Currency;
|
|
459
338
|
}
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
* Selling Partner API for Finances
|
|
463
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
464
|
-
*
|
|
465
|
-
* The version of the OpenAPI document: v0
|
|
466
|
-
*
|
|
467
|
-
*
|
|
468
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
469
|
-
* https://openapi-generator.tech
|
|
470
|
-
* Do not edit the class manually.
|
|
471
|
-
*/
|
|
472
|
-
|
|
339
|
+
//#endregion
|
|
340
|
+
//#region src/api-model/models/coupon-payment-event.d.ts
|
|
473
341
|
/**
|
|
474
342
|
* An event related to coupon payments.
|
|
475
343
|
*/
|
|
476
344
|
interface CouponPaymentEvent {
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
345
|
+
/**
|
|
346
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
347
|
+
*/
|
|
348
|
+
'PostedDate'?: string;
|
|
349
|
+
/**
|
|
350
|
+
* A coupon identifier.
|
|
351
|
+
*/
|
|
352
|
+
'CouponId'?: string;
|
|
353
|
+
/**
|
|
354
|
+
* The description provided by the seller when they created the coupon.
|
|
355
|
+
*/
|
|
356
|
+
'SellerCouponDescription'?: string;
|
|
357
|
+
/**
|
|
358
|
+
* The number of coupon clips or redemptions.
|
|
359
|
+
*/
|
|
360
|
+
'ClipOrRedemptionCount'?: number;
|
|
361
|
+
/**
|
|
362
|
+
* A payment event identifier.
|
|
363
|
+
*/
|
|
364
|
+
'PaymentEventId'?: string;
|
|
365
|
+
'FeeComponent'?: FeeComponent;
|
|
366
|
+
'ChargeComponent'?: ChargeComponent;
|
|
367
|
+
'TotalAmount'?: Currency;
|
|
500
368
|
}
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
* Selling Partner API for Finances
|
|
504
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
505
|
-
*
|
|
506
|
-
* The version of the OpenAPI document: v0
|
|
507
|
-
*
|
|
508
|
-
*
|
|
509
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
510
|
-
* https://openapi-generator.tech
|
|
511
|
-
* Do not edit the class manually.
|
|
512
|
-
*/
|
|
513
|
-
|
|
369
|
+
//#endregion
|
|
370
|
+
//#region src/api-model/models/debt-recovery-item.d.ts
|
|
514
371
|
/**
|
|
515
372
|
* An item of a debt payment or debt adjustment.
|
|
516
373
|
*/
|
|
517
374
|
interface DebtRecoveryItem {
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
375
|
+
'RecoveryAmount'?: Currency;
|
|
376
|
+
'OriginalAmount'?: Currency;
|
|
377
|
+
/**
|
|
378
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
379
|
+
*/
|
|
380
|
+
'GroupBeginDate'?: string;
|
|
381
|
+
/**
|
|
382
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
383
|
+
*/
|
|
384
|
+
'GroupEndDate'?: string;
|
|
528
385
|
}
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
* Selling Partner API for Finances
|
|
532
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
533
|
-
*
|
|
534
|
-
* The version of the OpenAPI document: v0
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
538
|
-
* https://openapi-generator.tech
|
|
539
|
-
* Do not edit the class manually.
|
|
540
|
-
*/
|
|
541
|
-
|
|
386
|
+
//#endregion
|
|
387
|
+
//#region src/api-model/models/debt-recovery-event.d.ts
|
|
542
388
|
/**
|
|
543
389
|
* A debt payment or debt adjustment.
|
|
544
390
|
*/
|
|
545
391
|
interface DebtRecoveryEvent {
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
392
|
+
/**
|
|
393
|
+
* The debt recovery type. Possible values: * `DebtPayment` * `DebtPaymentFailure` * `DebtAdjustment`
|
|
394
|
+
*/
|
|
395
|
+
'DebtRecoveryType'?: string;
|
|
396
|
+
'RecoveryAmount'?: Currency;
|
|
397
|
+
'OverPaymentCredit'?: Currency;
|
|
398
|
+
/**
|
|
399
|
+
* A list of debt recovery item information.
|
|
400
|
+
*/
|
|
401
|
+
'DebtRecoveryItemList'?: Array<DebtRecoveryItem>;
|
|
402
|
+
/**
|
|
403
|
+
* A list of payment instruments.
|
|
404
|
+
*/
|
|
405
|
+
'ChargeInstrumentList'?: Array<ChargeInstrument>;
|
|
560
406
|
}
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
* Selling Partner API for Finances
|
|
564
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
565
|
-
*
|
|
566
|
-
* The version of the OpenAPI document: v0
|
|
567
|
-
*
|
|
568
|
-
*
|
|
569
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
570
|
-
* https://openapi-generator.tech
|
|
571
|
-
* Do not edit the class manually.
|
|
572
|
-
*/
|
|
573
|
-
|
|
407
|
+
//#endregion
|
|
408
|
+
//#region src/api-model/models/direct-payment.d.ts
|
|
574
409
|
/**
|
|
575
410
|
* A payment made directly to a seller.
|
|
576
411
|
*/
|
|
577
412
|
interface DirectPayment {
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
413
|
+
/**
|
|
414
|
+
* The type of payment. Possible values: * `StoredValueCardRevenue` - The amount that is deducted from the seller\'s account because the seller received money through a stored value card. * `StoredValueCardRefund` - The amount that Amazon returns to the seller if the order that is purchased using a stored value card is refunded. * `PrivateLabelCreditCardRevenue` - The amount that is deducted from the seller\'s account because the seller received money through a private label credit card offered by Amazon. * `PrivateLabelCreditCardRefund` - The amount that Amazon returns to the seller if the order that is purchased using a private label credit card offered by Amazon is refunded. * `CollectOnDeliveryRevenue` - The COD amount that the seller collected directly from the buyer. * `CollectOnDeliveryRefund` - The amount that Amazon refunds to the buyer if an order paid for by COD is refunded.
|
|
415
|
+
*/
|
|
416
|
+
'DirectPaymentType'?: string;
|
|
417
|
+
'DirectPaymentAmount'?: Currency;
|
|
583
418
|
}
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
* Selling Partner API for Finances
|
|
587
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
588
|
-
*
|
|
589
|
-
* The version of the OpenAPI document: v0
|
|
590
|
-
*
|
|
591
|
-
*
|
|
592
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
593
|
-
* https://openapi-generator.tech
|
|
594
|
-
* Do not edit the class manually.
|
|
595
|
-
*/
|
|
596
|
-
|
|
419
|
+
//#endregion
|
|
420
|
+
//#region src/api-model/models/ebtrefund-reimbursement-only-event.d.ts
|
|
597
421
|
/**
|
|
598
422
|
* An EBT refund reimbursement event.
|
|
599
423
|
*/
|
|
600
424
|
interface EBTRefundReimbursementOnlyEvent {
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
425
|
+
/**
|
|
426
|
+
* The identifier of an order.
|
|
427
|
+
*/
|
|
428
|
+
'OrderId'?: string;
|
|
429
|
+
/**
|
|
430
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
431
|
+
*/
|
|
432
|
+
'PostedDate'?: string;
|
|
433
|
+
'Amount'?: Currency;
|
|
610
434
|
}
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
* Selling Partner API for Finances
|
|
614
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
615
|
-
*
|
|
616
|
-
* The version of the OpenAPI document: v0
|
|
617
|
-
*
|
|
618
|
-
*
|
|
619
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
620
|
-
* https://openapi-generator.tech
|
|
621
|
-
* Do not edit the class manually.
|
|
622
|
-
*/
|
|
623
|
-
|
|
435
|
+
//#endregion
|
|
436
|
+
//#region src/api-model/models/fbaliquidation-event.d.ts
|
|
624
437
|
/**
|
|
625
438
|
* A payment event for Fulfillment by Amazon (FBA) inventory liquidation. This event is used only in the US marketplace.
|
|
626
439
|
*/
|
|
627
440
|
interface FBALiquidationEvent {
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
441
|
+
/**
|
|
442
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
443
|
+
*/
|
|
444
|
+
'PostedDate'?: string;
|
|
445
|
+
/**
|
|
446
|
+
* The identifier for the original removal order.
|
|
447
|
+
*/
|
|
448
|
+
'OriginalRemovalOrderId'?: string;
|
|
449
|
+
'LiquidationProceedsAmount'?: Currency;
|
|
450
|
+
'LiquidationFeeAmount'?: Currency;
|
|
638
451
|
}
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
* Selling Partner API for Finances
|
|
642
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
643
|
-
*
|
|
644
|
-
* The version of the OpenAPI document: v0
|
|
645
|
-
*
|
|
646
|
-
*
|
|
647
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
648
|
-
* https://openapi-generator.tech
|
|
649
|
-
* Do not edit the class manually.
|
|
650
|
-
*/
|
|
651
|
-
|
|
452
|
+
//#endregion
|
|
453
|
+
//#region src/api-model/models/failed-adhoc-disbursement-event.d.ts
|
|
652
454
|
/**
|
|
653
455
|
* Failed ad hoc disbursement event list.
|
|
654
456
|
*/
|
|
655
457
|
interface FailedAdhocDisbursementEvent {
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
458
|
+
/**
|
|
459
|
+
* The type of fund transfer. For example, `Refund`.
|
|
460
|
+
*/
|
|
461
|
+
'FundsTransfersType'?: string;
|
|
462
|
+
/**
|
|
463
|
+
* The transfer identifier.
|
|
464
|
+
*/
|
|
465
|
+
'TransferId'?: string;
|
|
466
|
+
/**
|
|
467
|
+
* The disbursement identifier.
|
|
468
|
+
*/
|
|
469
|
+
'DisbursementId'?: string;
|
|
470
|
+
/**
|
|
471
|
+
* The type of payment for disbursement. For example, `CREDIT_CARD`.
|
|
472
|
+
*/
|
|
473
|
+
'PaymentDisbursementType'?: string;
|
|
474
|
+
/**
|
|
475
|
+
* The status of the failed `AdhocDisbursement`. For example, `HARD_DECLINED`.
|
|
476
|
+
*/
|
|
477
|
+
'Status'?: string;
|
|
478
|
+
'TransferAmount'?: Currency;
|
|
479
|
+
/**
|
|
480
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
481
|
+
*/
|
|
482
|
+
'PostedDate'?: string;
|
|
681
483
|
}
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
* Selling Partner API for Finances
|
|
685
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
686
|
-
*
|
|
687
|
-
* The version of the OpenAPI document: v0
|
|
688
|
-
*
|
|
689
|
-
*
|
|
690
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
691
|
-
* https://openapi-generator.tech
|
|
692
|
-
* Do not edit the class manually.
|
|
693
|
-
*/
|
|
694
|
-
|
|
484
|
+
//#endregion
|
|
485
|
+
//#region src/api-model/models/financial-event-group.d.ts
|
|
695
486
|
/**
|
|
696
487
|
* Information related to a financial event group.
|
|
697
488
|
*/
|
|
698
489
|
interface FinancialEventGroup {
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
490
|
+
/**
|
|
491
|
+
* A unique identifier for the financial event group.
|
|
492
|
+
*/
|
|
493
|
+
'FinancialEventGroupId'?: string;
|
|
494
|
+
/**
|
|
495
|
+
* The processing status of the financial event group indicates whether the balance of the financial event group is settled. Possible values: * `Open` * `Closed`
|
|
496
|
+
*/
|
|
497
|
+
'ProcessingStatus'?: string;
|
|
498
|
+
/**
|
|
499
|
+
* The status of the fund transfer.
|
|
500
|
+
*/
|
|
501
|
+
'FundTransferStatus'?: string;
|
|
502
|
+
'OriginalTotal'?: Currency;
|
|
503
|
+
'ConvertedTotal'?: Currency;
|
|
504
|
+
/**
|
|
505
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
506
|
+
*/
|
|
507
|
+
'FundTransferDate'?: string;
|
|
508
|
+
/**
|
|
509
|
+
* The trace identifier used by sellers to look up transactions externally.
|
|
510
|
+
*/
|
|
511
|
+
'TraceId'?: string;
|
|
512
|
+
/**
|
|
513
|
+
* The account tail of the payment instrument.
|
|
514
|
+
*/
|
|
515
|
+
'AccountTail'?: string;
|
|
516
|
+
'BeginningBalance'?: Currency;
|
|
517
|
+
/**
|
|
518
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
519
|
+
*/
|
|
520
|
+
'FinancialEventGroupStart'?: string;
|
|
521
|
+
/**
|
|
522
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
523
|
+
*/
|
|
524
|
+
'FinancialEventGroupEnd'?: string;
|
|
734
525
|
}
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
* Selling Partner API for Finances
|
|
738
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
739
|
-
*
|
|
740
|
-
* The version of the OpenAPI document: v0
|
|
741
|
-
*
|
|
742
|
-
*
|
|
743
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
744
|
-
* https://openapi-generator.tech
|
|
745
|
-
* Do not edit the class manually.
|
|
746
|
-
*/
|
|
747
|
-
|
|
526
|
+
//#endregion
|
|
527
|
+
//#region src/api-model/models/imaging-services-fee-event.d.ts
|
|
748
528
|
/**
|
|
749
529
|
* A fee event related to Amazon Imaging services.
|
|
750
530
|
*/
|
|
751
531
|
interface ImagingServicesFeeEvent {
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
532
|
+
/**
|
|
533
|
+
* The identifier for the imaging services request.
|
|
534
|
+
*/
|
|
535
|
+
'ImagingRequestBillingItemID'?: string;
|
|
536
|
+
/**
|
|
537
|
+
* The Amazon Standard Identification Number (ASIN) of the item for which the imaging service was requested.
|
|
538
|
+
*/
|
|
539
|
+
'ASIN'?: string;
|
|
540
|
+
/**
|
|
541
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
542
|
+
*/
|
|
543
|
+
'PostedDate'?: string;
|
|
544
|
+
/**
|
|
545
|
+
* A list of fee component information.
|
|
546
|
+
*/
|
|
547
|
+
'FeeList'?: Array<FeeComponent>;
|
|
768
548
|
}
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
* Selling Partner API for Finances
|
|
772
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
773
|
-
*
|
|
774
|
-
* The version of the OpenAPI document: v0
|
|
775
|
-
*
|
|
776
|
-
*
|
|
777
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
778
|
-
* https://openapi-generator.tech
|
|
779
|
-
* Do not edit the class manually.
|
|
780
|
-
*/
|
|
781
|
-
|
|
549
|
+
//#endregion
|
|
550
|
+
//#region src/api-model/models/loan-servicing-event.d.ts
|
|
782
551
|
/**
|
|
783
552
|
* A loan advance, loan payment, or loan refund.
|
|
784
553
|
*/
|
|
785
554
|
interface LoanServicingEvent {
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
555
|
+
'LoanAmount'?: Currency;
|
|
556
|
+
/**
|
|
557
|
+
* The type of event. Possible values: * `LoanAdvance` * `LoanPayment` * `LoanRefund`
|
|
558
|
+
*/
|
|
559
|
+
'SourceBusinessEventType'?: string;
|
|
791
560
|
}
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
* Selling Partner API for Finances
|
|
795
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
796
|
-
*
|
|
797
|
-
* The version of the OpenAPI document: v0
|
|
798
|
-
*
|
|
799
|
-
*
|
|
800
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
801
|
-
* https://openapi-generator.tech
|
|
802
|
-
* Do not edit the class manually.
|
|
803
|
-
*/
|
|
804
|
-
|
|
561
|
+
//#endregion
|
|
562
|
+
//#region src/api-model/models/network-commingling-transaction-event.d.ts
|
|
805
563
|
/**
|
|
806
564
|
* A network commingling transaction event.
|
|
807
565
|
*/
|
|
808
566
|
interface NetworkComminglingTransactionEvent {
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
567
|
+
/**
|
|
568
|
+
* The type of network item swap. Possible values: * `NetCo`: A Fulfillment by Amazon inventory pooling transaction. Available only in the India marketplace. * `ComminglingVAT`: A commingling VAT transaction. Available only in the Spain, UK, France, Germany, and Italy marketplaces.
|
|
569
|
+
*/
|
|
570
|
+
'TransactionType'?: string;
|
|
571
|
+
/**
|
|
572
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
573
|
+
*/
|
|
574
|
+
'PostedDate'?: string;
|
|
575
|
+
/**
|
|
576
|
+
* The identifier for the network item swap.
|
|
577
|
+
*/
|
|
578
|
+
'NetCoTransactionID'?: string;
|
|
579
|
+
/**
|
|
580
|
+
* The reason for the network item swap.
|
|
581
|
+
*/
|
|
582
|
+
'SwapReason'?: string;
|
|
583
|
+
/**
|
|
584
|
+
* The Amazon Standard Identification Number (ASIN) of the swapped item.
|
|
585
|
+
*/
|
|
586
|
+
'ASIN'?: string;
|
|
587
|
+
/**
|
|
588
|
+
* The marketplace in which the event took place.
|
|
589
|
+
*/
|
|
590
|
+
'MarketplaceId'?: string;
|
|
591
|
+
'TaxExclusiveAmount'?: Currency;
|
|
592
|
+
'TaxAmount'?: Currency;
|
|
835
593
|
}
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
* Selling Partner API for Finances
|
|
839
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
840
|
-
*
|
|
841
|
-
* The version of the OpenAPI document: v0
|
|
842
|
-
*
|
|
843
|
-
*
|
|
844
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
845
|
-
* https://openapi-generator.tech
|
|
846
|
-
* Do not edit the class manually.
|
|
847
|
-
*/
|
|
848
|
-
|
|
594
|
+
//#endregion
|
|
595
|
+
//#region src/api-model/models/pay-with-amazon-event.d.ts
|
|
849
596
|
/**
|
|
850
597
|
* An event related to the seller\'s Pay with Amazon account.
|
|
851
598
|
*/
|
|
852
599
|
interface PayWithAmazonEvent {
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
600
|
+
/**
|
|
601
|
+
* An order identifier that is specified by the seller.
|
|
602
|
+
*/
|
|
603
|
+
'SellerOrderId'?: string;
|
|
604
|
+
/**
|
|
605
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
606
|
+
*/
|
|
607
|
+
'TransactionPostedDate'?: string;
|
|
608
|
+
/**
|
|
609
|
+
* The type of business object.
|
|
610
|
+
*/
|
|
611
|
+
'BusinessObjectType'?: string;
|
|
612
|
+
/**
|
|
613
|
+
* The sales channel for the transaction.
|
|
614
|
+
*/
|
|
615
|
+
'SalesChannel'?: string;
|
|
616
|
+
'Charge'?: ChargeComponent;
|
|
617
|
+
/**
|
|
618
|
+
* A list of fee component information.
|
|
619
|
+
*/
|
|
620
|
+
'FeeList'?: Array<FeeComponent>;
|
|
621
|
+
/**
|
|
622
|
+
* The type of payment. Possible values: * `Sales`
|
|
623
|
+
*/
|
|
624
|
+
'PaymentAmountType'?: string;
|
|
625
|
+
/**
|
|
626
|
+
* A short description of this payment event.
|
|
627
|
+
*/
|
|
628
|
+
'AmountDescription'?: string;
|
|
629
|
+
/**
|
|
630
|
+
* The fulfillment channel. Possible values: * `AFN`: Amazon Fulfillment Network (Fulfillment by Amazon) * `MFN`: Merchant Fulfillment Network (self-fulfilled)
|
|
631
|
+
*/
|
|
632
|
+
'FulfillmentChannel'?: string;
|
|
633
|
+
/**
|
|
634
|
+
* The name of the store where the event occurred.
|
|
635
|
+
*/
|
|
636
|
+
'StoreName'?: string;
|
|
890
637
|
}
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
* Selling Partner API for Finances
|
|
894
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
895
|
-
*
|
|
896
|
-
* The version of the OpenAPI document: v0
|
|
897
|
-
*
|
|
898
|
-
*
|
|
899
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
900
|
-
* https://openapi-generator.tech
|
|
901
|
-
* Do not edit the class manually.
|
|
902
|
-
*/
|
|
903
|
-
|
|
638
|
+
//#endregion
|
|
639
|
+
//#region src/api-model/models/product-ads-payment-event.d.ts
|
|
904
640
|
/**
|
|
905
641
|
* A Sponsored Products payment event.
|
|
906
642
|
*/
|
|
907
643
|
interface ProductAdsPaymentEvent {
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
}
|
|
924
|
-
|
|
925
|
-
/**
|
|
926
|
-
* Selling Partner API for Finances
|
|
927
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
928
|
-
*
|
|
929
|
-
* The version of the OpenAPI document: v0
|
|
930
|
-
*
|
|
931
|
-
*
|
|
932
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
933
|
-
* https://openapi-generator.tech
|
|
934
|
-
* Do not edit the class manually.
|
|
935
|
-
*/
|
|
936
|
-
|
|
937
|
-
/**
|
|
938
|
-
* Item-level information for a removal shipment item adjustment.
|
|
939
|
-
*/
|
|
940
|
-
interface RemovalShipmentItemAdjustment {
|
|
941
|
-
/**
|
|
942
|
-
* An identifier for an item in a removal shipment.
|
|
943
|
-
*/
|
|
944
|
-
'RemovalShipmentItemId'?: string;
|
|
945
|
-
/**
|
|
946
|
-
* The tax collection model that is applied to the item. Possible values: * `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. * `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon.
|
|
947
|
-
*/
|
|
948
|
-
'TaxCollectionModel'?: string;
|
|
949
|
-
/**
|
|
950
|
-
* The Amazon fulfillment network SKU for the item.
|
|
951
|
-
*/
|
|
952
|
-
'FulfillmentNetworkSKU'?: string;
|
|
953
|
-
/**
|
|
954
|
-
* Adjusted quantity of `RemovalShipmentItemAdjustment` items.
|
|
955
|
-
*/
|
|
956
|
-
'AdjustedQuantity'?: number;
|
|
957
|
-
'RevenueAdjustment'?: Currency;
|
|
958
|
-
'TaxAmountAdjustment'?: Currency;
|
|
959
|
-
'TaxWithheldAdjustment'?: Currency;
|
|
644
|
+
/**
|
|
645
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
646
|
+
*/
|
|
647
|
+
'postedDate'?: string;
|
|
648
|
+
/**
|
|
649
|
+
* Indicates if the transaction is for a charge or a refund. Possible values: * `charge` * `refund`
|
|
650
|
+
*/
|
|
651
|
+
'transactionType'?: string;
|
|
652
|
+
/**
|
|
653
|
+
* The identifier for the invoice that includes the transaction.
|
|
654
|
+
*/
|
|
655
|
+
'invoiceId'?: string;
|
|
656
|
+
'baseValue'?: Currency;
|
|
657
|
+
'taxValue'?: Currency;
|
|
658
|
+
'transactionValue'?: Currency;
|
|
960
659
|
}
|
|
961
|
-
|
|
660
|
+
//#endregion
|
|
661
|
+
//#region src/api-model/models/removal-shipment-item-adjustment.d.ts
|
|
962
662
|
/**
|
|
963
|
-
*
|
|
964
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
965
|
-
*
|
|
966
|
-
* The version of the OpenAPI document: v0
|
|
967
|
-
*
|
|
968
|
-
*
|
|
969
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
970
|
-
* https://openapi-generator.tech
|
|
971
|
-
* Do not edit the class manually.
|
|
663
|
+
* Item-level information for a removal shipment item adjustment.
|
|
972
664
|
*/
|
|
973
|
-
|
|
665
|
+
interface RemovalShipmentItemAdjustment {
|
|
666
|
+
/**
|
|
667
|
+
* An identifier for an item in a removal shipment.
|
|
668
|
+
*/
|
|
669
|
+
'RemovalShipmentItemId'?: string;
|
|
670
|
+
/**
|
|
671
|
+
* The tax collection model that is applied to the item. Possible values: * `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. * `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon.
|
|
672
|
+
*/
|
|
673
|
+
'TaxCollectionModel'?: string;
|
|
674
|
+
/**
|
|
675
|
+
* The Amazon fulfillment network SKU for the item.
|
|
676
|
+
*/
|
|
677
|
+
'FulfillmentNetworkSKU'?: string;
|
|
678
|
+
/**
|
|
679
|
+
* Adjusted quantity of `RemovalShipmentItemAdjustment` items.
|
|
680
|
+
*/
|
|
681
|
+
'AdjustedQuantity'?: number;
|
|
682
|
+
'RevenueAdjustment'?: Currency;
|
|
683
|
+
'TaxAmountAdjustment'?: Currency;
|
|
684
|
+
'TaxWithheldAdjustment'?: Currency;
|
|
685
|
+
}
|
|
686
|
+
//#endregion
|
|
687
|
+
//#region src/api-model/models/removal-shipment-adjustment-event.d.ts
|
|
974
688
|
/**
|
|
975
689
|
* A financial adjustment event for FBA liquidated inventory. A positive value indicates money owed to Amazon by the buyer (for example, when the charge was incorrectly calculated as less than it should be). A negative value indicates a full or partial refund owed to the buyer (for example, when the buyer receives damaged items or fewer items than ordered).
|
|
976
690
|
*/
|
|
977
691
|
interface RemovalShipmentAdjustmentEvent {
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
692
|
+
/**
|
|
693
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
694
|
+
*/
|
|
695
|
+
'PostedDate'?: string;
|
|
696
|
+
/**
|
|
697
|
+
* The unique identifier for the adjustment event.
|
|
698
|
+
*/
|
|
699
|
+
'AdjustmentEventId'?: string;
|
|
700
|
+
/**
|
|
701
|
+
* The merchant removal orderId.
|
|
702
|
+
*/
|
|
703
|
+
'MerchantOrderId'?: string;
|
|
704
|
+
/**
|
|
705
|
+
* The orderId for shipping inventory.
|
|
706
|
+
*/
|
|
707
|
+
'OrderId'?: string;
|
|
708
|
+
/**
|
|
709
|
+
* The type of removal order. Possible values: * `WHOLESALE_LIQUIDATION`.
|
|
710
|
+
*/
|
|
711
|
+
'TransactionType'?: string;
|
|
712
|
+
/**
|
|
713
|
+
* A comma-delimited list of `RemovalShipmentItemAdjustment` details for FBA inventory.
|
|
714
|
+
*/
|
|
715
|
+
'RemovalShipmentItemAdjustmentList'?: Array<RemovalShipmentItemAdjustment>;
|
|
1002
716
|
}
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
* Selling Partner API for Finances
|
|
1006
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1007
|
-
*
|
|
1008
|
-
* The version of the OpenAPI document: v0
|
|
1009
|
-
*
|
|
1010
|
-
*
|
|
1011
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1012
|
-
* https://openapi-generator.tech
|
|
1013
|
-
* Do not edit the class manually.
|
|
1014
|
-
*/
|
|
1015
|
-
|
|
717
|
+
//#endregion
|
|
718
|
+
//#region src/api-model/models/removal-shipment-item.d.ts
|
|
1016
719
|
/**
|
|
1017
720
|
* Item-level information for a removal shipment.
|
|
1018
721
|
*/
|
|
1019
722
|
interface RemovalShipmentItem {
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
723
|
+
/**
|
|
724
|
+
* An identifier for an item in a removal shipment.
|
|
725
|
+
*/
|
|
726
|
+
'RemovalShipmentItemId'?: string;
|
|
727
|
+
/**
|
|
728
|
+
* The tax collection model that is applied to the item. Possible values: * `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. * `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon.
|
|
729
|
+
*/
|
|
730
|
+
'TaxCollectionModel'?: string;
|
|
731
|
+
/**
|
|
732
|
+
* The Amazon fulfillment network SKU for the item.
|
|
733
|
+
*/
|
|
734
|
+
'FulfillmentNetworkSKU'?: string;
|
|
735
|
+
/**
|
|
736
|
+
* The quantity of the item.
|
|
737
|
+
*/
|
|
738
|
+
'Quantity'?: number;
|
|
739
|
+
'Revenue'?: Currency;
|
|
740
|
+
'FeeAmount'?: Currency;
|
|
741
|
+
'TaxAmount'?: Currency;
|
|
742
|
+
'TaxWithheld'?: Currency;
|
|
1040
743
|
}
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
* Selling Partner API for Finances
|
|
1044
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1045
|
-
*
|
|
1046
|
-
* The version of the OpenAPI document: v0
|
|
1047
|
-
*
|
|
1048
|
-
*
|
|
1049
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1050
|
-
* https://openapi-generator.tech
|
|
1051
|
-
* Do not edit the class manually.
|
|
1052
|
-
*/
|
|
1053
|
-
|
|
744
|
+
//#endregion
|
|
745
|
+
//#region src/api-model/models/removal-shipment-event.d.ts
|
|
1054
746
|
/**
|
|
1055
747
|
* A removal shipment event for a removal order.
|
|
1056
748
|
*/
|
|
1057
749
|
interface RemovalShipmentEvent {
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
|
|
1081
|
-
|
|
750
|
+
/**
|
|
751
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
752
|
+
*/
|
|
753
|
+
'PostedDate'?: string;
|
|
754
|
+
/**
|
|
755
|
+
* The merchant removal `orderId`.
|
|
756
|
+
*/
|
|
757
|
+
'MerchantOrderId'?: string;
|
|
758
|
+
/**
|
|
759
|
+
* The identifier for the removal shipment order.
|
|
760
|
+
*/
|
|
761
|
+
'OrderId'?: string;
|
|
762
|
+
/**
|
|
763
|
+
* The type of removal order. Possible values: * `WHOLESALE_LIQUIDATION`
|
|
764
|
+
*/
|
|
765
|
+
'TransactionType'?: string;
|
|
766
|
+
/**
|
|
767
|
+
* The name of the store where the event occurred.
|
|
768
|
+
*/
|
|
769
|
+
'StoreName'?: string;
|
|
770
|
+
/**
|
|
771
|
+
* A list of `RemovalShipmentItem`.
|
|
772
|
+
*/
|
|
773
|
+
'RemovalShipmentItemList'?: Array<RemovalShipmentItem>;
|
|
1082
774
|
}
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
* Selling Partner API for Finances
|
|
1086
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1087
|
-
*
|
|
1088
|
-
* The version of the OpenAPI document: v0
|
|
1089
|
-
*
|
|
1090
|
-
*
|
|
1091
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1092
|
-
* https://openapi-generator.tech
|
|
1093
|
-
* Do not edit the class manually.
|
|
1094
|
-
*/
|
|
1095
|
-
|
|
775
|
+
//#endregion
|
|
776
|
+
//#region src/api-model/models/tax-withheld-component.d.ts
|
|
1096
777
|
/**
|
|
1097
778
|
* Information about the taxes withheld.
|
|
1098
779
|
*/
|
|
1099
780
|
interface TaxWithheldComponent {
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
781
|
+
/**
|
|
782
|
+
* The tax collection model applied to the item. Possible values: * `MarketplaceFacilitator`: Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. * `Standard`: Tax is paid to the seller and not remitted to the taxing authority by Amazon.
|
|
783
|
+
*/
|
|
784
|
+
'TaxCollectionModel'?: string;
|
|
785
|
+
/**
|
|
786
|
+
* A list of charge information on the seller\'s account.
|
|
787
|
+
*/
|
|
788
|
+
'TaxesWithheld'?: Array<ChargeComponent>;
|
|
1108
789
|
}
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
* Selling Partner API for Finances
|
|
1112
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1113
|
-
*
|
|
1114
|
-
* The version of the OpenAPI document: v0
|
|
1115
|
-
*
|
|
1116
|
-
*
|
|
1117
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1118
|
-
* https://openapi-generator.tech
|
|
1119
|
-
* Do not edit the class manually.
|
|
1120
|
-
*/
|
|
1121
|
-
|
|
790
|
+
//#endregion
|
|
791
|
+
//#region src/api-model/models/rental-transaction-event.d.ts
|
|
1122
792
|
/**
|
|
1123
793
|
* An event related to a rental transaction.
|
|
1124
794
|
*/
|
|
1125
795
|
interface RentalTransactionEvent {
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
|
|
796
|
+
/**
|
|
797
|
+
* An Amazon-defined identifier for an order.
|
|
798
|
+
*/
|
|
799
|
+
'AmazonOrderId'?: string;
|
|
800
|
+
/**
|
|
801
|
+
* The type of rental event. Possible values: * `RentalCustomerPayment-Buyout`: A transaction type that represents when the customer wants to buy out a rented item. * `RentalCustomerPayment-Extension`: A transaction type that represents when the customer wants to extend the rental period. * `RentalCustomerRefund-Buyout`: A transaction type that represents when the customer requests a refund for the buyout of the rented item. * `RentalCustomerRefund-Extension`: A transaction type that represents when the customer requests a refund over the extension on the rented item. * `RentalHandlingFee`: A transaction type that represents the fee that Amazon charges sellers who rent through Amazon. * `RentalChargeFailureReimbursement`: A transaction type that represents when Amazon sends money to the seller to compensate for a failed charge. * `RentalLostItemReimbursement`: A transaction type that represents when Amazon sends money to the seller to compensate for a lost item.
|
|
802
|
+
*/
|
|
803
|
+
'RentalEventType'?: string;
|
|
804
|
+
/**
|
|
805
|
+
* The number of days that the buyer extended an already rented item. This value is only returned for `RentalCustomerPayment-Extension` and `RentalCustomerRefund-Extension` events.
|
|
806
|
+
*/
|
|
807
|
+
'ExtensionLength'?: number;
|
|
808
|
+
/**
|
|
809
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
810
|
+
*/
|
|
811
|
+
'PostedDate'?: string;
|
|
812
|
+
/**
|
|
813
|
+
* A list of charge information on the seller\'s account.
|
|
814
|
+
*/
|
|
815
|
+
'RentalChargeList'?: Array<ChargeComponent>;
|
|
816
|
+
/**
|
|
817
|
+
* A list of fee component information.
|
|
818
|
+
*/
|
|
819
|
+
'RentalFeeList'?: Array<FeeComponent>;
|
|
820
|
+
/**
|
|
821
|
+
* The name of the marketplace.
|
|
822
|
+
*/
|
|
823
|
+
'MarketplaceName'?: string;
|
|
824
|
+
'RentalInitialValue'?: Currency;
|
|
825
|
+
'RentalReimbursement'?: Currency;
|
|
826
|
+
/**
|
|
827
|
+
* A list of information about taxes withheld.
|
|
828
|
+
*/
|
|
829
|
+
'RentalTaxWithheldList'?: Array<TaxWithheldComponent>;
|
|
1160
830
|
}
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
* Selling Partner API for Finances
|
|
1164
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1165
|
-
*
|
|
1166
|
-
* The version of the OpenAPI document: v0
|
|
1167
|
-
*
|
|
1168
|
-
*
|
|
1169
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1170
|
-
* https://openapi-generator.tech
|
|
1171
|
-
* Do not edit the class manually.
|
|
1172
|
-
*/
|
|
1173
|
-
|
|
831
|
+
//#endregion
|
|
832
|
+
//#region src/api-model/models/retrocharge-event.d.ts
|
|
1174
833
|
/**
|
|
1175
834
|
* A retrocharge or retrocharge reversal.
|
|
1176
835
|
*/
|
|
1177
836
|
interface RetrochargeEvent {
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
|
|
1199
|
-
|
|
837
|
+
/**
|
|
838
|
+
* The type of event. Possible values: * `Retrocharge` * `RetrochargeReversal`
|
|
839
|
+
*/
|
|
840
|
+
'RetrochargeEventType'?: string;
|
|
841
|
+
/**
|
|
842
|
+
* An Amazon-defined identifier for an order.
|
|
843
|
+
*/
|
|
844
|
+
'AmazonOrderId'?: string;
|
|
845
|
+
/**
|
|
846
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
847
|
+
*/
|
|
848
|
+
'PostedDate'?: string;
|
|
849
|
+
'BaseTax'?: Currency;
|
|
850
|
+
'ShippingTax'?: Currency;
|
|
851
|
+
/**
|
|
852
|
+
* The name of the marketplace where the retrocharge event occurred.
|
|
853
|
+
*/
|
|
854
|
+
'MarketplaceName'?: string;
|
|
855
|
+
/**
|
|
856
|
+
* A list of information about taxes withheld.
|
|
857
|
+
*/
|
|
858
|
+
'RetrochargeTaxWithheldList'?: Array<TaxWithheldComponent>;
|
|
1200
859
|
}
|
|
1201
|
-
|
|
1202
|
-
|
|
1203
|
-
* Selling Partner API for Finances
|
|
1204
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1205
|
-
*
|
|
1206
|
-
* The version of the OpenAPI document: v0
|
|
1207
|
-
*
|
|
1208
|
-
*
|
|
1209
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1210
|
-
* https://openapi-generator.tech
|
|
1211
|
-
* Do not edit the class manually.
|
|
1212
|
-
*/
|
|
1213
|
-
|
|
860
|
+
//#endregion
|
|
861
|
+
//#region src/api-model/models/safetreimbursement-item.d.ts
|
|
1214
862
|
/**
|
|
1215
863
|
* An item from a SAFE-T claim reimbursement.
|
|
1216
864
|
*/
|
|
1217
865
|
interface SAFETReimbursementItem {
|
|
1218
|
-
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
|
|
1226
|
-
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
|
|
866
|
+
/**
|
|
867
|
+
* A list of charge information on the seller\'s account.
|
|
868
|
+
*/
|
|
869
|
+
'itemChargeList'?: Array<ChargeComponent>;
|
|
870
|
+
/**
|
|
871
|
+
* The description of the item as shown on the product detail page on the retail website.
|
|
872
|
+
*/
|
|
873
|
+
'productDescription'?: string;
|
|
874
|
+
/**
|
|
875
|
+
* The number of units of the item being reimbursed.
|
|
876
|
+
*/
|
|
877
|
+
'quantity'?: string;
|
|
1230
878
|
}
|
|
1231
|
-
|
|
1232
|
-
|
|
1233
|
-
* Selling Partner API for Finances
|
|
1234
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1235
|
-
*
|
|
1236
|
-
* The version of the OpenAPI document: v0
|
|
1237
|
-
*
|
|
1238
|
-
*
|
|
1239
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1240
|
-
* https://openapi-generator.tech
|
|
1241
|
-
* Do not edit the class manually.
|
|
1242
|
-
*/
|
|
1243
|
-
|
|
879
|
+
//#endregion
|
|
880
|
+
//#region src/api-model/models/safetreimbursement-event.d.ts
|
|
1244
881
|
/**
|
|
1245
882
|
* A SAFE-T claim reimbursement on the seller\'s account.
|
|
1246
883
|
*/
|
|
1247
884
|
interface SAFETReimbursementEvent {
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1264
|
-
|
|
885
|
+
/**
|
|
886
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
887
|
+
*/
|
|
888
|
+
'PostedDate'?: string;
|
|
889
|
+
/**
|
|
890
|
+
* A SAFE-T claim identifier.
|
|
891
|
+
*/
|
|
892
|
+
'SAFETClaimId'?: string;
|
|
893
|
+
'ReimbursedAmount'?: Currency;
|
|
894
|
+
/**
|
|
895
|
+
* Indicates why the seller was reimbursed.
|
|
896
|
+
*/
|
|
897
|
+
'ReasonCode'?: string;
|
|
898
|
+
/**
|
|
899
|
+
* A list of `SAFETReimbursementItem`.
|
|
900
|
+
*/
|
|
901
|
+
'SAFETReimbursementItemList'?: Array<SAFETReimbursementItem>;
|
|
1265
902
|
}
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
* Selling Partner API for Finances
|
|
1269
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1270
|
-
*
|
|
1271
|
-
* The version of the OpenAPI document: v0
|
|
1272
|
-
*
|
|
1273
|
-
*
|
|
1274
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1275
|
-
* https://openapi-generator.tech
|
|
1276
|
-
* Do not edit the class manually.
|
|
1277
|
-
*/
|
|
1278
|
-
|
|
903
|
+
//#endregion
|
|
904
|
+
//#region src/api-model/models/seller-deal-payment-event.d.ts
|
|
1279
905
|
/**
|
|
1280
906
|
* An event linked to the payment of a fee related to the specified deal.
|
|
1281
907
|
*/
|
|
1282
908
|
interface SellerDealPaymentEvent {
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
909
|
+
/**
|
|
910
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
911
|
+
*/
|
|
912
|
+
'postedDate'?: string;
|
|
913
|
+
/**
|
|
914
|
+
* The unique identifier of the deal.
|
|
915
|
+
*/
|
|
916
|
+
'dealId'?: string;
|
|
917
|
+
/**
|
|
918
|
+
* The internal description of the deal.
|
|
919
|
+
*/
|
|
920
|
+
'dealDescription'?: string;
|
|
921
|
+
/**
|
|
922
|
+
* The type of event: `SellerDealComplete`.
|
|
923
|
+
*/
|
|
924
|
+
'eventType'?: string;
|
|
925
|
+
/**
|
|
926
|
+
* The type of fee: `RunLightningDealFee`.
|
|
927
|
+
*/
|
|
928
|
+
'feeType'?: string;
|
|
929
|
+
'feeAmount'?: Currency;
|
|
930
|
+
'taxAmount'?: Currency;
|
|
931
|
+
'totalAmount'?: Currency;
|
|
1306
932
|
}
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
* Selling Partner API for Finances
|
|
1310
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1311
|
-
*
|
|
1312
|
-
* The version of the OpenAPI document: v0
|
|
1313
|
-
*
|
|
1314
|
-
*
|
|
1315
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1316
|
-
* https://openapi-generator.tech
|
|
1317
|
-
* Do not edit the class manually.
|
|
1318
|
-
*/
|
|
1319
|
-
|
|
933
|
+
//#endregion
|
|
934
|
+
//#region src/api-model/models/seller-review-enrollment-payment-event.d.ts
|
|
1320
935
|
/**
|
|
1321
936
|
* A fee payment event for the Early Reviewer Program.
|
|
1322
937
|
*/
|
|
1323
938
|
interface SellerReviewEnrollmentPaymentEvent {
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
|
|
939
|
+
/**
|
|
940
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
941
|
+
*/
|
|
942
|
+
'PostedDate'?: string;
|
|
943
|
+
/**
|
|
944
|
+
* An enrollment identifier.
|
|
945
|
+
*/
|
|
946
|
+
'EnrollmentId'?: string;
|
|
947
|
+
/**
|
|
948
|
+
* The Amazon Standard Identification Number (ASIN) of the item that was enrolled in the Early Reviewer Program.
|
|
949
|
+
*/
|
|
950
|
+
'ParentASIN'?: string;
|
|
951
|
+
'FeeComponent'?: FeeComponent;
|
|
952
|
+
'ChargeComponent'?: ChargeComponent;
|
|
953
|
+
'TotalAmount'?: Currency;
|
|
1339
954
|
}
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
* Selling Partner API for Finances
|
|
1343
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1344
|
-
*
|
|
1345
|
-
* The version of the OpenAPI document: v0
|
|
1346
|
-
*
|
|
1347
|
-
*
|
|
1348
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1349
|
-
* https://openapi-generator.tech
|
|
1350
|
-
* Do not edit the class manually.
|
|
1351
|
-
*/
|
|
1352
|
-
|
|
955
|
+
//#endregion
|
|
956
|
+
//#region src/api-model/models/service-fee-event.d.ts
|
|
1353
957
|
/**
|
|
1354
958
|
* A service fee on the seller\'s account.
|
|
1355
959
|
*/
|
|
1356
960
|
interface ServiceFeeEvent {
|
|
1357
|
-
|
|
1358
|
-
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1385
|
-
|
|
1386
|
-
|
|
1387
|
-
|
|
1388
|
-
|
|
961
|
+
/**
|
|
962
|
+
* An Amazon-defined identifier for an order.
|
|
963
|
+
*/
|
|
964
|
+
'AmazonOrderId'?: string;
|
|
965
|
+
/**
|
|
966
|
+
* A short description of the service fee reason.
|
|
967
|
+
*/
|
|
968
|
+
'FeeReason'?: string;
|
|
969
|
+
/**
|
|
970
|
+
* A list of fee component information.
|
|
971
|
+
*/
|
|
972
|
+
'FeeList'?: Array<FeeComponent>;
|
|
973
|
+
/**
|
|
974
|
+
* The seller SKU of the item. The seller SKU is qualified by the seller\'s seller ID, which is included with every call to the Selling Partner API.
|
|
975
|
+
*/
|
|
976
|
+
'SellerSKU'?: string;
|
|
977
|
+
/**
|
|
978
|
+
* A unique identifier assigned by Amazon to products stored in and fulfilled from an Amazon fulfillment center.
|
|
979
|
+
*/
|
|
980
|
+
'FnSKU'?: string;
|
|
981
|
+
/**
|
|
982
|
+
* A short description of the service fee event.
|
|
983
|
+
*/
|
|
984
|
+
'FeeDescription'?: string;
|
|
985
|
+
/**
|
|
986
|
+
* The Amazon Standard Identification Number (ASIN) of the item.
|
|
987
|
+
*/
|
|
988
|
+
'ASIN'?: string;
|
|
989
|
+
/**
|
|
990
|
+
* The name of the store where the event occurred.
|
|
991
|
+
*/
|
|
992
|
+
'StoreName'?: string;
|
|
1389
993
|
}
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
* Selling Partner API for Finances
|
|
1393
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1394
|
-
*
|
|
1395
|
-
* The version of the OpenAPI document: v0
|
|
1396
|
-
*
|
|
1397
|
-
*
|
|
1398
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1399
|
-
* https://openapi-generator.tech
|
|
1400
|
-
* Do not edit the class manually.
|
|
1401
|
-
*/
|
|
1402
|
-
|
|
994
|
+
//#endregion
|
|
995
|
+
//#region src/api-model/models/promotion.d.ts
|
|
1403
996
|
/**
|
|
1404
997
|
* A promotion applied to an item.
|
|
1405
998
|
*/
|
|
1406
999
|
interface Promotion {
|
|
1407
|
-
|
|
1408
|
-
|
|
1409
|
-
|
|
1410
|
-
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
|
|
1000
|
+
/**
|
|
1001
|
+
* The type of promotion.
|
|
1002
|
+
*/
|
|
1003
|
+
'PromotionType'?: string;
|
|
1004
|
+
/**
|
|
1005
|
+
* The seller-specified identifier for the promotion.
|
|
1006
|
+
*/
|
|
1007
|
+
'PromotionId'?: string;
|
|
1008
|
+
'PromotionAmount'?: Currency;
|
|
1416
1009
|
}
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
* Selling Partner API for Finances
|
|
1420
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1421
|
-
*
|
|
1422
|
-
* The version of the OpenAPI document: v0
|
|
1423
|
-
*
|
|
1424
|
-
*
|
|
1425
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1426
|
-
* https://openapi-generator.tech
|
|
1427
|
-
* Do not edit the class manually.
|
|
1428
|
-
*/
|
|
1429
|
-
|
|
1010
|
+
//#endregion
|
|
1011
|
+
//#region src/api-model/models/shipment-item.d.ts
|
|
1430
1012
|
/**
|
|
1431
1013
|
* An item of a shipment, refund, guarantee claim, or chargeback.
|
|
1432
1014
|
*/
|
|
1433
1015
|
interface ShipmentItem {
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
|
|
1452
|
-
|
|
1453
|
-
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
|
-
|
|
1457
|
-
|
|
1458
|
-
|
|
1459
|
-
|
|
1460
|
-
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
|
|
1478
|
-
|
|
1479
|
-
|
|
1016
|
+
/**
|
|
1017
|
+
* The seller SKU of the item. The seller SKU is qualified by the seller\'s seller ID, which is included with every call to the Selling Partner API.
|
|
1018
|
+
*/
|
|
1019
|
+
'SellerSKU'?: string;
|
|
1020
|
+
/**
|
|
1021
|
+
* An Amazon-defined order item identifier.
|
|
1022
|
+
*/
|
|
1023
|
+
'OrderItemId'?: string;
|
|
1024
|
+
/**
|
|
1025
|
+
* An Amazon-defined order adjustment identifier defined for refunds, guarantee claims, and chargeback events.
|
|
1026
|
+
*/
|
|
1027
|
+
'OrderAdjustmentItemId'?: string;
|
|
1028
|
+
/**
|
|
1029
|
+
* The number of items shipped.
|
|
1030
|
+
*/
|
|
1031
|
+
'QuantityShipped'?: number;
|
|
1032
|
+
/**
|
|
1033
|
+
* A list of charge information on the seller\'s account.
|
|
1034
|
+
*/
|
|
1035
|
+
'ItemChargeList'?: Array<ChargeComponent>;
|
|
1036
|
+
/**
|
|
1037
|
+
* A list of charge information on the seller\'s account.
|
|
1038
|
+
*/
|
|
1039
|
+
'ItemChargeAdjustmentList'?: Array<ChargeComponent>;
|
|
1040
|
+
/**
|
|
1041
|
+
* A list of fee component information.
|
|
1042
|
+
*/
|
|
1043
|
+
'ItemFeeList'?: Array<FeeComponent>;
|
|
1044
|
+
/**
|
|
1045
|
+
* A list of fee component information.
|
|
1046
|
+
*/
|
|
1047
|
+
'ItemFeeAdjustmentList'?: Array<FeeComponent>;
|
|
1048
|
+
/**
|
|
1049
|
+
* A list of information about taxes withheld.
|
|
1050
|
+
*/
|
|
1051
|
+
'ItemTaxWithheldList'?: Array<TaxWithheldComponent>;
|
|
1052
|
+
/**
|
|
1053
|
+
* A list of promotions.
|
|
1054
|
+
*/
|
|
1055
|
+
'PromotionList'?: Array<Promotion>;
|
|
1056
|
+
/**
|
|
1057
|
+
* A list of promotions.
|
|
1058
|
+
*/
|
|
1059
|
+
'PromotionAdjustmentList'?: Array<Promotion>;
|
|
1060
|
+
'CostOfPointsGranted'?: Currency;
|
|
1061
|
+
'CostOfPointsReturned'?: Currency;
|
|
1480
1062
|
}
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
* Selling Partner API for Finances
|
|
1484
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1485
|
-
*
|
|
1486
|
-
* The version of the OpenAPI document: v0
|
|
1487
|
-
*
|
|
1488
|
-
*
|
|
1489
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1490
|
-
* https://openapi-generator.tech
|
|
1491
|
-
* Do not edit the class manually.
|
|
1492
|
-
*/
|
|
1493
|
-
|
|
1063
|
+
//#endregion
|
|
1064
|
+
//#region src/api-model/models/shipment-event.d.ts
|
|
1494
1065
|
/**
|
|
1495
1066
|
* A shipment, refund, guarantee claim, or chargeback.
|
|
1496
1067
|
*/
|
|
1497
1068
|
interface ShipmentEvent {
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
|
|
1513
|
-
|
|
1514
|
-
|
|
1515
|
-
|
|
1516
|
-
|
|
1517
|
-
|
|
1518
|
-
|
|
1519
|
-
|
|
1520
|
-
|
|
1521
|
-
|
|
1522
|
-
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
|
|
1526
|
-
|
|
1527
|
-
|
|
1528
|
-
|
|
1529
|
-
|
|
1530
|
-
|
|
1531
|
-
|
|
1532
|
-
|
|
1533
|
-
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
|
|
1537
|
-
|
|
1538
|
-
|
|
1539
|
-
|
|
1540
|
-
|
|
1541
|
-
|
|
1542
|
-
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
|
|
1546
|
-
|
|
1547
|
-
|
|
1548
|
-
|
|
1549
|
-
|
|
1550
|
-
|
|
1551
|
-
|
|
1552
|
-
|
|
1553
|
-
|
|
1069
|
+
/**
|
|
1070
|
+
* An Amazon-defined identifier for an order.
|
|
1071
|
+
*/
|
|
1072
|
+
'AmazonOrderId'?: string;
|
|
1073
|
+
/**
|
|
1074
|
+
* A seller-defined identifier for an order.
|
|
1075
|
+
*/
|
|
1076
|
+
'SellerOrderId'?: string;
|
|
1077
|
+
/**
|
|
1078
|
+
* The name of the marketplace where the event occurred.
|
|
1079
|
+
*/
|
|
1080
|
+
'MarketplaceName'?: string;
|
|
1081
|
+
/**
|
|
1082
|
+
* The name of the store where the event occurred.
|
|
1083
|
+
*/
|
|
1084
|
+
'StoreName'?: string;
|
|
1085
|
+
/**
|
|
1086
|
+
* A list of charge information on the seller\'s account.
|
|
1087
|
+
*/
|
|
1088
|
+
'OrderChargeList'?: Array<ChargeComponent>;
|
|
1089
|
+
/**
|
|
1090
|
+
* A list of charge information on the seller\'s account.
|
|
1091
|
+
*/
|
|
1092
|
+
'OrderChargeAdjustmentList'?: Array<ChargeComponent>;
|
|
1093
|
+
/**
|
|
1094
|
+
* A list of fee component information.
|
|
1095
|
+
*/
|
|
1096
|
+
'ShipmentFeeList'?: Array<FeeComponent>;
|
|
1097
|
+
/**
|
|
1098
|
+
* A list of fee component information.
|
|
1099
|
+
*/
|
|
1100
|
+
'ShipmentFeeAdjustmentList'?: Array<FeeComponent>;
|
|
1101
|
+
/**
|
|
1102
|
+
* A list of fee component information.
|
|
1103
|
+
*/
|
|
1104
|
+
'OrderFeeList'?: Array<FeeComponent>;
|
|
1105
|
+
/**
|
|
1106
|
+
* A list of fee component information.
|
|
1107
|
+
*/
|
|
1108
|
+
'OrderFeeAdjustmentList'?: Array<FeeComponent>;
|
|
1109
|
+
/**
|
|
1110
|
+
* A list of direct payment information.
|
|
1111
|
+
*/
|
|
1112
|
+
'DirectPaymentList'?: Array<DirectPayment>;
|
|
1113
|
+
/**
|
|
1114
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
1115
|
+
*/
|
|
1116
|
+
'PostedDate'?: string;
|
|
1117
|
+
/**
|
|
1118
|
+
* A list of shipment items.
|
|
1119
|
+
*/
|
|
1120
|
+
'ShipmentItemList'?: Array<ShipmentItem>;
|
|
1121
|
+
/**
|
|
1122
|
+
* A list of shipment items.
|
|
1123
|
+
*/
|
|
1124
|
+
'ShipmentItemAdjustmentList'?: Array<ShipmentItem>;
|
|
1554
1125
|
}
|
|
1555
|
-
|
|
1556
|
-
|
|
1557
|
-
* Selling Partner API for Finances
|
|
1558
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1559
|
-
*
|
|
1560
|
-
* The version of the OpenAPI document: v0
|
|
1561
|
-
*
|
|
1562
|
-
*
|
|
1563
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1564
|
-
* https://openapi-generator.tech
|
|
1565
|
-
* Do not edit the class manually.
|
|
1566
|
-
*/
|
|
1567
|
-
|
|
1126
|
+
//#endregion
|
|
1127
|
+
//#region src/api-model/models/solution-provider-credit-event.d.ts
|
|
1568
1128
|
/**
|
|
1569
1129
|
* A credit given to a solution provider.
|
|
1570
1130
|
*/
|
|
1571
1131
|
interface SolutionProviderCreditEvent {
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
|
|
1579
|
-
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
|
-
|
|
1583
|
-
|
|
1584
|
-
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
|
|
1590
|
-
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
|
-
|
|
1594
|
-
|
|
1595
|
-
|
|
1596
|
-
|
|
1597
|
-
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1132
|
+
/**
|
|
1133
|
+
* The transaction type.
|
|
1134
|
+
*/
|
|
1135
|
+
'ProviderTransactionType'?: string;
|
|
1136
|
+
/**
|
|
1137
|
+
* A seller-defined identifier for an order.
|
|
1138
|
+
*/
|
|
1139
|
+
'SellerOrderId'?: string;
|
|
1140
|
+
/**
|
|
1141
|
+
* The identifier of the marketplace where the order was placed.
|
|
1142
|
+
*/
|
|
1143
|
+
'MarketplaceId'?: string;
|
|
1144
|
+
/**
|
|
1145
|
+
* The two-letter country code of the country associated with the marketplace where the order was placed.
|
|
1146
|
+
*/
|
|
1147
|
+
'MarketplaceCountryCode'?: string;
|
|
1148
|
+
/**
|
|
1149
|
+
* The Amazon-defined identifier of the seller.
|
|
1150
|
+
*/
|
|
1151
|
+
'SellerId'?: string;
|
|
1152
|
+
/**
|
|
1153
|
+
* The store name where the payment event occurred.
|
|
1154
|
+
*/
|
|
1155
|
+
'SellerStoreName'?: string;
|
|
1156
|
+
/**
|
|
1157
|
+
* The Amazon-defined identifier of the solution provider.
|
|
1158
|
+
*/
|
|
1159
|
+
'ProviderId'?: string;
|
|
1160
|
+
/**
|
|
1161
|
+
* The store name where the payment event occurred.
|
|
1162
|
+
*/
|
|
1163
|
+
'ProviderStoreName'?: string;
|
|
1164
|
+
'TransactionAmount'?: Currency;
|
|
1165
|
+
/**
|
|
1166
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
1167
|
+
*/
|
|
1168
|
+
'TransactionCreationDate'?: string;
|
|
1609
1169
|
}
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
* Selling Partner API for Finances
|
|
1613
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1614
|
-
*
|
|
1615
|
-
* The version of the OpenAPI document: v0
|
|
1616
|
-
*
|
|
1617
|
-
*
|
|
1618
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1619
|
-
* https://openapi-generator.tech
|
|
1620
|
-
* Do not edit the class manually.
|
|
1621
|
-
*/
|
|
1622
|
-
|
|
1170
|
+
//#endregion
|
|
1171
|
+
//#region src/api-model/models/tdsreimbursement-event.d.ts
|
|
1623
1172
|
/**
|
|
1624
1173
|
* An event related to a Tax-Deducted-at-Source (TDS) reimbursement.
|
|
1625
1174
|
*/
|
|
1626
1175
|
interface TDSReimbursementEvent {
|
|
1627
|
-
|
|
1628
|
-
|
|
1629
|
-
|
|
1630
|
-
|
|
1631
|
-
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
|
|
1635
|
-
|
|
1176
|
+
/**
|
|
1177
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
1178
|
+
*/
|
|
1179
|
+
'PostedDate'?: string;
|
|
1180
|
+
/**
|
|
1181
|
+
* The Tax-Deducted-at-Source (TDS) identifier.
|
|
1182
|
+
*/
|
|
1183
|
+
'TDSOrderId'?: string;
|
|
1184
|
+
'ReimbursedAmount'?: Currency;
|
|
1636
1185
|
}
|
|
1637
|
-
|
|
1186
|
+
//#endregion
|
|
1187
|
+
//#region src/api-model/models/tax-withholding-period.d.ts
|
|
1638
1188
|
/**
|
|
1639
1189
|
* Selling Partner API for Finances
|
|
1640
1190
|
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
@@ -1650,359 +1200,272 @@ interface TDSReimbursementEvent {
|
|
|
1650
1200
|
* The period during which tax withholding on a seller\'s account is calculated.
|
|
1651
1201
|
*/
|
|
1652
1202
|
interface TaxWithholdingPeriod {
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
|
|
1656
|
-
|
|
1657
|
-
|
|
1658
|
-
|
|
1659
|
-
|
|
1660
|
-
|
|
1203
|
+
/**
|
|
1204
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
1205
|
+
*/
|
|
1206
|
+
'StartDate'?: string;
|
|
1207
|
+
/**
|
|
1208
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
1209
|
+
*/
|
|
1210
|
+
'EndDate'?: string;
|
|
1661
1211
|
}
|
|
1662
|
-
|
|
1663
|
-
|
|
1664
|
-
* Selling Partner API for Finances
|
|
1665
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1666
|
-
*
|
|
1667
|
-
* The version of the OpenAPI document: v0
|
|
1668
|
-
*
|
|
1669
|
-
*
|
|
1670
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1671
|
-
* https://openapi-generator.tech
|
|
1672
|
-
* Do not edit the class manually.
|
|
1673
|
-
*/
|
|
1674
|
-
|
|
1212
|
+
//#endregion
|
|
1213
|
+
//#region src/api-model/models/tax-withholding-event.d.ts
|
|
1675
1214
|
/**
|
|
1676
1215
|
* A tax withholding event on a seller\'s account.
|
|
1677
1216
|
*/
|
|
1678
1217
|
interface TaxWithholdingEvent {
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
|
|
1218
|
+
/**
|
|
1219
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
1220
|
+
*/
|
|
1221
|
+
'PostedDate'?: string;
|
|
1222
|
+
'BaseAmount'?: Currency;
|
|
1223
|
+
'WithheldAmount'?: Currency;
|
|
1224
|
+
'TaxWithholdingPeriod'?: TaxWithholdingPeriod;
|
|
1686
1225
|
}
|
|
1687
|
-
|
|
1688
|
-
|
|
1689
|
-
* Selling Partner API for Finances
|
|
1690
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1691
|
-
*
|
|
1692
|
-
* The version of the OpenAPI document: v0
|
|
1693
|
-
*
|
|
1694
|
-
*
|
|
1695
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1696
|
-
* https://openapi-generator.tech
|
|
1697
|
-
* Do not edit the class manually.
|
|
1698
|
-
*/
|
|
1699
|
-
|
|
1226
|
+
//#endregion
|
|
1227
|
+
//#region src/api-model/models/trial-shipment-event.d.ts
|
|
1700
1228
|
/**
|
|
1701
1229
|
* An event related to a trial shipment.
|
|
1702
1230
|
*/
|
|
1703
1231
|
interface TrialShipmentEvent {
|
|
1704
|
-
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
|
|
1721
|
-
|
|
1722
|
-
|
|
1723
|
-
|
|
1232
|
+
/**
|
|
1233
|
+
* An Amazon-defined identifier for an order.
|
|
1234
|
+
*/
|
|
1235
|
+
'AmazonOrderId'?: string;
|
|
1236
|
+
/**
|
|
1237
|
+
* The identifier of the financial event group.
|
|
1238
|
+
*/
|
|
1239
|
+
'FinancialEventGroupId'?: string;
|
|
1240
|
+
/**
|
|
1241
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
1242
|
+
*/
|
|
1243
|
+
'PostedDate'?: string;
|
|
1244
|
+
/**
|
|
1245
|
+
* The seller SKU of the item. The seller SKU is qualified by the seller\'s seller ID, which is included with every call to the Selling Partner API.
|
|
1246
|
+
*/
|
|
1247
|
+
'SKU'?: string;
|
|
1248
|
+
/**
|
|
1249
|
+
* A list of fee component information.
|
|
1250
|
+
*/
|
|
1251
|
+
'FeeList'?: Array<FeeComponent>;
|
|
1724
1252
|
}
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
* Selling Partner API for Finances
|
|
1728
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1729
|
-
*
|
|
1730
|
-
* The version of the OpenAPI document: v0
|
|
1731
|
-
*
|
|
1732
|
-
*
|
|
1733
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1734
|
-
* https://openapi-generator.tech
|
|
1735
|
-
* Do not edit the class manually.
|
|
1736
|
-
*/
|
|
1737
|
-
|
|
1253
|
+
//#endregion
|
|
1254
|
+
//#region src/api-model/models/value-added-service-charge-event.d.ts
|
|
1738
1255
|
/**
|
|
1739
1256
|
* An event related to a value added service charge.
|
|
1740
1257
|
*/
|
|
1741
1258
|
interface ValueAddedServiceChargeEvent {
|
|
1742
|
-
|
|
1743
|
-
|
|
1744
|
-
|
|
1745
|
-
|
|
1746
|
-
|
|
1747
|
-
|
|
1748
|
-
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
|
|
1752
|
-
|
|
1753
|
-
|
|
1754
|
-
|
|
1259
|
+
/**
|
|
1260
|
+
* The transaction type. For example, \'Other Support Service fees\'
|
|
1261
|
+
*/
|
|
1262
|
+
'TransactionType'?: string;
|
|
1263
|
+
/**
|
|
1264
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
1265
|
+
*/
|
|
1266
|
+
'PostedDate'?: string;
|
|
1267
|
+
/**
|
|
1268
|
+
* A short description of the service charge event.
|
|
1269
|
+
*/
|
|
1270
|
+
'Description'?: string;
|
|
1271
|
+
'TransactionAmount'?: Currency;
|
|
1755
1272
|
}
|
|
1756
|
-
|
|
1757
|
-
|
|
1758
|
-
* Selling Partner API for Finances
|
|
1759
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1760
|
-
*
|
|
1761
|
-
* The version of the OpenAPI document: v0
|
|
1762
|
-
*
|
|
1763
|
-
*
|
|
1764
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1765
|
-
* https://openapi-generator.tech
|
|
1766
|
-
* Do not edit the class manually.
|
|
1767
|
-
*/
|
|
1768
|
-
|
|
1273
|
+
//#endregion
|
|
1274
|
+
//#region src/api-model/models/financial-events.d.ts
|
|
1769
1275
|
/**
|
|
1770
1276
|
* All the information that is related to a financial event.
|
|
1771
1277
|
*/
|
|
1772
1278
|
interface FinancialEvents {
|
|
1773
|
-
|
|
1774
|
-
|
|
1775
|
-
|
|
1776
|
-
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
|
-
|
|
1780
|
-
|
|
1781
|
-
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
|
|
1787
|
-
|
|
1788
|
-
|
|
1789
|
-
|
|
1790
|
-
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
|
|
1795
|
-
|
|
1796
|
-
|
|
1797
|
-
|
|
1798
|
-
|
|
1799
|
-
|
|
1800
|
-
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
|
-
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
|
-
|
|
1807
|
-
|
|
1808
|
-
|
|
1809
|
-
|
|
1810
|
-
|
|
1811
|
-
|
|
1812
|
-
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
|
|
1817
|
-
|
|
1818
|
-
|
|
1819
|
-
|
|
1820
|
-
|
|
1821
|
-
|
|
1822
|
-
|
|
1823
|
-
|
|
1824
|
-
|
|
1825
|
-
|
|
1826
|
-
|
|
1827
|
-
|
|
1828
|
-
|
|
1829
|
-
|
|
1830
|
-
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
|
|
1838
|
-
|
|
1839
|
-
|
|
1840
|
-
|
|
1841
|
-
|
|
1842
|
-
|
|
1843
|
-
|
|
1844
|
-
|
|
1845
|
-
|
|
1846
|
-
|
|
1847
|
-
|
|
1848
|
-
|
|
1849
|
-
|
|
1850
|
-
|
|
1851
|
-
|
|
1852
|
-
|
|
1853
|
-
|
|
1854
|
-
|
|
1855
|
-
|
|
1856
|
-
|
|
1857
|
-
|
|
1858
|
-
|
|
1859
|
-
|
|
1860
|
-
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
|
-
|
|
1864
|
-
|
|
1865
|
-
|
|
1866
|
-
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
|
|
1870
|
-
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
|
|
1874
|
-
|
|
1875
|
-
|
|
1876
|
-
|
|
1877
|
-
|
|
1878
|
-
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
|
-
|
|
1884
|
-
|
|
1885
|
-
|
|
1886
|
-
|
|
1887
|
-
|
|
1888
|
-
|
|
1889
|
-
|
|
1890
|
-
|
|
1891
|
-
|
|
1892
|
-
|
|
1893
|
-
|
|
1894
|
-
|
|
1895
|
-
|
|
1896
|
-
|
|
1897
|
-
|
|
1898
|
-
|
|
1899
|
-
|
|
1900
|
-
|
|
1901
|
-
|
|
1902
|
-
|
|
1903
|
-
|
|
1904
|
-
|
|
1905
|
-
|
|
1906
|
-
|
|
1907
|
-
|
|
1908
|
-
|
|
1279
|
+
/**
|
|
1280
|
+
* A list of shipment event information.
|
|
1281
|
+
*/
|
|
1282
|
+
'ShipmentEventList'?: Array<ShipmentEvent>;
|
|
1283
|
+
/**
|
|
1284
|
+
* A list of `ShipmentEvent` items.
|
|
1285
|
+
*/
|
|
1286
|
+
'ShipmentSettleEventList'?: Array<ShipmentEvent>;
|
|
1287
|
+
/**
|
|
1288
|
+
* A list of shipment event information.
|
|
1289
|
+
*/
|
|
1290
|
+
'RefundEventList'?: Array<ShipmentEvent>;
|
|
1291
|
+
/**
|
|
1292
|
+
* A list of shipment event information.
|
|
1293
|
+
*/
|
|
1294
|
+
'GuaranteeClaimEventList'?: Array<ShipmentEvent>;
|
|
1295
|
+
/**
|
|
1296
|
+
* A list of EBT refund reimbursement events.
|
|
1297
|
+
*/
|
|
1298
|
+
'EBTRefundReimbursementOnlyEventList'?: Array<EBTRefundReimbursementOnlyEvent>;
|
|
1299
|
+
/**
|
|
1300
|
+
* A list of shipment event information.
|
|
1301
|
+
*/
|
|
1302
|
+
'ChargebackEventList'?: Array<ShipmentEvent>;
|
|
1303
|
+
/**
|
|
1304
|
+
* A list of events related to the seller\'s Pay with Amazon account.
|
|
1305
|
+
*/
|
|
1306
|
+
'PayWithAmazonEventList'?: Array<PayWithAmazonEvent>;
|
|
1307
|
+
/**
|
|
1308
|
+
* A list of `SolutionProviderCreditEvent`.
|
|
1309
|
+
*/
|
|
1310
|
+
'ServiceProviderCreditEventList'?: Array<SolutionProviderCreditEvent>;
|
|
1311
|
+
/**
|
|
1312
|
+
* A list of information about `Retrocharge` or `RetrochargeReversal` events.
|
|
1313
|
+
*/
|
|
1314
|
+
'RetrochargeEventList'?: Array<RetrochargeEvent>;
|
|
1315
|
+
/**
|
|
1316
|
+
* A list of rental transaction event information.
|
|
1317
|
+
*/
|
|
1318
|
+
'RentalTransactionEventList'?: Array<RentalTransactionEvent>;
|
|
1319
|
+
/**
|
|
1320
|
+
* A list of sponsored products payment events.
|
|
1321
|
+
*/
|
|
1322
|
+
'ProductAdsPaymentEventList'?: Array<ProductAdsPaymentEvent>;
|
|
1323
|
+
/**
|
|
1324
|
+
* A list of information about service fee events.
|
|
1325
|
+
*/
|
|
1326
|
+
'ServiceFeeEventList'?: Array<ServiceFeeEvent>;
|
|
1327
|
+
/**
|
|
1328
|
+
* A list of payment events for deal-related fees.
|
|
1329
|
+
*/
|
|
1330
|
+
'SellerDealPaymentEventList'?: Array<SellerDealPaymentEvent>;
|
|
1331
|
+
/**
|
|
1332
|
+
* A list of debt recovery event information.
|
|
1333
|
+
*/
|
|
1334
|
+
'DebtRecoveryEventList'?: Array<DebtRecoveryEvent>;
|
|
1335
|
+
/**
|
|
1336
|
+
* A list of loan servicing events.
|
|
1337
|
+
*/
|
|
1338
|
+
'LoanServicingEventList'?: Array<LoanServicingEvent>;
|
|
1339
|
+
/**
|
|
1340
|
+
* A list of adjustment event information for the seller\'s account.
|
|
1341
|
+
*/
|
|
1342
|
+
'AdjustmentEventList'?: Array<AdjustmentEvent>;
|
|
1343
|
+
/**
|
|
1344
|
+
* A list of `SAFETReimbursementEvent`.
|
|
1345
|
+
*/
|
|
1346
|
+
'SAFETReimbursementEventList'?: Array<SAFETReimbursementEvent>;
|
|
1347
|
+
/**
|
|
1348
|
+
* A list of information about fee events for the Early Reviewer Program.
|
|
1349
|
+
*/
|
|
1350
|
+
'SellerReviewEnrollmentPaymentEventList'?: Array<SellerReviewEnrollmentPaymentEvent>;
|
|
1351
|
+
/**
|
|
1352
|
+
* A list of FBA inventory liquidation payment events.
|
|
1353
|
+
*/
|
|
1354
|
+
'FBALiquidationEventList'?: Array<FBALiquidationEvent>;
|
|
1355
|
+
/**
|
|
1356
|
+
* A list of coupon payment event information.
|
|
1357
|
+
*/
|
|
1358
|
+
'CouponPaymentEventList'?: Array<CouponPaymentEvent>;
|
|
1359
|
+
/**
|
|
1360
|
+
* A list of fee events related to Amazon Imaging services.
|
|
1361
|
+
*/
|
|
1362
|
+
'ImagingServicesFeeEventList'?: Array<ImagingServicesFeeEvent>;
|
|
1363
|
+
/**
|
|
1364
|
+
* A list of network commingling transaction events.
|
|
1365
|
+
*/
|
|
1366
|
+
'NetworkComminglingTransactionEventList'?: Array<NetworkComminglingTransactionEvent>;
|
|
1367
|
+
/**
|
|
1368
|
+
* A list of expense information related to an affordability promotion.
|
|
1369
|
+
*/
|
|
1370
|
+
'AffordabilityExpenseEventList'?: Array<AffordabilityExpenseEvent>;
|
|
1371
|
+
/**
|
|
1372
|
+
* A list of expense information related to an affordability promotion.
|
|
1373
|
+
*/
|
|
1374
|
+
'AffordabilityExpenseReversalEventList'?: Array<AffordabilityExpenseEvent>;
|
|
1375
|
+
/**
|
|
1376
|
+
* A list of removal shipment event information.
|
|
1377
|
+
*/
|
|
1378
|
+
'RemovalShipmentEventList'?: Array<RemovalShipmentEvent>;
|
|
1379
|
+
/**
|
|
1380
|
+
* A comma-delimited list of `RemovalShipmentAdjustment` details for FBA inventory.
|
|
1381
|
+
*/
|
|
1382
|
+
'RemovalShipmentAdjustmentEventList'?: Array<RemovalShipmentAdjustmentEvent>;
|
|
1383
|
+
/**
|
|
1384
|
+
* A list of information about trial shipment financial events.
|
|
1385
|
+
*/
|
|
1386
|
+
'TrialShipmentEventList'?: Array<TrialShipmentEvent>;
|
|
1387
|
+
/**
|
|
1388
|
+
* A list of `TDSReimbursementEvent` items.
|
|
1389
|
+
*/
|
|
1390
|
+
'TDSReimbursementEventList'?: Array<TDSReimbursementEvent>;
|
|
1391
|
+
/**
|
|
1392
|
+
* A list of `AdhocDisbursement` events.
|
|
1393
|
+
*/
|
|
1394
|
+
'AdhocDisbursementEventList'?: Array<AdhocDisbursementEvent>;
|
|
1395
|
+
/**
|
|
1396
|
+
* A list of tax withholding events.
|
|
1397
|
+
*/
|
|
1398
|
+
'TaxWithholdingEventList'?: Array<TaxWithholdingEvent>;
|
|
1399
|
+
/**
|
|
1400
|
+
* A list of charge refund events.
|
|
1401
|
+
*/
|
|
1402
|
+
'ChargeRefundEventList'?: Array<ChargeRefundEvent>;
|
|
1403
|
+
/**
|
|
1404
|
+
* A list of `FailedAdhocDisbursementEvent`.
|
|
1405
|
+
*/
|
|
1406
|
+
'FailedAdhocDisbursementEventList'?: Array<FailedAdhocDisbursementEvent>;
|
|
1407
|
+
/**
|
|
1408
|
+
* A list of `ValueAddedServiceCharge` events.
|
|
1409
|
+
*/
|
|
1410
|
+
'ValueAddedServiceChargeEventList'?: Array<ValueAddedServiceChargeEvent>;
|
|
1411
|
+
/**
|
|
1412
|
+
* A list of `CapacityReservationBillingEvent` events.
|
|
1413
|
+
*/
|
|
1414
|
+
'CapacityReservationBillingEventList'?: Array<CapacityReservationBillingEvent>;
|
|
1909
1415
|
}
|
|
1910
|
-
|
|
1911
|
-
|
|
1912
|
-
* Selling Partner API for Finances
|
|
1913
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1914
|
-
*
|
|
1915
|
-
* The version of the OpenAPI document: v0
|
|
1916
|
-
*
|
|
1917
|
-
*
|
|
1918
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1919
|
-
* https://openapi-generator.tech
|
|
1920
|
-
* Do not edit the class manually.
|
|
1921
|
-
*/
|
|
1922
|
-
|
|
1416
|
+
//#endregion
|
|
1417
|
+
//#region src/api-model/models/list-financial-event-groups-payload.d.ts
|
|
1923
1418
|
/**
|
|
1924
1419
|
* The payload for the `listFinancialEventGroups` operation.
|
|
1925
1420
|
*/
|
|
1926
1421
|
interface ListFinancialEventGroupsPayload {
|
|
1927
|
-
|
|
1928
|
-
|
|
1929
|
-
|
|
1930
|
-
|
|
1931
|
-
|
|
1932
|
-
|
|
1933
|
-
|
|
1934
|
-
|
|
1422
|
+
/**
|
|
1423
|
+
* When present and not empty, pass this string token in the next request to return the next response page.
|
|
1424
|
+
*/
|
|
1425
|
+
'NextToken'?: string;
|
|
1426
|
+
/**
|
|
1427
|
+
* A list of financial event group information.
|
|
1428
|
+
*/
|
|
1429
|
+
'FinancialEventGroupList'?: Array<FinancialEventGroup>;
|
|
1935
1430
|
}
|
|
1936
|
-
|
|
1937
|
-
|
|
1938
|
-
* Selling Partner API for Finances
|
|
1939
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1940
|
-
*
|
|
1941
|
-
* The version of the OpenAPI document: v0
|
|
1942
|
-
*
|
|
1943
|
-
*
|
|
1944
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1945
|
-
* https://openapi-generator.tech
|
|
1946
|
-
* Do not edit the class manually.
|
|
1947
|
-
*/
|
|
1948
|
-
|
|
1431
|
+
//#endregion
|
|
1432
|
+
//#region src/api-model/models/list-financial-event-groups-response.d.ts
|
|
1949
1433
|
/**
|
|
1950
1434
|
* The response schema for the `listFinancialEventGroups` operation.
|
|
1951
1435
|
*/
|
|
1952
1436
|
interface ListFinancialEventGroupsResponse {
|
|
1953
|
-
|
|
1954
|
-
|
|
1955
|
-
|
|
1956
|
-
|
|
1957
|
-
|
|
1437
|
+
'payload'?: ListFinancialEventGroupsPayload;
|
|
1438
|
+
/**
|
|
1439
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
1440
|
+
*/
|
|
1441
|
+
'errors'?: Array<Error>;
|
|
1958
1442
|
}
|
|
1959
|
-
|
|
1960
|
-
|
|
1961
|
-
* Selling Partner API for Finances
|
|
1962
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1963
|
-
*
|
|
1964
|
-
* The version of the OpenAPI document: v0
|
|
1965
|
-
*
|
|
1966
|
-
*
|
|
1967
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1968
|
-
* https://openapi-generator.tech
|
|
1969
|
-
* Do not edit the class manually.
|
|
1970
|
-
*/
|
|
1971
|
-
|
|
1443
|
+
//#endregion
|
|
1444
|
+
//#region src/api-model/models/list-financial-events-payload.d.ts
|
|
1972
1445
|
/**
|
|
1973
1446
|
* The payload for the `listFinancialEvents` operation.
|
|
1974
1447
|
*/
|
|
1975
1448
|
interface ListFinancialEventsPayload {
|
|
1976
|
-
|
|
1977
|
-
|
|
1978
|
-
|
|
1979
|
-
|
|
1980
|
-
|
|
1449
|
+
/**
|
|
1450
|
+
* When present and not empty, pass this string token in the next request to return the next response page.
|
|
1451
|
+
*/
|
|
1452
|
+
'NextToken'?: string;
|
|
1453
|
+
'FinancialEvents'?: FinancialEvents;
|
|
1981
1454
|
}
|
|
1982
|
-
|
|
1983
|
-
|
|
1984
|
-
* Selling Partner API for Finances
|
|
1985
|
-
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
1986
|
-
*
|
|
1987
|
-
* The version of the OpenAPI document: v0
|
|
1988
|
-
*
|
|
1989
|
-
*
|
|
1990
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1991
|
-
* https://openapi-generator.tech
|
|
1992
|
-
* Do not edit the class manually.
|
|
1993
|
-
*/
|
|
1994
|
-
|
|
1455
|
+
//#endregion
|
|
1456
|
+
//#region src/api-model/models/list-financial-events-response.d.ts
|
|
1995
1457
|
/**
|
|
1996
1458
|
* The response schema for the `listFinancialEvents` operation.
|
|
1997
1459
|
*/
|
|
1998
1460
|
interface ListFinancialEventsResponse {
|
|
1999
|
-
|
|
2000
|
-
|
|
2001
|
-
|
|
2002
|
-
|
|
2003
|
-
|
|
1461
|
+
'payload'?: ListFinancialEventsPayload;
|
|
1462
|
+
/**
|
|
1463
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
1464
|
+
*/
|
|
1465
|
+
'errors'?: Array<Error>;
|
|
2004
1466
|
}
|
|
2005
|
-
|
|
1467
|
+
//#endregion
|
|
1468
|
+
//#region src/api-model/models/model-error.d.ts
|
|
2006
1469
|
/**
|
|
2007
1470
|
* Selling Partner API for Finances
|
|
2008
1471
|
* The Selling Partner API for Finances provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
@@ -2018,264 +1481,267 @@ interface ListFinancialEventsResponse {
|
|
|
2018
1481
|
* Error response returned when the request is unsuccessful.
|
|
2019
1482
|
*/
|
|
2020
1483
|
interface ModelError {
|
|
2021
|
-
|
|
2022
|
-
|
|
2023
|
-
|
|
2024
|
-
|
|
2025
|
-
|
|
2026
|
-
|
|
2027
|
-
|
|
2028
|
-
|
|
2029
|
-
|
|
2030
|
-
|
|
2031
|
-
|
|
2032
|
-
|
|
1484
|
+
/**
|
|
1485
|
+
* An error code that identifies the type of error that occurred.
|
|
1486
|
+
*/
|
|
1487
|
+
'code': string;
|
|
1488
|
+
/**
|
|
1489
|
+
* A message that describes the error condition in a human-readable form.
|
|
1490
|
+
*/
|
|
1491
|
+
'message': string;
|
|
1492
|
+
/**
|
|
1493
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
1494
|
+
*/
|
|
1495
|
+
'details'?: string;
|
|
2033
1496
|
}
|
|
2034
|
-
|
|
1497
|
+
//#endregion
|
|
1498
|
+
//#region src/api-model/api/finances-api.d.ts
|
|
2035
1499
|
/**
|
|
2036
1500
|
* FinancesApi - axios parameter creator
|
|
2037
1501
|
*/
|
|
2038
1502
|
declare const FinancesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2039
|
-
|
|
2040
|
-
|
|
2041
|
-
|
|
2042
|
-
|
|
2043
|
-
|
|
2044
|
-
|
|
2045
|
-
|
|
2046
|
-
|
|
2047
|
-
|
|
2048
|
-
|
|
2049
|
-
|
|
2050
|
-
|
|
2051
|
-
|
|
2052
|
-
|
|
2053
|
-
|
|
2054
|
-
|
|
2055
|
-
|
|
2056
|
-
|
|
2057
|
-
|
|
2058
|
-
|
|
2059
|
-
|
|
2060
|
-
|
|
2061
|
-
|
|
2062
|
-
|
|
2063
|
-
|
|
2064
|
-
|
|
2065
|
-
|
|
2066
|
-
|
|
2067
|
-
|
|
2068
|
-
|
|
2069
|
-
|
|
2070
|
-
|
|
2071
|
-
|
|
2072
|
-
|
|
2073
|
-
|
|
2074
|
-
|
|
2075
|
-
|
|
2076
|
-
|
|
2077
|
-
|
|
2078
|
-
|
|
1503
|
+
/**
|
|
1504
|
+
* Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1505
|
+
* @param {number} [maxResultsPerPage] The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
1506
|
+
* @param {string} [financialEventGroupStartedBefore] A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned.
|
|
1507
|
+
* @param {string} [financialEventGroupStartedAfter] A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request.
|
|
1508
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1509
|
+
* @param {*} [options] Override http request option.
|
|
1510
|
+
* @throws {RequiredError}
|
|
1511
|
+
*/
|
|
1512
|
+
listFinancialEventGroups: (maxResultsPerPage?: number, financialEventGroupStartedBefore?: string, financialEventGroupStartedAfter?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1513
|
+
/**
|
|
1514
|
+
* Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1515
|
+
* @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
1516
|
+
* @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
|
|
1517
|
+
* @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
|
|
1518
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1519
|
+
* @param {*} [options] Override http request option.
|
|
1520
|
+
* @throws {RequiredError}
|
|
1521
|
+
*/
|
|
1522
|
+
listFinancialEvents: (maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1523
|
+
/**
|
|
1524
|
+
* Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1525
|
+
* @param {string} eventGroupId The identifier of the financial event group to which the events belong.
|
|
1526
|
+
* @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
1527
|
+
* @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
|
|
1528
|
+
* @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
|
|
1529
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1530
|
+
* @param {*} [options] Override http request option.
|
|
1531
|
+
* @throws {RequiredError}
|
|
1532
|
+
*/
|
|
1533
|
+
listFinancialEventsByGroupId: (eventGroupId: string, maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1534
|
+
/**
|
|
1535
|
+
* Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1536
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
1537
|
+
* @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
1538
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1539
|
+
* @param {*} [options] Override http request option.
|
|
1540
|
+
* @throws {RequiredError}
|
|
1541
|
+
*/
|
|
1542
|
+
listFinancialEventsByOrderId: (orderId: string, maxResultsPerPage?: number, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2079
1543
|
};
|
|
2080
1544
|
/**
|
|
2081
1545
|
* FinancesApi - functional programming interface
|
|
2082
1546
|
*/
|
|
2083
1547
|
declare const FinancesApiFp: (configuration?: Configuration) => {
|
|
2084
|
-
|
|
2085
|
-
|
|
2086
|
-
|
|
2087
|
-
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
|
|
2091
|
-
|
|
2092
|
-
|
|
2093
|
-
|
|
2094
|
-
|
|
2095
|
-
|
|
2096
|
-
|
|
2097
|
-
|
|
2098
|
-
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
|
|
2102
|
-
|
|
2103
|
-
|
|
2104
|
-
|
|
2105
|
-
|
|
2106
|
-
|
|
2107
|
-
|
|
2108
|
-
|
|
2109
|
-
|
|
2110
|
-
|
|
2111
|
-
|
|
2112
|
-
|
|
2113
|
-
|
|
2114
|
-
|
|
2115
|
-
|
|
2116
|
-
|
|
2117
|
-
|
|
2118
|
-
|
|
2119
|
-
|
|
2120
|
-
|
|
2121
|
-
|
|
2122
|
-
|
|
2123
|
-
|
|
1548
|
+
/**
|
|
1549
|
+
* Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1550
|
+
* @param {number} [maxResultsPerPage] The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
1551
|
+
* @param {string} [financialEventGroupStartedBefore] A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned.
|
|
1552
|
+
* @param {string} [financialEventGroupStartedAfter] A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request.
|
|
1553
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1554
|
+
* @param {*} [options] Override http request option.
|
|
1555
|
+
* @throws {RequiredError}
|
|
1556
|
+
*/
|
|
1557
|
+
listFinancialEventGroups(maxResultsPerPage?: number, financialEventGroupStartedBefore?: string, financialEventGroupStartedAfter?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventGroupsResponse>>;
|
|
1558
|
+
/**
|
|
1559
|
+
* Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1560
|
+
* @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
1561
|
+
* @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
|
|
1562
|
+
* @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
|
|
1563
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1564
|
+
* @param {*} [options] Override http request option.
|
|
1565
|
+
* @throws {RequiredError}
|
|
1566
|
+
*/
|
|
1567
|
+
listFinancialEvents(maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventsResponse>>;
|
|
1568
|
+
/**
|
|
1569
|
+
* Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1570
|
+
* @param {string} eventGroupId The identifier of the financial event group to which the events belong.
|
|
1571
|
+
* @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
1572
|
+
* @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
|
|
1573
|
+
* @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
|
|
1574
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1575
|
+
* @param {*} [options] Override http request option.
|
|
1576
|
+
* @throws {RequiredError}
|
|
1577
|
+
*/
|
|
1578
|
+
listFinancialEventsByGroupId(eventGroupId: string, maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventsResponse>>;
|
|
1579
|
+
/**
|
|
1580
|
+
* Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1581
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
1582
|
+
* @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
1583
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1584
|
+
* @param {*} [options] Override http request option.
|
|
1585
|
+
* @throws {RequiredError}
|
|
1586
|
+
*/
|
|
1587
|
+
listFinancialEventsByOrderId(orderId: string, maxResultsPerPage?: number, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventsResponse>>;
|
|
2124
1588
|
};
|
|
2125
1589
|
/**
|
|
2126
1590
|
* FinancesApi - factory interface
|
|
2127
1591
|
*/
|
|
2128
1592
|
declare const FinancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
|
|
2135
|
-
|
|
2136
|
-
|
|
2137
|
-
|
|
2138
|
-
|
|
2139
|
-
|
|
2140
|
-
|
|
2141
|
-
|
|
2142
|
-
|
|
2143
|
-
|
|
2144
|
-
|
|
2145
|
-
|
|
2146
|
-
|
|
2147
|
-
|
|
2148
|
-
|
|
2149
|
-
|
|
2150
|
-
|
|
2151
|
-
|
|
2152
|
-
|
|
2153
|
-
|
|
2154
|
-
|
|
2155
|
-
|
|
2156
|
-
|
|
1593
|
+
/**
|
|
1594
|
+
* Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1595
|
+
* @param {FinancesApiListFinancialEventGroupsRequest} requestParameters Request parameters.
|
|
1596
|
+
* @param {*} [options] Override http request option.
|
|
1597
|
+
* @throws {RequiredError}
|
|
1598
|
+
*/
|
|
1599
|
+
listFinancialEventGroups(requestParameters?: FinancesApiListFinancialEventGroupsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventGroupsResponse>;
|
|
1600
|
+
/**
|
|
1601
|
+
* Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1602
|
+
* @param {FinancesApiListFinancialEventsRequest} requestParameters Request parameters.
|
|
1603
|
+
* @param {*} [options] Override http request option.
|
|
1604
|
+
* @throws {RequiredError}
|
|
1605
|
+
*/
|
|
1606
|
+
listFinancialEvents(requestParameters?: FinancesApiListFinancialEventsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventsResponse>;
|
|
1607
|
+
/**
|
|
1608
|
+
* Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1609
|
+
* @param {FinancesApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
|
|
1610
|
+
* @param {*} [options] Override http request option.
|
|
1611
|
+
* @throws {RequiredError}
|
|
1612
|
+
*/
|
|
1613
|
+
listFinancialEventsByGroupId(requestParameters: FinancesApiListFinancialEventsByGroupIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventsResponse>;
|
|
1614
|
+
/**
|
|
1615
|
+
* Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1616
|
+
* @param {FinancesApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
|
|
1617
|
+
* @param {*} [options] Override http request option.
|
|
1618
|
+
* @throws {RequiredError}
|
|
1619
|
+
*/
|
|
1620
|
+
listFinancialEventsByOrderId(requestParameters: FinancesApiListFinancialEventsByOrderIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventsResponse>;
|
|
2157
1621
|
};
|
|
2158
1622
|
/**
|
|
2159
1623
|
* Request parameters for listFinancialEventGroups operation in FinancesApi.
|
|
2160
1624
|
*/
|
|
2161
1625
|
interface FinancesApiListFinancialEventGroupsRequest {
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
|
|
2166
|
-
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
|
|
2170
|
-
|
|
2171
|
-
|
|
2172
|
-
|
|
2173
|
-
|
|
2174
|
-
|
|
2175
|
-
|
|
2176
|
-
|
|
2177
|
-
|
|
1626
|
+
/**
|
|
1627
|
+
* The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
1628
|
+
*/
|
|
1629
|
+
readonly maxResultsPerPage?: number;
|
|
1630
|
+
/**
|
|
1631
|
+
* A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned.
|
|
1632
|
+
*/
|
|
1633
|
+
readonly financialEventGroupStartedBefore?: string;
|
|
1634
|
+
/**
|
|
1635
|
+
* A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request.
|
|
1636
|
+
*/
|
|
1637
|
+
readonly financialEventGroupStartedAfter?: string;
|
|
1638
|
+
/**
|
|
1639
|
+
* The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1640
|
+
*/
|
|
1641
|
+
readonly nextToken?: string;
|
|
2178
1642
|
}
|
|
2179
1643
|
/**
|
|
2180
1644
|
* Request parameters for listFinancialEvents operation in FinancesApi.
|
|
2181
1645
|
*/
|
|
2182
1646
|
interface FinancesApiListFinancialEventsRequest {
|
|
2183
|
-
|
|
2184
|
-
|
|
2185
|
-
|
|
2186
|
-
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
|
|
2191
|
-
|
|
2192
|
-
|
|
2193
|
-
|
|
2194
|
-
|
|
2195
|
-
|
|
2196
|
-
|
|
2197
|
-
|
|
2198
|
-
|
|
1647
|
+
/**
|
|
1648
|
+
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
1649
|
+
*/
|
|
1650
|
+
readonly maxResultsPerPage?: number;
|
|
1651
|
+
/**
|
|
1652
|
+
* The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
|
|
1653
|
+
*/
|
|
1654
|
+
readonly postedAfter?: string;
|
|
1655
|
+
/**
|
|
1656
|
+
* The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
|
|
1657
|
+
*/
|
|
1658
|
+
readonly postedBefore?: string;
|
|
1659
|
+
/**
|
|
1660
|
+
* The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1661
|
+
*/
|
|
1662
|
+
readonly nextToken?: string;
|
|
2199
1663
|
}
|
|
2200
1664
|
/**
|
|
2201
1665
|
* Request parameters for listFinancialEventsByGroupId operation in FinancesApi.
|
|
2202
1666
|
*/
|
|
2203
1667
|
interface FinancesApiListFinancialEventsByGroupIdRequest {
|
|
2204
|
-
|
|
2205
|
-
|
|
2206
|
-
|
|
2207
|
-
|
|
2208
|
-
|
|
2209
|
-
|
|
2210
|
-
|
|
2211
|
-
|
|
2212
|
-
|
|
2213
|
-
|
|
2214
|
-
|
|
2215
|
-
|
|
2216
|
-
|
|
2217
|
-
|
|
2218
|
-
|
|
2219
|
-
|
|
2220
|
-
|
|
2221
|
-
|
|
2222
|
-
|
|
2223
|
-
|
|
1668
|
+
/**
|
|
1669
|
+
* The identifier of the financial event group to which the events belong.
|
|
1670
|
+
*/
|
|
1671
|
+
readonly eventGroupId: string;
|
|
1672
|
+
/**
|
|
1673
|
+
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
1674
|
+
*/
|
|
1675
|
+
readonly maxResultsPerPage?: number;
|
|
1676
|
+
/**
|
|
1677
|
+
* The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
|
|
1678
|
+
*/
|
|
1679
|
+
readonly postedAfter?: string;
|
|
1680
|
+
/**
|
|
1681
|
+
* The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
|
|
1682
|
+
*/
|
|
1683
|
+
readonly postedBefore?: string;
|
|
1684
|
+
/**
|
|
1685
|
+
* The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1686
|
+
*/
|
|
1687
|
+
readonly nextToken?: string;
|
|
2224
1688
|
}
|
|
2225
1689
|
/**
|
|
2226
1690
|
* Request parameters for listFinancialEventsByOrderId operation in FinancesApi.
|
|
2227
1691
|
*/
|
|
2228
1692
|
interface FinancesApiListFinancialEventsByOrderIdRequest {
|
|
2229
|
-
|
|
2230
|
-
|
|
2231
|
-
|
|
2232
|
-
|
|
2233
|
-
|
|
2234
|
-
|
|
2235
|
-
|
|
2236
|
-
|
|
2237
|
-
|
|
2238
|
-
|
|
2239
|
-
|
|
2240
|
-
|
|
1693
|
+
/**
|
|
1694
|
+
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
1695
|
+
*/
|
|
1696
|
+
readonly orderId: string;
|
|
1697
|
+
/**
|
|
1698
|
+
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
1699
|
+
*/
|
|
1700
|
+
readonly maxResultsPerPage?: number;
|
|
1701
|
+
/**
|
|
1702
|
+
* The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
1703
|
+
*/
|
|
1704
|
+
readonly nextToken?: string;
|
|
2241
1705
|
}
|
|
2242
1706
|
/**
|
|
2243
1707
|
* FinancesApi - object-oriented interface
|
|
2244
1708
|
*/
|
|
2245
1709
|
declare class FinancesApi extends BaseAPI {
|
|
2246
|
-
|
|
2247
|
-
|
|
2248
|
-
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
|
|
2266
|
-
|
|
2267
|
-
|
|
2268
|
-
|
|
2269
|
-
|
|
2270
|
-
|
|
2271
|
-
|
|
2272
|
-
|
|
2273
|
-
|
|
1710
|
+
/**
|
|
1711
|
+
* Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1712
|
+
* @param {FinancesApiListFinancialEventGroupsRequest} requestParameters Request parameters.
|
|
1713
|
+
* @param {*} [options] Override http request option.
|
|
1714
|
+
* @throws {RequiredError}
|
|
1715
|
+
*/
|
|
1716
|
+
listFinancialEventGroups(requestParameters?: FinancesApiListFinancialEventGroupsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialEventGroupsResponse, any, {}>>;
|
|
1717
|
+
/**
|
|
1718
|
+
* Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1719
|
+
* @param {FinancesApiListFinancialEventsRequest} requestParameters Request parameters.
|
|
1720
|
+
* @param {*} [options] Override http request option.
|
|
1721
|
+
* @throws {RequiredError}
|
|
1722
|
+
*/
|
|
1723
|
+
listFinancialEvents(requestParameters?: FinancesApiListFinancialEventsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialEventsResponse, any, {}>>;
|
|
1724
|
+
/**
|
|
1725
|
+
* Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1726
|
+
* @param {FinancesApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
|
|
1727
|
+
* @param {*} [options] Override http request option.
|
|
1728
|
+
* @throws {RequiredError}
|
|
1729
|
+
*/
|
|
1730
|
+
listFinancialEventsByGroupId(requestParameters: FinancesApiListFinancialEventsByGroupIdRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialEventsResponse, any, {}>>;
|
|
1731
|
+
/**
|
|
1732
|
+
* Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
|
|
1733
|
+
* @param {FinancesApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
|
|
1734
|
+
* @param {*} [options] Override http request option.
|
|
1735
|
+
* @throws {RequiredError}
|
|
1736
|
+
*/
|
|
1737
|
+
listFinancialEventsByOrderId(requestParameters: FinancesApiListFinancialEventsByOrderIdRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialEventsResponse, any, {}>>;
|
|
2274
1738
|
}
|
|
2275
|
-
|
|
1739
|
+
//#endregion
|
|
1740
|
+
//#region src/client.d.ts
|
|
2276
1741
|
declare const clientRateLimits: RateLimit[];
|
|
2277
1742
|
declare class FinancesApiClient extends FinancesApi {
|
|
2278
|
-
|
|
1743
|
+
constructor(configuration: ClientConfiguration);
|
|
2279
1744
|
}
|
|
2280
|
-
|
|
2281
|
-
export { type AdhocDisbursementEvent, type AdjustmentEvent, type AdjustmentItem, type AffordabilityExpenseEvent, type CapacityReservationBillingEvent, type ChargeComponent, type ChargeInstrument, type ChargeRefundEvent, type ChargeRefundTransaction, type CouponPaymentEvent, type Currency, type DebtRecoveryEvent, type DebtRecoveryItem, type DirectPayment, type EBTRefundReimbursementOnlyEvent, type FBALiquidationEvent, type FailedAdhocDisbursementEvent, type FeeComponent, FinancesApi, FinancesApiAxiosParamCreator, FinancesApiClient, FinancesApiFactory, FinancesApiFp,
|
|
1745
|
+
//#endregion
|
|
1746
|
+
export { type AdhocDisbursementEvent, type AdjustmentEvent, type AdjustmentItem, type AffordabilityExpenseEvent, type CapacityReservationBillingEvent, type ChargeComponent, type ChargeInstrument, type ChargeRefundEvent, type ChargeRefundTransaction, type CouponPaymentEvent, type Currency, type DebtRecoveryEvent, type DebtRecoveryItem, type DirectPayment, type EBTRefundReimbursementOnlyEvent, type FBALiquidationEvent, type FailedAdhocDisbursementEvent, type FeeComponent, FinancesApi, FinancesApiAxiosParamCreator, FinancesApiClient, FinancesApiFactory, FinancesApiFp, FinancesApiListFinancialEventGroupsRequest, FinancesApiListFinancialEventsByGroupIdRequest, FinancesApiListFinancialEventsByOrderIdRequest, FinancesApiListFinancialEventsRequest, type FinancialEventGroup, type FinancialEvents, type ImagingServicesFeeEvent, type ListFinancialEventGroupsPayload, type ListFinancialEventGroupsResponse, type ListFinancialEventsPayload, type ListFinancialEventsResponse, type LoanServicingEvent, type ModelError, type NetworkComminglingTransactionEvent, type PayWithAmazonEvent, type ProductAdsPaymentEvent, type Promotion, type RemovalShipmentAdjustmentEvent, type RemovalShipmentEvent, type RemovalShipmentItem, type RemovalShipmentItemAdjustment, type RentalTransactionEvent, type RetrochargeEvent, type SAFETReimbursementEvent, type SAFETReimbursementItem, type SellerDealPaymentEvent, type SellerReviewEnrollmentPaymentEvent, type ServiceFeeEvent, type ShipmentEvent, type ShipmentItem, type SolutionProviderCreditEvent, type TDSReimbursementEvent, type TaxWithheldComponent, type TaxWithholdingEvent, type TaxWithholdingPeriod, type TrialShipmentEvent, type ValueAddedServiceChargeEvent, clientRateLimits };
|
|
1747
|
+
//# sourceMappingURL=index.d.ts.map
|