Read Foxy transactions, subscriptions, customers, carts and coupons; update customers and subs.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Get the Foxy hAPI home document — its _links / rels (including fx:store for the authenticated default store). Useful for HAL discovery. Foxy hAPI: GET /.
This tool takes no arguments.
Get the Foxy hAPI home document — its _links / rels (including fx:store for the authenticated default store). Useful for HAL discovery. Foxy hAPI: GET /.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Get a single customer by id, optionally zooming related resources (default_billing_address, subscriptions…). Foxy hAPI: GET /customers/{id}.
| Argument | Type | Description |
|---|---|---|
| id* | any | Customer id. |
| zoom | string | Comma-separated related resources to embed. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Customer id."
},
"zoom": {
"type": "string",
"description": "Comma-separated related resources to embed."
}
}
}Resolve and return the authenticated user's default store (and its id) by fetching the API home and following the fx:store link. Use this to discover the store_id the list tools accept. Foxy hAPI: GET / then GET fx:store.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Get a single store resource by id, including its settings and _links to sub-collections. Foxy hAPI: GET /stores/{store_id}.
| Argument | Type | Description |
|---|---|---|
| store_id* | any | Store id (get it from foxy_get_default_store). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"store_id"
],
"properties": {
"store_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Store id (get it from foxy_get_default_store)."
}
}
}Get a single subscription by id, optionally zooming related resources. Foxy hAPI: GET /subscriptions/{id}.
| Argument | Type | Description |
|---|---|---|
| id* | any | Subscription id. |
| zoom | string | Comma-separated related resources to embed, e.g. 'transaction_template,original_transaction'. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Subscription id."
},
"zoom": {
"type": "string",
"description": "Comma-separated related resources to embed, e.g. 'transaction_template,original_transaction'."
}
}
}Get a single transaction by id, optionally zooming related resources (items, customer, payments, applied_taxes…). Foxy hAPI: GET /transactions/{id}.
| Argument | Type | Description |
|---|---|---|
| id* | any | Transaction id. |
| zoom | string | Comma-separated related resources to embed, e.g. 'items,customer'. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Transaction id."
},
"zoom": {
"type": "string",
"description": "Comma-separated related resources to embed, e.g. 'items,customer'."
}
}
}List a store's carts (in-progress / abandoned checkouts). Returns a HAL collection embedding fx:carts. Foxy hAPI: GET /stores/{store_id}/carts.
| Argument | Type | Description |
|---|---|---|
| zoom | string | Comma-separated related resources to embed, e.g. 'items,customer'. |
| limit | integer | Max results per page (Foxy default 20). |
| offset | integer | Pagination offset. |
| store_id | any | Store id. If omitted, the default store (fx:store) is used. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"zoom": {
"type": "string",
"description": "Comma-separated related resources to embed, e.g. 'items,customer'."
},
"limit": {
"type": "integer",
"maximum": 300,
"minimum": 1,
"description": "Max results per page (Foxy default 20)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Pagination offset."
},
"store_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Store id. If omitted, the default store (fx:store) is used."
}
}
}List a store's coupons (discount codes and their rules). Returns a HAL collection embedding fx:coupons. Foxy hAPI: GET /stores/{store_id}/coupons.
| Argument | Type | Description |
|---|---|---|
| zoom | string | Comma-separated related resources to embed, e.g. 'coupon_codes'. |
| limit | integer | Max results per page (Foxy default 20). |
| offset | integer | Pagination offset. |
| store_id | any | Store id. If omitted, the default store (fx:store) is used. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"zoom": {
"type": "string",
"description": "Comma-separated related resources to embed, e.g. 'coupon_codes'."
},
"limit": {
"type": "integer",
"maximum": 300,
"minimum": 1,
"description": "Max results per page (Foxy default 20)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Pagination offset."
},
"store_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Store id. If omitted, the default store (fx:store) is used."
}
}
}List a store's customers. Returns a HAL collection embedding fx:customers. Foxy hAPI: GET /stores/{store_id}/customers.
| Argument | Type | Description |
|---|---|---|
| string | Filter by exact customer email. | |
| limit | integer | Max results per page (Foxy default 20). |
| offset | integer | Pagination offset. |
| store_id | any | Store id. If omitted, the default store (fx:store) is used. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email": {
"type": "string",
"description": "Filter by exact customer email."
},
"limit": {
"type": "integer",
"maximum": 300,
"minimum": 1,
"description": "Max results per page (Foxy default 20)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Pagination offset."
},
"store_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Store id. If omitted, the default store (fx:store) is used."
}
}
}List the line items of a transaction (the products purchased). Returns a HAL collection embedding fx:items. Foxy hAPI: GET /transactions/{transaction_id}/items.
| Argument | Type | Description |
|---|---|---|
| zoom | string | Comma-separated related resources to embed, e.g. 'item_options'. |
| limit | integer | Max results per page (Foxy default 20). |
| offset | integer | Pagination offset. |
| transaction_id* | any | Transaction id whose line items to list. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"transaction_id"
],
"properties": {
"zoom": {
"type": "string",
"description": "Comma-separated related resources to embed, e.g. 'item_options'."
},
"limit": {
"type": "integer",
"maximum": 300,
"minimum": 1,
"description": "Max results per page (Foxy default 20)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Pagination offset."
},
"transaction_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Transaction id whose line items to list."
}
}
}List a store's subscriptions (recurring orders). Returns a HAL collection embedding fx:subscriptions. Foxy hAPI: GET /stores/{store_id}/subscriptions.
| Argument | Type | Description |
|---|---|---|
| zoom | string | Comma-separated related resources to embed, e.g. 'transaction_template,last_transaction'. |
| limit | integer | Max results per page (Foxy default 20). |
| offset | integer | Pagination offset. |
| store_id | any | Store id. If omitted, the default store (fx:store) is used. |
| is_active | boolean | Filter to active (true) or inactive (false) subscriptions. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"zoom": {
"type": "string",
"description": "Comma-separated related resources to embed, e.g. 'transaction_template,last_transaction'."
},
"limit": {
"type": "integer",
"maximum": 300,
"minimum": 1,
"description": "Max results per page (Foxy default 20)."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Pagination offset."
},
"store_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Store id. If omitted, the default store (fx:store) is used."
},
"is_active": {
"type": "boolean",
"description": "Filter to active (true) or inactive (false) subscriptions."
}
}
}List a store's transactions (orders), newest first. Returns a HAL collection embedding fx:transactions. Foxy hAPI: GET /stores/{store_id}/transactions.
| Argument | Type | Description |
|---|---|---|
| zoom | string | Comma-separated related resources to embed, e.g. 'items,customer,payments'. |
| limit | integer | Max results per page (Foxy default 20). |
| order | string | Sort expression, e.g. 'transaction_date desc'. |
| offset | integer | Pagination offset. |
| is_test | boolean | Filter to test (true) or live (false) transactions. |
| store_id | any | Store id. If omitted, the default store (fx:store) is used. |
| customer_email | string | Filter by the transaction's customer email. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"zoom": {
"type": "string",
"description": "Comma-separated related resources to embed, e.g. 'items,customer,payments'."
},
"limit": {
"type": "integer",
"maximum": 300,
"minimum": 1,
"description": "Max results per page (Foxy default 20)."
},
"order": {
"type": "string",
"description": "Sort expression, e.g. 'transaction_date desc'."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Pagination offset."
},
"is_test": {
"type": "boolean",
"description": "Filter to test (true) or live (false) transactions."
},
"store_id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Store id. If omitted, the default store (fx:store) is used."
},
"customer_email": {
"type": "string",
"description": "Filter by the transaction's customer email."
}
}
}UPDATES a customer's profile fields (first_name, last_name, email). This MODIFIES live store data. Foxy hAPI: PATCH /customers/{id}. Provide only the fields you want to change.
| Argument | Type | Description |
|---|---|---|
| id* | any | Customer id to update. |
| string | New email address. | |
| last_name | string | New last name. |
| first_name | string | New first name. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Customer id to update."
},
"email": {
"type": "string",
"description": "New email address."
},
"last_name": {
"type": "string",
"description": "New last name."
},
"first_name": {
"type": "string",
"description": "New first name."
}
}
}UPDATES a subscription — reschedule its next run (next_transaction_date), change its frequency, or activate/pause it (is_active). This MODIFIES live store data and affects future billing. Foxy hAPI: PATCH /subscriptions/{id}. Provide only the fields you want to change.
| Argument | Type | Description |
|---|---|---|
| id* | any | Subscription id to update. |
| frequency | string | Billing frequency, e.g. '1m' (monthly), '2w' (2 weeks), '1y' (yearly). |
| is_active | boolean | Set true to activate or false to pause the subscription. |
| next_transaction_date | string | Next run date, YYYY-MM-DD (reschedules the subscription). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Subscription id to update."
},
"frequency": {
"type": "string",
"description": "Billing frequency, e.g. '1m' (monthly), '2w' (2 weeks), '1y' (yearly)."
},
"is_active": {
"type": "boolean",
"description": "Set true to activate or false to pause the subscription."
},
"next_transaction_date": {
"type": "string",
"description": "Next run date, YYYY-MM-DD (reschedules the subscription)."
}
}
}