Shoprocket MCP by usefulapi

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.

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

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.

{
  "type": "object",
  "properties": {
    "from": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "First day, yyyy-mm-dd."
    },
    "to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Last day, yyyy-mm-dd."
    }
  },
  "required": [
    "from",
    "to"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "search": {
      "description": "Free-text search: order number, total amount, customer email or name, dates, statuses.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "status": {
      "description": "Payment status of the order.",
      "type": "string",
      "enum": [
        "payment_pending",
        "paid",
        "disputed",
        "refunded",
        "partially_refunded",
        "failed",
        "abandoned"
      ]
    },
    "fulfillment_status": {
      "description": "Fulfillment status of the order.",
      "type": "string",
      "enum": [
        "awaiting_processing",
        "processing",
        "shipped",
        "delivered",
        "cancelled",
        "returned",
        "ready_for_pickup",
        "not_applicable"
      ]
    },
    "payment_method": {
      "description": "Only orders paid with this method.",
      "type": "string",
      "enum": [
        "payu",
        "free",
        "stripe",
        "manual",
        "paypal"
      ]
    },
    "customer": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "description": "Comma-separated customer ids (cus_...): only their orders."
    },
    "order_amount_from": {
      "description": "Only orders of at least this amount.",
      "type": "number",
      "minimum": 0
    },
    "order_amount_to": {
      "description": "Only orders of at most this amount.",
      "type": "number",
      "minimum": 0
    },
    "has_sale": {
      "description": "true: only orders where a sale promotion applied.",
      "type": "boolean"
    },
    "has_discount_code": {
      "description": "true: only orders where a discount code applied.",
      "type": "boolean"
    },
    "has_automatic_discount": {
      "description": "true: only orders where an automatic discount applied.",
      "type": "boolean"
    },
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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}.

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[A-Za-z0-9_.-]+$",
      "description": "Shoprocket order id, e.g. ord_646e1f65ebcad629610675. Find it with shoprocket_list_orders."
    }
  },
  "required": [
    "order_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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}.

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[A-Za-z0-9_.-]+$",
      "description": "Shoprocket order id (ord_...)."
    },
    "payment_status": {
      "description": "New payment status. Omit to keep the current one.",
      "type": "string",
      "enum": [
        "payment_pending",
        "paid",
        "disputed",
        "refunded",
        "partially_refunded",
        "failed",
        "abandoned"
      ]
    },
    "fulfillment_status": {
      "description": "New fulfillment status. Omit to keep the current one.",
      "type": "string",
      "enum": [
        "awaiting_processing",
        "processing",
        "shipped",
        "delivered",
        "cancelled",
        "returned",
        "ready_for_pickup",
        "not_applicable"
      ]
    },
    "send_email": {
      "description": "true = email the customer about this update. Default false: no email is sent.",
      "type": "boolean"
    },
    "custom_text": {
      "description": "Extra text for the customer email. Only used when send_email is true.",
      "type": "string",
      "minLength": 1,
      "maxLength": 2000
    },
    "release_stock": {
      "description": "true = put the order's items back into stock. Only applies when fulfillment_status is cancelled.",
      "type": "boolean"
    }
  },
  "required": [
    "order_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "search": {
      "description": "Search text.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "sort": {
      "description": "product_order = store order (default), created = newest first.",
      "type": "string",
      "enum": [
        "product_order",
        "created",
        "name_asc",
        "name_desc",
        "price_asc",
        "price_desc"
      ]
    },
    "product_category": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "description": "Comma-separated category slugs."
    },
    "ids": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "description": "Comma-separated product ids (prod_...)."
    },
    "slugs": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "description": "Comma-separated product slugs."
    },
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One product by id (prod_...): description, price, SKU, stock, dimensions, categories, media, variants (skus), add-ons. GET /v1/products/{id}.

