@sp-api-sdk/finances-api-v0 2.6.2 → 2.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/cjs/api-model/api/default-api.js +45 -45
- package/dist/cjs/api-model/api.js +1 -1
- package/dist/cjs/api-model/base.js +1 -1
- package/dist/cjs/api-model/common.js +1 -1
- package/dist/cjs/api-model/configuration.js +1 -1
- package/dist/cjs/api-model/index.js +1 -1
- package/dist/cjs/api-model/models/adhoc-disbursement-event.js +1 -1
- package/dist/cjs/api-model/models/adjustment-event.js +1 -1
- package/dist/cjs/api-model/models/adjustment-item.js +1 -1
- package/dist/cjs/api-model/models/affordability-expense-event.js +1 -1
- package/dist/cjs/api-model/models/capacity-reservation-billing-event.js +1 -1
- package/dist/cjs/api-model/models/charge-component.js +1 -1
- package/dist/cjs/api-model/models/charge-instrument.js +1 -1
- package/dist/cjs/api-model/models/charge-refund-event.js +1 -1
- package/dist/cjs/api-model/models/charge-refund-transaction.js +1 -1
- package/dist/cjs/api-model/models/coupon-payment-event.js +1 -1
- package/dist/cjs/api-model/models/currency.js +1 -1
- package/dist/cjs/api-model/models/debt-recovery-event.js +1 -1
- package/dist/cjs/api-model/models/debt-recovery-item.js +1 -1
- package/dist/cjs/api-model/models/direct-payment.js +1 -1
- package/dist/cjs/api-model/models/failed-adhoc-disbursement-event.js +1 -1
- package/dist/cjs/api-model/models/fbaliquidation-event.js +1 -1
- package/dist/cjs/api-model/models/fee-component.js +1 -1
- package/dist/cjs/api-model/models/financial-event-group.js +1 -1
- package/dist/cjs/api-model/models/financial-events.js +1 -1
- package/dist/cjs/api-model/models/imaging-services-fee-event.js +1 -1
- package/dist/cjs/api-model/models/list-financial-event-groups-payload.js +1 -1
- package/dist/cjs/api-model/models/list-financial-event-groups-response.js +1 -1
- package/dist/cjs/api-model/models/list-financial-events-payload.js +1 -1
- package/dist/cjs/api-model/models/list-financial-events-response.js +1 -1
- package/dist/cjs/api-model/models/loan-servicing-event.js +1 -1
- package/dist/cjs/api-model/models/model-error.js +1 -1
- package/dist/cjs/api-model/models/network-commingling-transaction-event.js +1 -1
- package/dist/cjs/api-model/models/pay-with-amazon-event.js +1 -1
- package/dist/cjs/api-model/models/product-ads-payment-event.js +1 -1
- package/dist/cjs/api-model/models/promotion.js +1 -1
- package/dist/cjs/api-model/models/removal-shipment-adjustment-event.js +1 -1
- package/dist/cjs/api-model/models/removal-shipment-event.js +1 -1
- package/dist/cjs/api-model/models/removal-shipment-item-adjustment.js +1 -1
- package/dist/cjs/api-model/models/removal-shipment-item.js +1 -1
- package/dist/cjs/api-model/models/rental-transaction-event.js +1 -1
- package/dist/cjs/api-model/models/retrocharge-event.js +1 -1
- package/dist/cjs/api-model/models/safetreimbursement-event.js +1 -1
- package/dist/cjs/api-model/models/safetreimbursement-item.js +1 -1
- package/dist/cjs/api-model/models/seller-deal-payment-event.js +1 -1
- package/dist/cjs/api-model/models/seller-review-enrollment-payment-event.js +1 -1
- package/dist/cjs/api-model/models/service-fee-event.js +1 -1
- package/dist/cjs/api-model/models/shipment-event.js +1 -1
- package/dist/cjs/api-model/models/shipment-item.js +1 -1
- package/dist/cjs/api-model/models/solution-provider-credit-event.js +1 -1
- package/dist/cjs/api-model/models/tax-withheld-component.js +1 -1
- package/dist/cjs/api-model/models/tax-withholding-event.js +1 -1
- package/dist/cjs/api-model/models/tax-withholding-period.js +1 -1
- package/dist/cjs/api-model/models/tdsreimbursement-event.js +1 -1
- package/dist/cjs/api-model/models/trial-shipment-event.js +1 -1
- package/dist/cjs/api-model/models/value-added-service-charge-event.js +1 -1
- package/dist/es/api-model/api/default-api.js +45 -45
- package/dist/es/api-model/api.js +1 -1
- package/dist/es/api-model/base.js +1 -1
- package/dist/es/api-model/common.js +1 -1
- package/dist/es/api-model/configuration.js +1 -1
- package/dist/es/api-model/index.js +1 -1
- package/dist/es/api-model/models/adhoc-disbursement-event.js +1 -1
- package/dist/es/api-model/models/adjustment-event.js +1 -1
- package/dist/es/api-model/models/adjustment-item.js +1 -1
- package/dist/es/api-model/models/affordability-expense-event.js +1 -1
- package/dist/es/api-model/models/capacity-reservation-billing-event.js +1 -1
- package/dist/es/api-model/models/charge-component.js +1 -1
- package/dist/es/api-model/models/charge-instrument.js +1 -1
- package/dist/es/api-model/models/charge-refund-event.js +1 -1
- package/dist/es/api-model/models/charge-refund-transaction.js +1 -1
- package/dist/es/api-model/models/coupon-payment-event.js +1 -1
- package/dist/es/api-model/models/currency.js +1 -1
- package/dist/es/api-model/models/debt-recovery-event.js +1 -1
- package/dist/es/api-model/models/debt-recovery-item.js +1 -1
- package/dist/es/api-model/models/direct-payment.js +1 -1
- package/dist/es/api-model/models/failed-adhoc-disbursement-event.js +1 -1
- package/dist/es/api-model/models/fbaliquidation-event.js +1 -1
- package/dist/es/api-model/models/fee-component.js +1 -1
- package/dist/es/api-model/models/financial-event-group.js +1 -1
- package/dist/es/api-model/models/financial-events.js +1 -1
- package/dist/es/api-model/models/imaging-services-fee-event.js +1 -1
- package/dist/es/api-model/models/list-financial-event-groups-payload.js +1 -1
- package/dist/es/api-model/models/list-financial-event-groups-response.js +1 -1
- package/dist/es/api-model/models/list-financial-events-payload.js +1 -1
- package/dist/es/api-model/models/list-financial-events-response.js +1 -1
- package/dist/es/api-model/models/loan-servicing-event.js +1 -1
- package/dist/es/api-model/models/model-error.js +1 -1
- package/dist/es/api-model/models/network-commingling-transaction-event.js +1 -1
- package/dist/es/api-model/models/pay-with-amazon-event.js +1 -1
- package/dist/es/api-model/models/product-ads-payment-event.js +1 -1
- package/dist/es/api-model/models/promotion.js +1 -1
- package/dist/es/api-model/models/removal-shipment-adjustment-event.js +1 -1
- package/dist/es/api-model/models/removal-shipment-event.js +1 -1
- package/dist/es/api-model/models/removal-shipment-item-adjustment.js +1 -1
- package/dist/es/api-model/models/removal-shipment-item.js +1 -1
- package/dist/es/api-model/models/rental-transaction-event.js +1 -1
- package/dist/es/api-model/models/retrocharge-event.js +1 -1
- package/dist/es/api-model/models/safetreimbursement-event.js +1 -1
- package/dist/es/api-model/models/safetreimbursement-item.js +1 -1
- package/dist/es/api-model/models/seller-deal-payment-event.js +1 -1
- package/dist/es/api-model/models/seller-review-enrollment-payment-event.js +1 -1
- package/dist/es/api-model/models/service-fee-event.js +1 -1
- package/dist/es/api-model/models/shipment-event.js +1 -1
- package/dist/es/api-model/models/shipment-item.js +1 -1
- package/dist/es/api-model/models/solution-provider-credit-event.js +1 -1
- package/dist/es/api-model/models/tax-withheld-component.js +1 -1
- package/dist/es/api-model/models/tax-withholding-event.js +1 -1
- package/dist/es/api-model/models/tax-withholding-period.js +1 -1
- package/dist/es/api-model/models/tdsreimbursement-event.js +1 -1
- package/dist/es/api-model/models/trial-shipment-event.js +1 -1
- package/dist/es/api-model/models/value-added-service-charge-event.js +1 -1
- package/dist/types/api-model/api/default-api.d.ts +59 -59
- package/dist/types/api-model/api.d.ts +1 -1
- package/dist/types/api-model/base.d.ts +1 -1
- package/dist/types/api-model/common.d.ts +1 -1
- package/dist/types/api-model/configuration.d.ts +1 -1
- package/dist/types/api-model/index.d.ts +1 -1
- package/dist/types/api-model/models/adhoc-disbursement-event.d.ts +3 -3
- package/dist/types/api-model/models/adjustment-event.d.ts +3 -3
- package/dist/types/api-model/models/adjustment-item.d.ts +8 -2
- package/dist/types/api-model/models/affordability-expense-event.d.ts +4 -4
- package/dist/types/api-model/models/capacity-reservation-billing-event.d.ts +3 -3
- package/dist/types/api-model/models/charge-component.d.ts +2 -2
- package/dist/types/api-model/models/charge-instrument.d.ts +1 -1
- package/dist/types/api-model/models/charge-refund-event.d.ts +4 -4
- package/dist/types/api-model/models/charge-refund-transaction.d.ts +1 -1
- package/dist/types/api-model/models/coupon-payment-event.d.ts +2 -2
- package/dist/types/api-model/models/currency.d.ts +2 -2
- package/dist/types/api-model/models/debt-recovery-event.d.ts +2 -2
- package/dist/types/api-model/models/debt-recovery-item.d.ts +3 -3
- package/dist/types/api-model/models/direct-payment.d.ts +2 -2
- package/dist/types/api-model/models/failed-adhoc-disbursement-event.d.ts +5 -5
- package/dist/types/api-model/models/fbaliquidation-event.d.ts +2 -2
- package/dist/types/api-model/models/fee-component.d.ts +1 -1
- package/dist/types/api-model/models/financial-event-group.d.ts +5 -5
- package/dist/types/api-model/models/financial-events.d.ts +8 -8
- package/dist/types/api-model/models/imaging-services-fee-event.d.ts +2 -2
- package/dist/types/api-model/models/list-financial-event-groups-payload.d.ts +2 -2
- package/dist/types/api-model/models/list-financial-event-groups-response.d.ts +2 -2
- package/dist/types/api-model/models/list-financial-events-payload.d.ts +2 -2
- package/dist/types/api-model/models/list-financial-events-response.d.ts +2 -2
- package/dist/types/api-model/models/loan-servicing-event.d.ts +2 -2
- package/dist/types/api-model/models/model-error.d.ts +1 -1
- package/dist/types/api-model/models/network-commingling-transaction-event.d.ts +3 -3
- package/dist/types/api-model/models/pay-with-amazon-event.d.ts +5 -5
- package/dist/types/api-model/models/product-ads-payment-event.d.ts +4 -4
- package/dist/types/api-model/models/promotion.d.ts +1 -1
- package/dist/types/api-model/models/removal-shipment-adjustment-event.d.ts +4 -4
- package/dist/types/api-model/models/removal-shipment-event.d.ts +5 -5
- package/dist/types/api-model/models/removal-shipment-item-adjustment.d.ts +3 -3
- package/dist/types/api-model/models/removal-shipment-item.d.ts +2 -2
- package/dist/types/api-model/models/rental-transaction-event.d.ts +4 -4
- package/dist/types/api-model/models/retrocharge-event.d.ts +3 -3
- package/dist/types/api-model/models/safetreimbursement-event.d.ts +3 -3
- package/dist/types/api-model/models/safetreimbursement-item.d.ts +1 -1
- package/dist/types/api-model/models/seller-deal-payment-event.d.ts +4 -4
- package/dist/types/api-model/models/seller-review-enrollment-payment-event.d.ts +2 -2
- package/dist/types/api-model/models/service-fee-event.d.ts +1 -1
- package/dist/types/api-model/models/shipment-event.d.ts +2 -2
- package/dist/types/api-model/models/shipment-item.d.ts +1 -1
- package/dist/types/api-model/models/solution-provider-credit-event.d.ts +2 -2
- package/dist/types/api-model/models/tax-withheld-component.d.ts +2 -2
- package/dist/types/api-model/models/tax-withholding-event.d.ts +3 -3
- package/dist/types/api-model/models/tax-withholding-period.d.ts +4 -4
- package/dist/types/api-model/models/tdsreimbursement-event.d.ts +2 -2
- package/dist/types/api-model/models/trial-shipment-event.d.ts +2 -2
- package/dist/types/api-model/models/value-added-service-charge-event.d.ts +3 -3
- package/package.json +4 -4
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Finances
|
|
3
|
-
* 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, 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.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -21,41 +21,41 @@ import type { ListFinancialEventsResponse } from '../models';
|
|
|
21
21
|
*/
|
|
22
22
|
export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23
23
|
/**
|
|
24
|
-
* Returns financial event groups for a given date range.
|
|
25
|
-
* @param {number} [maxResultsPerPage] The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the
|
|
26
|
-
* @param {string} [financialEventGroupStartedBefore] A date
|
|
27
|
-
* @param {string} [financialEventGroupStartedAfter] A date
|
|
28
|
-
* @param {string} [nextToken]
|
|
24
|
+
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
25
|
+
* @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 API responds with \'InvalidInput\'.
|
|
26
|
+
* @param {string} [financialEventGroupStartedBefore] 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.
|
|
27
|
+
* @param {string} [financialEventGroupStartedAfter] 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.
|
|
28
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
29
29
|
* @param {*} [options] Override http request option.
|
|
30
30
|
* @throws {RequiredError}
|
|
31
31
|
*/
|
|
32
32
|
listFinancialEventGroups: (maxResultsPerPage?: number, financialEventGroupStartedBefore?: string, financialEventGroupStartedAfter?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
33
|
/**
|
|
34
|
-
* Returns financial events for the specified data range.
|
|
35
|
-
* @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
|
|
36
|
-
* @param {string} [postedAfter]
|
|
37
|
-
* @param {string} [postedBefore]
|
|
38
|
-
* @param {string} [nextToken]
|
|
34
|
+
* Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
35
|
+
* @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 API responds with \'InvalidInput\'.
|
|
36
|
+
* @param {string} [postedAfter] 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.
|
|
37
|
+
* @param {string} [postedBefore] 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.
|
|
38
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
39
39
|
* @param {*} [options] Override http request option.
|
|
40
40
|
* @throws {RequiredError}
|
|
41
41
|
*/
|
|
42
42
|
listFinancialEvents: (maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
43
|
/**
|
|
44
|
-
* Returns all financial events for the specified financial event group.
|
|
44
|
+
* Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
45
45
|
* @param {string} eventGroupId The identifier of the financial event group to which the events belong.
|
|
46
|
-
* @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
|
|
47
|
-
* @param {string} [postedAfter]
|
|
48
|
-
* @param {string} [postedBefore]
|
|
49
|
-
* @param {string} [nextToken]
|
|
46
|
+
* @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 API responds with \'InvalidInput\'.
|
|
47
|
+
* @param {string} [postedAfter] 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.
|
|
48
|
+
* @param {string} [postedBefore] 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.
|
|
49
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
50
50
|
* @param {*} [options] Override http request option.
|
|
51
51
|
* @throws {RequiredError}
|
|
52
52
|
*/
|
|
53
53
|
listFinancialEventsByGroupId: (eventGroupId: string, maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
54
|
/**
|
|
55
|
-
* Returns all financial events for the specified order.
|
|
55
|
+
* Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
56
56
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
57
|
-
* @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
|
|
58
|
-
* @param {string} [nextToken]
|
|
57
|
+
* @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 API responds with \'InvalidInput\'.
|
|
58
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
59
59
|
* @param {*} [options] Override http request option.
|
|
60
60
|
* @throws {RequiredError}
|
|
61
61
|
*/
|
|
@@ -67,41 +67,41 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
67
67
|
*/
|
|
68
68
|
export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
69
69
|
/**
|
|
70
|
-
* Returns financial event groups for a given date range.
|
|
71
|
-
* @param {number} [maxResultsPerPage] The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the
|
|
72
|
-
* @param {string} [financialEventGroupStartedBefore] A date
|
|
73
|
-
* @param {string} [financialEventGroupStartedAfter] A date
|
|
74
|
-
* @param {string} [nextToken]
|
|
70
|
+
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
71
|
+
* @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 API responds with \'InvalidInput\'.
|
|
72
|
+
* @param {string} [financialEventGroupStartedBefore] 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.
|
|
73
|
+
* @param {string} [financialEventGroupStartedAfter] 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.
|
|
74
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
75
75
|
* @param {*} [options] Override http request option.
|
|
76
76
|
* @throws {RequiredError}
|
|
77
77
|
*/
|
|
78
78
|
listFinancialEventGroups(maxResultsPerPage?: number, financialEventGroupStartedBefore?: string, financialEventGroupStartedAfter?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventGroupsResponse>>;
|
|
79
79
|
/**
|
|
80
|
-
* Returns financial events for the specified data range.
|
|
81
|
-
* @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
|
|
82
|
-
* @param {string} [postedAfter]
|
|
83
|
-
* @param {string} [postedBefore]
|
|
84
|
-
* @param {string} [nextToken]
|
|
80
|
+
* Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
81
|
+
* @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 API responds with \'InvalidInput\'.
|
|
82
|
+
* @param {string} [postedAfter] 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.
|
|
83
|
+
* @param {string} [postedBefore] 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.
|
|
84
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
85
85
|
* @param {*} [options] Override http request option.
|
|
86
86
|
* @throws {RequiredError}
|
|
87
87
|
*/
|
|
88
88
|
listFinancialEvents(maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventsResponse>>;
|
|
89
89
|
/**
|
|
90
|
-
* Returns all financial events for the specified financial event group.
|
|
90
|
+
* Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
91
91
|
* @param {string} eventGroupId The identifier of the financial event group to which the events belong.
|
|
92
|
-
* @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
|
|
93
|
-
* @param {string} [postedAfter]
|
|
94
|
-
* @param {string} [postedBefore]
|
|
95
|
-
* @param {string} [nextToken]
|
|
92
|
+
* @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 API responds with \'InvalidInput\'.
|
|
93
|
+
* @param {string} [postedAfter] 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.
|
|
94
|
+
* @param {string} [postedBefore] 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.
|
|
95
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
96
96
|
* @param {*} [options] Override http request option.
|
|
97
97
|
* @throws {RequiredError}
|
|
98
98
|
*/
|
|
99
99
|
listFinancialEventsByGroupId(eventGroupId: string, maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventsResponse>>;
|
|
100
100
|
/**
|
|
101
|
-
* Returns all financial events for the specified order.
|
|
101
|
+
* Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
102
102
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
103
|
-
* @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
|
|
104
|
-
* @param {string} [nextToken]
|
|
103
|
+
* @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 API responds with \'InvalidInput\'.
|
|
104
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
105
105
|
* @param {*} [options] Override http request option.
|
|
106
106
|
* @throws {RequiredError}
|
|
107
107
|
*/
|
|
@@ -113,28 +113,28 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
113
113
|
*/
|
|
114
114
|
export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
115
115
|
/**
|
|
116
|
-
* Returns financial event groups for a given date range.
|
|
116
|
+
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
117
117
|
* @param {DefaultApiListFinancialEventGroupsRequest} requestParameters Request parameters.
|
|
118
118
|
* @param {*} [options] Override http request option.
|
|
119
119
|
* @throws {RequiredError}
|
|
120
120
|
*/
|
|
121
121
|
listFinancialEventGroups(requestParameters?: DefaultApiListFinancialEventGroupsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventGroupsResponse>;
|
|
122
122
|
/**
|
|
123
|
-
* Returns financial events for the specified data range.
|
|
123
|
+
* Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
124
124
|
* @param {DefaultApiListFinancialEventsRequest} requestParameters Request parameters.
|
|
125
125
|
* @param {*} [options] Override http request option.
|
|
126
126
|
* @throws {RequiredError}
|
|
127
127
|
*/
|
|
128
128
|
listFinancialEvents(requestParameters?: DefaultApiListFinancialEventsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventsResponse>;
|
|
129
129
|
/**
|
|
130
|
-
* Returns all financial events for the specified financial event group.
|
|
130
|
+
* Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
131
131
|
* @param {DefaultApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
|
|
132
132
|
* @param {*} [options] Override http request option.
|
|
133
133
|
* @throws {RequiredError}
|
|
134
134
|
*/
|
|
135
135
|
listFinancialEventsByGroupId(requestParameters: DefaultApiListFinancialEventsByGroupIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventsResponse>;
|
|
136
136
|
/**
|
|
137
|
-
* Returns all financial events for the specified order.
|
|
137
|
+
* Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
138
138
|
* @param {DefaultApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
|
|
139
139
|
* @param {*} [options] Override http request option.
|
|
140
140
|
* @throws {RequiredError}
|
|
@@ -148,25 +148,25 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
148
148
|
*/
|
|
149
149
|
export interface DefaultApiListFinancialEventGroupsRequest {
|
|
150
150
|
/**
|
|
151
|
-
* The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the
|
|
151
|
+
* 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
152
|
* @type {number}
|
|
153
153
|
* @memberof DefaultApiListFinancialEventGroups
|
|
154
154
|
*/
|
|
155
155
|
readonly maxResultsPerPage?: number;
|
|
156
156
|
/**
|
|
157
|
-
* A date
|
|
157
|
+
* 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
158
|
* @type {string}
|
|
159
159
|
* @memberof DefaultApiListFinancialEventGroups
|
|
160
160
|
*/
|
|
161
161
|
readonly financialEventGroupStartedBefore?: string;
|
|
162
162
|
/**
|
|
163
|
-
* A date
|
|
163
|
+
* 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
164
|
* @type {string}
|
|
165
165
|
* @memberof DefaultApiListFinancialEventGroups
|
|
166
166
|
*/
|
|
167
167
|
readonly financialEventGroupStartedAfter?: string;
|
|
168
168
|
/**
|
|
169
|
-
*
|
|
169
|
+
* A string token returned in the response of your previous request.
|
|
170
170
|
* @type {string}
|
|
171
171
|
* @memberof DefaultApiListFinancialEventGroups
|
|
172
172
|
*/
|
|
@@ -179,25 +179,25 @@ export interface DefaultApiListFinancialEventGroupsRequest {
|
|
|
179
179
|
*/
|
|
180
180
|
export interface DefaultApiListFinancialEventsRequest {
|
|
181
181
|
/**
|
|
182
|
-
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the
|
|
182
|
+
* 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
183
|
* @type {number}
|
|
184
184
|
* @memberof DefaultApiListFinancialEvents
|
|
185
185
|
*/
|
|
186
186
|
readonly maxResultsPerPage?: number;
|
|
187
187
|
/**
|
|
188
|
-
*
|
|
188
|
+
* 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
189
|
* @type {string}
|
|
190
190
|
* @memberof DefaultApiListFinancialEvents
|
|
191
191
|
*/
|
|
192
192
|
readonly postedAfter?: string;
|
|
193
193
|
/**
|
|
194
|
-
*
|
|
194
|
+
* 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
195
|
* @type {string}
|
|
196
196
|
* @memberof DefaultApiListFinancialEvents
|
|
197
197
|
*/
|
|
198
198
|
readonly postedBefore?: string;
|
|
199
199
|
/**
|
|
200
|
-
*
|
|
200
|
+
* A string token returned in the response of your previous request.
|
|
201
201
|
* @type {string}
|
|
202
202
|
* @memberof DefaultApiListFinancialEvents
|
|
203
203
|
*/
|
|
@@ -216,25 +216,25 @@ export interface DefaultApiListFinancialEventsByGroupIdRequest {
|
|
|
216
216
|
*/
|
|
217
217
|
readonly eventGroupId: string;
|
|
218
218
|
/**
|
|
219
|
-
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the
|
|
219
|
+
* 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
220
|
* @type {number}
|
|
221
221
|
* @memberof DefaultApiListFinancialEventsByGroupId
|
|
222
222
|
*/
|
|
223
223
|
readonly maxResultsPerPage?: number;
|
|
224
224
|
/**
|
|
225
|
-
*
|
|
225
|
+
* 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
226
|
* @type {string}
|
|
227
227
|
* @memberof DefaultApiListFinancialEventsByGroupId
|
|
228
228
|
*/
|
|
229
229
|
readonly postedAfter?: string;
|
|
230
230
|
/**
|
|
231
|
-
*
|
|
231
|
+
* 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
232
|
* @type {string}
|
|
233
233
|
* @memberof DefaultApiListFinancialEventsByGroupId
|
|
234
234
|
*/
|
|
235
235
|
readonly postedBefore?: string;
|
|
236
236
|
/**
|
|
237
|
-
*
|
|
237
|
+
* A string token returned in the response of your previous request.
|
|
238
238
|
* @type {string}
|
|
239
239
|
* @memberof DefaultApiListFinancialEventsByGroupId
|
|
240
240
|
*/
|
|
@@ -253,13 +253,13 @@ export interface DefaultApiListFinancialEventsByOrderIdRequest {
|
|
|
253
253
|
*/
|
|
254
254
|
readonly orderId: string;
|
|
255
255
|
/**
|
|
256
|
-
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the
|
|
256
|
+
* 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
257
|
* @type {number}
|
|
258
258
|
* @memberof DefaultApiListFinancialEventsByOrderId
|
|
259
259
|
*/
|
|
260
260
|
readonly maxResultsPerPage?: number;
|
|
261
261
|
/**
|
|
262
|
-
*
|
|
262
|
+
* A string token returned in the response of your previous request.
|
|
263
263
|
* @type {string}
|
|
264
264
|
* @memberof DefaultApiListFinancialEventsByOrderId
|
|
265
265
|
*/
|
|
@@ -273,7 +273,7 @@ export interface DefaultApiListFinancialEventsByOrderIdRequest {
|
|
|
273
273
|
*/
|
|
274
274
|
export declare class DefaultApi extends BaseAPI {
|
|
275
275
|
/**
|
|
276
|
-
* Returns financial event groups for a given date range.
|
|
276
|
+
* Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
277
277
|
* @param {DefaultApiListFinancialEventGroupsRequest} requestParameters Request parameters.
|
|
278
278
|
* @param {*} [options] Override http request option.
|
|
279
279
|
* @throws {RequiredError}
|
|
@@ -281,7 +281,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
281
281
|
*/
|
|
282
282
|
listFinancialEventGroups(requestParameters?: DefaultApiListFinancialEventGroupsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFinancialEventGroupsResponse, any>>;
|
|
283
283
|
/**
|
|
284
|
-
* Returns financial events for the specified data range.
|
|
284
|
+
* Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until in 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
285
285
|
* @param {DefaultApiListFinancialEventsRequest} requestParameters Request parameters.
|
|
286
286
|
* @param {*} [options] Override http request option.
|
|
287
287
|
* @throws {RequiredError}
|
|
@@ -289,7 +289,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
289
289
|
*/
|
|
290
290
|
listFinancialEvents(requestParameters?: DefaultApiListFinancialEventsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFinancialEventsResponse, any>>;
|
|
291
291
|
/**
|
|
292
|
-
* Returns all financial events for the specified financial event group.
|
|
292
|
+
* Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
293
293
|
* @param {DefaultApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
|
|
294
294
|
* @param {*} [options] Override http request option.
|
|
295
295
|
* @throws {RequiredError}
|
|
@@ -297,7 +297,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
297
297
|
*/
|
|
298
298
|
listFinancialEventsByGroupId(requestParameters: DefaultApiListFinancialEventsByGroupIdRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFinancialEventsResponse, any>>;
|
|
299
299
|
/**
|
|
300
|
-
* Returns all financial events for the specified order.
|
|
300
|
+
* Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
301
301
|
* @param {DefaultApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
|
|
302
302
|
* @param {*} [options] Override http request option.
|
|
303
303
|
* @throws {RequiredError}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Finances
|
|
3
|
-
* 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, 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.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Finances
|
|
3
|
-
* 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, 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.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Finances
|
|
3
|
-
* 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, 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.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Finances
|
|
3
|
-
* 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, 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.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Finances
|
|
3
|
-
* 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, 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.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Finances
|
|
3
|
-
* 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, 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.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -17,13 +17,13 @@ import type { Currency } from './currency';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface AdhocDisbursementEvent {
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* Indicates the type of transaction. Example: \"Disbursed to Amazon Gift Card balance\"
|
|
21
21
|
* @type {string}
|
|
22
22
|
* @memberof AdhocDisbursementEvent
|
|
23
23
|
*/
|
|
24
24
|
'TransactionType'?: string;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
|
|
27
27
|
* @type {string}
|
|
28
28
|
* @memberof AdhocDisbursementEvent
|
|
29
29
|
*/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Finances
|
|
3
|
-
* 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, 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.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -18,13 +18,13 @@ import type { Currency } from './currency';
|
|
|
18
18
|
*/
|
|
19
19
|
export interface AdjustmentEvent {
|
|
20
20
|
/**
|
|
21
|
-
* The type of adjustment. Possible values: *
|
|
21
|
+
* 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
22
|
* @type {string}
|
|
23
23
|
* @memberof AdjustmentEvent
|
|
24
24
|
*/
|
|
25
25
|
'AdjustmentType'?: string;
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
|
|
28
28
|
* @type {string}
|
|
29
29
|
* @memberof AdjustmentEvent
|
|
30
30
|
*/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Finances
|
|
3
|
-
* 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, 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.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -17,7 +17,7 @@ import type { Currency } from './currency';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface AdjustmentItem {
|
|
19
19
|
/**
|
|
20
|
-
* Represents the number of units in the seller\'s inventory when the
|
|
20
|
+
* Represents the number of units in the seller\'s inventory when the AdustmentType is FBAInventoryReimbursement.
|
|
21
21
|
* @type {string}
|
|
22
22
|
* @memberof AdjustmentItem
|
|
23
23
|
*/
|
|
@@ -58,4 +58,10 @@ export interface AdjustmentItem {
|
|
|
58
58
|
* @memberof AdjustmentItem
|
|
59
59
|
*/
|
|
60
60
|
'ASIN'?: string;
|
|
61
|
+
/**
|
|
62
|
+
* The transaction number that is related to the adjustment.
|
|
63
|
+
* @type {string}
|
|
64
|
+
* @memberof AdjustmentItem
|
|
65
|
+
*/
|
|
66
|
+
'TransactionNumber'?: string;
|
|
61
67
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Finances
|
|
3
|
-
* 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, 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.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -23,19 +23,19 @@ export interface AffordabilityExpenseEvent {
|
|
|
23
23
|
*/
|
|
24
24
|
'AmazonOrderId'?: string;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
|
|
27
27
|
* @type {string}
|
|
28
28
|
* @memberof AffordabilityExpenseEvent
|
|
29
29
|
*/
|
|
30
30
|
'PostedDate'?: string;
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
32
|
+
* An encrypted, Amazon-defined marketplace identifier.
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof AffordabilityExpenseEvent
|
|
35
35
|
*/
|
|
36
36
|
'MarketplaceId'?: string;
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* Indicates the type of transaction. Possible values: * Charge - For an affordability promotion expense. * Refund - For an affordability promotion expense reversal.
|
|
39
39
|
* @type {string}
|
|
40
40
|
* @memberof AffordabilityExpenseEvent
|
|
41
41
|
*/
|