v1

latestOpenAPI 3.0.02026-07-12414931.1 MB
Transactions

Get Transactions

The Get Transactions API retrieves a list of transactions with optional filtering, sorting, and pagination.

get/v1/transactions

Query parameters

state_codestring

Filter transactions by state code.

Filter transactions by state code.

transaction_typestring

Filter by transaction type (e.g., SALE, FULL_CREDIT_NOTE, PARTIAL_CREDIT_NOTE, ARCHIVE etc.).

Filter by transaction type (e.g., SALE, FULL_CREDIT_NOTE, PARTIAL_CREDIT_NOTE, ARCHIVE etc.).

transaction_sourcestring

Filter transactions based on the source.

Filter transactions based on the source.

search_querystring

Search for transactions using a general query (e.g., order ID, customer name).

Search for transactions using a general query (e.g., order ID, customer name).

countryCountryCodeEnum[]

Filter transactions by country code (ISO 3166-1 alpha-2 format, e.g., US).

Filter transactions by country code (ISO 3166-1 alpha-2 format, e.g., US).

statestring

Filter by full state name (e.g., California).

Filter by full state name (e.g., California).

address_status__instring

Filter by address status (e.g., UNVERIFIED, INVALID, PARTIALLY_VERIFIED, VERIFIED, UNVERIFIABLE).

Filter by address status (e.g., UNVERIFIED, INVALID, PARTIALLY_VERIFIED, VERIFIED, UNVERIFIABLE).

status'PENDING' | 'COMMITTED' | 'CANCELLED' | 'FULLY_REFUNDED' | 'PARTIALLY_REFUNDED' | 'INVALID' | 'ARCHIVED'

Filter by transaction status (e.g., PENDING, COMMITTED, CANCELLED, FULLY_REFUNDED, PARTIALLY_REFUNDED, ARCHIVED).

filing_idstring

Retrieve transactions linked to a specific filing ID.

Retrieve transactions linked to a specific filing ID.

order_bystring

Sort results based on specified fields. Prefix with - for descending order (e.g., -date for newest first).

Sort results based on specified fields. Prefix with - for descending order (e.g., -date for newest first).

date__gtestring

Retrieve transactions with a date greater than or equal to (YYYY-MM-DD).

Retrieve transactions with a date greater than or equal to (YYYY-MM-DD).

date__ltestring

Retrieve transactions with a date less than or equal to (YYYY-MM-DD).

Retrieve transactions with a date less than or equal to (YYYY-MM-DD).

processing_status__instring

Filter transactions based on processing status. Multiple values can be passed as a comma-separated list.

Filter transactions based on processing status. Multiple values can be passed as a comma-separated list.

marketplaceboolean

Filter transactions by marketplace (e.g., AMAZON, EBAY).

Filter transactions by marketplace (e.g., AMAZON, EBAY).

exempt__instring

Filter transactions by exemption status. Multiple values can be passed as a comma-separated list (e.g., EXEMPT,TAXABLE).

Filter transactions by exemption status. Multiple values can be passed as a comma-separated list (e.g., EXEMPT,TAXABLE).

pageinteger

Page number

Page number

sizeinteger

Page size

Page size

Response

Successfully retrieved transactions

totalinteger required
pageinteger required
sizeinteger required
pagesinteger required