Shoprocket MCP by usefulapi is an MCP server published by io.usefulapi, hosted at shoprocket.usefulapi.io. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 26 tools, including shoprocket_get_store, shoprocket_get_store_stats, shoprocket_list_orders, shoprocket_get_order, shoprocket_update_order_status.
MCP server for Shoprocket — orders, products, customers, store stats and discount codes.
4,279 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 Shoprocket store this key belongs to: name, address, environment (test or live), paused state, currencies and languages, setup status. The store's API keys are never returned. GET /v1/store/details.
No parameters.
{
"name": "shoprocket_get_store",
"title": "Get store",
"description": "The Shoprocket store this key belongs to: name, address, environment (test or live), paused state, currencies and languages, setup status. The store's API keys are never returned. GET /v1/store/details.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "Get store",
"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.
Sales statistics for a date range, compared with the previous period: orders, revenue, visitors, abandoned carts, conversion rate, average order value, a daily sales graph, regions, sources and popular products. GET /v1/store/stats.
| Parameter | Type | Description |
|---|---|---|
| to * | string | Last day, yyyy-mm-dd. |
| from * | string | First day, yyyy-mm-dd. |
{
"name": "shoprocket_get_store_stats",
"title": "Get store stats",
"description": "Sales statistics for a date range, compared with the previous period: orders, revenue, visitors, abandoned carts, conversion rate, average order value, a daily sales graph, regions, sources and popular products. GET /v1/store/stats.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"from",
"to"
],
"properties": {
"to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Last day, yyyy-mm-dd."
},
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "First day, yyyy-mm-dd."
}
}
},
"annotations": {
"title": "Get store stats",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List or search orders with totals, customer, addresses, payment and fulfillment status, discounts, line items and shipping. Filter by payment status, fulfillment status, payment method, customer ids, amount range, sale/discount use or free text. GET /v1/orders.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
| search | string | Free-text search: order number, total amount, customer email or name, dates, statuses. |
| status | string | Payment status of the order. |
| customer | string | Comma-separated customer ids (cus_...): only their orders. |
| has_sale | boolean | true: only orders where a sale promotion applied. |
| payment_method | string | Only orders paid with this method. |
| order_amount_to | number | Only orders of at most this amount. |
| has_discount_code | boolean | true: only orders where a discount code applied. |
| order_amount_from | number | Only orders of at least this amount. |
| fulfillment_status | string | Fulfillment status of the order. |
| has_automatic_discount | boolean | true: only orders where an automatic discount applied. |
{
"name": "shoprocket_list_orders",
"title": "List orders",
"description": "List or search orders with totals, customer, addresses, payment and fulfillment status, discounts, line items and shipping. Filter by payment status, fulfillment status, payment method, customer ids, amount range, sale/discount use or free text. GET /v1/orders.",
"inputSchema": {
"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": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search: order number, total amount, customer email or name, dates, statuses."
},
"status": {
"enum": [
"payment_pending",
"paid",
"disputed",
"refunded",
"partially_refunded",
"failed",
"abandoned"
],
"type": "string",
"description": "Payment status of the order."
},
"customer": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "Comma-separated customer ids (cus_...): only their orders."
},
"has_sale": {
"type": "boolean",
"description": "true: only orders where a sale promotion applied."
},
"payment_method": {
"enum": [
"payu",
"free",
"stripe",
"manual",
"paypal"
],
"type": "string",
"description": "Only orders paid with this method."
},
"order_amount_to": {
"type": "number",
"minimum": 0,
"description": "Only orders of at most this amount."
},
"has_discount_code": {
"type": "boolean",
"description": "true: only orders where a discount code applied."
},
"order_amount_from": {
"type": "number",
"minimum": 0,
"description": "Only orders of at least this amount."
},
"fulfillment_status": {
"enum": [
"awaiting_processing",
"processing",
"shipped",
"delivered",
"cancelled",
"returned",
"ready_for_pickup",
"not_applicable"
],
"type": "string",
"description": "Fulfillment status of the order."
},
"has_automatic_discount": {
"type": "boolean",
"description": "true: only orders where an automatic discount applied."
}
}
},
"annotations": {
"title": "List orders",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One order by id (ord_..., not the #number shown in the dashboard): totals, customer, billing and shipping address, payment and fulfillment status, discounts, line items and tracking. GET /v1/orders/{id}.
| Parameter | Type | Description |
|---|---|---|
| order_id * | string | Shoprocket order id, e.g. ord_646e1f65ebcad629610675. Find it with shoprocket_list_orders. |
{
"name": "shoprocket_get_order",
"title": "Get order",
"description": "One order by id (ord_..., not the #number shown in the dashboard): totals, customer, billing and shipping address, payment and fulfillment status, discounts, line items and tracking. GET /v1/orders/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"order_id"
],
"properties": {
"order_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+$",
"maxLength": 100,
"minLength": 1,
"description": "Shoprocket order id, e.g. ord_646e1f65ebcad629610675. Find it with shoprocket_list_orders."
}
}
},
"annotations": {
"title": "Get order",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: change an order's payment status and/or fulfillment status (for example mark it shipped or paid). Shoprocket needs both values, so a value you leave out is read from the order first and kept. With send_email true Shoprocket EMAILS THE CUSTOMER an order update (optionally with custom_text); the default is no email. Cancelling can return the items to stock (release_stock). POST /v1/orders/{id}.
| Parameter | Type | Description |
|---|---|---|
| order_id * | string | Shoprocket order id (ord_...). |
| send_email | boolean | true = email the customer about this update. Default false: no email is sent. |
| custom_text | string | Extra text for the customer email. Only used when send_email is true. |
| release_stock | boolean | true = put the order's items back into stock. Only applies when fulfillment_status is cancelled. |
| payment_status | string | New payment status. Omit to keep the current one. |
| fulfillment_status | string | New fulfillment status. Omit to keep the current one. |
{
"name": "shoprocket_update_order_status",
"title": "Update order status",
"description": "WRITE: change an order's payment status and/or fulfillment status (for example mark it shipped or paid). Shoprocket needs both values, so a value you leave out is read from the order first and kept. With send_email true Shoprocket EMAILS THE CUSTOMER an order update (optionally with custom_text); the default is no email. Cancelling can return the items to stock (release_stock). POST /v1/orders/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"order_id"
],
"properties": {
"order_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+$",
"maxLength": 100,
"minLength": 1,
"description": "Shoprocket order id (ord_...)."
},
"send_email": {
"type": "boolean",
"description": "true = email the customer about this update. Default false: no email is sent."
},
"custom_text": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "Extra text for the customer email. Only used when send_email is true."
},
"release_stock": {
"type": "boolean",
"description": "true = put the order's items back into stock. Only applies when fulfillment_status is cancelled."
},
"payment_status": {
"enum": [
"payment_pending",
"paid",
"disputed",
"refunded",
"partially_refunded",
"failed",
"abandoned"
],
"type": "string",
"description": "New payment status. Omit to keep the current one."
},
"fulfillment_status": {
"enum": [
"awaiting_processing",
"processing",
"shipped",
"delivered",
"cancelled",
"returned",
"ready_for_pickup",
"not_applicable"
],
"type": "string",
"description": "New fulfillment status. Omit to keep the current one."
}
}
},
"annotations": {
"title": "Update order status",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}List products with price, SKU, stock quantity, categories, images, variants (skus) and status. Search by text, filter by category slugs, product ids or slugs, and sort. GET /v1/products.
| Parameter | Type | Description |
|---|---|---|
| ids | string | Comma-separated product ids (prod_...). |
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| sort | string | product_order = store order (default), created = newest first. |
| limit | integer | Results per page, 1-100 (default 25). |
| slugs | string | Comma-separated product slugs. |
| search | string | Search text. |
| product_category | string | Comma-separated category slugs. |
{
"name": "shoprocket_list_products",
"title": "List products",
"description": "List products with price, SKU, stock quantity, categories, images, variants (skus) and status. Search by text, filter by category slugs, product ids or slugs, and sort. GET /v1/products.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"ids": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "Comma-separated product ids (prod_...)."
},
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"sort": {
"enum": [
"product_order",
"created",
"name_asc",
"name_desc",
"price_asc",
"price_desc"
],
"type": "string",
"description": "product_order = store order (default), created = newest first."
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"slugs": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "Comma-separated product slugs."
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Search text."
},
"product_category": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "Comma-separated category slugs."
}
}
},
"annotations": {
"title": "List products",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One product by id (prod_...): description, price, SKU, stock, dimensions, categories, media, variants (skus), add-ons. GET /v1/products/{id}.
| Parameter | Type | Description |
|---|---|---|
| product_id * | string | Shoprocket product id, e.g. prod_646e0498ec090321649753. |
{
"name": "shoprocket_get_product",
"title": "Get product",
"description": "One product by id (prod_...): description, price, SKU, stock, dimensions, categories, media, variants (skus), add-ons. GET /v1/products/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"product_id"
],
"properties": {
"product_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+$",
"maxLength": 100,
"minLength": 1,
"description": "Shoprocket product id, e.g. prod_646e0498ec090321649753."
}
}
},
"annotations": {
"title": "Get product",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: create a product in the store (visible to shoppers unless status is 0). A name and at least one category (name or slug) are required. Does not create duplicates by itself: calling twice creates two products. Variants and add-ons are not set by this tool. PUT /v1/products.
| Parameter | Type | Description |
|---|---|---|
| sku | string | SKU. |
| name * | string | Product name. |
| price | integer | Price as an integer in the smallest currency unit (cents: 1999 = 19.99), as Shoprocket's API takes it. Check the reply. |
| status | any | 1 = active (Shoprocket returns status "1" for live products), 0 = inactive. |
| weight | number | Weight, in the store's weight unit. |
| summary | string | Short summary. |
| quantity | integer | Stock quantity. |
| categories * | string | Comma-separated categories the product belongs to (as Shoprocket's API takes them; see shoprocket_list_categories). |
| description | string | Product description (HTML allowed). |
| max_order_quantity | integer | Maximum quantity per order. |
| min_order_quantity | integer | Minimum quantity per order. |
{
"name": "shoprocket_create_product",
"title": "Create product",
"description": "WRITE: create a product in the store (visible to shoppers unless status is 0). A name and at least one category (name or slug) are required. Does not create duplicates by itself: calling twice creates two products. Variants and add-ons are not set by this tool. PUT /v1/products.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"categories"
],
"properties": {
"sku": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "SKU."
},
"name": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "Product name."
},
"price": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Price as an integer in the smallest currency unit (cents: 1999 = 19.99), as Shoprocket's API takes it. Check the reply."
},
"status": {
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
}
],
"description": "1 = active (Shoprocket returns status \"1\" for live products), 0 = inactive."
},
"weight": {
"type": "number",
"minimum": 0,
"description": "Weight, in the store's weight unit."
},
"summary": {
"type": "string",
"maxLength": 2000,
"description": "Short summary."
},
"quantity": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Stock quantity."
},
"categories": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "Comma-separated categories the product belongs to (as Shoprocket's API takes them; see shoprocket_list_categories)."
},
"description": {
"type": "string",
"maxLength": 20000,
"description": "Product description (HTML allowed)."
},
"max_order_quantity": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Maximum quantity per order.",
"exclusiveMinimum": 0
},
"min_order_quantity": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Minimum quantity per order.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Create product",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}WRITE: change a product's fields (price, stock quantity, description, status...). Shoprocket requires the name on every update, so pass the current name to keep it. Only the fields you pass are sent. POST /v1/products/{id}.
| Parameter | Type | Description |
|---|---|---|
| sku | string | SKU. |
| name * | string | Product name (required by Shoprocket on every update; pass the current one to keep it). |
| price | integer | Price as an integer in the smallest currency unit (cents: 1999 = 19.99), as Shoprocket's API takes it. Check the reply. |
| status | any | 1 = active (Shoprocket returns status "1" for live products), 0 = inactive. |
| weight | number | Weight, in the store's weight unit. |
| summary | string | Short summary. |
| quantity | integer | Stock quantity. |
| categories | string | Comma-separated categories for the product, in the same form as shoprocket_create_product. Shoprocket lists it as required but leaves it out of its update example: pass it if Shoprocket answers that categories are required. |
| product_id * | string | Shoprocket product id (prod_...). |
| description | string | Product description (HTML allowed). |
| max_order_quantity | integer | Maximum quantity per order. |
| min_order_quantity | integer | Minimum quantity per order. |
{
"name": "shoprocket_update_product",
"title": "Update product",
"description": "WRITE: change a product's fields (price, stock quantity, description, status...). Shoprocket requires the name on every update, so pass the current name to keep it. Only the fields you pass are sent. POST /v1/products/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"product_id",
"name"
],
"properties": {
"sku": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "SKU."
},
"name": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "Product name (required by Shoprocket on every update; pass the current one to keep it)."
},
"price": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Price as an integer in the smallest currency unit (cents: 1999 = 19.99), as Shoprocket's API takes it. Check the reply."
},
"status": {
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
}
],
"description": "1 = active (Shoprocket returns status \"1\" for live products), 0 = inactive."
},
"weight": {
"type": "number",
"minimum": 0,
"description": "Weight, in the store's weight unit."
},
"summary": {
"type": "string",
"maxLength": 2000,
"description": "Short summary."
},
"quantity": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Stock quantity."
},
"categories": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "Comma-separated categories for the product, in the same form as shoprocket_create_product. Shoprocket lists it as required but leaves it out of its update example: pass it if Shoprocket answers that categories are required."
},
"product_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+$",
"maxLength": 100,
"minLength": 1,
"description": "Shoprocket product id (prod_...)."
},
"description": {
"type": "string",
"maxLength": 20000,
"description": "Product description (HTML allowed)."
},
"max_order_quantity": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Maximum quantity per order.",
"exclusiveMinimum": 0
},
"min_order_quantity": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Minimum quantity per order.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Update product",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}List product categories with id, name and slug. GET /v1/categories.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
{
"name": "shoprocket_list_categories",
"title": "List categories",
"description": "List product categories with id, name and slug. GET /v1/categories.",
"inputSchema": {
"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": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List categories",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One category by id (cat_...); with expand_products also the products in it. GET /v1/categories/{id}.
| Parameter | Type | Description |
|---|---|---|
| category_id * | string | Shoprocket category id, e.g. cat_646de66683dc4922710922. |
| expand_products | boolean | true = include the category's products. |
{
"name": "shoprocket_get_category",
"title": "Get category",
"description": "One category by id (cat_...); with expand_products also the products in it. GET /v1/categories/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"category_id"
],
"properties": {
"category_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+$",
"maxLength": 100,
"minLength": 1,
"description": "Shoprocket category id, e.g. cat_646de66683dc4922710922."
},
"expand_products": {
"type": "boolean",
"description": "true = include the category's products."
}
}
},
"annotations": {
"title": "Get category",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: create a product category (optionally assigning existing products). Calling twice with the same name may create a duplicate or be refused by Shoprocket. PUT /v1/categories.
| Parameter | Type | Description |
|---|---|---|
| name * | string | Category name. |
| slug | string | Unique slug. Default: the name, lowercase and hyphenated. |
| products | string | Comma-separated product ids (prod_...) to put in the category. |
{
"name": "shoprocket_create_category",
"title": "Create category",
"description": "WRITE: create a product category (optionally assigning existing products). Calling twice with the same name may create a duplicate or be refused by Shoprocket. PUT /v1/categories.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Category name."
},
"slug": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Unique slug. Default: the name, lowercase and hyphenated."
},
"products": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "Comma-separated product ids (prod_...) to put in the category."
}
}
},
"annotations": {
"title": "Create category",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}WRITE: rename a category, change its slug, or set the products in it. Only the fields you pass are sent. POST /v1/categories/{id}.
| Parameter | Type | Description |
|---|---|---|
| name | string | New name. |
| slug | string | New slug. |
| products | string | Comma-separated product ids (prod_...) assigned to the category. |
| category_id * | string | Shoprocket category id (cat_...). |
{
"name": "shoprocket_update_category",
"title": "Update category",
"description": "WRITE: rename a category, change its slug, or set the products in it. Only the fields you pass are sent. POST /v1/categories/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"category_id"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "New name."
},
"slug": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "New slug."
},
"products": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "Comma-separated product ids (prod_...) assigned to the category."
},
"category_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+$",
"maxLength": 100,
"minLength": 1,
"description": "Shoprocket category id (cat_...)."
}
}
},
"annotations": {
"title": "Update category",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}List customers with name, email, phone, company, tax number, country and marketing opt-in. GET /v1/customers.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
{
"name": "shoprocket_list_customers",
"title": "List customers",
"description": "List customers with name, email, phone, company, tax number, country and marketing opt-in. GET /v1/customers.",
"inputSchema": {
"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": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List customers",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One customer by id (cus_...). GET /v1/customers/{id}.
| Parameter | Type | Description |
|---|---|---|
| customer_id * | string | Shoprocket customer id, e.g. cus_646dec8c0e3a4390458285. |
{
"name": "shoprocket_get_customer",
"title": "Get customer",
"description": "One customer by id (cus_...). GET /v1/customers/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"customer_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+$",
"maxLength": 100,
"minLength": 1,
"description": "Shoprocket customer id, e.g. cus_646dec8c0e3a4390458285."
}
}
},
"annotations": {
"title": "Get customer",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: add a customer record (it does not email the customer). marketing_subscribed records newsletter consent: set it to true only if the customer actually opted in. PUT /v1/customers.
| Parameter | Type | Description |
|---|---|---|
| tax_number | string | Tax number. |
| company_name | string | Company name. |
| customer_name | string | Full name. |
| customer_email * | string | Customer email address. |
| customer_contact | string | Phone number. |
| marketing_subscribed | boolean | true only if the customer opted in to the newsletter. |
{
"name": "shoprocket_create_customer",
"title": "Create customer",
"description": "WRITE: add a customer record (it does not email the customer). marketing_subscribed records newsletter consent: set it to true only if the customer actually opted in. PUT /v1/customers.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_email"
],
"properties": {
"tax_number": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Tax number."
},
"company_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Company name."
},
"customer_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Full name."
},
"customer_email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254,
"description": "Customer email address."
},
"customer_contact": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Phone number."
},
"marketing_subscribed": {
"type": "boolean",
"description": "true only if the customer opted in to the newsletter."
}
}
},
"annotations": {
"title": "Create customer",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}WRITE: change a customer's email, name, phone, company, tax number or newsletter consent. Only the fields you pass are sent. Set marketing_subscribed true only if the customer actually opted in. POST /v1/customers/{id}.
| Parameter | Type | Description |
|---|---|---|
| name | string | Full name. |
| string | New email address. | |
| contact | string | Phone number. |
| tax_number | string | Tax number. |
| customer_id * | string | Shoprocket customer id (cus_...). |
| company_name | string | Company name. |
| marketing_subscribed | boolean | true only if the customer opted in to the newsletter. |
{
"name": "shoprocket_update_customer",
"title": "Update customer",
"description": "WRITE: change a customer's email, name, phone, company, tax number or newsletter consent. Only the fields you pass are sent. Set marketing_subscribed true only if the customer actually opted in. POST /v1/customers/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Full name."
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254,
"description": "New email address."
},
"contact": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Phone number."
},
"tax_number": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Tax number."
},
"customer_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+$",
"maxLength": 100,
"minLength": 1,
"description": "Shoprocket customer id (cus_...)."
},
"company_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Company name."
},
"marketing_subscribed": {
"type": "boolean",
"description": "true only if the customer opted in to the newsletter."
}
}
},
"annotations": {
"title": "Update customer",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}List discount codes with type, value, what they apply to, usage limit and count, minimum order, dates and status. GET /v1/discount-codes.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
{
"name": "shoprocket_list_discount_codes",
"title": "List discount codes",
"description": "List discount codes with type, value, what they apply to, usage limit and count, minimum order, dates and status. GET /v1/discount-codes.",
"inputSchema": {
"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": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List discount codes",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One discount code by id (ofr_...). GET /v1/discount-codes/{id}.
| Parameter | Type | Description |
|---|---|---|
| discount_code_id * | string | Shoprocket discount code id, e.g. ofr_646dfea0b2880691674525. |
{
"name": "shoprocket_get_discount_code",
"title": "Get discount code",
"description": "One discount code by id (ofr_...). GET /v1/discount-codes/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"discount_code_id"
],
"properties": {
"discount_code_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+$",
"maxLength": 100,
"minLength": 1,
"description": "Shoprocket discount code id, e.g. ofr_646dfea0b2880691674525."
}
}
},
"annotations": {
"title": "Get discount code",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: create a live discount code that shoppers can use at checkout and that reduces the store's revenue. Type fixed or percentage needs coupon_value; free_shipping does not. Use usage_limit and dates to bound it. Calling twice creates two codes. PUT /v1/discount-codes.
| Parameter | Type | Description |
|---|---|---|
| start_date | string | First valid day, yyyy-mm-dd. Required together with expire_date. |
| coupon_code | string | The code shoppers type. Default: Shoprocket generates a random one. |
| coupon_type * | string | fixed = amount off, percentage = percent off, free_shipping. |
| description * | string | What the code is for (shown in the dashboard). |
| expire_date | string | Last valid day, yyyy-mm-dd. Required together with start_date. |
| usage_limit | integer | Maximum number of uses in total. |
| coupon_value | integer | Required for fixed and percentage. Shoprocket documents 'a positive integer in cents': for fixed 500 = 5.00; for percentage send the whole percent (10 = 10%) and check the reply. |
| limit_per_user | any | 1 = one use per customer. |
| coupon_applies_to * | string | What it applies to. free_shipping allows only all_orders and all_orders_over. |
| minimum_order_value | integer | Minimum order value in cents (as Shoprocket takes it); used with all_orders_over. |
| coupon_applies_to_value | string | Required for multiple_products (comma-separated product ids) and categories (comma-separated category slugs). |
{
"name": "shoprocket_create_discount_code",
"title": "Create discount code",
"description": "WRITE: create a live discount code that shoppers can use at checkout and that reduces the store's revenue. Type fixed or percentage needs coupon_value; free_shipping does not. Use usage_limit and dates to bound it. Calling twice creates two codes. PUT /v1/discount-codes.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"coupon_type",
"description",
"coupon_applies_to"
],
"properties": {
"start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "First valid day, yyyy-mm-dd. Required together with expire_date."
},
"coupon_code": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]+$",
"maxLength": 64,
"minLength": 2,
"description": "The code shoppers type. Default: Shoprocket generates a random one."
},
"coupon_type": {
"enum": [
"fixed",
"percentage",
"free_shipping"
],
"type": "string",
"description": "fixed = amount off, percentage = percent off, free_shipping."
},
"description": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "What the code is for (shown in the dashboard)."
},
"expire_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Last valid day, yyyy-mm-dd. Required together with start_date."
},
"usage_limit": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Maximum number of uses in total.",
"exclusiveMinimum": 0
},
"coupon_value": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Required for fixed and percentage. Shoprocket documents 'a positive integer in cents': for fixed 500 = 5.00; for percentage send the whole percent (10 = 10%) and check the reply.",
"exclusiveMinimum": 0
},
"limit_per_user": {
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
}
],
"description": "1 = one use per customer."
},
"coupon_applies_to": {
"enum": [
"all_orders",
"all_orders_over",
"multiple_products",
"categories"
],
"type": "string",
"description": "What it applies to. free_shipping allows only all_orders and all_orders_over."
},
"minimum_order_value": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Minimum order value in cents (as Shoprocket takes it); used with all_orders_over."
},
"coupon_applies_to_value": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "Required for multiple_products (comma-separated product ids) and categories (comma-separated category slugs)."
}
}
},
"annotations": {
"title": "Create discount code",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}List automatic discounts (applied at checkout without a code) with type, value, conditions, dates and status. GET /v1/automatic-discounts.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
{
"name": "shoprocket_list_automatic_discounts",
"title": "List automatic discounts",
"description": "List automatic discounts (applied at checkout without a code) with type, value, conditions, dates and status. GET /v1/automatic-discounts.",
"inputSchema": {
"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": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List automatic discounts",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List sale promotions (price reductions on products) with type, value, what they apply to, dates and status. GET /v1/sale-promotions.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
{
"name": "shoprocket_list_sales",
"title": "List sale promotions",
"description": "List sale promotions (price reductions on products) with type, value, what they apply to, dates and status. GET /v1/sale-promotions.",
"inputSchema": {
"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": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List sale promotions",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the store's shipping methods and rates. GET /v1/shippings.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
{
"name": "shoprocket_list_shipping_methods",
"title": "List shipping methods",
"description": "List the store's shipping methods and rates. GET /v1/shippings.",
"inputSchema": {
"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": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List shipping methods",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the store's tax rules. GET /v1/taxes.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
{
"name": "shoprocket_list_taxes",
"title": "List taxes",
"description": "List the store's tax rules. GET /v1/taxes.",
"inputSchema": {
"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": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List taxes",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the store's shipping zones (the regions it ships to). GET /v1/zones.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
{
"name": "shoprocket_list_zones",
"title": "List shipping zones",
"description": "List the store's shipping zones (the regions it ships to). GET /v1/zones.",
"inputSchema": {
"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": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List shipping zones",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the store's payment gateways (Stripe, PayPal, manual...) and whether they are enabled. Gateway credentials are never returned. GET /v1/payment-methods.
No parameters.
{
"name": "shoprocket_list_payment_methods",
"title": "List payment methods",
"description": "List the store's payment gateways (Stripe, PayPal, manual...) and whether they are enabled. Gateway credentials are never returned. GET /v1/payment-methods.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List payment methods",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Tools for Shoprocket, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Which orders are paid but not yet shipped?"; "How did my store do last week compared with the week before?"; "Which products have a stock quantity under 5?". Read-only tools never change data; ask the user before a tool that creates, changes or deletes Shoprocket data. Free plan: 50 tool calls per month. Run shoprocket_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 shoprocket_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 shoprocket_upgrade without a plan: it returns both plans, each with a payment link for the user to open. shoprocket_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.