Apilo MCP by usefulapi is an MCP server published by io.usefulapi, hosted at apilo.usefulapi.io. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 17 tools, including apilo_whoami, apilo_get_map, apilo_list_orders, apilo_get_order, apilo_list_order_notes.
Read orders, shipments, products and stock; set order status, notes and stock quantity in Apilo.
4,088 connections through 5 shared values. Tap any node.
Inferred from the host name and headers: what a server runs on, not who runs it.
The Apilo API key (application) this connection uses: client id, name and the date it is valid to. GET /rest/api/whoami/.
No parameters.
{
"name": "apilo_whoami",
"title": "Get API key info",
"description": "The Apilo API key (application) this connection uses: client id, name and the date it is valid to. GET /rest/api/whoami/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "Get API key info",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}None yet. Changes appear after a server's second daily check.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
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/.
| Parameter | Type | Description |
|---|---|---|
| table * | string | Which lookup table. |
{
"name": "apilo_get_map",
"title": "Get lookup table",
"description": "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/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"table"
],
"properties": {
"table": {
"enum": [
"status",
"payment",
"carrier",
"carrier_account",
"platform",
"tag",
"document",
"shipment_status"
],
"type": "string",
"description": "Which lookup table."
}
}
},
"annotations": {
"title": "Get lookup table",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}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/.
| Parameter | Type | Description |
|---|---|---|
| id | string | Apilo order id. |
| sort | string | Sort order. |
| string | Customer email. | |
| limit | integer | Results per page, 1-512 (default 25). |
| phone | string | Customer phone. |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
| carrierId | integer | Only orders with this carrier (apilo_get_map carrier). |
| idExternal | string | The order id in the marketplace or shop. |
| paymentType | integer | Payment type id (apilo_get_map payment). |
| createdAfter | string | Created at or after (ISO 8601 date or date-time; offsets are converted to UTC, no zone = UTC). |
| orderedAfter | string | Ordered by the buyer at or after (ISO 8601). |
| updatedAfter | string | Updated at or after (ISO 8601). |
| createdBefore | string | Created at or before (ISO 8601). |
| orderedBefore | string | Ordered by the buyer at or before (ISO 8601). |
| paymentStatus | integer | Payment status code. |
| updatedBefore | string | Updated at or before (ISO 8601). |
| orderStatusIds | array | Only these order statuses (ids from apilo_get_map status). |
| isOrderDocument | boolean | Only orders with (true) or without (false) an order document. |
| platformAccountId | integer | Only orders of this sales channel account (apilo_get_map platform). |
{
"name": "apilo_list_orders",
"title": "List orders",
"description": "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/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9.|]{10,11}$",
"description": "Apilo order id."
},
"sort": {
"enum": [
"createdAtAsc",
"createdAtDesc",
"updatedAtAsc",
"updatedAtDesc",
"orderedAtAsc",
"orderedAtDesc"
],
"type": "string",
"description": "Sort order."
},
"email": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Customer email."
},
"limit": {
"type": "integer",
"maximum": 512,
"minimum": 1,
"description": "Results per page, 1-512 (default 25)."
},
"phone": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Customer phone."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
},
"carrierId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only orders with this carrier (apilo_get_map carrier).",
"exclusiveMinimum": 0
},
"idExternal": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "The order id in the marketplace or shop."
},
"paymentType": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Payment type id (apilo_get_map payment).",
"exclusiveMinimum": 0
},
"createdAfter": {
"type": "string",
"description": "Created at or after (ISO 8601 date or date-time; offsets are converted to UTC, no zone = UTC)."
},
"orderedAfter": {
"type": "string",
"description": "Ordered by the buyer at or after (ISO 8601)."
},
"updatedAfter": {
"type": "string",
"description": "Updated at or after (ISO 8601)."
},
"createdBefore": {
"type": "string",
"description": "Created at or before (ISO 8601)."
},
"orderedBefore": {
"type": "string",
"description": "Ordered by the buyer at or before (ISO 8601)."
},
"paymentStatus": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Payment status code.",
"exclusiveMinimum": 0
},
"updatedBefore": {
"type": "string",
"description": "Updated at or before (ISO 8601)."
},
"orderStatusIds": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"minItems": 1,
"description": "Only these order statuses (ids from apilo_get_map status)."
},
"isOrderDocument": {
"type": "boolean",
"description": "Only orders with (true) or without (false) an order document."
},
"platformAccountId": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only orders of this sales channel account (apilo_get_map platform).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List orders",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}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}/.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Apilo order id, e.g. AL231100017 (the `id` of an order from apilo_list_orders). |
{
"name": "apilo_get_order",
"title": "Get order",
"description": "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}/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"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)."
}
}
},
"annotations": {
"title": "Get order",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The notes of an order (internal notes and customer messages), with type 1 = customer message, 2 = internal note. GET /rest/api/orders/{id}/note/.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Apilo order id, e.g. AL231100017 (the `id` of an order from apilo_list_orders). |
{
"name": "apilo_list_order_notes",
"title": "List order notes",
"description": "The notes of an order (internal notes and customer messages), with type 1 = customer message, 2 = internal note. GET /rest/api/orders/{id}/note/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"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)."
}
}
},
"annotations": {
"title": "List order notes",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The documents attached to an order (invoices, receipts, labels). GET /rest/api/orders/{id}/documents/.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Apilo order id, e.g. AL231100017 (the `id` of an order from apilo_list_orders). |
| limit | integer | Results per page, 1-512 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
{
"name": "apilo_list_order_documents",
"title": "List order documents",
"description": "The documents attached to an order (invoices, receipts, labels). GET /rest/api/orders/{id}/documents/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"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": {
"type": "integer",
"maximum": 512,
"minimum": 1,
"description": "Results per page, 1-512 (default 25)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
}
}
},
"annotations": {
"title": "List order documents",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}The shipments created for an order (Apilo id and carrier's id). GET /rest/api/orders/{id}/shipment/.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Apilo order id, e.g. AL231100017 (the `id` of an order from apilo_list_orders). |
| limit | integer | Results per page, 1-512 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
{
"name": "apilo_list_order_shipments",
"title": "List order shipments",
"description": "The shipments created for an order (Apilo id and carrier's id). GET /rest/api/orders/{id}/shipment/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"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": {
"type": "integer",
"maximum": 512,
"minimum": 1,
"description": "Results per page, 1-512 (default 25)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
}
}
},
"annotations": {
"title": "List order shipments",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One shipment of an order with its details. GET /rest/api/orders/{id}/shipment/{shipment}/.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Apilo order id, e.g. AL231100017 (the `id` of an order from apilo_list_orders). |
| shipment * | string | Shipment id from apilo_list_order_shipments. |
{
"name": "apilo_get_shipment",
"title": "Get order shipment",
"description": "One shipment of an order with its details. GET /rest/api/orders/{id}/shipment/{shipment}/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"shipment"
],
"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",
"maxLength": 64,
"minLength": 1,
"description": "Shipment id from apilo_list_order_shipments."
}
}
},
"annotations": {
"title": "Get order shipment",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}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/.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-512 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
| status | array | 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. |
| postDateAfter | string | Shipment created in Apilo at or after (ISO 8601). |
| postDateBefore | string | Shipment created in Apilo at or before (ISO 8601). |
| carrierAccountId | array | Carrier account ids (apilo_get_map carrier_account). |
| receivedDateAfter | string | Delivered at or after (ISO 8601). |
| receivedDateBefore | string | Delivered at or before (ISO 8601). |
{
"name": "apilo_list_shipment_tracking",
"title": "List shipment tracking",
"description": "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/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 512,
"minimum": 1,
"description": "Results per page, 1-512 (default 25)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
},
"status": {
"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
}
]
},
"maxItems": 9,
"minItems": 1,
"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."
},
"postDateAfter": {
"type": "string",
"description": "Shipment created in Apilo at or after (ISO 8601)."
},
"postDateBefore": {
"type": "string",
"description": "Shipment created in Apilo at or before (ISO 8601)."
},
"carrierAccountId": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"minItems": 1,
"description": "Carrier account ids (apilo_get_map carrier_account)."
},
"receivedDateAfter": {
"type": "string",
"description": "Delivered at or after (ISO 8601)."
},
"receivedDateBefore": {
"type": "string",
"description": "Delivered at or before (ISO 8601)."
}
}
},
"annotations": {
"title": "List shipment tracking",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}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/.
| Parameter | Type | Description |
|---|---|---|
| id | integer | Apilo product id. |
| ean | string | EAN. |
| sku | string | Exact SKU. |
| name | string | Product name (text). |
| limit | integer | Results per page, 1-512 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
| status | any | 0 inactive, 1 active, 8 archived. |
{
"name": "apilo_list_products",
"title": "List products",
"description": "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/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Apilo product id.",
"exclusiveMinimum": 0
},
"ean": {
"type": "string",
"maxLength": 32,
"minLength": 1,
"description": "EAN."
},
"sku": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Exact SKU."
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Product name (text)."
},
"limit": {
"type": "integer",
"maximum": 512,
"minimum": 1,
"description": "Results per page, 1-512 (default 25)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
},
"status": {
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 8
}
],
"description": "0 inactive, 1 active, 8 archived."
}
}
},
"annotations": {
"title": "List products",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One warehouse product by Apilo id. GET /rest/api/warehouse/product/{id}/.
| Parameter | Type | Description |
|---|---|---|
| id * | integer | Apilo product id. |
{
"name": "apilo_get_product",
"title": "Get product",
"description": "One warehouse product by Apilo id. GET /rest/api/warehouse/product/{id}/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Apilo product id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get product",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Product categories with id, name and parent ids. GET /rest/api/warehouse/category/.
| Parameter | Type | Description |
|---|---|---|
| id | integer | Only this category id. |
| limit | integer | Results per page, 1-512 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
{
"name": "apilo_list_categories",
"title": "List categories",
"description": "Product categories with id, name and parent ids. GET /rest/api/warehouse/category/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this category id.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 512,
"minimum": 1,
"description": "Results per page, 1-512 (default 25)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
}
}
},
"annotations": {
"title": "List categories",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Warehouse locations (shelves, bins) with id, name and code. GET /rest/api/warehouse/location/.
| Parameter | Type | Description |
|---|---|---|
| id | integer | Only this location id. |
| code | string | Location code. |
| name | string | Location name. |
| limit | integer | Results per page, 1-512 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
{
"name": "apilo_list_locations",
"title": "List warehouse locations",
"description": "Warehouse locations (shelves, bins) with id, name and code. GET /rest/api/warehouse/location/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this location id.",
"exclusiveMinimum": 0
},
"code": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Location code."
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Location name."
},
"limit": {
"type": "integer",
"maximum": 512,
"minimum": 1,
"description": "Results per page, 1-512 (default 25)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
}
}
},
"annotations": {
"title": "List warehouse locations",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Accounting documents (invoices, receipts, corrections) with number, amounts, currency and dates. Filter by type and invoice date. GET /rest/api/finance/documents/.
| Parameter | Type | Description |
|---|---|---|
| type | any | Document type: 1 invoice, 5 receipt, 10 proforma, 31 corrective invoice. |
| limit | integer | Results per page, 1-512 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
| invoiceAfter | string | Invoiced at or after (ISO 8601 date or date-time). |
| invoiceBefore | string | Invoiced at or before (ISO 8601 date or date-time). |
{
"name": "apilo_list_finance_documents",
"title": "List accounting documents",
"description": "Accounting documents (invoices, receipts, corrections) with number, amounts, currency and dates. Filter by type and invoice date. GET /rest/api/finance/documents/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"type": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 5
},
{
"type": "number",
"const": 10
},
{
"type": "number",
"const": 31
}
],
"description": "Document type: 1 invoice, 5 receipt, 10 proforma, 31 corrective invoice."
},
"limit": {
"type": "integer",
"maximum": 512,
"minimum": 1,
"description": "Results per page, 1-512 (default 25)."
},
"offset": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
},
"invoiceAfter": {
"type": "string",
"description": "Invoiced at or after (ISO 8601 date or date-time)."
},
"invoiceBefore": {
"type": "string",
"description": "Invoiced at or before (ISO 8601 date or date-time)."
}
}
},
"annotations": {
"title": "List accounting documents",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}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/.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Apilo order id, e.g. AL231100017 (the `id` of an order from apilo_list_orders). |
| status * | integer | New status id (apilo_get_map status). |
{
"name": "apilo_update_order_status",
"title": "Update order status",
"description": "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/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"status"
],
"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",
"maximum": 9007199254740991,
"description": "New status id (apilo_get_map status).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Update order status",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}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/.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Apilo order id, e.g. AL231100017 (the `id` of an order from apilo_list_orders). |
| comment * | string | The note text, up to 1024 characters. |
{
"name": "apilo_add_order_note",
"title": "Add internal order note",
"description": "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/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"comment"
],
"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",
"maxLength": 1024,
"minLength": 1,
"description": "The note text, up to 1024 characters."
}
}
},
"annotations": {
"title": "Add internal order note",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}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/.
| Parameter | Type | Description |
|---|---|---|
| id * | integer | Apilo product id. |
| quantity * | integer | The new stock quantity (units). |
{
"name": "apilo_set_product_stock",
"title": "Set product stock quantity",
"description": "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/.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"quantity"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Apilo product id.",
"exclusiveMinimum": 0
},
"quantity": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "The new stock quantity (units)."
}
}
},
"annotations": {
"title": "Set product stock quantity",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}Tools for Apilo, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Which orders came in today and are still unpaid?"; "Show order AL231100017 with its items and delivery address."; "Which products have a stock quantity below 5?". Read-only tools never change data; ask the user before a tool that creates, changes or deletes Apilo data. Free plan: 50 tool calls per month. Run apilo_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run apilo_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run apilo_upgrade without a plan: it returns both plans, each with a payment link for the user to open. apilo_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Shared addresses on big platforms (Cloudflare, Vercel and the like) put unrelated servers together; those are marked shared_infrastructure. A match is a pivot, not a link between operators.