transactions
Resource: transaction
This link relationship returns a collection of transactions. You can paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last.
Required Scopes
Full
store_full_access
Read
transactions_read
Write
transactions_write Collection Resource
transactionActions
GET View a list of transactions
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported
Properties (5)
_embedded Object · Read-only Contains fx:transactions[] — array of transaction resources
total_items String · Read-only Total number of resources in this collection.
returned_items Number · Read-only Number of resources returned in this page.
limit Number · Read-only Maximum number of resources per page.
offset Number · Read-only Number of resources skipped.
Link Relations (5)
self This Collection first First Page of this Collection prev Previous Page of this Collection next Next Page of this Collection last Last Page of this Collection https://api.foxycart.com/stores/{store_id}/transactions
Available via
fx:transactions on customer·fx:transactions on store·fx:transactions on store_transaction_folder·fx:transactions on subscription Example Representation
{
"_links": {
"curies": [
{
"name": "fx",
"href": "https://api.foxycart.com/rels/{rel}",
"templated": true
}
],
"self": {
"href": "https://api.foxycart.com/stores/123/transactions",
"title": "This Collection"
},
"first": {
"href": "https://api.foxycart.com/stores/123/transactions?offset=0",
"title": "First Page of this Collection"
},
"prev": {
"href": "https://api.foxycart.com/stores/123/transactions?offset=0",
"title": "Previous Page of this Collection"
},
"next": {
"href": "https://api.foxycart.com/stores/123/transactions?offset=20",
"title": "Next Page of this Collection"
},
"last": {
"href": "https://api.foxycart.com/stores/123/transactions?offset=20",
"title": "Last Page of this Collection"
}
},
"_embedded": {
"fx:transactions": [
{
"_links": {
"curies": [
{
"name": "fx",
"href": "https://api.foxycart.com/rels/{rel}",
"templated": true
}
],
"self": {
"href": "https://api.foxycart.com/transactions/456",
"title": "This Transaction"
},
"fx:store": {
"href": "https://api.foxycart.com/stores/456",
"title": "This Store"
},
"fx:receipt": {
"href": "https://mystore.foxycart.com/receipt?id=c2e419c3d3ef4713d8d792c6abb90df35b5c67a39ce144736338380d06319a9a",
"title": "This Receipt"
},
"fx:customer": {
"href": "https://api.foxycart.com/customers/789",
"title": "This Customer"
},
"fx:attributes": {
"href": "https://api.foxycart.com/transactions/123/attributes",
"title": "Attributes for this Transaction"
},
"fx:items": {
"href": "https://api.foxycart.com/transactions/123/items",
"title": "The Items for this Transaction"
},
"fx:payments": {
"href": "https://api.foxycart.com/transactions/123/payments",
"title": "The Payments for this Transaction"
},
"fx:applied_taxes": {
"href": "https://api.foxycart.com/transactions/123/applied_taxes",
"title": "The Applied Taxes for this Transaction"
},
"fx:applied_gift_card_codes": {
"href": "https://api.foxycart.com/transactions/123/gift_card_code_logs",
"title": "The Applied Gift Card Codes for this Transaction"
},
"fx:custom_fields": {
"href": "https://api.foxycart.com/transactions/123/transaction_custom_fields",
"title": "The Custom Fields for this Transaction"
},
"fx:discounts": {
"href": "https://api.foxycart.com/transactions/123/discounts",
"title": "The Discounts for this Transaction"
},
"fx:shipments": {
"href": "https://api.foxycart.com/transactions/123/shipments",
"title": "The Shipments for this Transaction"
},
"fx:billing_addresses": {
"href": "https://api.foxycart.com/transactions/123/billing_addresses",
"title": "The Billing Addresses for this Transaction"
},
"fx:folder": {
"href": "https://api.foxycart.com/store_transaction_folders/222",
"title": "Transaction Folder"
},
"fx:subscription": {
"href": "https://api.foxycart.com/subscriptions/321",
"title": "This Subscription"
},
"fx:native_integrations": {
"href": "https://api.foxycart.com/transactions/123/native_integrations",
"title": "POST here to resend transaction to the Webhooks."
},
"fx:process_webhook": {
"href": "https://api.foxycart.com/transactions/123/process_webhook",
"title": "POST here to resend the webhook notification for this transaction"
},
"fx:send_webhooks": {
"href": "https://api.foxycart.com/transactions/123/send_webhooks",
"title": "Refeed webhooks v2 for this Transaction"
},
"fx:send_emails": {
"href": "https://api.foxycart.com/transactions/123/send_emails",
"title": "POST here to resend emails for this transaction"
},
"fx:transaction_logs": {
"href": "https://api.foxycart.com/transactions/123/transaction_logs",
"title": "Transaction Logs"
},
"fx:transaction_journal_entries": {
"href": "https://api.foxycart.com/transactions/123/journal_entries",
"title": "Transaction Journal Entries"
},
"fx:void": {
"href": "https://api.foxycart.com/transactions/123/void",
"title": "POST here to void this transaction."
},
"fx:refund": {
"href": "https://api.foxycart.com/transactions/123/refund",
"title": "POST here to refund this transaction."
},
"fx:capture": {
"href": "https://api.foxycart.com/transactions/123/capture",
"title": "POST here to capture this transaction."
}
},
"id": 3820290,
"is_test": true,
"hide_transaction": false,
"data_is_fed": true,
"transaction_date": "2013-06-06T17:26:07-05:00",
"locale_code": "en_US",
"customer_first_name": "Test",
"customer_last_name": "User",
"customer_tax_id": "",
"customer_email": "testing@example.com",
"customer_ip": "10.1.248.210",
"ip_country": "",
"total_item_price": 10,
"total_tax": 1.9,
"total_shipping": 0,
"total_future_shipping": 0,
"total_order": 11.9,
"date_created": null,
"date_modified": "2013-06-06T15:26:07-0700",
"currency_code": "USD",
"currency_symbol": "$"
}
]
},
"total_items": 1,
"returned_items": 1,
"limit": 20,
"offset": 0
}