@sp-api-sdk/finances-api-v0 4.0.1 → 4.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api-model/api/finances-api.js +0 -10
- package/dist/cjs/api-model/base.js +0 -19
- package/dist/cjs/api-model/common.js +0 -37
- package/dist/cjs/api-model/configuration.js +0 -17
- package/dist/es/api-model/api/finances-api.js +0 -10
- package/dist/es/api-model/base.js +0 -19
- package/dist/es/api-model/common.js +0 -37
- package/dist/es/api-model/configuration.js +0 -17
- package/dist/types/api-model/api/finances-api.d.ts +0 -50
- package/dist/types/api-model/base.d.ts +0 -24
- package/dist/types/api-model/common.d.ts +0 -37
- package/dist/types/api-model/configuration.d.ts +0 -17
- package/dist/types/api-model/models/adhoc-disbursement-event.d.ts +0 -13
- package/dist/types/api-model/models/adjustment-event.d.ts +0 -15
- package/dist/types/api-model/models/adjustment-item.d.ts +0 -24
- package/dist/types/api-model/models/affordability-expense-event.d.ts +0 -35
- package/dist/types/api-model/models/capacity-reservation-billing-event.d.ts +0 -13
- package/dist/types/api-model/models/charge-component.d.ts +0 -9
- package/dist/types/api-model/models/charge-instrument.d.ts +0 -11
- package/dist/types/api-model/models/charge-refund-event.d.ts +0 -10
- package/dist/types/api-model/models/charge-refund-transaction.d.ts +0 -9
- package/dist/types/api-model/models/coupon-payment-event.d.ts +0 -27
- package/dist/types/api-model/models/currency.d.ts +0 -6
- package/dist/types/api-model/models/debt-recovery-event.d.ts +0 -18
- package/dist/types/api-model/models/debt-recovery-item.d.ts +0 -16
- package/dist/types/api-model/models/direct-payment.d.ts +0 -9
- package/dist/types/api-model/models/failed-adhoc-disbursement-event.d.ts +0 -19
- package/dist/types/api-model/models/fbaliquidation-event.d.ts +0 -16
- package/dist/types/api-model/models/fee-component.d.ts +0 -9
- package/dist/types/api-model/models/financial-event-group.d.ts +0 -33
- package/dist/types/api-model/models/financial-events.d.ts +0 -68
- package/dist/types/api-model/models/imaging-services-fee-event.d.ts +0 -10
- package/dist/types/api-model/models/list-financial-event-groups-payload.d.ts +0 -6
- package/dist/types/api-model/models/list-financial-event-groups-response.d.ts +0 -9
- package/dist/types/api-model/models/list-financial-events-payload.d.ts +0 -9
- package/dist/types/api-model/models/list-financial-events-response.d.ts +0 -9
- package/dist/types/api-model/models/loan-servicing-event.d.ts +0 -9
- package/dist/types/api-model/models/model-error.d.ts +0 -8
- package/dist/types/api-model/models/network-commingling-transaction-event.d.ts +0 -24
- package/dist/types/api-model/models/pay-with-amazon-event.d.ts +0 -25
- package/dist/types/api-model/models/product-ads-payment-event.d.ts +0 -23
- package/dist/types/api-model/models/promotion.d.ts +0 -11
- package/dist/types/api-model/models/removal-shipment-adjustment-event.d.ts +0 -14
- package/dist/types/api-model/models/removal-shipment-event.d.ts +0 -14
- package/dist/types/api-model/models/removal-shipment-item-adjustment.d.ts +0 -25
- package/dist/types/api-model/models/removal-shipment-item.d.ts +0 -30
- package/dist/types/api-model/models/rental-transaction-event.d.ts +0 -28
- package/dist/types/api-model/models/retrocharge-event.d.ts +0 -22
- package/dist/types/api-model/models/safetreimbursement-event.d.ts +0 -15
- package/dist/types/api-model/models/safetreimbursement-item.d.ts +0 -8
- package/dist/types/api-model/models/seller-deal-payment-event.d.ts +0 -27
- package/dist/types/api-model/models/seller-review-enrollment-payment-event.d.ts +0 -23
- package/dist/types/api-model/models/service-fee-event.d.ts +0 -18
- package/dist/types/api-model/models/shipment-event.d.ts +0 -30
- package/dist/types/api-model/models/shipment-item.d.ts +0 -34
- package/dist/types/api-model/models/solution-provider-credit-event.d.ts +0 -25
- package/dist/types/api-model/models/tax-withheld-component.d.ts +0 -6
- package/dist/types/api-model/models/tax-withholding-event.d.ts +0 -19
- package/dist/types/api-model/models/tax-withholding-period.d.ts +0 -6
- package/dist/types/api-model/models/tdsreimbursement-event.d.ts +0 -11
- package/dist/types/api-model/models/trial-shipment-event.d.ts +0 -12
- package/dist/types/api-model/models/value-added-service-charge-event.d.ts +0 -13
- package/package.json +25 -4
|
@@ -17,7 +17,6 @@ import type { ListFinancialEventGroupsResponse } from '../models';
|
|
|
17
17
|
import type { ListFinancialEventsResponse } from '../models';
|
|
18
18
|
/**
|
|
19
19
|
* FinancesApi - axios parameter creator
|
|
20
|
-
* @export
|
|
21
20
|
*/
|
|
22
21
|
export declare const FinancesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23
22
|
/**
|
|
@@ -63,7 +62,6 @@ export declare const FinancesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
63
62
|
};
|
|
64
63
|
/**
|
|
65
64
|
* FinancesApi - functional programming interface
|
|
66
|
-
* @export
|
|
67
65
|
*/
|
|
68
66
|
export declare const FinancesApiFp: (configuration?: Configuration) => {
|
|
69
67
|
/**
|
|
@@ -109,7 +107,6 @@ export declare const FinancesApiFp: (configuration?: Configuration) => {
|
|
|
109
107
|
};
|
|
110
108
|
/**
|
|
111
109
|
* FinancesApi - factory interface
|
|
112
|
-
* @export
|
|
113
110
|
*/
|
|
114
111
|
export declare const FinancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
115
112
|
/**
|
|
@@ -143,133 +140,90 @@ export declare const FinancesApiFactory: (configuration?: Configuration, basePat
|
|
|
143
140
|
};
|
|
144
141
|
/**
|
|
145
142
|
* Request parameters for listFinancialEventGroups operation in FinancesApi.
|
|
146
|
-
* @export
|
|
147
|
-
* @interface FinancesApiListFinancialEventGroupsRequest
|
|
148
143
|
*/
|
|
149
144
|
export interface FinancesApiListFinancialEventGroupsRequest {
|
|
150
145
|
/**
|
|
151
146
|
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'.
|
|
152
|
-
* @type {number}
|
|
153
|
-
* @memberof FinancesApiListFinancialEventGroups
|
|
154
147
|
*/
|
|
155
148
|
readonly maxResultsPerPage?: number;
|
|
156
149
|
/**
|
|
157
150
|
* A date used for selecting 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 later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned.
|
|
158
|
-
* @type {string}
|
|
159
|
-
* @memberof FinancesApiListFinancialEventGroups
|
|
160
151
|
*/
|
|
161
152
|
readonly financialEventGroupStartedBefore?: string;
|
|
162
153
|
/**
|
|
163
154
|
* A date used for selecting 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 no later than two minutes before the request was submitted.
|
|
164
|
-
* @type {string}
|
|
165
|
-
* @memberof FinancesApiListFinancialEventGroups
|
|
166
155
|
*/
|
|
167
156
|
readonly financialEventGroupStartedAfter?: string;
|
|
168
157
|
/**
|
|
169
158
|
* A string token returned in the response of your previous request.
|
|
170
|
-
* @type {string}
|
|
171
|
-
* @memberof FinancesApiListFinancialEventGroups
|
|
172
159
|
*/
|
|
173
160
|
readonly nextToken?: string;
|
|
174
161
|
}
|
|
175
162
|
/**
|
|
176
163
|
* Request parameters for listFinancialEvents operation in FinancesApi.
|
|
177
|
-
* @export
|
|
178
|
-
* @interface FinancesApiListFinancialEventsRequest
|
|
179
164
|
*/
|
|
180
165
|
export interface FinancesApiListFinancialEventsRequest {
|
|
181
166
|
/**
|
|
182
167
|
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'.
|
|
183
|
-
* @type {number}
|
|
184
|
-
* @memberof FinancesApiListFinancialEvents
|
|
185
168
|
*/
|
|
186
169
|
readonly maxResultsPerPage?: number;
|
|
187
170
|
/**
|
|
188
171
|
* A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
|
|
189
|
-
* @type {string}
|
|
190
|
-
* @memberof FinancesApiListFinancialEvents
|
|
191
172
|
*/
|
|
192
173
|
readonly postedAfter?: string;
|
|
193
174
|
/**
|
|
194
175
|
* A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
|
|
195
|
-
* @type {string}
|
|
196
|
-
* @memberof FinancesApiListFinancialEvents
|
|
197
176
|
*/
|
|
198
177
|
readonly postedBefore?: string;
|
|
199
178
|
/**
|
|
200
179
|
* A string token returned in the response of your previous request.
|
|
201
|
-
* @type {string}
|
|
202
|
-
* @memberof FinancesApiListFinancialEvents
|
|
203
180
|
*/
|
|
204
181
|
readonly nextToken?: string;
|
|
205
182
|
}
|
|
206
183
|
/**
|
|
207
184
|
* Request parameters for listFinancialEventsByGroupId operation in FinancesApi.
|
|
208
|
-
* @export
|
|
209
|
-
* @interface FinancesApiListFinancialEventsByGroupIdRequest
|
|
210
185
|
*/
|
|
211
186
|
export interface FinancesApiListFinancialEventsByGroupIdRequest {
|
|
212
187
|
/**
|
|
213
188
|
* The identifier of the financial event group to which the events belong.
|
|
214
|
-
* @type {string}
|
|
215
|
-
* @memberof FinancesApiListFinancialEventsByGroupId
|
|
216
189
|
*/
|
|
217
190
|
readonly eventGroupId: string;
|
|
218
191
|
/**
|
|
219
192
|
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'.
|
|
220
|
-
* @type {number}
|
|
221
|
-
* @memberof FinancesApiListFinancialEventsByGroupId
|
|
222
193
|
*/
|
|
223
194
|
readonly maxResultsPerPage?: number;
|
|
224
195
|
/**
|
|
225
196
|
* A date used for selecting financial events posted after (or at) a specified time. The date-time **must** be more than two minutes before the time of the request, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
|
|
226
|
-
* @type {string}
|
|
227
|
-
* @memberof FinancesApiListFinancialEventsByGroupId
|
|
228
197
|
*/
|
|
229
198
|
readonly postedAfter?: string;
|
|
230
199
|
/**
|
|
231
200
|
* A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than `PostedAfter` and no later than two minutes before the request was submitted, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format. If `PostedAfter` and `PostedBefore` are more than 180 days apart, no financial events are returned. You must specify the `PostedAfter` parameter if you specify the `PostedBefore` parameter. Default: Now minus two minutes.
|
|
232
|
-
* @type {string}
|
|
233
|
-
* @memberof FinancesApiListFinancialEventsByGroupId
|
|
234
201
|
*/
|
|
235
202
|
readonly postedBefore?: string;
|
|
236
203
|
/**
|
|
237
204
|
* A string token returned in the response of your previous request.
|
|
238
|
-
* @type {string}
|
|
239
|
-
* @memberof FinancesApiListFinancialEventsByGroupId
|
|
240
205
|
*/
|
|
241
206
|
readonly nextToken?: string;
|
|
242
207
|
}
|
|
243
208
|
/**
|
|
244
209
|
* Request parameters for listFinancialEventsByOrderId operation in FinancesApi.
|
|
245
|
-
* @export
|
|
246
|
-
* @interface FinancesApiListFinancialEventsByOrderIdRequest
|
|
247
210
|
*/
|
|
248
211
|
export interface FinancesApiListFinancialEventsByOrderIdRequest {
|
|
249
212
|
/**
|
|
250
213
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
251
|
-
* @type {string}
|
|
252
|
-
* @memberof FinancesApiListFinancialEventsByOrderId
|
|
253
214
|
*/
|
|
254
215
|
readonly orderId: string;
|
|
255
216
|
/**
|
|
256
217
|
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'.
|
|
257
|
-
* @type {number}
|
|
258
|
-
* @memberof FinancesApiListFinancialEventsByOrderId
|
|
259
218
|
*/
|
|
260
219
|
readonly maxResultsPerPage?: number;
|
|
261
220
|
/**
|
|
262
221
|
* A string token returned in the response of your previous request.
|
|
263
|
-
* @type {string}
|
|
264
|
-
* @memberof FinancesApiListFinancialEventsByOrderId
|
|
265
222
|
*/
|
|
266
223
|
readonly nextToken?: string;
|
|
267
224
|
}
|
|
268
225
|
/**
|
|
269
226
|
* FinancesApi - object-oriented interface
|
|
270
|
-
* @export
|
|
271
|
-
* @class FinancesApi
|
|
272
|
-
* @extends {BaseAPI}
|
|
273
227
|
*/
|
|
274
228
|
export declare class FinancesApi extends BaseAPI {
|
|
275
229
|
/**
|
|
@@ -277,7 +231,6 @@ export declare class FinancesApi extends BaseAPI {
|
|
|
277
231
|
* @param {FinancesApiListFinancialEventGroupsRequest} requestParameters Request parameters.
|
|
278
232
|
* @param {*} [options] Override http request option.
|
|
279
233
|
* @throws {RequiredError}
|
|
280
|
-
* @memberof FinancesApi
|
|
281
234
|
*/
|
|
282
235
|
listFinancialEventGroups(requestParameters?: FinancesApiListFinancialEventGroupsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFinancialEventGroupsResponse, any>>;
|
|
283
236
|
/**
|
|
@@ -285,7 +238,6 @@ export declare class FinancesApi extends BaseAPI {
|
|
|
285
238
|
* @param {FinancesApiListFinancialEventsRequest} requestParameters Request parameters.
|
|
286
239
|
* @param {*} [options] Override http request option.
|
|
287
240
|
* @throws {RequiredError}
|
|
288
|
-
* @memberof FinancesApi
|
|
289
241
|
*/
|
|
290
242
|
listFinancialEvents(requestParameters?: FinancesApiListFinancialEventsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFinancialEventsResponse, any>>;
|
|
291
243
|
/**
|
|
@@ -293,7 +245,6 @@ export declare class FinancesApi extends BaseAPI {
|
|
|
293
245
|
* @param {FinancesApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
|
|
294
246
|
* @param {*} [options] Override http request option.
|
|
295
247
|
* @throws {RequiredError}
|
|
296
|
-
* @memberof FinancesApi
|
|
297
248
|
*/
|
|
298
249
|
listFinancialEventsByGroupId(requestParameters: FinancesApiListFinancialEventsByGroupIdRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFinancialEventsResponse, any>>;
|
|
299
250
|
/**
|
|
@@ -301,7 +252,6 @@ export declare class FinancesApi extends BaseAPI {
|
|
|
301
252
|
* @param {FinancesApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
|
|
302
253
|
* @param {*} [options] Override http request option.
|
|
303
254
|
* @throws {RequiredError}
|
|
304
|
-
* @memberof FinancesApi
|
|
305
255
|
*/
|
|
306
256
|
listFinancialEventsByOrderId(requestParameters: FinancesApiListFinancialEventsByOrderIdRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFinancialEventsResponse, any>>;
|
|
307
257
|
}
|
|
@@ -12,42 +12,22 @@
|
|
|
12
12
|
import type { Configuration } from './configuration';
|
|
13
13
|
import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
export declare const BASE_PATH: string;
|
|
15
|
-
/**
|
|
16
|
-
*
|
|
17
|
-
* @export
|
|
18
|
-
*/
|
|
19
15
|
export declare const COLLECTION_FORMATS: {
|
|
20
16
|
csv: string;
|
|
21
17
|
ssv: string;
|
|
22
18
|
tsv: string;
|
|
23
19
|
pipes: string;
|
|
24
20
|
};
|
|
25
|
-
/**
|
|
26
|
-
*
|
|
27
|
-
* @export
|
|
28
|
-
* @interface RequestArgs
|
|
29
|
-
*/
|
|
30
21
|
export interface RequestArgs {
|
|
31
22
|
url: string;
|
|
32
23
|
options: RawAxiosRequestConfig;
|
|
33
24
|
}
|
|
34
|
-
/**
|
|
35
|
-
*
|
|
36
|
-
* @export
|
|
37
|
-
* @class BaseAPI
|
|
38
|
-
*/
|
|
39
25
|
export declare class BaseAPI {
|
|
40
26
|
protected basePath: string;
|
|
41
27
|
protected axios: AxiosInstance;
|
|
42
28
|
protected configuration: Configuration | undefined;
|
|
43
29
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
44
30
|
}
|
|
45
|
-
/**
|
|
46
|
-
*
|
|
47
|
-
* @export
|
|
48
|
-
* @class RequiredError
|
|
49
|
-
* @extends {Error}
|
|
50
|
-
*/
|
|
51
31
|
export declare class RequiredError extends Error {
|
|
52
32
|
field: string;
|
|
53
33
|
constructor(field: string, msg?: string);
|
|
@@ -58,9 +38,5 @@ interface ServerMap {
|
|
|
58
38
|
description: string;
|
|
59
39
|
}[];
|
|
60
40
|
}
|
|
61
|
-
/**
|
|
62
|
-
*
|
|
63
|
-
* @export
|
|
64
|
-
*/
|
|
65
41
|
export declare const operationServerMap: ServerMap;
|
|
66
42
|
export {};
|
|
@@ -12,54 +12,17 @@
|
|
|
12
12
|
import type { Configuration } from "./configuration";
|
|
13
13
|
import type { RequestArgs } from "./base";
|
|
14
14
|
import type { AxiosInstance, AxiosResponse } from 'axios';
|
|
15
|
-
/**
|
|
16
|
-
*
|
|
17
|
-
* @export
|
|
18
|
-
*/
|
|
19
15
|
export declare const DUMMY_BASE_URL = "https://example.com";
|
|
20
16
|
/**
|
|
21
17
|
*
|
|
22
18
|
* @throws {RequiredError}
|
|
23
|
-
* @export
|
|
24
19
|
*/
|
|
25
20
|
export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
|
|
26
|
-
/**
|
|
27
|
-
*
|
|
28
|
-
* @export
|
|
29
|
-
*/
|
|
30
21
|
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @export
|
|
34
|
-
*/
|
|
35
22
|
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
|
|
36
|
-
/**
|
|
37
|
-
*
|
|
38
|
-
* @export
|
|
39
|
-
*/
|
|
40
23
|
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
|
|
41
|
-
/**
|
|
42
|
-
*
|
|
43
|
-
* @export
|
|
44
|
-
*/
|
|
45
24
|
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
|
|
46
|
-
/**
|
|
47
|
-
*
|
|
48
|
-
* @export
|
|
49
|
-
*/
|
|
50
25
|
export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
51
|
-
/**
|
|
52
|
-
*
|
|
53
|
-
* @export
|
|
54
|
-
*/
|
|
55
26
|
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
|
|
56
|
-
/**
|
|
57
|
-
*
|
|
58
|
-
* @export
|
|
59
|
-
*/
|
|
60
27
|
export declare const toPathString: (url: URL) => string;
|
|
61
|
-
/**
|
|
62
|
-
*
|
|
63
|
-
* @export
|
|
64
|
-
*/
|
|
65
28
|
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
|
@@ -23,49 +23,32 @@ export declare class Configuration {
|
|
|
23
23
|
/**
|
|
24
24
|
* parameter for apiKey security
|
|
25
25
|
* @param name security name
|
|
26
|
-
* @memberof Configuration
|
|
27
26
|
*/
|
|
28
27
|
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
29
28
|
/**
|
|
30
29
|
* parameter for basic security
|
|
31
|
-
*
|
|
32
|
-
* @type {string}
|
|
33
|
-
* @memberof Configuration
|
|
34
30
|
*/
|
|
35
31
|
username?: string;
|
|
36
32
|
/**
|
|
37
33
|
* parameter for basic security
|
|
38
|
-
*
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof Configuration
|
|
41
34
|
*/
|
|
42
35
|
password?: string;
|
|
43
36
|
/**
|
|
44
37
|
* parameter for oauth2 security
|
|
45
38
|
* @param name security name
|
|
46
39
|
* @param scopes oauth2 scope
|
|
47
|
-
* @memberof Configuration
|
|
48
40
|
*/
|
|
49
41
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
50
42
|
/**
|
|
51
43
|
* override base path
|
|
52
|
-
*
|
|
53
|
-
* @type {string}
|
|
54
|
-
* @memberof Configuration
|
|
55
44
|
*/
|
|
56
45
|
basePath?: string;
|
|
57
46
|
/**
|
|
58
47
|
* override server index
|
|
59
|
-
*
|
|
60
|
-
* @type {number}
|
|
61
|
-
* @memberof Configuration
|
|
62
48
|
*/
|
|
63
49
|
serverIndex?: number;
|
|
64
50
|
/**
|
|
65
51
|
* base options for axios calls
|
|
66
|
-
*
|
|
67
|
-
* @type {any}
|
|
68
|
-
* @memberof Configuration
|
|
69
52
|
*/
|
|
70
53
|
baseOptions?: any;
|
|
71
54
|
/**
|
|
@@ -12,32 +12,19 @@
|
|
|
12
12
|
import type { Currency } from './currency';
|
|
13
13
|
/**
|
|
14
14
|
* An event related to an Adhoc Disbursement.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface AdhocDisbursementEvent
|
|
17
15
|
*/
|
|
18
16
|
export interface AdhocDisbursementEvent {
|
|
19
17
|
/**
|
|
20
18
|
* Indicates the type of transaction. Example: \"Disbursed to Amazon Gift Card balance\"
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof AdhocDisbursementEvent
|
|
23
19
|
*/
|
|
24
20
|
'TransactionType'?: string;
|
|
25
21
|
/**
|
|
26
22
|
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
|
|
27
|
-
* @type {string}
|
|
28
|
-
* @memberof AdhocDisbursementEvent
|
|
29
23
|
*/
|
|
30
24
|
'PostedDate'?: string;
|
|
31
25
|
/**
|
|
32
26
|
* The identifier for the transaction.
|
|
33
|
-
* @type {string}
|
|
34
|
-
* @memberof AdhocDisbursementEvent
|
|
35
27
|
*/
|
|
36
28
|
'TransactionId'?: string;
|
|
37
|
-
/**
|
|
38
|
-
*
|
|
39
|
-
* @type {Currency}
|
|
40
|
-
* @memberof AdhocDisbursementEvent
|
|
41
|
-
*/
|
|
42
29
|
'TransactionAmount'?: Currency;
|
|
43
30
|
}
|
|
@@ -13,38 +13,23 @@ import type { AdjustmentItem } from './adjustment-item';
|
|
|
13
13
|
import type { Currency } from './currency';
|
|
14
14
|
/**
|
|
15
15
|
* An adjustment to the seller\'s account.
|
|
16
|
-
* @export
|
|
17
|
-
* @interface AdjustmentEvent
|
|
18
16
|
*/
|
|
19
17
|
export interface AdjustmentEvent {
|
|
20
18
|
/**
|
|
21
19
|
* 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 of a settlement period closing. 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.
|
|
22
|
-
* @type {string}
|
|
23
|
-
* @memberof AdjustmentEvent
|
|
24
20
|
*/
|
|
25
21
|
'AdjustmentType'?: string;
|
|
26
22
|
/**
|
|
27
23
|
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
|
|
28
|
-
* @type {string}
|
|
29
|
-
* @memberof AdjustmentEvent
|
|
30
24
|
*/
|
|
31
25
|
'PostedDate'?: string;
|
|
32
26
|
/**
|
|
33
27
|
* The name of the store where the event occurred.
|
|
34
|
-
* @type {string}
|
|
35
|
-
* @memberof AdjustmentEvent
|
|
36
28
|
*/
|
|
37
29
|
'StoreName'?: string;
|
|
38
|
-
/**
|
|
39
|
-
*
|
|
40
|
-
* @type {Currency}
|
|
41
|
-
* @memberof AdjustmentEvent
|
|
42
|
-
*/
|
|
43
30
|
'AdjustmentAmount'?: Currency;
|
|
44
31
|
/**
|
|
45
32
|
* A list of information about items in an adjustment to the seller\'s account.
|
|
46
|
-
* @type {Array<AdjustmentItem>}
|
|
47
|
-
* @memberof AdjustmentEvent
|
|
48
33
|
*/
|
|
49
34
|
'AdjustmentItemList'?: Array<AdjustmentItem>;
|
|
50
35
|
}
|
|
@@ -12,56 +12,32 @@
|
|
|
12
12
|
import type { Currency } from './currency';
|
|
13
13
|
/**
|
|
14
14
|
* An item in an adjustment to the seller\'s account.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface AdjustmentItem
|
|
17
15
|
*/
|
|
18
16
|
export interface AdjustmentItem {
|
|
19
17
|
/**
|
|
20
18
|
* Represents the number of units in the seller\'s inventory when the AdustmentType is FBAInventoryReimbursement.
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof AdjustmentItem
|
|
23
19
|
*/
|
|
24
20
|
'Quantity'?: string;
|
|
25
|
-
/**
|
|
26
|
-
*
|
|
27
|
-
* @type {Currency}
|
|
28
|
-
* @memberof AdjustmentItem
|
|
29
|
-
*/
|
|
30
21
|
'PerUnitAmount'?: Currency;
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @type {Currency}
|
|
34
|
-
* @memberof AdjustmentItem
|
|
35
|
-
*/
|
|
36
22
|
'TotalAmount'?: Currency;
|
|
37
23
|
/**
|
|
38
24
|
* 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.
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof AdjustmentItem
|
|
41
25
|
*/
|
|
42
26
|
'SellerSKU'?: string;
|
|
43
27
|
/**
|
|
44
28
|
* A unique identifier assigned to products stored in and fulfilled from a fulfillment center.
|
|
45
|
-
* @type {string}
|
|
46
|
-
* @memberof AdjustmentItem
|
|
47
29
|
*/
|
|
48
30
|
'FnSKU'?: string;
|
|
49
31
|
/**
|
|
50
32
|
* A short description of the item.
|
|
51
|
-
* @type {string}
|
|
52
|
-
* @memberof AdjustmentItem
|
|
53
33
|
*/
|
|
54
34
|
'ProductDescription'?: string;
|
|
55
35
|
/**
|
|
56
36
|
* The Amazon Standard Identification Number (ASIN) of the item.
|
|
57
|
-
* @type {string}
|
|
58
|
-
* @memberof AdjustmentItem
|
|
59
37
|
*/
|
|
60
38
|
'ASIN'?: string;
|
|
61
39
|
/**
|
|
62
40
|
* The transaction number that is related to the adjustment.
|
|
63
|
-
* @type {string}
|
|
64
|
-
* @memberof AdjustmentItem
|
|
65
41
|
*/
|
|
66
42
|
'TransactionNumber'?: string;
|
|
67
43
|
}
|
|
@@ -12,62 +12,27 @@
|
|
|
12
12
|
import type { Currency } from './currency';
|
|
13
13
|
/**
|
|
14
14
|
* An expense related to an affordability promotion.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface AffordabilityExpenseEvent
|
|
17
15
|
*/
|
|
18
16
|
export interface AffordabilityExpenseEvent {
|
|
19
17
|
/**
|
|
20
18
|
* An Amazon-defined identifier for an order.
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof AffordabilityExpenseEvent
|
|
23
19
|
*/
|
|
24
20
|
'AmazonOrderId'?: string;
|
|
25
21
|
/**
|
|
26
22
|
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
|
|
27
|
-
* @type {string}
|
|
28
|
-
* @memberof AffordabilityExpenseEvent
|
|
29
23
|
*/
|
|
30
24
|
'PostedDate'?: string;
|
|
31
25
|
/**
|
|
32
26
|
* An encrypted, Amazon-defined marketplace identifier.
|
|
33
|
-
* @type {string}
|
|
34
|
-
* @memberof AffordabilityExpenseEvent
|
|
35
27
|
*/
|
|
36
28
|
'MarketplaceId'?: string;
|
|
37
29
|
/**
|
|
38
30
|
* Indicates the type of transaction. Possible values: * Charge - For an affordability promotion expense. * Refund - For an affordability promotion expense reversal.
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof AffordabilityExpenseEvent
|
|
41
31
|
*/
|
|
42
32
|
'TransactionType'?: string;
|
|
43
|
-
/**
|
|
44
|
-
*
|
|
45
|
-
* @type {Currency}
|
|
46
|
-
* @memberof AffordabilityExpenseEvent
|
|
47
|
-
*/
|
|
48
33
|
'BaseExpense'?: Currency;
|
|
49
|
-
/**
|
|
50
|
-
*
|
|
51
|
-
* @type {Currency}
|
|
52
|
-
* @memberof AffordabilityExpenseEvent
|
|
53
|
-
*/
|
|
54
34
|
'TaxTypeCGST': Currency;
|
|
55
|
-
/**
|
|
56
|
-
*
|
|
57
|
-
* @type {Currency}
|
|
58
|
-
* @memberof AffordabilityExpenseEvent
|
|
59
|
-
*/
|
|
60
35
|
'TaxTypeSGST': Currency;
|
|
61
|
-
/**
|
|
62
|
-
*
|
|
63
|
-
* @type {Currency}
|
|
64
|
-
* @memberof AffordabilityExpenseEvent
|
|
65
|
-
*/
|
|
66
36
|
'TaxTypeIGST': Currency;
|
|
67
|
-
/**
|
|
68
|
-
*
|
|
69
|
-
* @type {Currency}
|
|
70
|
-
* @memberof AffordabilityExpenseEvent
|
|
71
|
-
*/
|
|
72
37
|
'TotalExpense'?: Currency;
|
|
73
38
|
}
|
|
@@ -12,32 +12,19 @@
|
|
|
12
12
|
import type { Currency } from './currency';
|
|
13
13
|
/**
|
|
14
14
|
* An event related to a capacity reservation billing charge.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface CapacityReservationBillingEvent
|
|
17
15
|
*/
|
|
18
16
|
export interface CapacityReservationBillingEvent {
|
|
19
17
|
/**
|
|
20
18
|
* Indicates the type of transaction. For example, FBA Inventory Fee
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof CapacityReservationBillingEvent
|
|
23
19
|
*/
|
|
24
20
|
'TransactionType'?: string;
|
|
25
21
|
/**
|
|
26
22
|
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
|
|
27
|
-
* @type {string}
|
|
28
|
-
* @memberof CapacityReservationBillingEvent
|
|
29
23
|
*/
|
|
30
24
|
'PostedDate'?: string;
|
|
31
25
|
/**
|
|
32
26
|
* A short description of the capacity reservation billing event.
|
|
33
|
-
* @type {string}
|
|
34
|
-
* @memberof CapacityReservationBillingEvent
|
|
35
27
|
*/
|
|
36
28
|
'Description'?: string;
|
|
37
|
-
/**
|
|
38
|
-
*
|
|
39
|
-
* @type {Currency}
|
|
40
|
-
* @memberof CapacityReservationBillingEvent
|
|
41
|
-
*/
|
|
42
29
|
'TransactionAmount'?: Currency;
|
|
43
30
|
}
|
|
@@ -12,20 +12,11 @@
|
|
|
12
12
|
import type { Currency } from './currency';
|
|
13
13
|
/**
|
|
14
14
|
* A charge on the seller\'s account. Possible values: * Principal - The selling price of the order item, equal to the selling price of the item multiplied by the quantity ordered. * Tax - The tax collected by the seller on the Principal. * MarketplaceFacilitatorTax-Principal - The tax withheld on the Principal. * MarketplaceFacilitatorTax-Shipping - The tax withheld on the ShippingCharge. * MarketplaceFacilitatorTax-Giftwrap - The tax withheld on the Giftwrap charge. * MarketplaceFacilitatorTax-Other - The tax withheld on other miscellaneous charges. * Discount - The promotional discount for an order item. * TaxDiscount - The tax amount deducted for promotional rebates. * CODItemCharge - The COD charge for an order item. * CODItemTaxCharge - The tax collected by the seller on a CODItemCharge. * CODOrderCharge - The COD charge for an order. * CODOrderTaxCharge - The tax collected by the seller on a CODOrderCharge. * CODShippingCharge - Shipping charges for a COD order. * CODShippingTaxCharge - The tax collected by the seller on a CODShippingCharge. * ShippingCharge - The shipping charge. * ShippingTax - The tax collected by the seller on a ShippingCharge. * Goodwill - The amount 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 collected by the seller on a Giftwrap charge. * RestockingFee - The charge applied to the buyer when returning a product in certain categories. * ReturnShipping - The amount given to the buyer to compensate for shipping the item back in the event 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 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).
|
|
15
|
-
* @export
|
|
16
|
-
* @interface ChargeComponent
|
|
17
15
|
*/
|
|
18
16
|
export interface ChargeComponent {
|
|
19
17
|
/**
|
|
20
18
|
* The type of charge.
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof ChargeComponent
|
|
23
19
|
*/
|
|
24
20
|
'ChargeType'?: string;
|
|
25
|
-
/**
|
|
26
|
-
*
|
|
27
|
-
* @type {Currency}
|
|
28
|
-
* @memberof ChargeComponent
|
|
29
|
-
*/
|
|
30
21
|
'ChargeAmount'?: Currency;
|
|
31
22
|
}
|
|
@@ -12,26 +12,15 @@
|
|
|
12
12
|
import type { Currency } from './currency';
|
|
13
13
|
/**
|
|
14
14
|
* A payment instrument.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface ChargeInstrument
|
|
17
15
|
*/
|
|
18
16
|
export interface ChargeInstrument {
|
|
19
17
|
/**
|
|
20
18
|
* A short description of the charge instrument.
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof ChargeInstrument
|
|
23
19
|
*/
|
|
24
20
|
'Description'?: string;
|
|
25
21
|
/**
|
|
26
22
|
* The account tail (trailing digits) of the charge instrument.
|
|
27
|
-
* @type {string}
|
|
28
|
-
* @memberof ChargeInstrument
|
|
29
23
|
*/
|
|
30
24
|
'Tail'?: string;
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @type {Currency}
|
|
34
|
-
* @memberof ChargeInstrument
|
|
35
|
-
*/
|
|
36
25
|
'Amount'?: Currency;
|
|
37
26
|
}
|
|
@@ -12,32 +12,22 @@
|
|
|
12
12
|
import type { ChargeRefundTransaction } from './charge-refund-transaction';
|
|
13
13
|
/**
|
|
14
14
|
* An event related to charge refund.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface ChargeRefundEvent
|
|
17
15
|
*/
|
|
18
16
|
export interface ChargeRefundEvent {
|
|
19
17
|
/**
|
|
20
18
|
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof ChargeRefundEvent
|
|
23
19
|
*/
|
|
24
20
|
'PostedDate'?: string;
|
|
25
21
|
/**
|
|
26
22
|
* The reason given for a charge refund. Example: `SubscriptionFeeCorrection`
|
|
27
|
-
* @type {string}
|
|
28
|
-
* @memberof ChargeRefundEvent
|
|
29
23
|
*/
|
|
30
24
|
'ReasonCode'?: string;
|
|
31
25
|
/**
|
|
32
26
|
* A description of the Reason Code. Example: `SubscriptionFeeCorrection`
|
|
33
|
-
* @type {string}
|
|
34
|
-
* @memberof ChargeRefundEvent
|
|
35
27
|
*/
|
|
36
28
|
'ReasonCodeDescription'?: string;
|
|
37
29
|
/**
|
|
38
30
|
* A list of `ChargeRefund` transactions
|
|
39
|
-
* @type {Array<ChargeRefundTransaction>}
|
|
40
|
-
* @memberof ChargeRefundEvent
|
|
41
31
|
*/
|
|
42
32
|
'ChargeRefundTransactions'?: Array<ChargeRefundTransaction>;
|
|
43
33
|
}
|
|
@@ -12,20 +12,11 @@
|
|
|
12
12
|
import type { Currency } from './currency';
|
|
13
13
|
/**
|
|
14
14
|
* The charge refund transaction.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface ChargeRefundTransaction
|
|
17
15
|
*/
|
|
18
16
|
export interface ChargeRefundTransaction {
|
|
19
|
-
/**
|
|
20
|
-
*
|
|
21
|
-
* @type {Currency}
|
|
22
|
-
* @memberof ChargeRefundTransaction
|
|
23
|
-
*/
|
|
24
17
|
'ChargeAmount'?: Currency;
|
|
25
18
|
/**
|
|
26
19
|
* The type of charge.
|
|
27
|
-
* @type {string}
|
|
28
|
-
* @memberof ChargeRefundTransaction
|
|
29
20
|
*/
|
|
30
21
|
'ChargeType'?: string;
|
|
31
22
|
}
|