{
  "type": "object",
  "properties": {
    "product_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[A-Za-z0-9_.-]+$",
      "description": "Shoprocket product id, e.g. prod_646e0498ec090321649753."
    }
  },
  "required": [
    "product_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 300,
      "description": "Product name."
    },
    "categories": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "description": "Comma-separated categories the product belongs to (as Shoprocket's API takes them; see shoprocket_list_categories)."
    },
    "description": {
      "description": "Product description (HTML allowed).",
      "type": "string",
      "maxLength": 20000
    },
    "summary": {
      "description": "Short summary.",
      "type": "string",
      "maxLength": 2000
    },
    "price": {
      "description": "Price as an integer in the smallest currency unit (cents: 1999 = 19.99), as Shoprocket's API takes it. Check the reply.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "sku": {
      "description": "SKU.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "quantity": {
      "description": "Stock quantity.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "weight": {
      "description": "Weight, in the store's weight unit.",
      "type": "number",
      "minimum": 0
    },
    "status": {
      "description": "1 = active (Shoprocket returns status \"1\" for live products), 0 = inactive.",
      "anyOf": [
        {
          "type": "number",
          "const": 0
        },
        {
          "type": "number",
          "const": 1
        }
      ]
    },
    "min_order_quantity": {
      "description": "Minimum quantity per order.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "max_order_quantity": {
      "description": "Maximum quantity per order.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "name",
    "categories"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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}.

