@sp-api-sdk/finances-api-2024-06-19 3.0.0 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api-model/api/finances-api.js +18 -13
- package/dist/cjs/api-model/models/business-context.js +19 -0
- package/dist/cjs/api-model/models/index.js +2 -1
- package/dist/cjs/api-model/models/related-identifier.js +3 -2
- package/dist/es/api-model/api/finances-api.js +18 -13
- package/dist/es/api-model/models/business-context.js +16 -0
- package/dist/es/api-model/models/index.js +2 -1
- package/dist/es/api-model/models/related-identifier.js +3 -2
- package/dist/types/api-model/api/finances-api.d.ts +20 -12
- package/dist/types/api-model/models/breakdown.d.ts +1 -1
- package/dist/types/api-model/models/business-context.d.ts +28 -0
- package/dist/types/api-model/models/context.d.ts +2 -1
- package/dist/types/api-model/models/index.d.ts +2 -1
- package/dist/types/api-model/models/item.d.ts +1 -1
- package/dist/types/api-model/models/list-transactions-response.d.ts +4 -4
- package/dist/types/api-model/models/marketplace-details.d.ts +1 -1
- package/dist/types/api-model/models/related-identifier.d.ts +2 -1
- package/dist/types/api-model/models/selling-partner-metadata.d.ts +1 -1
- package/dist/types/api-model/models/transaction.d.ts +2 -2
- package/dist/types/api-model/models/{list-transactions-response-payload.d.ts → transactions-payload.d.ts} +6 -6
- package/package.json +4 -4
- /package/dist/cjs/api-model/models/{list-transactions-response-payload.js → transactions-payload.js} +0 -0
- /package/dist/es/api-model/models/{list-transactions-response-payload.js → transactions-payload.js} +0 -0
|
@@ -30,15 +30,16 @@ const base_1 = require("../base");
|
|
|
30
30
|
const FinancesApiAxiosParamCreator = function (configuration) {
|
|
31
31
|
return {
|
|
32
32
|
/**
|
|
33
|
-
* Returns transactions for the given parameters.
|
|
34
|
-
* @param {string} postedAfter
|
|
33
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 may 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).
|
|
34
|
+
* @param {string} postedAfter The response includes financial events posted on or after 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.
|
|
35
35
|
* @param {string} [postedBefore] A date used for selecting transactions 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 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
|
|
36
|
-
* @param {string} [marketplaceId]
|
|
36
|
+
* @param {string} [marketplaceId] The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
37
|
+
* @param {string} [transactionStatus] The status of the transaction. **Possible values:** * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.
|
|
37
38
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
38
39
|
* @param {*} [options] Override http request option.
|
|
39
40
|
* @throws {RequiredError}
|
|
40
41
|
*/
|
|
41
|
-
listTransactions: async (postedAfter, postedBefore, marketplaceId, nextToken, options = {}) => {
|
|
42
|
+
listTransactions: async (postedAfter, postedBefore, marketplaceId, transactionStatus, nextToken, options = {}) => {
|
|
42
43
|
// verify required parameter 'postedAfter' is not null or undefined
|
|
43
44
|
(0, common_1.assertParamExists)('listTransactions', 'postedAfter', postedAfter);
|
|
44
45
|
const localVarPath = `/finances/2024-06-19/transactions`;
|
|
@@ -64,6 +65,9 @@ const FinancesApiAxiosParamCreator = function (configuration) {
|
|
|
64
65
|
if (marketplaceId !== undefined) {
|
|
65
66
|
localVarQueryParameter['marketplaceId'] = marketplaceId;
|
|
66
67
|
}
|
|
68
|
+
if (transactionStatus !== undefined) {
|
|
69
|
+
localVarQueryParameter['transactionStatus'] = transactionStatus;
|
|
70
|
+
}
|
|
67
71
|
if (nextToken !== undefined) {
|
|
68
72
|
localVarQueryParameter['nextToken'] = nextToken;
|
|
69
73
|
}
|
|
@@ -86,16 +90,17 @@ const FinancesApiFp = function (configuration) {
|
|
|
86
90
|
const localVarAxiosParamCreator = (0, exports.FinancesApiAxiosParamCreator)(configuration);
|
|
87
91
|
return {
|
|
88
92
|
/**
|
|
89
|
-
* Returns transactions for the given parameters.
|
|
90
|
-
* @param {string} postedAfter
|
|
93
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 may 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).
|
|
94
|
+
* @param {string} postedAfter The response includes financial events posted on or after 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.
|
|
91
95
|
* @param {string} [postedBefore] A date used for selecting transactions 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 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
|
|
92
|
-
* @param {string} [marketplaceId]
|
|
96
|
+
* @param {string} [marketplaceId] The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
97
|
+
* @param {string} [transactionStatus] The status of the transaction. **Possible values:** * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.
|
|
93
98
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
94
99
|
* @param {*} [options] Override http request option.
|
|
95
100
|
* @throws {RequiredError}
|
|
96
101
|
*/
|
|
97
|
-
async listTransactions(postedAfter, postedBefore, marketplaceId, nextToken, options) {
|
|
98
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listTransactions(postedAfter, postedBefore, marketplaceId, nextToken, options);
|
|
102
|
+
async listTransactions(postedAfter, postedBefore, marketplaceId, transactionStatus, nextToken, options) {
|
|
103
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listTransactions(postedAfter, postedBefore, marketplaceId, transactionStatus, nextToken, options);
|
|
99
104
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
100
105
|
const localVarOperationServerBasePath = base_1.operationServerMap['FinancesApi.listTransactions']?.[localVarOperationServerIndex]?.url;
|
|
101
106
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -111,13 +116,13 @@ const FinancesApiFactory = function (configuration, basePath, axios) {
|
|
|
111
116
|
const localVarFp = (0, exports.FinancesApiFp)(configuration);
|
|
112
117
|
return {
|
|
113
118
|
/**
|
|
114
|
-
* Returns transactions for the given parameters.
|
|
119
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 may 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).
|
|
115
120
|
* @param {FinancesApiListTransactionsRequest} requestParameters Request parameters.
|
|
116
121
|
* @param {*} [options] Override http request option.
|
|
117
122
|
* @throws {RequiredError}
|
|
118
123
|
*/
|
|
119
124
|
listTransactions(requestParameters, options) {
|
|
120
|
-
return localVarFp.listTransactions(requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.marketplaceId, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
125
|
+
return localVarFp.listTransactions(requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.marketplaceId, requestParameters.transactionStatus, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
121
126
|
},
|
|
122
127
|
};
|
|
123
128
|
};
|
|
@@ -130,14 +135,14 @@ exports.FinancesApiFactory = FinancesApiFactory;
|
|
|
130
135
|
*/
|
|
131
136
|
class FinancesApi extends base_1.BaseAPI {
|
|
132
137
|
/**
|
|
133
|
-
* Returns transactions for the given parameters.
|
|
138
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 may 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).
|
|
134
139
|
* @param {FinancesApiListTransactionsRequest} requestParameters Request parameters.
|
|
135
140
|
* @param {*} [options] Override http request option.
|
|
136
141
|
* @throws {RequiredError}
|
|
137
142
|
* @memberof FinancesApi
|
|
138
143
|
*/
|
|
139
144
|
listTransactions(requestParameters, options) {
|
|
140
|
-
return (0, exports.FinancesApiFp)(this.configuration).listTransactions(requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.marketplaceId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
145
|
+
return (0, exports.FinancesApiFp)(this.configuration).listTransactions(requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.marketplaceId, requestParameters.transactionStatus, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
141
146
|
}
|
|
142
147
|
}
|
|
143
148
|
exports.FinancesApi = FinancesApi;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* The Selling Partner API for Finances
|
|
6
|
+
* The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.BusinessContextStoreNameEnum = void 0;
|
|
17
|
+
exports.BusinessContextStoreNameEnum = {
|
|
18
|
+
AmazonHaul: 'AMAZON_HAUL'
|
|
19
|
+
};
|
|
@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./amazon-pay-context"), exports);
|
|
18
18
|
__exportStar(require("./breakdown"), exports);
|
|
19
|
+
__exportStar(require("./business-context"), exports);
|
|
19
20
|
__exportStar(require("./context"), exports);
|
|
20
21
|
__exportStar(require("./context-all-of"), exports);
|
|
21
22
|
__exportStar(require("./currency"), exports);
|
|
@@ -24,7 +25,6 @@ __exportStar(require("./error-list"), exports);
|
|
|
24
25
|
__exportStar(require("./item"), exports);
|
|
25
26
|
__exportStar(require("./item-related-identifier"), exports);
|
|
26
27
|
__exportStar(require("./list-transactions-response"), exports);
|
|
27
|
-
__exportStar(require("./list-transactions-response-payload"), exports);
|
|
28
28
|
__exportStar(require("./marketplace-details"), exports);
|
|
29
29
|
__exportStar(require("./model-error"), exports);
|
|
30
30
|
__exportStar(require("./payments-context"), exports);
|
|
@@ -33,3 +33,4 @@ __exportStar(require("./related-identifier"), exports);
|
|
|
33
33
|
__exportStar(require("./selling-partner-metadata"), exports);
|
|
34
34
|
__exportStar(require("./time-range-context"), exports);
|
|
35
35
|
__exportStar(require("./transaction"), exports);
|
|
36
|
+
__exportStar(require("./transactions-payload"), exports);
|
|
@@ -17,11 +17,12 @@ exports.RelatedIdentifierRelatedIdentifierNameEnum = void 0;
|
|
|
17
17
|
exports.RelatedIdentifierRelatedIdentifierNameEnum = {
|
|
18
18
|
OrderId: 'ORDER_ID',
|
|
19
19
|
ShipmentId: 'SHIPMENT_ID',
|
|
20
|
-
|
|
20
|
+
FinancialEventGroupId: 'FINANCIAL_EVENT_GROUP_ID',
|
|
21
21
|
RefundId: 'REFUND_ID',
|
|
22
22
|
InvoiceId: 'INVOICE_ID',
|
|
23
23
|
DisbursementId: 'DISBURSEMENT_ID',
|
|
24
24
|
TransferId: 'TRANSFER_ID',
|
|
25
25
|
DeferredTransactionId: 'DEFERRED_TRANSACTION_ID',
|
|
26
|
-
ReleaseTransactionId: 'RELEASE_TRANSACTION_ID'
|
|
26
|
+
ReleaseTransactionId: 'RELEASE_TRANSACTION_ID',
|
|
27
|
+
SettlementId: 'SETTLEMENT_ID'
|
|
27
28
|
};
|
|
@@ -24,15 +24,16 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
|
|
|
24
24
|
export const FinancesApiAxiosParamCreator = function (configuration) {
|
|
25
25
|
return {
|
|
26
26
|
/**
|
|
27
|
-
* Returns transactions for the given parameters.
|
|
28
|
-
* @param {string} postedAfter
|
|
27
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 may 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).
|
|
28
|
+
* @param {string} postedAfter The response includes financial events posted on or after 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.
|
|
29
29
|
* @param {string} [postedBefore] A date used for selecting transactions 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 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
|
|
30
|
-
* @param {string} [marketplaceId]
|
|
30
|
+
* @param {string} [marketplaceId] The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
31
|
+
* @param {string} [transactionStatus] The status of the transaction. **Possible values:** * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.
|
|
31
32
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
32
33
|
* @param {*} [options] Override http request option.
|
|
33
34
|
* @throws {RequiredError}
|
|
34
35
|
*/
|
|
35
|
-
listTransactions: async (postedAfter, postedBefore, marketplaceId, nextToken, options = {}) => {
|
|
36
|
+
listTransactions: async (postedAfter, postedBefore, marketplaceId, transactionStatus, nextToken, options = {}) => {
|
|
36
37
|
// verify required parameter 'postedAfter' is not null or undefined
|
|
37
38
|
assertParamExists('listTransactions', 'postedAfter', postedAfter);
|
|
38
39
|
const localVarPath = `/finances/2024-06-19/transactions`;
|
|
@@ -58,6 +59,9 @@ export const FinancesApiAxiosParamCreator = function (configuration) {
|
|
|
58
59
|
if (marketplaceId !== undefined) {
|
|
59
60
|
localVarQueryParameter['marketplaceId'] = marketplaceId;
|
|
60
61
|
}
|
|
62
|
+
if (transactionStatus !== undefined) {
|
|
63
|
+
localVarQueryParameter['transactionStatus'] = transactionStatus;
|
|
64
|
+
}
|
|
61
65
|
if (nextToken !== undefined) {
|
|
62
66
|
localVarQueryParameter['nextToken'] = nextToken;
|
|
63
67
|
}
|
|
@@ -79,16 +83,17 @@ export const FinancesApiFp = function (configuration) {
|
|
|
79
83
|
const localVarAxiosParamCreator = FinancesApiAxiosParamCreator(configuration);
|
|
80
84
|
return {
|
|
81
85
|
/**
|
|
82
|
-
* Returns transactions for the given parameters.
|
|
83
|
-
* @param {string} postedAfter
|
|
86
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 may 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).
|
|
87
|
+
* @param {string} postedAfter The response includes financial events posted on or after 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.
|
|
84
88
|
* @param {string} [postedBefore] A date used for selecting transactions 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 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
|
|
85
|
-
* @param {string} [marketplaceId]
|
|
89
|
+
* @param {string} [marketplaceId] The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
90
|
+
* @param {string} [transactionStatus] The status of the transaction. **Possible values:** * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.
|
|
86
91
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
87
92
|
* @param {*} [options] Override http request option.
|
|
88
93
|
* @throws {RequiredError}
|
|
89
94
|
*/
|
|
90
|
-
async listTransactions(postedAfter, postedBefore, marketplaceId, nextToken, options) {
|
|
91
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listTransactions(postedAfter, postedBefore, marketplaceId, nextToken, options);
|
|
95
|
+
async listTransactions(postedAfter, postedBefore, marketplaceId, transactionStatus, nextToken, options) {
|
|
96
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listTransactions(postedAfter, postedBefore, marketplaceId, transactionStatus, nextToken, options);
|
|
92
97
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
93
98
|
const localVarOperationServerBasePath = operationServerMap['FinancesApi.listTransactions']?.[localVarOperationServerIndex]?.url;
|
|
94
99
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -103,13 +108,13 @@ export const FinancesApiFactory = function (configuration, basePath, axios) {
|
|
|
103
108
|
const localVarFp = FinancesApiFp(configuration);
|
|
104
109
|
return {
|
|
105
110
|
/**
|
|
106
|
-
* Returns transactions for the given parameters.
|
|
111
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 may 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).
|
|
107
112
|
* @param {FinancesApiListTransactionsRequest} requestParameters Request parameters.
|
|
108
113
|
* @param {*} [options] Override http request option.
|
|
109
114
|
* @throws {RequiredError}
|
|
110
115
|
*/
|
|
111
116
|
listTransactions(requestParameters, options) {
|
|
112
|
-
return localVarFp.listTransactions(requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.marketplaceId, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
117
|
+
return localVarFp.listTransactions(requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.marketplaceId, requestParameters.transactionStatus, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
113
118
|
},
|
|
114
119
|
};
|
|
115
120
|
};
|
|
@@ -121,13 +126,13 @@ export const FinancesApiFactory = function (configuration, basePath, axios) {
|
|
|
121
126
|
*/
|
|
122
127
|
export class FinancesApi extends BaseAPI {
|
|
123
128
|
/**
|
|
124
|
-
* Returns transactions for the given parameters.
|
|
129
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 may 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).
|
|
125
130
|
* @param {FinancesApiListTransactionsRequest} requestParameters Request parameters.
|
|
126
131
|
* @param {*} [options] Override http request option.
|
|
127
132
|
* @throws {RequiredError}
|
|
128
133
|
* @memberof FinancesApi
|
|
129
134
|
*/
|
|
130
135
|
listTransactions(requestParameters, options) {
|
|
131
|
-
return FinancesApiFp(this.configuration).listTransactions(requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.marketplaceId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
136
|
+
return FinancesApiFp(this.configuration).listTransactions(requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.marketplaceId, requestParameters.transactionStatus, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
132
137
|
}
|
|
133
138
|
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Selling Partner API for Finances
|
|
5
|
+
* The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export const BusinessContextStoreNameEnum = {
|
|
15
|
+
AmazonHaul: 'AMAZON_HAUL'
|
|
16
|
+
};
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export * from './amazon-pay-context';
|
|
2
2
|
export * from './breakdown';
|
|
3
|
+
export * from './business-context';
|
|
3
4
|
export * from './context';
|
|
4
5
|
export * from './context-all-of';
|
|
5
6
|
export * from './currency';
|
|
@@ -8,7 +9,6 @@ export * from './error-list';
|
|
|
8
9
|
export * from './item';
|
|
9
10
|
export * from './item-related-identifier';
|
|
10
11
|
export * from './list-transactions-response';
|
|
11
|
-
export * from './list-transactions-response-payload';
|
|
12
12
|
export * from './marketplace-details';
|
|
13
13
|
export * from './model-error';
|
|
14
14
|
export * from './payments-context';
|
|
@@ -17,3 +17,4 @@ export * from './related-identifier';
|
|
|
17
17
|
export * from './selling-partner-metadata';
|
|
18
18
|
export * from './time-range-context';
|
|
19
19
|
export * from './transaction';
|
|
20
|
+
export * from './transactions-payload';
|
|
@@ -14,11 +14,12 @@
|
|
|
14
14
|
export const RelatedIdentifierRelatedIdentifierNameEnum = {
|
|
15
15
|
OrderId: 'ORDER_ID',
|
|
16
16
|
ShipmentId: 'SHIPMENT_ID',
|
|
17
|
-
|
|
17
|
+
FinancialEventGroupId: 'FINANCIAL_EVENT_GROUP_ID',
|
|
18
18
|
RefundId: 'REFUND_ID',
|
|
19
19
|
InvoiceId: 'INVOICE_ID',
|
|
20
20
|
DisbursementId: 'DISBURSEMENT_ID',
|
|
21
21
|
TransferId: 'TRANSFER_ID',
|
|
22
22
|
DeferredTransactionId: 'DEFERRED_TRANSACTION_ID',
|
|
23
|
-
ReleaseTransactionId: 'RELEASE_TRANSACTION_ID'
|
|
23
|
+
ReleaseTransactionId: 'RELEASE_TRANSACTION_ID',
|
|
24
|
+
SettlementId: 'SETTLEMENT_ID'
|
|
24
25
|
};
|
|
@@ -20,15 +20,16 @@ import type { ListTransactionsResponse } from '../models';
|
|
|
20
20
|
*/
|
|
21
21
|
export declare const FinancesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
22
|
/**
|
|
23
|
-
* Returns transactions for the given parameters.
|
|
24
|
-
* @param {string} postedAfter
|
|
23
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 may 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).
|
|
24
|
+
* @param {string} postedAfter The response includes financial events posted on or after 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.
|
|
25
25
|
* @param {string} [postedBefore] A date used for selecting transactions 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 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
|
|
26
|
-
* @param {string} [marketplaceId]
|
|
26
|
+
* @param {string} [marketplaceId] The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
27
|
+
* @param {string} [transactionStatus] The status of the transaction. **Possible values:** * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.
|
|
27
28
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
28
29
|
* @param {*} [options] Override http request option.
|
|
29
30
|
* @throws {RequiredError}
|
|
30
31
|
*/
|
|
31
|
-
listTransactions: (postedAfter: string, postedBefore?: string, marketplaceId?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
|
+
listTransactions: (postedAfter: string, postedBefore?: string, marketplaceId?: string, transactionStatus?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
33
|
};
|
|
33
34
|
/**
|
|
34
35
|
* FinancesApi - functional programming interface
|
|
@@ -36,15 +37,16 @@ export declare const FinancesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
36
37
|
*/
|
|
37
38
|
export declare const FinancesApiFp: (configuration?: Configuration) => {
|
|
38
39
|
/**
|
|
39
|
-
* Returns transactions for the given parameters.
|
|
40
|
-
* @param {string} postedAfter
|
|
40
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 may 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).
|
|
41
|
+
* @param {string} postedAfter The response includes financial events posted on or after 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.
|
|
41
42
|
* @param {string} [postedBefore] A date used for selecting transactions 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 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
|
|
42
|
-
* @param {string} [marketplaceId]
|
|
43
|
+
* @param {string} [marketplaceId] The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
44
|
+
* @param {string} [transactionStatus] The status of the transaction. **Possible values:** * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.
|
|
43
45
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
44
46
|
* @param {*} [options] Override http request option.
|
|
45
47
|
* @throws {RequiredError}
|
|
46
48
|
*/
|
|
47
|
-
listTransactions(postedAfter: string, postedBefore?: string, marketplaceId?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactionsResponse>>;
|
|
49
|
+
listTransactions(postedAfter: string, postedBefore?: string, marketplaceId?: string, transactionStatus?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactionsResponse>>;
|
|
48
50
|
};
|
|
49
51
|
/**
|
|
50
52
|
* FinancesApi - factory interface
|
|
@@ -52,7 +54,7 @@ export declare const FinancesApiFp: (configuration?: Configuration) => {
|
|
|
52
54
|
*/
|
|
53
55
|
export declare const FinancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
54
56
|
/**
|
|
55
|
-
* Returns transactions for the given parameters.
|
|
57
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 may 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).
|
|
56
58
|
* @param {FinancesApiListTransactionsRequest} requestParameters Request parameters.
|
|
57
59
|
* @param {*} [options] Override http request option.
|
|
58
60
|
* @throws {RequiredError}
|
|
@@ -66,7 +68,7 @@ export declare const FinancesApiFactory: (configuration?: Configuration, basePat
|
|
|
66
68
|
*/
|
|
67
69
|
export interface FinancesApiListTransactionsRequest {
|
|
68
70
|
/**
|
|
69
|
-
*
|
|
71
|
+
* The response includes financial events posted on or after 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.
|
|
70
72
|
* @type {string}
|
|
71
73
|
* @memberof FinancesApiListTransactions
|
|
72
74
|
*/
|
|
@@ -78,11 +80,17 @@ export interface FinancesApiListTransactionsRequest {
|
|
|
78
80
|
*/
|
|
79
81
|
readonly postedBefore?: string;
|
|
80
82
|
/**
|
|
81
|
-
*
|
|
83
|
+
* The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
82
84
|
* @type {string}
|
|
83
85
|
* @memberof FinancesApiListTransactions
|
|
84
86
|
*/
|
|
85
87
|
readonly marketplaceId?: string;
|
|
88
|
+
/**
|
|
89
|
+
* The status of the transaction. **Possible values:** * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.
|
|
90
|
+
* @type {string}
|
|
91
|
+
* @memberof FinancesApiListTransactions
|
|
92
|
+
*/
|
|
93
|
+
readonly transactionStatus?: string;
|
|
86
94
|
/**
|
|
87
95
|
* A string token returned in the response of your previous request.
|
|
88
96
|
* @type {string}
|
|
@@ -98,7 +106,7 @@ export interface FinancesApiListTransactionsRequest {
|
|
|
98
106
|
*/
|
|
99
107
|
export declare class FinancesApi extends BaseAPI {
|
|
100
108
|
/**
|
|
101
|
-
* Returns transactions for the given parameters.
|
|
109
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 may 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).
|
|
102
110
|
* @param {FinancesApiListTransactionsRequest} requestParameters Request parameters.
|
|
103
111
|
* @param {*} [options] Override http request option.
|
|
104
112
|
* @throws {RequiredError}
|
|
@@ -29,7 +29,7 @@ export interface Breakdown {
|
|
|
29
29
|
*/
|
|
30
30
|
'breakdownAmount'?: Currency;
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
32
|
+
* A list of breakdowns that detail how the total amount is calculated for the transaction.
|
|
33
33
|
* @type {Array<Breakdown>}
|
|
34
34
|
* @memberof Breakdown
|
|
35
35
|
*/
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Finances
|
|
3
|
+
* The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Information about the line of business associated with a transaction.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface BusinessContext
|
|
16
|
+
*/
|
|
17
|
+
export interface BusinessContext {
|
|
18
|
+
/**
|
|
19
|
+
* The store name associated with the transaction.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof BusinessContext
|
|
22
|
+
*/
|
|
23
|
+
'storeName'?: BusinessContextStoreNameEnum;
|
|
24
|
+
}
|
|
25
|
+
export declare const BusinessContextStoreNameEnum: {
|
|
26
|
+
readonly AmazonHaul: "AMAZON_HAUL";
|
|
27
|
+
};
|
|
28
|
+
export type BusinessContextStoreNameEnum = typeof BusinessContextStoreNameEnum[keyof typeof BusinessContextStoreNameEnum];
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { AmazonPayContext } from './amazon-pay-context';
|
|
13
|
+
import type { BusinessContext } from './business-context';
|
|
13
14
|
import type { ContextAllOf } from './context-all-of';
|
|
14
15
|
import type { DeferredContext } from './deferred-context';
|
|
15
16
|
import type { PaymentsContext } from './payments-context';
|
|
@@ -20,4 +21,4 @@ import type { TimeRangeContext } from './time-range-context';
|
|
|
20
21
|
* Additional Information about the item.
|
|
21
22
|
* @export
|
|
22
23
|
*/
|
|
23
|
-
export type Context = AmazonPayContext & ContextAllOf & DeferredContext & PaymentsContext & ProductContext & TimeRangeContext;
|
|
24
|
+
export type Context = AmazonPayContext & BusinessContext & ContextAllOf & DeferredContext & PaymentsContext & ProductContext & TimeRangeContext;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export * from './amazon-pay-context';
|
|
2
2
|
export * from './breakdown';
|
|
3
|
+
export * from './business-context';
|
|
3
4
|
export * from './context';
|
|
4
5
|
export * from './context-all-of';
|
|
5
6
|
export * from './currency';
|
|
@@ -8,7 +9,6 @@ export * from './error-list';
|
|
|
8
9
|
export * from './item';
|
|
9
10
|
export * from './item-related-identifier';
|
|
10
11
|
export * from './list-transactions-response';
|
|
11
|
-
export * from './list-transactions-response-payload';
|
|
12
12
|
export * from './marketplace-details';
|
|
13
13
|
export * from './model-error';
|
|
14
14
|
export * from './payments-context';
|
|
@@ -17,3 +17,4 @@ export * from './related-identifier';
|
|
|
17
17
|
export * from './selling-partner-metadata';
|
|
18
18
|
export * from './time-range-context';
|
|
19
19
|
export * from './transaction';
|
|
20
|
+
export * from './transactions-payload';
|
|
@@ -38,7 +38,7 @@ export interface Item {
|
|
|
38
38
|
*/
|
|
39
39
|
'totalAmount'?: Currency;
|
|
40
40
|
/**
|
|
41
|
-
*
|
|
41
|
+
* A list of breakdowns that detail how the total amount is calculated for the transaction.
|
|
42
42
|
* @type {Array<Breakdown>}
|
|
43
43
|
* @memberof Item
|
|
44
44
|
*/
|
|
@@ -9,17 +9,17 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { TransactionsPayload } from './transactions-payload';
|
|
13
13
|
/**
|
|
14
|
-
* The response schema for the `listTransactions` operation
|
|
14
|
+
* The response schema for the `listTransactions` operation.
|
|
15
15
|
* @export
|
|
16
16
|
* @interface ListTransactionsResponse
|
|
17
17
|
*/
|
|
18
18
|
export interface ListTransactionsResponse {
|
|
19
19
|
/**
|
|
20
20
|
*
|
|
21
|
-
* @type {
|
|
21
|
+
* @type {TransactionsPayload}
|
|
22
22
|
* @memberof ListTransactionsResponse
|
|
23
23
|
*/
|
|
24
|
-
'payload'?:
|
|
24
|
+
'payload'?: TransactionsPayload;
|
|
25
25
|
}
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface MarketplaceDetails {
|
|
18
18
|
/**
|
|
19
|
-
* The identifier of the marketplace where the transaction
|
|
19
|
+
* The identifier of the marketplace where the transaction occurred. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof MarketplaceDetails
|
|
22
22
|
*/
|
|
@@ -31,12 +31,13 @@ export interface RelatedIdentifier {
|
|
|
31
31
|
export declare const RelatedIdentifierRelatedIdentifierNameEnum: {
|
|
32
32
|
readonly OrderId: "ORDER_ID";
|
|
33
33
|
readonly ShipmentId: "SHIPMENT_ID";
|
|
34
|
-
readonly
|
|
34
|
+
readonly FinancialEventGroupId: "FINANCIAL_EVENT_GROUP_ID";
|
|
35
35
|
readonly RefundId: "REFUND_ID";
|
|
36
36
|
readonly InvoiceId: "INVOICE_ID";
|
|
37
37
|
readonly DisbursementId: "DISBURSEMENT_ID";
|
|
38
38
|
readonly TransferId: "TRANSFER_ID";
|
|
39
39
|
readonly DeferredTransactionId: "DEFERRED_TRANSACTION_ID";
|
|
40
40
|
readonly ReleaseTransactionId: "RELEASE_TRANSACTION_ID";
|
|
41
|
+
readonly SettlementId: "SETTLEMENT_ID";
|
|
41
42
|
};
|
|
42
43
|
export type RelatedIdentifierRelatedIdentifierNameEnum = typeof RelatedIdentifierRelatedIdentifierNameEnum[keyof typeof RelatedIdentifierRelatedIdentifierNameEnum];
|
|
@@ -28,7 +28,7 @@ export interface SellingPartnerMetadata {
|
|
|
28
28
|
*/
|
|
29
29
|
'accountType'?: string;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* The identifier of the marketplace where the transaction occurred. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof SellingPartnerMetadata
|
|
34
34
|
*/
|
|
@@ -47,7 +47,7 @@ export interface Transaction {
|
|
|
47
47
|
*/
|
|
48
48
|
'transactionId'?: string;
|
|
49
49
|
/**
|
|
50
|
-
* The status of the transaction. **Possible values:** * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released.
|
|
50
|
+
* The status of the transaction. **Possible values:** * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.
|
|
51
51
|
* @type {string}
|
|
52
52
|
* @memberof Transaction
|
|
53
53
|
*/
|
|
@@ -89,7 +89,7 @@ export interface Transaction {
|
|
|
89
89
|
*/
|
|
90
90
|
'contexts'?: Array<Context>;
|
|
91
91
|
/**
|
|
92
|
-
*
|
|
92
|
+
* A list of breakdowns that detail how the total amount is calculated for the transaction.
|
|
93
93
|
* @type {Array<Breakdown>}
|
|
94
94
|
* @memberof Transaction
|
|
95
95
|
*/
|
|
@@ -11,21 +11,21 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Transaction } from './transaction';
|
|
13
13
|
/**
|
|
14
|
-
* The payload
|
|
14
|
+
* The payload for the `listTransactions` operation.
|
|
15
15
|
* @export
|
|
16
|
-
* @interface
|
|
16
|
+
* @interface TransactionsPayload
|
|
17
17
|
*/
|
|
18
|
-
export interface
|
|
18
|
+
export interface TransactionsPayload {
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* When present and not empty, pass this string token in the next request to return the next response page.
|
|
21
21
|
* @type {string}
|
|
22
|
-
* @memberof
|
|
22
|
+
* @memberof TransactionsPayload
|
|
23
23
|
*/
|
|
24
24
|
'nextToken'?: string;
|
|
25
25
|
/**
|
|
26
26
|
* Contains transactions within a given time period.
|
|
27
27
|
* @type {Array<Transaction>}
|
|
28
|
-
* @memberof
|
|
28
|
+
* @memberof TransactionsPayload
|
|
29
29
|
*/
|
|
30
30
|
'transactions'?: Array<Transaction>;
|
|
31
31
|
}
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/finances-api-2024-06-19",
|
|
3
3
|
"author": "Bertrand Marron <bertrand@bizon.solutions>",
|
|
4
4
|
"description": "The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.",
|
|
5
|
-
"version": "3.
|
|
5
|
+
"version": "3.1.0",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
@@ -18,8 +18,8 @@
|
|
|
18
18
|
"dist/**/*.d.ts"
|
|
19
19
|
],
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@sp-api-sdk/common": "2.1.
|
|
22
|
-
"axios": "^1.
|
|
21
|
+
"@sp-api-sdk/common": "2.1.15",
|
|
22
|
+
"axios": "^1.10.0"
|
|
23
23
|
},
|
|
24
24
|
"repository": {
|
|
25
25
|
"type": "git",
|
|
@@ -40,5 +40,5 @@
|
|
|
40
40
|
"sp sdk",
|
|
41
41
|
"finances api"
|
|
42
42
|
],
|
|
43
|
-
"gitHead": "
|
|
43
|
+
"gitHead": "b36600f33d62a2b6c3a9035968a93bc83e9838a9"
|
|
44
44
|
}
|
/package/dist/cjs/api-model/models/{list-transactions-response-payload.js → transactions-payload.js}
RENAMED
|
File without changes
|
/package/dist/es/api-model/models/{list-transactions-response-payload.js → transactions-payload.js}
RENAMED
|
File without changes
|