@sp-api-sdk/finances-api-v0 2.4.1 → 2.5.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/src/api-model/api/default-api.js +45 -45
- package/dist/cjs/src/api-model/api.js +1 -1
- package/dist/cjs/src/api-model/base.js +1 -1
- package/dist/cjs/src/api-model/common.js +1 -1
- package/dist/cjs/src/api-model/configuration.js +1 -1
- package/dist/cjs/src/api-model/index.js +1 -1
- package/dist/cjs/src/api-model/models/adhoc-disbursement-event.js +1 -1
- package/dist/cjs/src/api-model/models/adjustment-event.js +1 -1
- package/dist/cjs/src/api-model/models/adjustment-item.js +1 -1
- package/dist/cjs/src/api-model/models/affordability-expense-event.js +1 -1
- package/dist/cjs/src/api-model/models/capacity-reservation-billing-event.js +1 -1
- package/dist/cjs/src/api-model/models/charge-component.js +1 -1
- package/dist/cjs/src/api-model/models/charge-instrument.js +1 -1
- package/dist/cjs/src/api-model/models/charge-refund-event.js +1 -1
- package/dist/cjs/src/api-model/models/charge-refund-transaction.js +1 -1
- package/dist/cjs/src/api-model/models/coupon-payment-event.js +1 -1
- package/dist/cjs/src/api-model/models/currency.js +1 -1
- package/dist/cjs/src/api-model/models/debt-recovery-event.js +1 -1
- package/dist/cjs/src/api-model/models/debt-recovery-item.js +1 -1
- package/dist/cjs/src/api-model/models/direct-payment.js +1 -1
- package/dist/cjs/src/api-model/models/failed-adhoc-disbursement-event.js +1 -1
- package/dist/cjs/src/api-model/models/fbaliquidation-event.js +1 -1
- package/dist/cjs/src/api-model/models/fee-component.js +1 -1
- package/dist/cjs/src/api-model/models/financial-event-group.js +1 -1
- package/dist/cjs/src/api-model/models/financial-events.js +1 -1
- package/dist/cjs/src/api-model/models/imaging-services-fee-event.js +1 -1
- package/dist/cjs/src/api-model/models/list-financial-event-groups-payload.js +1 -1
- package/dist/cjs/src/api-model/models/list-financial-event-groups-response.js +1 -1
- package/dist/cjs/src/api-model/models/list-financial-events-payload.js +1 -1
- package/dist/cjs/src/api-model/models/list-financial-events-response.js +1 -1
- package/dist/cjs/src/api-model/models/loan-servicing-event.js +1 -1
- package/dist/cjs/src/api-model/models/model-error.js +1 -1
- package/dist/cjs/src/api-model/models/network-commingling-transaction-event.js +1 -1
- package/dist/cjs/src/api-model/models/pay-with-amazon-event.js +1 -1
- package/dist/cjs/src/api-model/models/product-ads-payment-event.js +1 -1
- package/dist/cjs/src/api-model/models/promotion.js +1 -1
- package/dist/cjs/src/api-model/models/removal-shipment-adjustment-event.js +1 -1
- package/dist/cjs/src/api-model/models/removal-shipment-event.js +1 -1
- package/dist/cjs/src/api-model/models/removal-shipment-item-adjustment.js +1 -1
- package/dist/cjs/src/api-model/models/removal-shipment-item.js +1 -1
- package/dist/cjs/src/api-model/models/rental-transaction-event.js +1 -1
- package/dist/cjs/src/api-model/models/retrocharge-event.js +1 -1
- package/dist/cjs/src/api-model/models/safetreimbursement-event.js +1 -1
- package/dist/cjs/src/api-model/models/safetreimbursement-item.js +1 -1
- package/dist/cjs/src/api-model/models/seller-deal-payment-event.js +1 -1
- package/dist/cjs/src/api-model/models/seller-review-enrollment-payment-event.js +1 -1
- package/dist/cjs/src/api-model/models/service-fee-event.js +1 -1
- package/dist/cjs/src/api-model/models/shipment-event.js +1 -1
- package/dist/cjs/src/api-model/models/shipment-item.js +1 -1
- package/dist/cjs/src/api-model/models/solution-provider-credit-event.js +1 -1
- package/dist/cjs/src/api-model/models/tax-withheld-component.js +1 -1
- package/dist/cjs/src/api-model/models/tax-withholding-event.js +1 -1
- package/dist/cjs/src/api-model/models/tax-withholding-period.js +1 -1
- package/dist/cjs/src/api-model/models/tdsreimbursement-event.js +1 -1
- package/dist/cjs/src/api-model/models/trial-shipment-event.js +1 -1
- package/dist/cjs/src/api-model/models/value-added-service-charge-event.js +1 -1
- package/dist/es/src/api-model/api/default-api.js +45 -45
- package/dist/es/src/api-model/api.js +1 -1
- package/dist/es/src/api-model/base.js +1 -1
- package/dist/es/src/api-model/common.js +1 -1
- package/dist/es/src/api-model/configuration.js +1 -1
- package/dist/es/src/api-model/index.js +1 -1
- package/dist/es/src/api-model/models/adhoc-disbursement-event.js +1 -1
- package/dist/es/src/api-model/models/adjustment-event.js +1 -1
- package/dist/es/src/api-model/models/adjustment-item.js +1 -1
- package/dist/es/src/api-model/models/affordability-expense-event.js +1 -1
- package/dist/es/src/api-model/models/capacity-reservation-billing-event.js +1 -1
- package/dist/es/src/api-model/models/charge-component.js +1 -1
- package/dist/es/src/api-model/models/charge-instrument.js +1 -1
- package/dist/es/src/api-model/models/charge-refund-event.js +1 -1
- package/dist/es/src/api-model/models/charge-refund-transaction.js +1 -1
- package/dist/es/src/api-model/models/coupon-payment-event.js +1 -1
- package/dist/es/src/api-model/models/currency.js +1 -1
- package/dist/es/src/api-model/models/debt-recovery-event.js +1 -1
- package/dist/es/src/api-model/models/debt-recovery-item.js +1 -1
- package/dist/es/src/api-model/models/direct-payment.js +1 -1
- package/dist/es/src/api-model/models/failed-adhoc-disbursement-event.js +1 -1
- package/dist/es/src/api-model/models/fbaliquidation-event.js +1 -1
- package/dist/es/src/api-model/models/fee-component.js +1 -1
- package/dist/es/src/api-model/models/financial-event-group.js +1 -1
- package/dist/es/src/api-model/models/financial-events.js +1 -1
- package/dist/es/src/api-model/models/imaging-services-fee-event.js +1 -1
- package/dist/es/src/api-model/models/list-financial-event-groups-payload.js +1 -1
- package/dist/es/src/api-model/models/list-financial-event-groups-response.js +1 -1
- package/dist/es/src/api-model/models/list-financial-events-payload.js +1 -1
- package/dist/es/src/api-model/models/list-financial-events-response.js +1 -1
- package/dist/es/src/api-model/models/loan-servicing-event.js +1 -1
- package/dist/es/src/api-model/models/model-error.js +1 -1
- package/dist/es/src/api-model/models/network-commingling-transaction-event.js +1 -1
- package/dist/es/src/api-model/models/pay-with-amazon-event.js +1 -1
- package/dist/es/src/api-model/models/product-ads-payment-event.js +1 -1
- package/dist/es/src/api-model/models/promotion.js +1 -1
- package/dist/es/src/api-model/models/removal-shipment-adjustment-event.js +1 -1
- package/dist/es/src/api-model/models/removal-shipment-event.js +1 -1
- package/dist/es/src/api-model/models/removal-shipment-item-adjustment.js +1 -1
- package/dist/es/src/api-model/models/removal-shipment-item.js +1 -1
- package/dist/es/src/api-model/models/rental-transaction-event.js +1 -1
- package/dist/es/src/api-model/models/retrocharge-event.js +1 -1
- package/dist/es/src/api-model/models/safetreimbursement-event.js +1 -1
- package/dist/es/src/api-model/models/safetreimbursement-item.js +1 -1
- package/dist/es/src/api-model/models/seller-deal-payment-event.js +1 -1
- package/dist/es/src/api-model/models/seller-review-enrollment-payment-event.js +1 -1
- package/dist/es/src/api-model/models/service-fee-event.js +1 -1
- package/dist/es/src/api-model/models/shipment-event.js +1 -1
- package/dist/es/src/api-model/models/shipment-item.js +1 -1
- package/dist/es/src/api-model/models/solution-provider-credit-event.js +1 -1
- package/dist/es/src/api-model/models/tax-withheld-component.js +1 -1
- package/dist/es/src/api-model/models/tax-withholding-event.js +1 -1
- package/dist/es/src/api-model/models/tax-withholding-period.js +1 -1
- package/dist/es/src/api-model/models/tdsreimbursement-event.js +1 -1
- package/dist/es/src/api-model/models/trial-shipment-event.js +1 -1
- package/dist/es/src/api-model/models/value-added-service-charge-event.js +1 -1
- package/dist/types/src/api-model/api/default-api.d.ts +59 -59
- package/dist/types/src/api-model/api.d.ts +1 -1
- package/dist/types/src/api-model/base.d.ts +1 -1
- package/dist/types/src/api-model/common.d.ts +1 -1
- package/dist/types/src/api-model/configuration.d.ts +1 -1
- package/dist/types/src/api-model/index.d.ts +1 -1
- package/dist/types/src/api-model/models/adhoc-disbursement-event.d.ts +3 -3
- package/dist/types/src/api-model/models/adjustment-event.d.ts +3 -3
- package/dist/types/src/api-model/models/adjustment-item.d.ts +2 -2
- package/dist/types/src/api-model/models/affordability-expense-event.d.ts +4 -4
- package/dist/types/src/api-model/models/capacity-reservation-billing-event.d.ts +3 -3
- package/dist/types/src/api-model/models/charge-component.d.ts +2 -2
- package/dist/types/src/api-model/models/charge-instrument.d.ts +1 -1
- package/dist/types/src/api-model/models/charge-refund-event.d.ts +4 -4
- package/dist/types/src/api-model/models/charge-refund-transaction.d.ts +1 -1
- package/dist/types/src/api-model/models/coupon-payment-event.d.ts +2 -2
- package/dist/types/src/api-model/models/currency.d.ts +2 -2
- package/dist/types/src/api-model/models/debt-recovery-event.d.ts +2 -2
- package/dist/types/src/api-model/models/debt-recovery-item.d.ts +3 -3
- package/dist/types/src/api-model/models/direct-payment.d.ts +2 -2
- package/dist/types/src/api-model/models/failed-adhoc-disbursement-event.d.ts +5 -5
- package/dist/types/src/api-model/models/fbaliquidation-event.d.ts +2 -2
- package/dist/types/src/api-model/models/fee-component.d.ts +1 -1
- package/dist/types/src/api-model/models/financial-event-group.d.ts +5 -5
- package/dist/types/src/api-model/models/financial-events.d.ts +8 -8
- package/dist/types/src/api-model/models/imaging-services-fee-event.d.ts +2 -2
- package/dist/types/src/api-model/models/list-financial-event-groups-payload.d.ts +2 -2
- package/dist/types/src/api-model/models/list-financial-event-groups-response.d.ts +2 -2
- package/dist/types/src/api-model/models/list-financial-events-payload.d.ts +2 -2
- package/dist/types/src/api-model/models/list-financial-events-response.d.ts +2 -2
- package/dist/types/src/api-model/models/loan-servicing-event.d.ts +2 -2
- package/dist/types/src/api-model/models/model-error.d.ts +1 -1
- package/dist/types/src/api-model/models/network-commingling-transaction-event.d.ts +3 -3
- package/dist/types/src/api-model/models/pay-with-amazon-event.d.ts +5 -5
- package/dist/types/src/api-model/models/product-ads-payment-event.d.ts +4 -4
- package/dist/types/src/api-model/models/promotion.d.ts +1 -1
- package/dist/types/src/api-model/models/removal-shipment-adjustment-event.d.ts +4 -4
- package/dist/types/src/api-model/models/removal-shipment-event.d.ts +11 -5
- package/dist/types/src/api-model/models/removal-shipment-item-adjustment.d.ts +3 -3
- package/dist/types/src/api-model/models/removal-shipment-item.d.ts +2 -2
- package/dist/types/src/api-model/models/rental-transaction-event.d.ts +4 -4
- package/dist/types/src/api-model/models/retrocharge-event.d.ts +3 -3
- package/dist/types/src/api-model/models/safetreimbursement-event.d.ts +3 -3
- package/dist/types/src/api-model/models/safetreimbursement-item.d.ts +1 -1
- package/dist/types/src/api-model/models/seller-deal-payment-event.d.ts +4 -4
- package/dist/types/src/api-model/models/seller-review-enrollment-payment-event.d.ts +2 -2
- package/dist/types/src/api-model/models/service-fee-event.d.ts +7 -1
- package/dist/types/src/api-model/models/shipment-event.d.ts +8 -2
- package/dist/types/src/api-model/models/shipment-item.d.ts +1 -1
- package/dist/types/src/api-model/models/solution-provider-credit-event.d.ts +2 -2
- package/dist/types/src/api-model/models/tax-withheld-component.d.ts +2 -2
- package/dist/types/src/api-model/models/tax-withholding-event.d.ts +3 -3
- package/dist/types/src/api-model/models/tax-withholding-period.d.ts +4 -4
- package/dist/types/src/api-model/models/tdsreimbursement-event.d.ts +2 -2
- package/dist/types/src/api-model/models/trial-shipment-event.d.ts +2 -2
- package/dist/types/src/api-model/models/value-added-service-charge-event.d.ts +3 -3
- 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
|
*
|
|
@@ -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
|
|
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. 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).
|
|
25
|
+
* @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`.
|
|
26
|
+
* @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.
|
|
27
|
+
* @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.
|
|
28
|
+
* @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.
|
|
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. 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 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 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).
|
|
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 response is `InvalidInput`.
|
|
36
|
+
* @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.
|
|
37
|
+
* @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.
|
|
38
|
+
* @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.
|
|
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. 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).
|
|
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 response is `InvalidInput`.
|
|
47
|
+
* @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.
|
|
48
|
+
* @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 requestd 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.
|
|
49
|
+
* @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.
|
|
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. 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).
|
|
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 response is `InvalidInput`.
|
|
58
|
+
* @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.
|
|
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
|
|
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. 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).
|
|
71
|
+
* @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`.
|
|
72
|
+
* @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.
|
|
73
|
+
* @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.
|
|
74
|
+
* @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.
|
|
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. 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 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 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).
|
|
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 response is `InvalidInput`.
|
|
82
|
+
* @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.
|
|
83
|
+
* @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.
|
|
84
|
+
* @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.
|
|
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. 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).
|
|
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 response is `InvalidInput`.
|
|
93
|
+
* @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.
|
|
94
|
+
* @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 requestd 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.
|
|
95
|
+
* @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.
|
|
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. 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).
|
|
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 response is `InvalidInput`.
|
|
104
|
+
* @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.
|
|
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. 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).
|
|
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. 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 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 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).
|
|
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. 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).
|
|
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. 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).
|
|
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
|
|
151
|
+
* The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
|
|
152
152
|
* @type {number}
|
|
153
153
|
* @memberof DefaultApiListFinancialEventGroups
|
|
154
154
|
*/
|
|
155
155
|
readonly maxResultsPerPage?: number;
|
|
156
156
|
/**
|
|
157
|
-
* A date
|
|
157
|
+
* 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.
|
|
158
158
|
* @type {string}
|
|
159
159
|
* @memberof DefaultApiListFinancialEventGroups
|
|
160
160
|
*/
|
|
161
161
|
readonly financialEventGroupStartedBefore?: string;
|
|
162
162
|
/**
|
|
163
|
-
* A date
|
|
163
|
+
* 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.
|
|
164
164
|
* @type {string}
|
|
165
165
|
* @memberof DefaultApiListFinancialEventGroups
|
|
166
166
|
*/
|
|
167
167
|
readonly financialEventGroupStartedAfter?: string;
|
|
168
168
|
/**
|
|
169
|
-
*
|
|
169
|
+
* 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.
|
|
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 response is `InvalidInput`.
|
|
183
183
|
* @type {number}
|
|
184
184
|
* @memberof DefaultApiListFinancialEvents
|
|
185
185
|
*/
|
|
186
186
|
readonly maxResultsPerPage?: number;
|
|
187
187
|
/**
|
|
188
|
-
*
|
|
188
|
+
* 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.
|
|
189
189
|
* @type {string}
|
|
190
190
|
* @memberof DefaultApiListFinancialEvents
|
|
191
191
|
*/
|
|
192
192
|
readonly postedAfter?: string;
|
|
193
193
|
/**
|
|
194
|
-
*
|
|
194
|
+
* 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.
|
|
195
195
|
* @type {string}
|
|
196
196
|
* @memberof DefaultApiListFinancialEvents
|
|
197
197
|
*/
|
|
198
198
|
readonly postedBefore?: string;
|
|
199
199
|
/**
|
|
200
|
-
*
|
|
200
|
+
* 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.
|
|
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 response is `InvalidInput`.
|
|
220
220
|
* @type {number}
|
|
221
221
|
* @memberof DefaultApiListFinancialEventsByGroupId
|
|
222
222
|
*/
|
|
223
223
|
readonly maxResultsPerPage?: number;
|
|
224
224
|
/**
|
|
225
|
-
*
|
|
225
|
+
* 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.
|
|
226
226
|
* @type {string}
|
|
227
227
|
* @memberof DefaultApiListFinancialEventsByGroupId
|
|
228
228
|
*/
|
|
229
229
|
readonly postedAfter?: string;
|
|
230
230
|
/**
|
|
231
|
-
*
|
|
231
|
+
* 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 requestd 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.
|
|
232
232
|
* @type {string}
|
|
233
233
|
* @memberof DefaultApiListFinancialEventsByGroupId
|
|
234
234
|
*/
|
|
235
235
|
readonly postedBefore?: string;
|
|
236
236
|
/**
|
|
237
|
-
*
|
|
237
|
+
* 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.
|
|
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 response is `InvalidInput`.
|
|
257
257
|
* @type {number}
|
|
258
258
|
* @memberof DefaultApiListFinancialEventsByOrderId
|
|
259
259
|
*/
|
|
260
260
|
readonly maxResultsPerPage?: number;
|
|
261
261
|
/**
|
|
262
|
-
*
|
|
262
|
+
* 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.
|
|
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. 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).
|
|
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. 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 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 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).
|
|
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. 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).
|
|
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. 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).
|
|
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 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
|
*
|
|
@@ -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
|
*
|
|
@@ -17,13 +17,13 @@ import type { Currency } from './currency';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface AdhocDisbursementEvent {
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* The type of transaction. For 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
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
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 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
|
*
|
|
@@ -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: * FBAInventoryReimbursement
|
|
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 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.
|
|
22
22
|
* @type {string}
|
|
23
23
|
* @memberof AdjustmentEvent
|
|
24
24
|
*/
|
|
25
25
|
'AdjustmentType'?: string;
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
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 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
|
*
|
|
@@ -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 `AdjustmentType` is `FBAInventoryReimbursement`.
|
|
21
21
|
* @type {string}
|
|
22
22
|
* @memberof AdjustmentItem
|
|
23
23
|
*/
|
|
@@ -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
|
*
|
|
@@ -23,19 +23,19 @@ export interface AffordabilityExpenseEvent {
|
|
|
23
23
|
*/
|
|
24
24
|
'AmazonOrderId'?: string;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
27
27
|
* @type {string}
|
|
28
28
|
* @memberof AffordabilityExpenseEvent
|
|
29
29
|
*/
|
|
30
30
|
'PostedDate'?: string;
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
32
|
+
* The Amazon-defined marketplace identifier.
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof AffordabilityExpenseEvent
|
|
35
35
|
*/
|
|
36
36
|
'MarketplaceId'?: string;
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* The type of transaction. Possible values: * `Charge`: an affordability promotion expense. * `Refund`: an affordability promotion expense reversal.
|
|
39
39
|
* @type {string}
|
|
40
40
|
* @memberof AffordabilityExpenseEvent
|
|
41
41
|
*/
|
|
@@ -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
|
*
|
|
@@ -17,13 +17,13 @@ import type { Currency } from './currency';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface CapacityReservationBillingEvent {
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* The transaction type. For example, FBA Inventory Fee.
|
|
21
21
|
* @type {string}
|
|
22
22
|
* @memberof CapacityReservationBillingEvent
|
|
23
23
|
*/
|
|
24
24
|
'TransactionType'?: string;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
27
27
|
* @type {string}
|
|
28
28
|
* @memberof CapacityReservationBillingEvent
|
|
29
29
|
*/
|