Servers Playground How we check Add a server Log in

Sapo MCP by usefulapi

Working · 3.5 s

io.usefulapi/sapov1.2.0 Domain verified

Read Sapo store products, orders, customers and stock levels; edit order notes and stock.

Commerce

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://sapo.usefulapi.io/mcp

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.

sapo_count_customers Read-only

Total number of customers. GET /admin/customers/count.json.

This tool takes no arguments.

Sapo MCP by usefulapi MCP server | mcptry

Tools (20)

sapo_count_customers

Total number of customers. GET /admin/customers/count.json.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

sapo_count_orders

Number of orders matching the filters. GET /admin/orders/count.json.

read-only

Argument	Type	Description
status	string	Order status: open (Sapo default when omitted, so archived orders are left out), closed, or any (all orders). Pass any for date-range totals.
created_on_max	string	ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
created_on_min	string	ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
modified_on_max	string	ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
modified_on_min	string	ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
financial_status	string	Payment status: authorized, pending, paid, refunded, voided, or any. Sapo default when omitted: authorized, pending and paid only (refunded and voided are left out).
fulfillment_status	string	Fulfillment status (for example unfulfilled, fulfilled, partial).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "status": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Order status: open (Sapo default when omitted, so archived orders are left out), closed, or any (all orders). Pass any for date-range totals."
    },
    "created_on_max": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    },
    "created_on_min": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    },
    "modified_on_max": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    },
    "modified_on_min": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    },
    "financial_status": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Payment status: authorized, pending, paid, refunded, voided, or any. Sapo default when omitted: authorized, pending and paid only (refunded and voided are left out)."
    },
    "fulfillment_status": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Fulfillment status (for example unfulfilled, fulfilled, partial)."
    }
  }
}

sapo_count_products

Number of products matching the filters. GET /admin/products/count.json.

read-only

Argument	Type	Description
vendor	string	Exact vendor (brand) name.
product_type	string	Exact product type.
collection_id	integer	Only products in this collection (see sapo_list_custom_collections).
created_on_max	string	ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
created_on_min	string	ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "vendor": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Exact vendor (brand) name."
    },
    "product_type": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Exact product type."
    },
    "collection_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only products in this collection (see sapo_list_custom_collections).",
      "exclusiveMinimum": 0
    },
    "created_on_max": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    },
    "created_on_min": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    }
  }
}

sapo_get_customer

One customer by id. GET /admin/customers/{id}.json.

read-only

Argument	Type	Description
customer_id*	integer	Sapo customer id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id"
  ],
  "properties": {
    "customer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Sapo customer id.",
      "exclusiveMinimum": 0
    }
  }
}

sapo_get_order

One order by id with line items, addresses, discounts, payment and shipping. GET /admin/orders/{id}.json.

read-only

Argument	Type	Description
order_id*	integer	Sapo order id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order_id"
  ],
  "properties": {
    "order_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Sapo order id.",
      "exclusiveMinimum": 0
    }
  }
}

sapo_get_product

One product by id, with variants and images. GET /admin/products/{id}.json.

read-only

Argument	Type	Description
product_id*	integer	Sapo product id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id"
  ],
  "properties": {
    "product_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Sapo product id.",
      "exclusiveMinimum": 0
    }
  }
}

sapo_get_product_variant

One product variant by id. GET /admin/variants/{id}.json.

read-only

Argument	Type	Description
variant_id*	integer	Sapo variant id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "variant_id"
  ],
  "properties": {
    "variant_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Sapo variant id.",
      "exclusiveMinimum": 0
    }
  }
}

sapo_get_store

The Sapo store this login belongs to: name, domain, currency, timezone, plan and other settings. GET /admin/store.json.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

sapo_list_custom_collections

List manual product collections (danh mục thủ công). Paged. GET /admin/custom_collections.json.

read-only

Argument	Type	Description
name	string	Filter by collection name.
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
limit	integer	Results per page, 1-250 (default 50).
product_id	integer	Only collections that contain this product.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Filter by collection name."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "maximum": 250,
      "description": "Results per page, 1-250 (default 50).",
      "exclusiveMinimum": 0
    },
    "product_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only collections that contain this product.",
      "exclusiveMinimum": 0
    }
  }
}

sapo_list_customers

List customers with contact details, addresses, order count and total spent. Paged. GET /admin/customers.json.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
limit	integer	Results per page, 1-250 (default 50).
since_id	integer	Only customers with an id greater than this.
created_on_max	string	ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
created_on_min	string	ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
modified_on_max	string	ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
modified_on_min	string	ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "maximum": 250,
      "description": "Results per page, 1-250 (default 50).",
      "exclusiveMinimum": 0
    },
    "since_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only customers with an id greater than this.",
      "exclusiveMinimum": 0
    },
    "created_on_max": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    },
    "created_on_min": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    },
    "modified_on_max": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    },
    "modified_on_min": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    }
  }
}

