# Foxy Hypermedia API

> The Foxy API is a hypermedia API that uses HAL+JSON, HAL+XML, and Siren+JSON formats with CURIE-based link relations (fx:{rel}).

## API Overview

- Base URL: https://api.foxycart.com
- Authentication: OAuth 2.0
- Versioning: FOXY-API-VERSION header (current: 1)
- CURIEs: fx:{rel} expands to https://api.foxycart.com/rels/{rel}
- Each resource has a markdown version at /rels/{name}.md with full documentation

## Resources

- [admin_email_template](https://api.foxycart.com/rels/admin_email_template.md): The Admin Email Template contains the Twig content used to display the email receipt sent to your administrative staff.
- [api_home](https://api.foxycart.com/rels/api_home.md): The API homepage is the starting point for the Foxy hypermedia API.
- [applied_coupon_code](https://api.foxycart.com/rels/applied_coupon_code.md): This resource represents a coupon which has been applied to a shopping cart.
- [applied_coupon_codes](https://api.foxycart.com/rels/applied_coupon_codes.md): This link relationship returns a collection of applied coupon codes.
- [applied_tax](https://api.foxycart.com/rels/applied_tax.md): The historical record of taxes that were applied to a given transaction.
- [applied_taxes](https://api.foxycart.com/rels/applied_taxes.md): This link relationship returns a collection of applied taxes.
- [attribute](https://api.foxycart.com/rels/attribute.md): An attribute is a non-standard property that can be applied to multiple resources such as a client, user, store, transaction, cart, subscription, shipment, item, and customer.
- [attributes](https://api.foxycart.com/rels/attributes.md): This link relationship returns a collection of attributes.
- [billing_address](https://api.foxycart.com/rels/billing_address.md): The read only billing address used in a completed transaction.
- [billing_addresses](https://api.foxycart.com/rels/billing_addresses.md): This link relationship returns a collection of billing addresses.
- [cart](https://api.foxycart.com/rels/cart.md): A cart is an uncompleted transaction.
- [cart_include_template](https://api.foxycart.com/rels/cart_include_template.md): The Cart Include Template contains the Twig content used to display the actual cart data within your sidecart, full page cart, checkout, and receipt pages.
- [cart_include_templates](https://api.foxycart.com/rels/cart_include_templates.md): This link relationship returns a collection of cart include templates.
- [cart_template](https://api.foxycart.com/rels/cart_template.md): The Cart Template contains the Twig content used to display the full page cart for your store.
- [cart_templates](https://api.foxycart.com/rels/cart_templates.md): This link relationship returns a collection of cart templates.
- [carts](https://api.foxycart.com/rels/carts.md): This link relationship returns a collection of carts.
- [checkout_template](https://api.foxycart.com/rels/checkout_template.md): The Checkout Template contains the Twig content used to display the checkout page for your store.
- [checkout_templates](https://api.foxycart.com/rels/checkout_templates.md): This link relationship returns a collection of checkout templates.
- [client](https://api.foxycart.com/rels/client.md): To view and work with a client, you must be connected to the API using an OAuth token with client_full_access scope.
- [connect_gateway](https://api.foxycart.com/rels/connect_gateway.md): This endpoint generates an onboarding URL, allowing you to do OAuth-style payment gateway connections within your own platform.
- [coupon](https://api.foxycart.com/rels/coupon.md): Coupons are where you configure discounts for your customers to use for an entire order.
- [coupon_code](https://api.foxycart.com/rels/coupon_code.md): Coupon codes are configured for each coupon you set up.
- [coupon_code_transaction](https://api.foxycart.com/rels/coupon_code_transaction.md): This resource is a historical record for every transaction which has used a specific coupon code.
- [coupon_code_transactions](https://api.foxycart.com/rels/coupon_code_transactions.md): This link relationship returns a collection of coupon code transactions.
- [coupon_codes](https://api.foxycart.com/rels/coupon_codes.md): This link relationship returns a collection of coupon codes.
- [coupon_detail](https://api.foxycart.com/rels/coupon_detail.md): Coupon details provide a summary of what portion of coupons apply to a given item in the cart.
- [coupon_details](https://api.foxycart.com/rels/coupon_details.md): This link relationship returns a collection of coupon details.
- [coupon_item_categories](https://api.foxycart.com/rels/coupon_item_categories.md): This link relationship returns a collection of coupon item categories.
- [coupon_item_category](https://api.foxycart.com/rels/coupon_item_category.md): This resource represents a relationship between a coupon and an item_category for the purpose of limiting which categories the coupon applies to.
- [coupons](https://api.foxycart.com/rels/coupons.md): This link relationship returns a collection of coupons.
- [create_client](https://api.foxycart.com/rels/create_client.md): POST to this endpoint to register a new client application with the Foxy API.
- [create_session](https://api.foxycart.com/rels/create_session.md): POST to this endpoint to create a new cart session.
- [create_user](https://api.foxycart.com/rels/create_user.md): POST to this endpoint to create a new FoxyCart user.
- [custom_field](https://api.foxycart.com/rels/custom_field.md): For a transaction, a custom field is a historical record of the custom field added to a transaction during checkout.
- [custom_fields](https://api.foxycart.com/rels/custom_fields.md): This link relationship returns a collection of custom fields.
- [customer](https://api.foxycart.com/rels/customer.md): A customer is the person who completes a transaction.
- [customer_address](https://api.foxycart.com/rels/customer_address.md): An address saved for a customer.
- [customer_addresses](https://api.foxycart.com/rels/customer_addresses.md): This link relationship returns a collection of customer addresses.
- [customer_email_template](https://api.foxycart.com/rels/customer_email_template.md): The Customer Email Template contains the Twig content used to display the email receipt sent to customers.
- [customer_portal_settings](https://api.foxycart.com/rels/customer_portal_settings.md): This resource controls all aspects of the Foxy customer portal and /s/customer endpoint.
- [customers](https://api.foxycart.com/rels/customers.md): This link relationship returns a collection of customers.
- [default_billing_address](https://api.foxycart.com/rels/default_billing_address.md): The default billing address for this customer.
- [default_payment_method](https://api.foxycart.com/rels/default_payment_method.md): The default payment method for a customer.
- [default_shipping_address](https://api.foxycart.com/rels/default_shipping_address.md): The default shipping address for this customer.
- [default_store](https://api.foxycart.com/rels/default_store.md): This link relationship goes directly to the default store for the current user.
- [discount](https://api.foxycart.com/rels/discount.md): Discounts are historical records of coupons used in a transaction.
- [discount_detail](https://api.foxycart.com/rels/discount_detail.md): Discount details provide a summary of what portion of discounts (both category and product level) apply to a given item in the cart.
- [discount_details](https://api.foxycart.com/rels/discount_details.md): This link relationship returns a collection of discount details.
- [discounts](https://api.foxycart.com/rels/discounts.md): This link relationship returns a collection of discounts.
- [downloadable](https://api.foxycart.com/rels/downloadable.md): Downloadables are items configured directly in Foxy for users to purchase and download.
- [downloadable_purchase](https://api.foxycart.com/rels/downloadable_purchase.md): When a downloadable item is purchased, a downloadable purchase resource is created.
- [downloadable_purchases](https://api.foxycart.com/rels/downloadable_purchases.md): This link relationship returns a collection of downloadable purchases.
- [downloadables](https://api.foxycart.com/rels/downloadables.md): This link relationship returns a collection of downloadables.
- [email_template](https://api.foxycart.com/rels/email_template.md): The Email Template contains the Twig content used to display the email receipt sent to your customers.
- [email_templates](https://api.foxycart.com/rels/email_templates.md): This link relationship returns a collection of email templates.
- [error_entries](https://api.foxycart.com/rels/error_entries.md): This link relationship returns a collection of error entries.
- [error_entry](https://api.foxycart.com/rels/error_entry.md): An error entry is a logged error for your store.
- [fraud_protection](https://api.foxycart.com/rels/fraud_protection.md): A fraud protection is a configuration of your fraud protection controls such as minFraud which allow you to set thresholds for when a transaction should be rejected based on the information known about the customer placing the order.
- [fraud_protections](https://api.foxycart.com/rels/fraud_protections.md): This link relationship returns a collection of fraud protections.
- [gift_card](https://api.foxycart.com/rels/gift_card.md): Gift cards set the usage restrictions for gift card codes (which are the resources actually used by customers, and where individual balances are maintained).
- [gift_card_code](https://api.foxycart.com/rels/gift_card_code.md): Gift card codes are the individual resources that maintain balances, and that are entered by customers.
- [gift_card_code_log_detail](https://api.foxycart.com/rels/gift_card_code_log_detail.md): This resource is a historical record for every event (Foxy transactions, external (POS) transactions you sync with Foxy using this API, admin actions to update the balance, etc.) for specific gift card codes.
- [gift_card_code_logs](https://api.foxycart.com/rels/gift_card_code_logs.md): This link relationship returns a collection of gift card code logs.
- [gift_card_codes](https://api.foxycart.com/rels/gift_card_codes.md): This link relationship returns a collection of gift card codes.
- [gift_card_item_categories](https://api.foxycart.com/rels/gift_card_item_categories.md): This link relationship returns a collection of gift card item categories.
- [gift_card_item_category](https://api.foxycart.com/rels/gift_card_item_category.md): This resource represents a relationship between a gift card and an item_category for the purpose of limiting which categories the gift card applies to.
- [gift_cards](https://api.foxycart.com/rels/gift_cards.md): This link relationship returns a collection of gift cards.
- [hosted_payment_gateway](https://api.foxycart.com/rels/hosted_payment_gateway.md): A hosted payment gateway is a checkout payment method which involves the customer being redirected to a third party payment service hosted page such as PayPal or Amazon.
- [hosted_payment_gateways](https://api.foxycart.com/rels/hosted_payment_gateways.md): This link relationship returns a collection of hosted payment gateways.
- [integration](https://api.foxycart.com/rels/integration.md): An integration represents an active OAuth refresh token with the current store.
- [integrations](https://api.foxycart.com/rels/integrations.md): This link relationship returns a collection of integrations.
- [item](https://api.foxycart.com/rels/item.md): An item is a product added to a cart or contained in a transaction.
- [item_categories](https://api.foxycart.com/rels/item_categories.md): This link relationship returns a collection of item categories.
- [item_category](https://api.foxycart.com/rels/item_category.md): An item category offers a way to give items additional behaviors that cannot be accomplished by item options alone, including item delivery types.
- [item_option](https://api.foxycart.com/rels/item_option.md): An item option is a property added to the cart for an item which isn't part of the standard item properties such as name, weight, etc.
- [item_options](https://api.foxycart.com/rels/item_options.md): This link relationship returns a collection of item options.
- [item_taxes](https://api.foxycart.com/rels/item_taxes.md): Displays a list of applicable taxes for the product.
- [items](https://api.foxycart.com/rels/items.md): This link relationship returns a collection of items.
- [language_override](https://api.foxycart.com/rels/language_override.md): A language override allows you to customize an individual string output by FoxyCart.
- [language_overrides](https://api.foxycart.com/rels/language_overrides.md): This link relationship returns a collection of language overrides.
- [last_transaction](https://api.foxycart.com/rels/last_transaction.md): The last transaction is the last successful transaction to have processed for this subscription.
- [native_integration](https://api.foxycart.com/rels/native_integration.md): A native integration represents a third party system natively integrated with Foxy which requires configuration settings and credentials.
- [native_integrations](https://api.foxycart.com/rels/native_integrations.md): This link relationship returns a collection of native integrations.
- [original_transaction](https://api.foxycart.com/rels/original_transaction.md): The original transaction is the transaction that first created a subscription.
- [passkey](https://api.foxycart.com/rels/passkey.md): Passkeys are an additional authentication method used at auth.foxy.io to access admin.foxy.io.
- [passkeys](https://api.foxycart.com/rels/passkeys.md): This link relationship returns a collection of passkeys.
- [payment](https://api.foxycart.com/rels/payment.md): The historical record of payment applied to a given transaction which includes the payment gateway response, purchase order, third party id and/or masked payment card information.
- [payment_gateway](https://api.foxycart.com/rels/payment_gateway.md): A payment gateway stores the account information for your payment card gateway processor.
- [payment_gateways](https://api.foxycart.com/rels/payment_gateways.md): This link relationship returns a collection of payment gateways.
- [payment_method_expiring](https://api.foxycart.com/rels/payment_method_expiring.md): This resource shows you a customer payment card which is soon to expire.
- [payment_method_set](https://api.foxycart.com/rels/payment_method_set.md): A Payment Method Set is where you configure your payment gateway and your hosted gateways as being in live or test mode and where you enable the pay by purchase order option for your store.
- [payment_method_set_fraud_protection](https://api.foxycart.com/rels/payment_method_set_fraud_protection.md): This resource represents a relationship between a payment method set and a fraud protection.
- [payment_method_set_fraud_protections](https://api.foxycart.com/rels/payment_method_set_fraud_protections.md): This link relationship returns a collection of payment method set fraud protections.
- [payment_method_set_hosted_payment_gateway](https://api.foxycart.com/rels/payment_method_set_hosted_payment_gateway.md): This resource represents a relationship between a payment method set and a hosted payment gateway.
- [payment_method_set_hosted_payment_gateways](https://api.foxycart.com/rels/payment_method_set_hosted_payment_gateways.md): This link relationship returns a collection of payment method set hosted payment gateways.
- [payment_method_sets](https://api.foxycart.com/rels/payment_method_sets.md): This link relationship returns a collection of payment method sets.
- [payment_methods_expiring](https://api.foxycart.com/rels/payment_methods_expiring.md): This link relationship returns a collection of payment methods expiring.
- [payments](https://api.foxycart.com/rels/payments.md): This link relationship returns a collection of payments.
- [property_helpers](https://api.foxycart.com/rels/property_helpers.md): Property helpers are links to various helpers for determining default values for resource properties along with other helpful API information.
- [receipt_template](https://api.foxycart.com/rels/receipt_template.md): The Receipt Template contains the Twig content used to display the receipt page for your store.
- [receipt_templates](https://api.foxycart.com/rels/receipt_templates.md): This link relationship returns a collection of receipt templates.
- [report](https://api.foxycart.com/rels/report.md): To generate a report, send a POST request to the reports resource with the specified parameters detailed in the Properties section.
- [reports](https://api.foxycart.com/rels/reports.md): This link relationship returns a collection of reports.
- [send_webhooks](https://api.foxycart.com/rels/send_webhooks.md): Send Webhooks allows you to send data for a specific transaction, customer, or subscription to the webhooks you specify.
- [shipment](https://api.foxycart.com/rels/shipment.md): A shipment resource contains the address for where items in a transaction grouped by a common shipto were sent.
- [shipments](https://api.foxycart.com/rels/shipments.md): This link relationship returns a collection of shipments.
- [shipping_containers](https://api.foxycart.com/rels/shipping_containers.md): Collection of available shipping containers for a shipping method.
- [shipping_drop_types](https://api.foxycart.com/rels/shipping_drop_types.md): Collection of available shipping drop types for a shipping method.
- [shipping_methods](https://api.foxycart.com/rels/shipping_methods.md): Collection of available shipping methods.
- [shipping_services](https://api.foxycart.com/rels/shipping_services.md): Collection of available shipping services for a shipping method.
- [store](https://api.foxycart.com/rels/store.md): A FoxyCart Store is your home for managing your online payment system as it relates to FoxyCart's platform.
- [store_changelog](https://api.foxycart.com/rels/store_changelog.md): All changes to store resources will be logged to this resource, when resources are created, updated or deleted, including their values before and after the change.
- [store_changelogs](https://api.foxycart.com/rels/store_changelogs.md): This link relationship returns a collection of store changelogs.
- [store_shipping_method](https://api.foxycart.com/rels/store_shipping_method.md): This resource represents an active shipping method for your store.
- [store_shipping_methods](https://api.foxycart.com/rels/store_shipping_methods.md): This link relationship returns a collection of store shipping methods.
- [store_shipping_service](https://api.foxycart.com/rels/store_shipping_service.md): This resource represents an active shipping service configured for a given shipping method on your store.
- [store_shipping_services](https://api.foxycart.com/rels/store_shipping_services.md): This link relationship returns a collection of store shipping services.
- [store_transaction_folder](https://api.foxycart.com/rels/store_transaction_folder.md): Store transaction folder is used for order management.
- [store_transaction_folders](https://api.foxycart.com/rels/store_transaction_folders.md): This link relationship returns a collection of store transaction folders.
- [store_version](https://api.foxycart.com/rels/store_version.md): A store version represents a specific version of the Foxy storefront.
- [store_versions](https://api.foxycart.com/rels/store_versions.md): Collection of available FoxyCart store versions.
- [stores](https://api.foxycart.com/rels/stores.md): This link relationship returns a collection of stores.
- [subscription](https://api.foxycart.com/rels/subscription.md): A subscription is a recurring transaction.
- [subscription_event](https://api.foxycart.com/rels/subscription_event.md): A subscription event is a structured audit log entry for a subscription lifecycle action.
- [subscription_events](https://api.foxycart.com/rels/subscription_events.md): This link relationship returns a collection of subscription events.
- [subscription_mrr_snapshot](https://api.foxycart.com/rels/subscription_mrr_snapshot.md): An MRR snapshot captures pre-aggregated daily subscription metrics for a store.
- [subscription_mrr_snapshots](https://api.foxycart.com/rels/subscription_mrr_snapshots.md): This link relationship returns a collection of subscription mrr snapshots.
- [subscription_settings](https://api.foxycart.com/rels/subscription_settings.md): The subscription settings resource contains properties used to configure how your store processes subscriptions.
- [subscription_upcoming_item](https://api.foxycart.com/rels/subscription_upcoming_item.md): A subscription upcoming item represents a single line item from a projected future subscription renewal.
- [subscription_upcoming_items](https://api.foxycart.com/rels/subscription_upcoming_items.md): This link relationship returns a collection of subscription upcoming items.
- [subscriptions](https://api.foxycart.com/rels/subscriptions.md): This link relationship returns a collection of subscriptions.
- [tax](https://api.foxycart.com/rels/tax.md): Tax rates are determined by the customer's shipping location.
- [tax_item_categories](https://api.foxycart.com/rels/tax_item_categories.md): This link relationship returns a collection of tax item categories.
- [tax_item_category](https://api.foxycart.com/rels/tax_item_category.md): This resource represents a relationship between a tax and an item category which that tax is applied to.
- [taxes](https://api.foxycart.com/rels/taxes.md): This link relationship returns a collection of taxes.
- [template_config](https://api.foxycart.com/rels/template_config.md): The Template Config allows you to configure a lot of the template parameters used for displaying the cart, checkout, receipt and email pages for your store.
- [template_configs](https://api.foxycart.com/rels/template_configs.md): This link relationship returns a collection of template configs.
- [template_set](https://api.foxycart.com/rels/template_set.md): Template sets are collections of templates such as the cart, checkout and receipt for a given store.
- [template_sets](https://api.foxycart.com/rels/template_sets.md): This link relationship returns a collection of template sets.
- [token](https://api.foxycart.com/rels/token.md): The OAuth token endpoint for all access and refresh token requests.
- [transaction](https://api.foxycart.com/rels/transaction.md): A transaction is a historical record of a cart that has been purchased by a customer.
- [transaction_journal_entries](https://api.foxycart.com/rels/transaction_journal_entries.md): This link relationship returns a collection of transaction journal entries.
- [transaction_journal_entry](https://api.foxycart.com/rels/transaction_journal_entry.md): A journal entry records the movement of money related to transactions in Foxy, primarily for use in reconciling Foxy with external accounting systems.
- [transaction_log](https://api.foxycart.com/rels/transaction_log.md): 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.
- [transaction_log_detail](https://api.foxycart.com/rels/transaction_log_detail.md): Details of an individual transaction log change.
- [transaction_log_details](https://api.foxycart.com/rels/transaction_log_details.md): This link relationship returns a collection of transaction log details.
- [transaction_logs](https://api.foxycart.com/rels/transaction_logs.md): This link relationship returns a collection of transaction logs.
- [transaction_template](https://api.foxycart.com/rels/transaction_template.md): A transaction template is basically a cart which will be processed as a transaction each time the subscription runs.
- [transactions](https://api.foxycart.com/rels/transactions.md): This link relationship returns a collection of transactions.
- [user](https://api.foxycart.com/rels/user.md): A FoxyCart User is someone who manages and configures a FoxyCart Store.
- [user_access](https://api.foxycart.com/rels/user_access.md): This resource represents a relationship between a FoxyCart store and the FoxyCart admin user who can access that store.
- [user_accesses](https://api.foxycart.com/rels/user_accesses.md): This link relationship returns a collection of user accesses.
- [user_invitation](https://api.foxycart.com/rels/user_invitation.md): Invitation for a user to access a certain store.
- [user_invitations](https://api.foxycart.com/rels/user_invitations.md): This link relationship returns a collection of user invitations.
- [users](https://api.foxycart.com/rels/users.md): This link relationship returns a collection of users.
- [webhook](https://api.foxycart.com/rels/webhook.md): Webhooks allow you to configure Foxy to push data to an endpoint of your choosing.
- [webhooks](https://api.foxycart.com/rels/webhooks.md): This link relationship returns a collection of webhooks.

## Property Helpers

- [card_verification](https://api.foxycart.com/rels/card_verification.md): Available card verification mode options for the Payment method resource's card_verification and test_card_verification properties.
- [checkout_types](https://api.foxycart.com/rels/checkout_types.md): Available checkout type options.
- [config_3d_secure](https://api.foxycart.com/rels/config_3d_secure.md): Available 3D Secure configuration options for the Payment method resource's config_3d_secure property.
- [countries](https://api.foxycart.com/rels/countries.md): List of supported countries.
- [customer_password_hash_types](https://api.foxycart.com/rels/customer_password_hash_types.md): Available customer password hashing mechanisms.
- [default_templates](https://api.foxycart.com/rels/default_templates.md): Links to the default Twig templates for the cart, checkout, receipt, and email.
- [language_strings](https://api.foxycart.com/rels/language_strings.md): Default language strings per language which can be customized via language overrides.
- [languages](https://api.foxycart.com/rels/languages.md): List of currently supported languages for the Store resource's language property.
- [locale_codes](https://api.foxycart.com/rels/locale_codes.md): List of supported locale codes for the Store resource's locale_code property.
- [regions](https://api.foxycart.com/rels/regions.md): List of regions for a given country.
- [shipping_address_types](https://api.foxycart.com/rels/shipping_address_types.md): Available shipping address types for calculating shipping costs.
- [shipping_container](https://api.foxycart.com/rels/shipping_container.md): A supported shipping method container type.
- [shipping_drop_type](https://api.foxycart.com/rels/shipping_drop_type.md): A supported shipping method drop type.
- [shipping_method](https://api.foxycart.com/rels/shipping_method.md): A supported shipping method with its name, code, and links to related shipping services, containers, and drop types.
- [shipping_service](https://api.foxycart.com/rels/shipping_service.md): A supported shipping method service.
- [timezones](https://api.foxycart.com/rels/timezones.md): Valid entries for the Store resource's timezone property.