{
  "type": "object",
  "properties": {
    "product_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[A-Za-z0-9_.-]+$",
      "description": "Shoprocket product id (prod_...)."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 300,
      "description": "Product name (required by Shoprocket on every update; pass the current one to keep it)."
    },
    "categories": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "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."
    },
    "description": {
      "description": "Product description (HTML allowed).",
      "type": "string",
      "maxLength": 20000
    },
    "summary": {
      "description": "Short summary.",
      "type": "string",
      "maxLength": 2000
    },
    "price": {
      "description": "Price as an integer in the smallest currency unit (cents: 1999 = 19.99), as Shoprocket's API takes it. Check the reply.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "sku": {
      "description": "SKU.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "quantity": {
      "description": "Stock quantity.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "weight": {
      "description": "Weight, in the store's weight unit.",
      "type": "number",
      "minimum": 0
    },
    "status": {
      "description": "1 = active (Shoprocket returns status \"1\" for live products), 0 = inactive.",
      "anyOf": [
        {
          "type": "number",
          "const": 0
        },
        {
          "type": "number",
          "const": 1
        }
      ]
    },
    "min_order_quantity": {
      "description": "Minimum quantity per order.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "max_order_quantity": {
      "description": "Maximum quantity per order.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "product_id",
    "name"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List product categories with id, name and slug. GET /v1/categories.

{
  "type": "object",
  "properties": {
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One category by id (cat_...); with expand_products also the products in it. GET /v1/categories/{id}.

{
  "type": "object",
  "properties": {
    "category_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[A-Za-z0-9_.-]+$",
      "description": "Shoprocket category id, e.g. cat_646de66683dc4922710922."
    },
    "expand_products": {
      "description": "true = include the category's products.",
      "type": "boolean"
    }
  },
  "required": [
    "category_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Category name."
    },
    "slug": {
      "description": "Unique slug. Default: the name, lowercase and hyphenated.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "products": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "description": "Comma-separated product ids (prod_...) to put in the category."
    }
  },
  "required": [
    "name"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

WRITE: rename a category, change its slug, or set the products in it. Only the fields you pass are sent. POST /v1/categories/{id}.

{
  "type": "object",
  "properties": {
    "category_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[A-Za-z0-9_.-]+$",
      "description": "Shoprocket category id (cat_...)."
    },
    "name": {
      "description": "New name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "slug": {
      "description": "New slug.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "products": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "description": "Comma-separated product ids (prod_...) assigned to the category."
    }
  },
  "required": [
    "category_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List customers with name, email, phone, company, tax number, country and marketing opt-in. GET /v1/customers.

{
  "type": "object",
  "properties": {
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One customer by id (cus_...). GET /v1/customers/{id}.

{
  "type": "object",
  "properties": {
    "customer_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[A-Za-z0-9_.-]+$",
      "description": "Shoprocket customer id, e.g. cus_646dec8c0e3a4390458285."
    }
  },
  "required": [
    "customer_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "customer_email": {
      "type": "string",
      "maxLength": 254,
      "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,}$",
      "description": "Customer email address."
    },
    "customer_name": {
      "description": "Full name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "customer_contact": {
      "description": "Phone number.",
      "type": "string",
      "minLength": 1,
      "maxLength": 50
    },
    "company_name": {
      "description": "Company name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "tax_number": {
      "description": "Tax number.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "marketing_subscribed": {
      "description": "true only if the customer opted in to the newsletter.",
      "type": "boolean"
    }
  },
  "required": [
    "customer_email"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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}.

{
  "type": "object",
  "properties": {
    "customer_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[A-Za-z0-9_.-]+$",
      "description": "Shoprocket customer id (cus_...)."
    },
    "email": {
      "description": "New email address.",
      "type": "string",
      "maxLength": 254,
      "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,}$"
    },
    "name": {
      "description": "Full name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "contact": {
      "description": "Phone number.",
      "type": "string",
      "minLength": 1,
      "maxLength": 50
    },
    "company_name": {
      "description": "Company name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "tax_number": {
      "description": "Tax number.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "marketing_subscribed": {
      "description": "true only if the customer opted in to the newsletter.",
      "type": "boolean"
    }
  },
  "required": [
    "customer_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List discount codes with type, value, what they apply to, usage limit and count, minimum order, dates and status. GET /v1/discount-codes.

{
  "type": "object",
  "properties": {
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One discount code by id (ofr_...). GET /v1/discount-codes/{id}.

{
  "type": "object",
  "properties": {
    "discount_code_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[A-Za-z0-9_.-]+$",
      "description": "Shoprocket discount code id, e.g. ofr_646dfea0b2880691674525."
    }
  },
  "required": [
    "discount_code_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "coupon_code": {
      "description": "The code shoppers type. Default: Shoprocket generates a random one.",
      "type": "string",
      "minLength": 2,
      "maxLength": 64,
      "pattern": "^[A-Za-z0-9_-]+$"
    },
    "coupon_type": {
      "type": "string",
      "enum": [
        "fixed",
        "percentage",
        "free_shipping"
      ],
      "description": "fixed = amount off, percentage = percent off, free_shipping."
    },
    "coupon_value": {
      "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.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "description": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500,
      "description": "What the code is for (shown in the dashboard)."
    },
    "coupon_applies_to": {
      "type": "string",
      "enum": [
        "all_orders",
        "all_orders_over",
        "multiple_products",
        "categories"
      ],
      "description": "What it applies to. free_shipping allows only all_orders and all_orders_over."
    },
    "coupon_applies_to_value": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "description": "Required for multiple_products (comma-separated product ids) and categories (comma-separated category slugs)."
    },
    "usage_limit": {
      "description": "Maximum number of uses in total.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "minimum_order_value": {
      "description": "Minimum order value in cents (as Shoprocket takes it); used with all_orders_over.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "limit_per_user": {
      "description": "1 = one use per customer.",
      "anyOf": [
        {
          "type": "number",
          "const": 0
        },
        {
          "type": "number",
          "const": 1
        }
      ]
    },
    "start_date": {
      "description": "First valid day, yyyy-mm-dd. Required together with expire_date.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "expire_date": {
      "description": "Last valid day, yyyy-mm-dd. Required together with start_date.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    }
  },
  "required": [
    "coupon_type",
    "description",
    "coupon_applies_to"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List automatic discounts (applied at checkout without a code) with type, value, conditions, dates and status. GET /v1/automatic-discounts.

{
  "type": "object",
  "properties": {
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List sale promotions (price reductions on products) with type, value, what they apply to, dates and status. GET /v1/sale-promotions.

{
  "type": "object",
  "properties": {
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List the store's shipping methods and rates. GET /v1/shippings.

{
  "type": "object",
  "properties": {
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List the store's tax rules. GET /v1/taxes.

{
  "type": "object",
  "properties": {
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List the store's shipping zones (the regions it ships to). GET /v1/zones.

{
  "type": "object",
  "properties": {
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List the store's payment gateways (Stripe, PayPal, manual...) and whether they are enabled. Gateway credentials are never returned. GET /v1/payment-methods.

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