sapo_list_inventory_items

List inventory items (one per variant) by SKU/barcode search, variant or product ids. The id is what stock levels use as inventory_item_id. Paged. GET /admin/inventory_items.json.

read-only

Argument	Type	Description
ids	array	Only these inventory item ids.
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
limit	integer	Results per page, 1-250 (default 50).
query	string	Search by barcode or SKU.
product_ids	array	Only these product ids.
variant_ids	array	Only these variant ids.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 250,
      "minItems": 1,
      "description": "Only these inventory item ids."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "maximum": 250,
      "description": "Results per page, 1-250 (default 50).",
      "exclusiveMinimum": 0
    },
    "query": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Search by barcode or SKU."
    },
    "product_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 250,
      "minItems": 1,
      "description": "Only these product ids."
    },
    "variant_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 250,
      "minItems": 1,
      "description": "Only these variant ids."
    }
  }
}

sapo_list_inventory_levels

Stock per item and location: on_hand, available, committed, incoming, reserved. Filter by inventory item or location ids, or by a minimum/maximum available quantity. Sapo documents no paging for this list, so narrow it with ids. GET /admin/inventory_levels.json.

read-only

Argument	Type	Description
location_ids	array	Only these location ids (see sapo_list_locations).
available_max	number	Only levels with at most this much available.
available_min	number	Only levels with at least this much available.
inventory_item_ids	array	Only these inventory item ids (see sapo_list_inventory_items).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "location_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 250,
      "minItems": 1,
      "description": "Only these location ids (see sapo_list_locations)."
    },
    "available_max": {
      "type": "number",
      "description": "Only levels with at most this much available."
    },
    "available_min": {
      "type": "number",
      "description": "Only levels with at least this much available."
    },
    "inventory_item_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 250,
      "minItems": 1,
      "description": "Only these inventory item ids (see sapo_list_inventory_items)."
    }
  }
}

sapo_list_locations

List branches, stores and warehouses (id, name, address, whether they track stock). Use the ids for stock levels. Paged. GET /admin/locations.json.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
limit	integer	Results per page, 1-250 (default 50).
query	string	Search by name, code or phone.
status	string	Branch status; Sapo spells the inactive value "expried".

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "maximum": 250,
      "description": "Results per page, 1-250 (default 50).",
      "exclusiveMinimum": 0
    },
    "query": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Search by name, code or phone."
    },
    "status": {
      "enum": [
        "active",
        "expried"
      ],
      "type": "string",
      "description": "Branch status; Sapo spells the inactive value \"expried\"."
    }
  }
}

sapo_list_order_transactions

The payment transactions recorded on one order. GET /admin/orders/{order_id}/transactions.json.

read-only

Argument	Type	Description
order_id*	integer	Sapo order id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order_id"
  ],
  "properties": {
    "order_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Sapo order id.",
      "exclusiveMinimum": 0
    }
  }
}

sapo_list_orders

List orders with line items, customer, totals, payment and fulfillment status. Filter by status, tag, customer or dates. Paged: pass next_page as page. GET /admin/orders.json.

read-only

Argument	Type	Description
tag	string	Only orders with this tag.
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
limit	integer	Results per page, 1-250 (default 50).
query	string	Search text (order number, customer name, phone, email).
status	string	Order status: open (Sapo default when omitted, so archived orders are left out), closed, or any (all orders). Pass any for date-range totals.
customer_id	integer	Only orders of this customer.
created_on_max	string	ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
created_on_min	string	ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z.

sapo_list_price_rules

List discount price rules (percentage, fixed amount, fixed price) with validity dates and usage counts. Paged. GET /admin/price_rules.json.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
limit	integer	Results per page, 1-250 (default 50).
times_used	integer	Only rules used exactly this many times.
ends_on_max	string	Only rules that end on or before this date.
ends_on_min	string	Only rules that end on or after this date.
starts_on_max	string	Only rules that start on or before this date.
starts_on_min	string	Only rules that start on or after this date.
created_on_max	string	ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z.
created_on_min

sapo_list_product_variants

The variants (size, color, SKU, barcode, price) of one product. Paged. GET /admin/products/{product_id}/variants.json.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
limit	integer	Results per page, 1-250 (default 50).
product_id*	integer	Sapo product id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "maximum": 250,
      "description": "Results per page, 1-250 (default 50).",
      "exclusiveMinimum": 0
    },
    "product_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Sapo product id.",
      "exclusiveMinimum": 0
    }
  }
}

