Skip to main content

List BigCommerce Transactions

GET 

/api/big-commerce/:integrationInstance/transactions

List the payment transactions (purchases, authorizations, captures, refunds, voids) that SKU.io has synced from BigCommerce for an integration instance, newest first. Each transaction includes a summary of the BigCommerce order it belongs to.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Bearer token (Personal Access Token).

Filters: filter[search] matches the BigCommerce order number or gateway; filter[event], filter[status] and filter[big_commerce_order_id] are exact matches; filter[date_from] / filter[date_to] bound the BigCommerce transaction date (Y-m-d, account timezone, both inclusive). Operator filters (filter[<column>.<operator>]) are available for event, status, gateway, method, currency, amount, date_created and created_at, and filter_groups accepts a nested AND/OR tree.

Sorting: id, amount, event, status, gateway, method, date_created, created_at, currency (default -id).

Pagination: page / per_page (default 15). Amounts are decimal numbers in the transaction currency. Returns 400 for an unknown filter or sort name.

Request​

Responses​

OK

Response Headers
    Content-Type