@sp-api-sdk/finances-api-v0 4.0.6 → 4.2.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/finances-api.js +49 -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 +13 -2
- 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/ebtrefund-reimbursement-only-event.js +15 -0
- 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/index.js +1 -0
- 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/cjs/index.js +0 -1
- package/dist/es/api-model/api/finances-api.js +49 -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 +13 -2
- 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/ebtrefund-reimbursement-only-event.js +14 -0
- 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/index.js +1 -0
- 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/es/index.js +0 -1
- package/dist/types/api-model/api/finances-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 +25 -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 +2 -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/ebtrefund-reimbursement-only-event.d.ts +26 -0
- 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 +13 -8
- package/dist/types/api-model/models/imaging-services-fee-event.d.ts +2 -2
- package/dist/types/api-model/models/index.d.ts +1 -0
- 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/dist/types/index.d.ts +1 -1
- package/package.json +5 -5
|
@@ -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 provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -20,41 +20,41 @@ import type { ListFinancialEventsResponse } from '../models';
|
|
|
20
20
|
*/
|
|
21
21
|
export declare const FinancesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
22
|
/**
|
|
23
|
-
* Returns financial event groups for a given date range.
|
|
24
|
-
* @param {number} [maxResultsPerPage] The maximum number of results
|
|
25
|
-
* @param {string} [financialEventGroupStartedBefore] A date
|
|
26
|
-
* @param {string} [financialEventGroupStartedAfter] A date
|
|
27
|
-
* @param {string} [nextToken]
|
|
23
|
+
* Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
24
|
+
* @param {number} [maxResultsPerPage] The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
25
|
+
* @param {string} [financialEventGroupStartedBefore] A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned.
|
|
26
|
+
* @param {string} [financialEventGroupStartedAfter] A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request.
|
|
27
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
28
28
|
* @param {*} [options] Override http request option.
|
|
29
29
|
* @throws {RequiredError}
|
|
30
30
|
*/
|
|
31
31
|
listFinancialEventGroups: (maxResultsPerPage?: number, financialEventGroupStartedBefore?: string, financialEventGroupStartedAfter?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
32
|
/**
|
|
33
|
-
* Returns financial events for the specified data range.
|
|
34
|
-
* @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
|
|
35
|
-
* @param {string} [postedAfter]
|
|
36
|
-
* @param {string} [postedBefore]
|
|
37
|
-
* @param {string} [nextToken]
|
|
33
|
+
* Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
34
|
+
* @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
35
|
+
* @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
|
|
36
|
+
* @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
|
|
37
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
38
38
|
* @param {*} [options] Override http request option.
|
|
39
39
|
* @throws {RequiredError}
|
|
40
40
|
*/
|
|
41
41
|
listFinancialEvents: (maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
42
|
/**
|
|
43
|
-
* Returns all financial events for the specified financial event group.
|
|
43
|
+
* Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
44
44
|
* @param {string} eventGroupId The identifier of the financial event group to which the events belong.
|
|
45
|
-
* @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
|
|
46
|
-
* @param {string} [postedAfter]
|
|
47
|
-
* @param {string} [postedBefore]
|
|
48
|
-
* @param {string} [nextToken]
|
|
45
|
+
* @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
46
|
+
* @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
|
|
47
|
+
* @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
|
|
48
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
49
49
|
* @param {*} [options] Override http request option.
|
|
50
50
|
* @throws {RequiredError}
|
|
51
51
|
*/
|
|
52
52
|
listFinancialEventsByGroupId: (eventGroupId: string, maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
53
|
/**
|
|
54
|
-
* Returns all financial events for the specified order.
|
|
54
|
+
* Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
55
55
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
56
|
-
* @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
|
|
57
|
-
* @param {string} [nextToken]
|
|
56
|
+
* @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
57
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
58
58
|
* @param {*} [options] Override http request option.
|
|
59
59
|
* @throws {RequiredError}
|
|
60
60
|
*/
|
|
@@ -65,41 +65,41 @@ export declare const FinancesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
65
65
|
*/
|
|
66
66
|
export declare const FinancesApiFp: (configuration?: Configuration) => {
|
|
67
67
|
/**
|
|
68
|
-
* Returns financial event groups for a given date range.
|
|
69
|
-
* @param {number} [maxResultsPerPage] The maximum number of results
|
|
70
|
-
* @param {string} [financialEventGroupStartedBefore] A date
|
|
71
|
-
* @param {string} [financialEventGroupStartedAfter] A date
|
|
72
|
-
* @param {string} [nextToken]
|
|
68
|
+
* Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
69
|
+
* @param {number} [maxResultsPerPage] The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
70
|
+
* @param {string} [financialEventGroupStartedBefore] A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned.
|
|
71
|
+
* @param {string} [financialEventGroupStartedAfter] A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request.
|
|
72
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
73
73
|
* @param {*} [options] Override http request option.
|
|
74
74
|
* @throws {RequiredError}
|
|
75
75
|
*/
|
|
76
76
|
listFinancialEventGroups(maxResultsPerPage?: number, financialEventGroupStartedBefore?: string, financialEventGroupStartedAfter?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventGroupsResponse>>;
|
|
77
77
|
/**
|
|
78
|
-
* Returns financial events for the specified data range.
|
|
79
|
-
* @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
|
|
80
|
-
* @param {string} [postedAfter]
|
|
81
|
-
* @param {string} [postedBefore]
|
|
82
|
-
* @param {string} [nextToken]
|
|
78
|
+
* Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
79
|
+
* @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
80
|
+
* @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
|
|
81
|
+
* @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
|
|
82
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
83
83
|
* @param {*} [options] Override http request option.
|
|
84
84
|
* @throws {RequiredError}
|
|
85
85
|
*/
|
|
86
86
|
listFinancialEvents(maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventsResponse>>;
|
|
87
87
|
/**
|
|
88
|
-
* Returns all financial events for the specified financial event group.
|
|
88
|
+
* Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
89
89
|
* @param {string} eventGroupId The identifier of the financial event group to which the events belong.
|
|
90
|
-
* @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
|
|
91
|
-
* @param {string} [postedAfter]
|
|
92
|
-
* @param {string} [postedBefore]
|
|
93
|
-
* @param {string} [nextToken]
|
|
90
|
+
* @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
91
|
+
* @param {string} [postedAfter] The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
|
|
92
|
+
* @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
|
|
93
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
94
94
|
* @param {*} [options] Override http request option.
|
|
95
95
|
* @throws {RequiredError}
|
|
96
96
|
*/
|
|
97
97
|
listFinancialEventsByGroupId(eventGroupId: string, maxResultsPerPage?: number, postedAfter?: string, postedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventsResponse>>;
|
|
98
98
|
/**
|
|
99
|
-
* Returns all financial events for the specified order.
|
|
99
|
+
* Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
100
100
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
101
|
-
* @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
|
|
102
|
-
* @param {string} [nextToken]
|
|
101
|
+
* @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
102
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
103
103
|
* @param {*} [options] Override http request option.
|
|
104
104
|
* @throws {RequiredError}
|
|
105
105
|
*/
|
|
@@ -110,28 +110,28 @@ export declare const FinancesApiFp: (configuration?: Configuration) => {
|
|
|
110
110
|
*/
|
|
111
111
|
export declare const FinancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
112
112
|
/**
|
|
113
|
-
* Returns financial event groups for a given date range.
|
|
113
|
+
* Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
114
114
|
* @param {FinancesApiListFinancialEventGroupsRequest} requestParameters Request parameters.
|
|
115
115
|
* @param {*} [options] Override http request option.
|
|
116
116
|
* @throws {RequiredError}
|
|
117
117
|
*/
|
|
118
118
|
listFinancialEventGroups(requestParameters?: FinancesApiListFinancialEventGroupsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventGroupsResponse>;
|
|
119
119
|
/**
|
|
120
|
-
* Returns financial events for the specified data range.
|
|
120
|
+
* Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
121
121
|
* @param {FinancesApiListFinancialEventsRequest} requestParameters Request parameters.
|
|
122
122
|
* @param {*} [options] Override http request option.
|
|
123
123
|
* @throws {RequiredError}
|
|
124
124
|
*/
|
|
125
125
|
listFinancialEvents(requestParameters?: FinancesApiListFinancialEventsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventsResponse>;
|
|
126
126
|
/**
|
|
127
|
-
* Returns all financial events for the specified financial event group.
|
|
127
|
+
* Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
128
128
|
* @param {FinancesApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
|
|
129
129
|
* @param {*} [options] Override http request option.
|
|
130
130
|
* @throws {RequiredError}
|
|
131
131
|
*/
|
|
132
132
|
listFinancialEventsByGroupId(requestParameters: FinancesApiListFinancialEventsByGroupIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFinancialEventsResponse>;
|
|
133
133
|
/**
|
|
134
|
-
* Returns all financial events for the specified order.
|
|
134
|
+
* Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
135
135
|
* @param {FinancesApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
|
|
136
136
|
* @param {*} [options] Override http request option.
|
|
137
137
|
* @throws {RequiredError}
|
|
@@ -143,19 +143,19 @@ export declare const FinancesApiFactory: (configuration?: Configuration, basePat
|
|
|
143
143
|
*/
|
|
144
144
|
export interface FinancesApiListFinancialEventGroupsRequest {
|
|
145
145
|
/**
|
|
146
|
-
* The maximum number of results
|
|
146
|
+
* The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
147
147
|
*/
|
|
148
148
|
readonly maxResultsPerPage?: number;
|
|
149
149
|
/**
|
|
150
|
-
* A date
|
|
150
|
+
* A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned.
|
|
151
151
|
*/
|
|
152
152
|
readonly financialEventGroupStartedBefore?: string;
|
|
153
153
|
/**
|
|
154
|
-
* A date
|
|
154
|
+
* A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request.
|
|
155
155
|
*/
|
|
156
156
|
readonly financialEventGroupStartedAfter?: string;
|
|
157
157
|
/**
|
|
158
|
-
*
|
|
158
|
+
* The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
159
159
|
*/
|
|
160
160
|
readonly nextToken?: string;
|
|
161
161
|
}
|
|
@@ -164,19 +164,19 @@ export interface FinancesApiListFinancialEventGroupsRequest {
|
|
|
164
164
|
*/
|
|
165
165
|
export interface FinancesApiListFinancialEventsRequest {
|
|
166
166
|
/**
|
|
167
|
-
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the
|
|
167
|
+
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
168
168
|
*/
|
|
169
169
|
readonly maxResultsPerPage?: number;
|
|
170
170
|
/**
|
|
171
|
-
*
|
|
171
|
+
* The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
|
|
172
172
|
*/
|
|
173
173
|
readonly postedAfter?: string;
|
|
174
174
|
/**
|
|
175
|
-
*
|
|
175
|
+
* The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
|
|
176
176
|
*/
|
|
177
177
|
readonly postedBefore?: string;
|
|
178
178
|
/**
|
|
179
|
-
*
|
|
179
|
+
* The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
180
180
|
*/
|
|
181
181
|
readonly nextToken?: string;
|
|
182
182
|
}
|
|
@@ -189,19 +189,19 @@ export interface FinancesApiListFinancialEventsByGroupIdRequest {
|
|
|
189
189
|
*/
|
|
190
190
|
readonly eventGroupId: string;
|
|
191
191
|
/**
|
|
192
|
-
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the
|
|
192
|
+
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
193
193
|
*/
|
|
194
194
|
readonly maxResultsPerPage?: number;
|
|
195
195
|
/**
|
|
196
|
-
*
|
|
196
|
+
* The response includes financial events posted after (or on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request.
|
|
197
197
|
*/
|
|
198
198
|
readonly postedAfter?: string;
|
|
199
199
|
/**
|
|
200
|
-
*
|
|
200
|
+
* The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
|
|
201
201
|
*/
|
|
202
202
|
readonly postedBefore?: string;
|
|
203
203
|
/**
|
|
204
|
-
*
|
|
204
|
+
* The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
205
205
|
*/
|
|
206
206
|
readonly nextToken?: string;
|
|
207
207
|
}
|
|
@@ -214,11 +214,11 @@ export interface FinancesApiListFinancialEventsByOrderIdRequest {
|
|
|
214
214
|
*/
|
|
215
215
|
readonly orderId: string;
|
|
216
216
|
/**
|
|
217
|
-
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the
|
|
217
|
+
* The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
218
218
|
*/
|
|
219
219
|
readonly maxResultsPerPage?: number;
|
|
220
220
|
/**
|
|
221
|
-
*
|
|
221
|
+
* The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
222
222
|
*/
|
|
223
223
|
readonly nextToken?: string;
|
|
224
224
|
}
|
|
@@ -227,28 +227,28 @@ export interface FinancesApiListFinancialEventsByOrderIdRequest {
|
|
|
227
227
|
*/
|
|
228
228
|
export declare class FinancesApi extends BaseAPI {
|
|
229
229
|
/**
|
|
230
|
-
* Returns financial event groups for a given date range.
|
|
230
|
+
* Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
231
231
|
* @param {FinancesApiListFinancialEventGroupsRequest} requestParameters Request parameters.
|
|
232
232
|
* @param {*} [options] Override http request option.
|
|
233
233
|
* @throws {RequiredError}
|
|
234
234
|
*/
|
|
235
235
|
listFinancialEventGroups(requestParameters?: FinancesApiListFinancialEventGroupsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFinancialEventGroupsResponse, any, {}>>;
|
|
236
236
|
/**
|
|
237
|
-
* Returns financial events for the specified data range.
|
|
237
|
+
* Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
238
238
|
* @param {FinancesApiListFinancialEventsRequest} requestParameters Request parameters.
|
|
239
239
|
* @param {*} [options] Override http request option.
|
|
240
240
|
* @throws {RequiredError}
|
|
241
241
|
*/
|
|
242
242
|
listFinancialEvents(requestParameters?: FinancesApiListFinancialEventsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFinancialEventsResponse, any, {}>>;
|
|
243
243
|
/**
|
|
244
|
-
* Returns all financial events for the specified financial event group.
|
|
244
|
+
* Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
245
245
|
* @param {FinancesApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
|
|
246
246
|
* @param {*} [options] Override http request option.
|
|
247
247
|
* @throws {RequiredError}
|
|
248
248
|
*/
|
|
249
249
|
listFinancialEventsByGroupId(requestParameters: FinancesApiListFinancialEventsByGroupIdRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListFinancialEventsResponse, any, {}>>;
|
|
250
250
|
/**
|
|
251
|
-
* Returns all financial events for the specified order.
|
|
251
|
+
* Returns all financial events for the specified order. Orders from the last 48 hours might not be included in financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
252
252
|
* @param {FinancesApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
|
|
253
253
|
* @param {*} [options] Override http request option.
|
|
254
254
|
* @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 provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
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 provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
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 provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
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 provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -9,11 +9,23 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
interface AWSv4Configuration {
|
|
13
|
+
options?: {
|
|
14
|
+
region?: string;
|
|
15
|
+
service?: string;
|
|
16
|
+
};
|
|
17
|
+
credentials?: {
|
|
18
|
+
accessKeyId?: string;
|
|
19
|
+
secretAccessKey?: string;
|
|
20
|
+
sessionToken?: string;
|
|
21
|
+
};
|
|
22
|
+
}
|
|
12
23
|
export interface ConfigurationParameters {
|
|
13
24
|
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
14
25
|
username?: string;
|
|
15
26
|
password?: string;
|
|
16
27
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
28
|
+
awsv4?: AWSv4Configuration;
|
|
17
29
|
basePath?: string;
|
|
18
30
|
serverIndex?: number;
|
|
19
31
|
baseOptions?: any;
|
|
@@ -39,6 +51,17 @@ export declare class Configuration {
|
|
|
39
51
|
* @param scopes oauth2 scope
|
|
40
52
|
*/
|
|
41
53
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
54
|
+
/**
|
|
55
|
+
* parameter for aws4 signature security
|
|
56
|
+
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
57
|
+
* @param {string} options.region - aws region
|
|
58
|
+
* @param {string} options.service - name of the service.
|
|
59
|
+
* @param {string} credentials.accessKeyId - aws access key id
|
|
60
|
+
* @param {string} credentials.secretAccessKey - aws access key
|
|
61
|
+
* @param {string} credentials.sessionToken - aws session token
|
|
62
|
+
* @memberof Configuration
|
|
63
|
+
*/
|
|
64
|
+
awsv4?: AWSv4Configuration;
|
|
42
65
|
/**
|
|
43
66
|
* override base path
|
|
44
67
|
*/
|
|
@@ -72,3 +95,4 @@ export declare class Configuration {
|
|
|
72
95
|
*/
|
|
73
96
|
isJsonMime(mime: string): boolean;
|
|
74
97
|
}
|
|
98
|
+
export {};
|
|
@@ -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 provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
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 provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -15,11 +15,11 @@ import type { Currency } from './currency';
|
|
|
15
15
|
*/
|
|
16
16
|
export interface AdhocDisbursementEvent {
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
18
|
+
* The type of transaction. For example, \"Disbursed to Amazon Gift Card balance\".
|
|
19
19
|
*/
|
|
20
20
|
'TransactionType'?: string;
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
23
23
|
*/
|
|
24
24
|
'PostedDate'?: string;
|
|
25
25
|
/**
|
|
@@ -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 provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -16,11 +16,11 @@ import type { Currency } from './currency';
|
|
|
16
16
|
*/
|
|
17
17
|
export interface AdjustmentEvent {
|
|
18
18
|
/**
|
|
19
|
-
* The type of adjustment. Possible values: * FBAInventoryReimbursement
|
|
19
|
+
* The type of adjustment. Possible values: * `FBAInventoryReimbursement`: An FBA inventory reimbursement to a seller\'s account. This occurs if a seller\'s inventory is damaged. * `ReserveEvent`: A reserve event that is generated at the time a settlement period closes. This occurs when some money from a seller\'s account is held back. * `PostageBilling`: The amount paid by a seller for shipping labels. * `PostageRefund`: The reimbursement of shipping labels purchased for orders that were canceled or refunded. * `LostOrDamagedReimbursement`: An Amazon Easy Ship reimbursement to a seller\'s account for a package that we lost or damaged. * `CanceledButPickedUpReimbursement`: An Amazon Easy Ship reimbursement to a seller\'s account. This occurs when a package is picked up and the order is subsequently canceled. This value is used only in the India marketplace. * `ReimbursementClawback`: An Amazon Easy Ship reimbursement clawback from a seller\'s account. This occurs when a prior reimbursement is reversed. This value is used only in the India marketplace. * `SellerRewards`: An award credited to a seller\'s account for their participation in an offer in the Seller Rewards program. Applies only to the India marketplace.
|
|
20
20
|
*/
|
|
21
21
|
'AdjustmentType'?: string;
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
24
24
|
*/
|
|
25
25
|
'PostedDate'?: string;
|
|
26
26
|
/**
|
|
@@ -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 provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -15,7 +15,7 @@ import type { Currency } from './currency';
|
|
|
15
15
|
*/
|
|
16
16
|
export interface AdjustmentItem {
|
|
17
17
|
/**
|
|
18
|
-
* Represents the number of units in the seller\'s inventory when the
|
|
18
|
+
* Represents the number of units in the seller\'s inventory when the `AdjustmentType` is `FBAInventoryReimbursement`.
|
|
19
19
|
*/
|
|
20
20
|
'Quantity'?: string;
|
|
21
21
|
'PerUnitAmount'?: Currency;
|
|
@@ -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 provides financial information that is relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -19,15 +19,15 @@ export interface AffordabilityExpenseEvent {
|
|
|
19
19
|
*/
|
|
20
20
|
'AmazonOrderId'?: string;
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
23
23
|
*/
|
|
24
24
|
'PostedDate'?: string;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* The Amazon-defined marketplace identifier.
|
|
27
27
|
*/
|
|
28
28
|
'MarketplaceId'?: string;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* The type of transaction. Possible values: * `Charge`: an affordability promotion expense. * `Refund`: an affordability promotion expense reversal.
|
|
31
31
|
*/
|
|
32
32
|
'TransactionType'?: string;
|
|
33
33
|
'BaseExpense'?: Currency;
|