sapo_list_products

List products with their variants, prices, SKUs and images. Filter by name, vendor, type, collection or created/modified dates. Paged: pass next_page as page. GET /admin/products.json.

read-only

Argument	Type	Description
ids	array	Only these product ids.
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
limit	integer	Results per page, 1-250 (default 50).
query	string	Search by product name.
vendor	string	Exact vendor (brand) name.
since_id	integer	Only products with an id greater than this.
product_type	string	Exact product type.
collection_id	integer	Only products in this collection (see sapo_list_custom_collections).
created_on_max	string	ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z.

sapo_set_inventory_level

WRITE: set the physical stock (on_hand) of one inventory item at one location to an exact quantity, with a reason. This OVERWRITES the current number and is recorded as a stock adjustment: read the level first (sapo_list_inventory_levels). PUT /admin/inventory_levels/set.json.

destructive

Argument	Type	Description
reason	string	Why the stock changes (default: Sapo's own default).
on_hand*	number	Physical on-hand quantity to set (at most 3 decimals are kept).
location_id*	integer	Location id (see sapo_list_locations).
inventory_item_id*	integer	Inventory item id (see sapo_list_inventory_items).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "inventory_item_id",
    "location_id",
    "on_hand"
  ],
  "properties": {
    "reason": {
      "enum": [
        "inventory_change_by_damaged",
        "inventory_change_by_return_restock",
        "inventory_change_by_transfer",
        "inventory_change_by_manufacture",
        "inventory_change_by_loss",
        "inventory_change_by_correction",
        "inventory_change_by_other_reason"
      ],
      "type": "string",
      "description": "Why the stock changes (default: Sapo's own default)."
    },
    "on_hand": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0,
      "description": "Physical on-hand quantity to set (at most 3 decimals are kept)."
    },
    "location_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Location id (see sapo_list_locations).",
      "exclusiveMinimum": 0
    },
    "inventory_item_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Inventory item id (see sapo_list_inventory_items).",
      "exclusiveMinimum": 0
    }
  }
}

sapo_update_order

WRITE: set the note and/or the tags of an order (Sapo only lets an order's items and quantities stay fixed after creation). The value REPLACES the existing note or tags: read the order first to keep what is there. PUT /admin/orders/{id}.json.

destructive

Argument	Type	Description
note	string	New order note (replaces the old one; empty string clears it).
tags	array	New tag list (replaces all tags; an empty list clears them).
order_id*	integer	Sapo order id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "order_id"
  ],
  "properties": {
    "note": {
      "type": "string",
      "maxLength": 5000,
      "description": "New order note (replaces the old one; empty string clears it)."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 50,
      "description": "New tag list (replaces all tags; an empty list clears them)."
    },
    "order_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Sapo order id.",
      "exclusiveMinimum": 0
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "tag": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only orders with this tag."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "maximum": 250,
      "description": "Results per page, 1-250 (default 50).",
      "exclusiveMinimum": 0
    },
    "query": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Search text (order number, customer name, phone, email)."
    },
    "status": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Order status: open (Sapo default when omitted, so archived orders are left out), closed, or any (all orders). Pass any for date-range totals."
    },
    "customer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only orders of this customer.",
      "exclusiveMinimum": 0
    },
    "created_on_max": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    },
    "created_on_min": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    },
    "modified_on_max": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    },
    "modified_on_min": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    },
    "financial_status": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Payment status: authorized, pending, paid, refunded, voided, or any. Sapo default when omitted: authorized, pending and paid only (refunded and voided are left out)."
    },
    "fulfillment_status": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Fulfillment status (for example unfulfilled, fulfilled, partial)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 250,
      "minItems": 1,
      "description": "Only these product ids."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "maximum": 250,
      "description": "Results per page, 1-250 (default 50).",
      "exclusiveMinimum": 0
    },
    "query": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Search by product name."
    },
    "vendor": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Exact vendor (brand) name."
    },
    "since_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only products with an id greater than this.",
      "exclusiveMinimum": 0
    },
    "product_type": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Exact product type."
    },
    "collection_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only products in this collection (see sapo_list_custom_collections).",
      "exclusiveMinimum": 0
    },
    "created_on_max": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    },
    "created_on_min": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    },
    "modified_on_max": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    },
    "modified_on_min": {
      "type": "string",
      "description": "ISO 8601 date or date-time (UTC unless it carries an offset), e.g. 2026-10-01 or 2026-10-01T00:00:00Z."
    }
  }
}