Apilo MCP by usefulapi
Read orders, shipments, products and stock; set order status, notes and stock quantity in Apilo.
我該用這個嗎
品質與安全性
根據工具定義與協定合規性的自動化分析。
上下文成本
這是每次將伺服器的工具載入模型上下文時所消耗的約略 token 數量。數量越高，可用於其他工作的注意力就越少。
安裝
一鍵安裝
將以下內容加入你的 `claude_desktop_config.json` 檔案：
{
"mcpServers": {
"apilo": {
"url": "https://apilo.usefulapi.io/mcp"
}
}
}遠端端點
https://apilo.usefulapi.io/mcpstreamable-http它能做什麼
工具清單
工具（17）
🟢apilo_whoami
The Apilo API key (application) this connection uses: client id, name and the date it is valid to. GET /rest/api/whoami/.
輸入結構描述
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢apilo_get_map(table)
Apilo's id lookup tables, each a list of { id, key, name, description }: `status` (order statuses, for apilo_list_orders and apilo_update_order_status), `payment` (payment types), `carrier`, `carrier_account`, `platform` (sales channels and their accounts), `tag`, `document` (document types), `shipment_status`. GET /rest/api/orders/<table>/map/.
輸入結構描述
{
"type": "object",
"properties": {
"table": {
"type": "string",
"enum": [
"status",
"payment",
"carrier",
"carrier_account",
"platform",
"tag",
"document",
"shipment_status"
],
"description": "Which lookup table."
}
},
"required": [
"table"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢apilo_list_orders(createdAfter, createdBefore, orderedAfter, orderedBefore, updatedAfter, ...)
List or search orders (all connected marketplaces and shops), with items, customer address and totals. Filter by date, status, payment, sales channel, carrier, email or phone. Status, payment, carrier and platform ids come from apilo_get_map. Page with limit/offset (reply has totalCount and next_offset). GET /rest/api/orders/.
輸入結構描述
{
"type": "object",
"properties": {
"createdAfter": {
"description": "Created at or after (ISO 8601 date or date-time; offsets are converted to UTC, no zone = UTC).",
"type": "string"
},
"createdBefore": {
"description": "Created at or before (ISO 8601).",
"type": "string"
},
"orderedAfter": {
"description": "Ordered by the buyer at or after (ISO 8601).",
"type": "string"
},
"orderedBefore": {
"description": "Ordered by the buyer at or before (ISO 8601).",
"type": "string"
},
"updatedAfter": {
"description": "Updated at or after (ISO 8601).",
"type": "string"
},
"updatedBefore": {
"description": "Updated at or before (ISO 8601).",
"type": "string"
},
"id": {
"description": "Apilo order id.",
"type": "string",
"pattern": "^[A-Za-z0-9.|]{10,11}$"
},
"idExternal": {
"description": "The order id in the marketplace or shop.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"orderStatusIds": {
"description": "Only these order statuses (ids from apilo_get_map status).",
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"paymentStatus": {
"description": "Payment status code.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"paymentType": {
"description": "Payment type id (apilo_get_map payment).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"isOrderDocument": {
"description": "Only orders with (true) or without (false) an order document.",
"type": "boolean"
},
"platformAccountId": {
"description": "Only orders of this sales channel account (apilo_get_map platform).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"carrierId": {
"description": "Only orders with this carrier (apilo_get_map carrier).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"email": {
"description": "Customer email.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"phone": {
"description": "Customer phone.",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"sort": {
"description": "Sort order.",
"type": "string",
"enum": [
"createdAtAsc",
"createdAtDesc",
"updatedAtAsc",
"updatedAtDesc",
"orderedAtAsc",
"orderedAtDesc"
]
},
"limit": {
"description": "Results per page, 1-512 (default 25).",
"type": "integer",
"minimum": 1,
"maximum": 512
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 10000000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢apilo_get_order(id)
One order in full: status, payment, items (SKU, EAN, price, quantity), customer/delivery/invoice addresses, payments, notes, discounts, carrier and sales channel. GET /rest/api/orders/{id}/.
輸入結構描述
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9.|]{10,11}$",
"description": "Apilo order id, e.g. AL231100017 (the `id` of an order from apilo_list_orders)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢apilo_list_order_notes(id)
The notes of an order (internal notes and customer messages), with type 1 = customer message, 2 = internal note. GET /rest/api/orders/{id}/note/.
輸入結構描述
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9.|]{10,11}$",
"description": "Apilo order id, e.g. AL231100017 (the `id` of an order from apilo_list_orders)."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢apilo_list_order_documents(id, limit, offset)
The documents attached to an order (invoices, receipts, labels). GET /rest/api/orders/{id}/documents/.
輸入結構描述
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9.|]{10,11}$",
"description": "Apilo order id, e.g. AL231100017 (the `id` of an order from apilo_list_orders)."
},
"limit": {
"description": "Results per page, 1-512 (default 25).",
"type": "integer",
"minimum": 1,
"maximum": 512
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 10000000
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢apilo_list_order_shipments(id, limit, offset)
The shipments created for an order (Apilo id and carrier's id). GET /rest/api/orders/{id}/shipment/.
輸入結構描述
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9.|]{10,11}$",
"description": "Apilo order id, e.g. AL231100017 (the `id` of an order from apilo_list_orders)."
},
"limit": {
"description": "Results per page, 1-512 (default 25).",
"type": "integer",
"minimum": 1,
"maximum": 512
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 10000000
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢apilo_get_shipment(id, shipment)
One shipment of an order with its details. GET /rest/api/orders/{id}/shipment/{shipment}/.
輸入結構描述
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9.|]{10,11}$",
"description": "Apilo order id, e.g. AL231100017 (the `id` of an order from apilo_list_orders)."
},
"shipment": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Shipment id from apilo_list_order_shipments."
}
},
"required": [
"id",
"shipment"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢apilo_list_shipment_tracking(carrierAccountId, postDateAfter, postDateBefore, receivedDateAfter, receivedDateBefore, ...)
Tracking status of shipments (status, status date and description, received date and days in transit), filtered by carrier account, post date, received date or status. Page with limit/offset (reply has totalCount and next_offset). GET /rest/api/shipping/shipment/tracking/.
輸入結構描述
{
"type": "object",
"properties": {
"carrierAccountId": {
"description": "Carrier account ids (apilo_get_map carrier_account).",
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"postDateAfter": {
"description": "Shipment created in Apilo at or after (ISO 8601).",
"type": "string"
},
"postDateBefore": {
"description": "Shipment created in Apilo at or before (ISO 8601).",
"type": "string"
},
"receivedDateAfter": {
"description": "Delivered at or after (ISO 8601).",
"type": "string"
},
"receivedDateBefore": {
"description": "Delivered at or before (ISO 8601).",
"type": "string"
},
"status": {
"description": "Shipment status codes: 0 new, 1 waiting, 2 registered, 21 in delivery, 9 removed, 31 awaiting collection, 32 returning/error, 100 received, 101 return delivered.",
"minItems": 1,
"maxItems": 9,
"type": "array",
"items": {
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
},
{
"type": "number",
"const": 21
},
{
"type": "number",
"const": 9
},
{
"type": "number",
"const": 31
},
{
"type": "number",
"const": 32
},
{
"type": "number",
"const": 100
},
{
"type": "number",
"const": 101
}
]
}
},
"limit": {
"description": "Results per page, 1-512 (default 25).",
"type": "integer",
"minimum": 1,
"maximum": 512
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 10000000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢apilo_list_products(id, sku, name, ean, status, ...)
List warehouse products with SKU, EAN, name, stock quantity, prices, tax and location. Filter by id, SKU, name, EAN or status. GET /rest/api/warehouse/product/.
輸入結構描述
{
"type": "object",
"properties": {
"id": {
"description": "Apilo product id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"sku": {
"description": "Exact SKU.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"name": {
"description": "Product name (text).",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"ean": {
"description": "EAN.",
"type": "string",
"minLength": 1,
"maxLength": 32
},
"status": {
"description": "0 inactive, 1 active, 8 archived.",
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 8
}
]
},
"limit": {
"description": "Results per page, 1-512 (default 25).",
"type": "integer",
"minimum": 1,
"maximum": 512
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 10000000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢apilo_get_product(id)
One warehouse product by Apilo id. GET /rest/api/warehouse/product/{id}/.
輸入結構描述
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Apilo product id."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢apilo_list_categories(id, limit, offset)
Product categories with id, name and parent ids. GET /rest/api/warehouse/category/.
輸入結構描述
{
"type": "object",
"properties": {
"id": {
"description": "Only this category id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"limit": {
"description": "Results per page, 1-512 (default 25).",
"type": "integer",
"minimum": 1,
"maximum": 512
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 10000000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢apilo_list_locations(id, name, code, limit, offset)
Warehouse locations (shelves, bins) with id, name and code. GET /rest/api/warehouse/location/.
輸入結構描述
{
"type": "object",
"properties": {
"id": {
"description": "Only this location id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"name": {
"description": "Location name.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"code": {
"description": "Location code.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"limit": {
"description": "Results per page, 1-512 (default 25).",
"type": "integer",
"minimum": 1,
"maximum": 512
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 10000000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢apilo_list_finance_documents(type, invoiceAfter, invoiceBefore, limit, offset)
Accounting documents (invoices, receipts, corrections) with number, amounts, currency and dates. Filter by type and invoice date. GET /rest/api/finance/documents/.
輸入結構描述
{
"type": "object",
"properties": {
"type": {
"description": "Document type: 1 invoice, 5 receipt, 10 proforma, 31 corrective invoice.",
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 5
},
{
"type": "number",
"const": 10
},
{
"type": "number",
"const": 31
}
]
},
"invoiceAfter": {
"description": "Invoiced at or after (ISO 8601 date or date-time).",
"type": "string"
},
"invoiceBefore": {
"description": "Invoiced at or before (ISO 8601 date or date-time).",
"type": "string"
},
"limit": {
"description": "Results per page, 1-512 (default 25).",
"type": "integer",
"minimum": 1,
"maximum": 512
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 10000000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴apilo_update_order_status(id, status)
WRITE: set an order's status (id from apilo_get_map status). Apilo may run its own automations on a status change (emails, marketplace updates, shipping). Setting the current status changes nothing. PUT /rest/api/orders/{id}/status/.
輸入結構描述
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9.|]{10,11}$",
"description": "Apilo order id, e.g. AL231100017 (the `id` of an order from apilo_list_orders)."
},
"status": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "New status id (apilo_get_map status)."
}
},
"required": [
"id",
"status"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡apilo_add_order_note(id, comment)
WRITE: add an INTERNAL note to an order (never a message to the customer). Not idempotent: calling twice adds two notes. POST /rest/api/orders/{id}/note/.
輸入結構描述
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9.|]{10,11}$",
"description": "Apilo order id, e.g. AL231100017 (the `id` of an order from apilo_list_orders)."
},
"comment": {
"type": "string",
"minLength": 1,
"maxLength": 1024,
"description": "The note text, up to 1024 characters."
}
},
"required": [
"id",
"comment"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴apilo_set_product_stock(id, quantity)
WRITE: set the stock quantity of one warehouse product to an absolute number (it replaces the current quantity, so read it with apilo_get_product first if unsure). Apilo may push the new quantity to connected marketplaces. PATCH /rest/api/warehouse/product/.
輸入結構描述
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Apilo product id."
},
"quantity": {
"type": "integer",
"minimum": 0,
"maximum": 10000000,
"description": "The new stock quantity (units)."
}
},
"required": [
"id",
"quantity"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}社群
證據