stores
Resource: store
This link relationship returns a collection of stores. 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
stores_read
Write
stores_write Collection Resource
storeActions
GET View a list of stores
POST Create a new store
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported
Properties (5)
_embedded Object · Read-only Contains fx:stores[] — array of store 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/users/{user_id}/stores
Example Representation
{
"_links": {
"curies": [
{
"name": "fx",
"href": "https://api.foxycart.com/rels/{rel}",
"templated": true
}
],
"self": {
"href": "https://api.foxycart.com/stores/123/stores",
"title": "This Collection"
},
"first": {
"href": "https://api.foxycart.com/stores/123/stores?offset=0",
"title": "First Page of this Collection"
},
"prev": {
"href": "https://api.foxycart.com/stores/123/stores?offset=0",
"title": "Previous Page of this Collection"
},
"next": {
"href": "https://api.foxycart.com/stores/123/stores?offset=20",
"title": "Next Page of this Collection"
},
"last": {
"href": "https://api.foxycart.com/stores/123/stores?offset=20",
"title": "Last Page of this Collection"
}
},
"_embedded": {
"fx:stores": [
{
"_links": {
"curies": [
{
"name": "fx",
"href": "https://api.foxycart.com/rels/{rel}",
"templated": true
}
],
"self": {
"href": "https://api.foxycart.com/stores/456",
"title": "This Store"
},
"fx:store_version": {
"href": "https://api.foxycart.com/property_helpers/store_versions/999",
"title": "This Store's Version"
},
"fx:attributes": {
"href": "https://api.foxycart.com/stores/123/attributes",
"title": "Attributes for This Store"
},
"fx:users": {
"href": "https://api.foxycart.com/stores/123/users",
"title": "Users for This Store"
},
"fx:user_accesses": {
"href": "https://api.foxycart.com/stores/123/user_accesses",
"title": "User Access for This Store"
},
"fx:user_invitations": {
"href": "https://api.foxycart.com/stores/123/user_invitations",
"title": "User Invitations for This Store"
},
"fx:customers": {
"href": "https://api.foxycart.com/stores/123/customers",
"title": "Customers for This Store"
},
"fx:carts": {
"href": "https://api.foxycart.com/stores/123/carts",
"title": "Carts for This Store"
},
"fx:transactions": {
"href": "https://api.foxycart.com/stores/123/transactions",
"title": "Transactions for This Store"
},
"fx:subscriptions": {
"href": "https://api.foxycart.com/stores/123/subscriptions",
"title": "Subscriptions for This Store"
},
"fx:subscription_events": {
"href": "https://api.foxycart.com/stores/123/subscription_events",
"title": "Subscription Events for This Store"
},
"fx:subscription_mrr_snapshots": {
"href": "https://api.foxycart.com/stores/123/subscription_mrr_snapshots",
"title": "MRR Snapshots for This Store"
},
"fx:subscription_upcoming_items": {
"href": "https://api.foxycart.com/stores/123/subscription_upcoming_items",
"title": "Upcoming Subscription Items for This Store"
},
"fx:subscription_settings": {
"href": "https://api.foxycart.com/store_subscription_settings/123",
"title": "Subscription Settings for This Store"
},
"fx:customer_portal_settings": {
"href": "https://api.foxycart.com/stores/123/customer_portal_settings",
"title": "Customer Portal Settings for This Store"
},
"fx:process_subscription_webhook": {
"href": "https://api.foxycart.com/stores/123/process_subscription_webhook",
"title": "POST here to resend the daily subscription webhook notification for this store"
},
"fx:item_categories": {
"href": "https://api.foxycart.com/stores/123/item_categories",
"title": "Item Categories for This Store"
},
"fx:taxes": {
"href": "https://api.foxycart.com/stores/123/taxes",
"title": "Taxes for This Store"
},
"fx:payment_method_sets": {
"href": "https://api.foxycart.com/stores/123/payment_method_sets",
"title": "Payment Method Sets for This Store"
},
"fx:coupons": {
"href": "https://api.foxycart.com/stores/123/coupons",
"title": "Coupons for This Store"
},
"fx:template_sets": {
"href": "https://api.foxycart.com/stores/123/template_sets",
"title": "Template Sets for This Store"
},
"fx:cart_templates": {
"href": "https://api.foxycart.com/stores/123/cart_templates",
"title": "Cart Templates for This Store"
},
"fx:cart_include_templates": {
"href": "https://api.foxycart.com/stores/123/cart_include_templates",
"title": "Cart Include Templates for This Store"
},
"fx:checkout_templates": {
"href": "https://api.foxycart.com/stores/123/checkout_templates",
"title": "Checkout Templates for This Store"
},
"fx:receipt_templates": {
"href": "https://api.foxycart.com/stores/123/receipt_templates",
"title": "Receipt Templates for This Store"
},
"fx:email_templates": {
"href": "https://api.foxycart.com/stores/123/email_templates",
"title": "Email Templates for This Store"
},
"fx:error_entries": {
"href": "https://api.foxycart.com/stores/123/error_entries",
"title": "Error Entries for This Store"
},
"fx:downloadables": {
"href": "https://api.foxycart.com/stores/123/downloadables",
"title": "Downloadables for This Store"
},
"fx:hosted_payment_gateways": {
"href": "https://api.foxycart.com/stores/123/hosted_payment_gateways",
"title": "Hosted Payment Gateways for This Store"
},
"fx:fraud_protections": {
"href": "https://api.foxycart.com/stores/123/fraud_protections",
"title": "Fraud Protections for This Store"
},
"fx:transaction_folders": {
"href": "https://api.foxycart.com/stores/123/store_transaction_folders",
"title": "Transaction Folders for This Store"
},
"fx:gift_cards": {
"href": "https://api.foxycart.com/stores/123/gift_cards",
"title": "Gift Cards for This Store"
},
"fx:reports": {
"href": "https://api.foxycart.com/stores/123/reports",
"title": "Reports for This Store"
},
"fx:store_shipping_methods": {
"href": "https://api.foxycart.com/stores/123/store_shipping_methods",
"title": "Shipping Methods for This Store"
},
"fx:webhooks": {
"href": "https://api.foxycart.com/stores/123/webhooks",
"title": "Webhooks for This Store"
},
"fx:activate_store_starter_monthly_url": {
"href": "https://api.foxycart.com/activate_store_starter_monthly_url",
"title": "Add-to-cart URL for the Starter plan with monthly billing"
},
"fx:activate_store_starter_yearly_url": {
"href": "https://api.foxycart.com/activate_store_starter_yearly_url",
"title": "Add-to-cart URL for the Starter plan with yearly billing"
},
"fx:activate_store_growth_monthly_url": {
"href": "https://api.foxycart.com/activate_store_growth_monthly_url",
"title": "Add-to-cart URL for the Growth plan with monthly billing"
},
"fx:activate_store_growth_yearly_url": {
"href": "https://api.foxycart.com/activate_store_growth_yearly_url",
"title": "Add-to-cart URL for the Growth plan with yearly billing"
},
"fx:activate_store_advanced_monthly_url": {
"href": "https://api.foxycart.com/activate_store_advanced_monthly_url",
"title": "Add-to-cart URL for the Advanced plan with monthly billing"
},
"fx:activate_store_advanced_yearly_url": {
"href": "https://api.foxycart.com/activate_store_advanced_yearly_url",
"title": "Add-to-cart URL for the Advanced plan with yearly billing"
},
"fx:template_configs": {
"href": "https://api.foxycart.com/stores/123/template_configs",
"title": "Template Configs for This Store"
},
"fx:payment_gateways": {
"href": "https://api.foxycart.com/stores/123/payment_gateways",
"title": "Payment Gateways for This Store"
},
"fx:payment_methods_expiring": {
"href": "https://api.foxycart.com/stores/123/payment_methods_expiring",
"title": "Customer payment methods which are about to expire"
},
"fx:integrations": {
"href": "https://api.foxycart.com/stores/123/integrations",
"title": "Third party integrations which have been granted OAuth access to this store"
},
"fx:native_integrations": {
"href": "https://api.foxycart.com/stores/123/native_integrations",
"title": "Third party integrations which require credentials and configuration."
},
"fx:send_webhooks": {
"href": "https://api.foxycart.com/stores/123/send_webhooks",
"title": "Refeed webhooks v2 for this Store"
},
"fx:changelogs": {
"href": "https://api.foxycart.com/stores/123/changelogs",
"title": "Change logs for this Store."
},
"fx:transaction_journal_entries": {
"href": "https://api.foxycart.com/stores/123/transaction_journal_entries",
"title": "Transaction journal entries for This Store"
}
},
"store_version_uri": "https://api.foxycart.com/property_helpers/store_versions/20",
"store_name": "Example Store",
"store_domain": "example",
"use_remote_domain": false,
"store_url": "https://example.com/catalog",
"receipt_continue_url": "http://www.example.com/thankyou",
"store_email": "someone@example.com",
"from_email": "helpdesk@example.com",
"bcc_on_receipt_email": false,
"smtp_config": "{\"username\":\"someone@gmail.com\",\"password\":\"mycomplexpassword\",\"host\":\"smtp.gmail.com\",\"port\":\"465\",\"security\":\"ssl\"}",
"use_email_dns": false,
"postal_code": "37211",
"region": "TN",
"country": "US",
"locale_code": "en_US",
"hide_currency_symbol": false,
"hide_decimal_characters": false,
"use_international_currency_symbol": false,
"language": "english",
"logo_url": "",
"checkout_type": "default_account",
"use_webhook": true,
"webhook_url": "http://example.com/my_webhook_script",
"webhook_key": "some super secure password your mom could not not guess",
"use_cart_validation": false,
"use_single_sign_on": false,
"single_sign_on_url": "http://example.com/my_single_sign_on_script",
"customer_password_hash_type": "phpass",
"customer_password_hash_config": "8",
"features_multiship": false,
"products_require_expires_property": false,
"app_session_time": 43200,
"shipping_address_type": "residential",
"require_signed_shipping_rates": false,
"timezone": "America/Chicago",
"unified_order_entry_password": "here I am, buying all your stufz",
"custom_display_id_config": "{\"enabled\":true,\"start\":\"1\",\"length\":\"\",\"prefix\":\"TI-\",\"suffix\":\"\",\"transaction_journal_entries\":{\"transaction_separator\":\"-\",\"enabled\":true,\"log_detail_request_types\":{\"transaction_authcapture\":{\"prefix\":\"AC-\"},\"transaction_refund\":{\"prefix\":\"RF-\"},\"transaction_capture\":{\"prefix\":\"CP-\"},\"transaction_void\":{\"prefix\":\"VO-\"}}}}",
"affiliate_id": 0,
"is_maintenance_mode": false,
"is_active": false,
"first_payment_date": null,
"features": "{\"allow_transaction_editing\":true}",
"date_created": "2010-04-24T19:25:02-0700",
"date_modified": "2013-07-19T11:47:26-0700"
}
]
},
"total_items": 1,
"returned_items": 1,
"limit": 20,
"offset": 0
}