transaction_log

Collection: transaction_logs

For stores and gateways which allow for transaction modifications, the transaction log keeps a record of all changes made to the transaction such as captures and refunds.

Required Scopes

Full store_full_access

Read transactions_read

Write transactions_write

Actions

GET View a transaction log

HEAD Get just the header response

OPTIONS Get a response explaining which HTTP methods are supported

Properties (3)

snapshot String · Read-only

A complete JSON snapshot of the transaction prior to the modification this log entry records. It includes all of the following zoom values: customer, payments, applied_taxes, discounts, shipments, billing_addresses, items, items:item_options, custom_fields, attributes.

request_source String · Read-only

Describes the source of the transaction modification such as admin or hAPI.

date_created String (nullable) · Read-only

The date this resource was created.

Link Relations (7)

self This Transaction Log

fx:store GET PATCH PUT DELETE This Store

fx:transaction GET PATCH PUT POST This Transaction

fx:transaction_log_details GET Transaction Log Details

fx:user GET PATCH PUT DELETE This User

fx:send_webhooks POST Refeed webhooks v2 for this Transaction Log

fx:customer GET PATCH PUT DELETE The customer associated with this transaction log.

Only present when the transaction log has an associated customer.

Zoomable Resources

Embed related resources using ?zoom=<resource>. Filter with ?resource:property=value.

transaction_log_details

https://api.foxycart.com/transaction_logs/{id}

Available via fx:transaction_log on transaction_journal_entry·fx:transaction_log on transaction_log_detail

Example Representation

No example representation available for this resource.