{ "opencollection": "1.0.0", "info": { "name": "eBay Account Advertising_eligibility Transaction API", "version": "v1.9.2" }, "items": [ { "info": { "name": "Transaction", "type": "folder" }, "items": [ { "info": { "name": "getTransactions", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/transaction", "headers": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Numerous filters are available for the getTransactions method, and these filters are discussed below. One or more of these filter types can be used. If none of these filters are used, all previous monetary transactions are returned: For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField" }, { "name": "limit", "value": "", "type": "query", "description": "The number of monetary transactions to return per page of the result set. Use this parameter in conjunction with the offset parameter to control the pagination of the output.

For example, if offset is set to 10 and limit is set to 10, the method retrieves monetary transactions 11 thru 20 from the result set.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.

Maximum: 1000
Default: 20" }, { "name": "offset", "value": "", "type": "query", "description": "This integer value indicates the actual position that the first monetary transaction returned on the current page has in the results set. So, if you wanted to view the 11th monetary transaction of the result set, you would set the offset value in the request to 10.

In the request, you can use the offset parameter in conjunction with the limit parameter to control the pagination of the output. For example, if offset is set to 30 and limit is set to 10, the method retrieves transactions 31 thru 40 from the resulting collection of transactions.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.
Default: 0 (zero)" }, { "name": "sort", "value": "", "type": "query", "description": "By default, monetary transactions that match the input criteria are sorted in descending order according to the transaction date (i.e, most recent transactions returned first).

To view transactions in ascending order instead (i.e., oldest transactions first), you would include the sort query parameter and set its value to transactionDate. Below is the proper syntax to use if filtering by a transaction date range in ascending order:

https://apiz.ebay.com/sell/finances/v1/transaction?filter=transactionDate:[2023-10-01T00:00:01.000Z..2023-10-12T00:00:01.000Z]&sort=transactionDate

Transactions can only be sorted according to transaction date. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:SortField" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "

Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU" }, { "info": { "name": "getTransactionSummary", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/transaction_summary", "headers": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Numerous filters are available for the getTransactionSummary method, and these filters are discussed below. One or more of these filter types can be used. The transactionStatus filter must be used. All other filters are optional.

For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "

Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU" } ] } ], "bundled": true }