@ratio-mcp/docs-server 1.5.0 → 1.6.0

package/dist/schemas/product_reviews.json

@@ -0,0 +1,45 @@
+{
+  "resource": "product_reviews",
+  "auth": {
+    "type": "bearer",
+    "header": "Authorization",
+    "format": "Bearer <access_token>"
+  },
+  "common_headers": {
+    "gk-merchant-id": "Required. Tenant/merchant context for the request."
+  },
+  "endpoints": [
+    {
+      "method": "GET",
+      "path": "/api/v1/v1/reviews/:productId",
+      "controller_order": 1,
+      "handler_name": "getProductReviews",
+      "required_scope": "read_product_reviews",
+      "summary": "Get reviews for a product",
+      "description": "List customer reviews for a given product. Read-only. Note the path carries a doubled /v1 segment (global /api/v1 prefix + controller 'v1/reviews').",
+      "path_params": [
+        { "name": "productId", "type": "string", "required": true, "description": "The product ID to fetch reviews for" }
+      ],
+      "query_params": [
+        { "name": "limit", "type": "number", "required": false, "description": "Number of reviews per page" },
+        { "name": "offset", "type": "number", "required": false, "description": "Offset for pagination" },
+        { "name": "rating", "type": "number", "required": false, "description": "Filter by star rating" },
+        { "name": "sort", "type": "string", "required": false, "description": "Sort order" }
+      ],
+      "request_body": null,
+      "response_schema": "ProductReviewListResponse"
+    }
+  ],
+  "schemas": {
+    "ProductReview": {
+      "id": "string — review identifier",
+      "product_id": "string",
+      "rating": "number — star rating",
+      "title": "string | null",
+      "body": "string | null",
+      "author": "string | null",
+      "status": "string — moderation status",
+      "created_at": "string — ISO 8601"
+    }
+  }
+}

package/dist/schemas/products.json

@@ -1,167 +1,450 @@
 {
   "resource": "products",
-  "base_url": "https://gkx.gokwik.co/aes",
   "auth": {
     "type": "bearer",
     "header": "Authorization",
     "format": "Bearer <access_token>"
   },
+  "_generated": "by scripts/sync-schemas.mjs from backend OpenAPI (x-required-scope). Do not hand-edit.",
   "endpoints": [
     {
       "method": "GET",
       "path": "/api/v1/v1/products",
       "controller_order": 1,
-      "handler_name": "getProducts",
+      "handler_name": "findAll",
       "required_scope": "read_products",
-      "summary": "List products with pagination and filtering",
-      "description": "Retrieve a paginated list of products. Supports filtering by status, vendor, tags, category, collection, and search.",
+      "summary": "Get a list of products",
       "query_params": [
-        { "name": "limit", "type": "number", "required": false, "default": 10, "description": "Number of products per page" },
-        { "name": "page", "type": "number", "required": false, "default": 1, "description": "Page number for pagination" },
-        { "name": "offset", "type": "number", "required": false, "default": 0, "description": "Offset for pagination" },
-        { "name": "all", "type": "boolean", "required": false, "description": "Return all products (ignore pagination)" },
-        { "name": "search", "type": "string", "required": false, "description": "Search products by title" },
-        { "name": "status", "type": "string", "required": false, "enum": ["draft", "active", "archived"], "description": "Filter by product status" },
-        { "name": "vendor", "type": "string", "required": false, "description": "Filter by vendor/brand name" },
-        { "name": "categoryId", "type": "string", "required": false, "description": "Filter by category ID" },
-        { "name": "collectionId", "type": "string", "required": false, "description": "Filter by collection ID" },
-        { "name": "tagId", "type": "string", "required": false, "description": "Filter by tag ID" },
-        { "name": "tags", "type": "string", "required": false, "description": "Filter by tags" },
-        { "name": "published", "type": "boolean", "required": false, "description": "Filter by published status" },
-        { "name": "show_variants", "type": "boolean", "required": false, "default": false, "description": "Include variant details in response" }
+        {
+          "name": "limit",
+          "type": "number",
+          "required": false,
+          "default": 10
+        },
+        {
+          "name": "all",
+          "type": "boolean",
+          "required": false
+        },
+        {
+          "name": "page",
+          "type": "number",
+          "required": false,
+          "default": 1
+        },
+        {
+          "name": "offset",
+          "type": "number",
+          "required": false,
+          "default": 0
+        },
+        {
+          "name": "search",
+          "type": "string",
+          "required": false
+        },
+        {
+          "name": "categoryId",
+          "type": "string",
+          "required": false
+        },
+        {
+          "name": "collectionId",
+          "type": "string",
+          "required": false
+        },
+        {
+          "name": "tagId",
+          "type": "string",
+          "required": false
+        },
+        {
+          "name": "tags",
+          "type": "string",
+          "required": false
+        },
+        {
+          "name": "vendor",
+          "type": "string",
+          "required": false
+        },
+        {
+          "name": "status",
+          "type": "string",
+          "required": false,
+          "enum": [
+            "draft",
+            "active",
+            "archived"
+          ]
+        },
+        {
+          "name": "published",
+          "type": "boolean",
+          "required": false
+        },
+        {
+          "name": "show_variants",
+          "type": "boolean",
+          "required": false,
+          "default": false
+        }
       ],
-      "request_body": null,
-      "response_schema": "ProductListResponse"
-    },
-    {
-      "method": "GET",
-      "path": "/api/v1/v1/products/:id",
-      "controller_order": 2,
-      "handler_name": "getProductById",
-      "required_scope": "read_products",
-      "summary": "Get a single product by ID",
-      "description": "Retrieve the full details of a single product.",
-      "path_params": [
-        { "name": "id", "type": "string", "required": true, "description": "The product ID" }
-      ],
-      "query_params": [
-        { "name": "show_variants", "type": "boolean", "required": false, "description": "Include variant details in response" }
-      ],
-      "request_body": null,
-      "response_schema": "Product"
+      "request_body": null
     },
     {
       "method": "POST",
       "path": "/api/v1/v1/products",
-      "controller_order": 3,
-      "handler_name": "createProduct",
+      "controller_order": 2,
+      "handler_name": "create",
       "required_scope": "write_products",
       "summary": "Create a product",
-      "description": "Create a product in the merchant's store. The body must be wrapped in a { product: { ... } } object.",
       "request_body": {
         "content_type": "application/json",
-        "note": "The request body MUST be wrapped: { \"product\": { ... } }",
         "fields": [
-          { "name": "title", "type": "string", "required": true, "description": "Product title" },
-          { "name": "body_html", "type": "string", "required": false, "description": "HTML description" },
-          { "name": "handle", "type": "string", "required": false, "description": "URL-friendly slug" },
-          { "name": "product_type", "type": "string", "required": false, "description": "Product type/category" },
-          { "name": "vendor", "type": "string", "required": false, "description": "Manufacturer/brand" },
-          { "name": "status", "type": "string", "required": false, "enum": ["draft", "active", "archived"], "description": "Product status" },
-          { "name": "tags", "type": "string", "required": false, "description": "Comma-separated tags" },
-          { "name": "price", "type": "number", "required": false, "description": "Price in paise (integer)" },
-          { "name": "compare_at_price", "type": "number", "required": false, "description": "Compare-at price in paise" },
-          { "name": "sku", "type": "string", "required": false, "description": "Stock keeping unit" },
-          { "name": "barcode", "type": "string", "required": false, "description": "Barcode" },
-          { "name": "weight", "type": "number", "required": false, "description": "Weight value" },
-          { "name": "weight_unit", "type": "string", "required": false, "description": "Weight unit (kg, g, lb, oz)" },
-          { "name": "charge_tax", "type": "boolean", "required": false, "description": "Charge tax on this product" },
-          { "name": "track_inventory", "type": "boolean", "required": false, "description": "Track inventory" },
-          { "name": "is_physical_product", "type": "boolean", "required": false, "description": "Is physical product" },
-          { "name": "seo_title", "type": "string", "required": false, "description": "SEO title" },
-          { "name": "seo_description", "type": "string", "required": false, "description": "SEO description" },
-          { "name": "categoryId", "type": "string", "required": false, "description": "Category ID" },
-          { "name": "collectionIds", "type": "string[]", "required": false, "description": "Collection IDs" },
-          { "name": "tagIds", "type": "string[]", "required": false, "description": "Tag IDs" },
-          { "name": "metadata", "type": "object", "required": false, "description": "Additional metadata" }
+          {
+            "name": "product",
+            "type": "object",
+            "required": true
+          }
         ]
-      },
-      "response_schema": "Product"
+      }
+    },
+    {
+      "method": "GET",
+      "path": "/api/v1/v1/products/:id",
+      "controller_order": 3,
+      "handler_name": "findOne",
+      "required_scope": "read_products",
+      "summary": "Get a single product by ID",
+      "query_params": [
+        {
+          "name": "show_variants",
+          "type": "boolean",
+          "required": false
+        }
+      ],
+      "path_params": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true
+        }
+      ],
+      "request_body": null
     },
     {
       "method": "PUT",
       "path": "/api/v1/v1/products/:id",
       "controller_order": 4,
-      "handler_name": "updateProduct",
+      "handler_name": "update",
       "required_scope": "write_products",
       "summary": "Update a product",
-      "description": "Update product fields. Only provided fields are modified.",
       "path_params": [
-        { "name": "id", "type": "string", "required": true, "description": "The product ID to update" }
+        {
+          "name": "id",
+          "type": "string",
+          "required": true
+        }
       ],
       "request_body": {
         "content_type": "application/json",
         "fields": [
-          { "name": "title", "type": "string", "required": false },
-          { "name": "body_html", "type": "string", "required": false },
-          { "name": "handle", "type": "string", "required": false },
-          { "name": "product_type", "type": "string", "required": false },
-          { "name": "vendor", "type": "string", "required": false },
-          { "name": "status", "type": "string", "required": false, "enum": ["draft", "active", "archived"] },
-          { "name": "tags", "type": "string", "required": false },
-          { "name": "price", "type": "number", "required": false },
-          { "name": "compare_at_price", "type": "number", "required": false },
-          { "name": "sku", "type": "string", "required": false },
-          { "name": "barcode", "type": "string", "required": false },
-          { "name": "weight", "type": "number", "required": false },
-          { "name": "weight_unit", "type": "string", "required": false },
-          { "name": "seo_title", "type": "string", "required": false },
-          { "name": "seo_description", "type": "string", "required": false },
-          { "name": "categoryId", "type": "string", "required": false },
-          { "name": "collectionIds", "type": "string[]", "required": false },
-          { "name": "tagIds", "type": "string[]", "required": false },
-          { "name": "metadata", "type": "object", "required": false }
+          {
+            "name": "title",
+            "type": "string",
+            "required": false,
+            "description": "The title of the product"
+          },
+          {
+            "name": "body_html",
+            "type": "string",
+            "required": false,
+            "description": "HTML description of the product"
+          },
+          {
+            "name": "handle",
+            "type": "string",
+            "required": false,
+            "description": "URL-friendly slug for the product"
+          },
+          {
+            "name": "product_type",
+            "type": "string",
+            "required": false,
+            "description": "The type of product"
+          },
+          {
+            "name": "vendor",
+            "type": "string",
+            "required": false,
+            "description": "The manufacturer or brand of the product"
+          },
+          {
+            "name": "published_at",
+            "type": "object",
+            "required": false,
+            "description": "The date and time when the product was published"
+          },
+          {
+            "name": "publishedAt",
+            "type": "object",
+            "required": false,
+            "description": "The specific date and time when the product was published"
+          },
+          {
+            "name": "template_suffix",
+            "type": "object",
+            "required": false,
+            "description": "The template suffix"
+          },
+          {
+            "name": "published_scope",
+            "type": "string",
+            "required": false,
+            "description": "The published scope",
+            "default": "web"
+          },
+          {
+            "name": "tags",
+            "type": "string",
+            "required": false,
+            "description": "The tags of the product, comma-separated"
+          },
+          {
+            "name": "status",
+            "type": "string",
+            "required": false,
+            "description": "The current status of the product",
+            "enum": [
+              "draft",
+              "active",
+              "archived"
+            ],
+            "default": "draft"
+          },
+          {
+            "name": "metadata",
+            "type": "object",
+            "required": false,
+            "description": "Additional flexible metadata for the product"
+          },
+          {
+            "name": "seo_title",
+            "type": "string",
+            "required": false,
+            "description": "SEO title for the product"
+          },
+          {
+            "name": "seo_url_handle",
+            "type": "string",
+            "required": false,
+            "description": "SEO URL handle (can be different from the product handle)"
+          },
+          {
+            "name": "seo_description",
+            "type": "string",
+            "required": false,
+            "description": "SEO description for the product"
+          },
+          {
+            "name": "price",
+            "type": "number",
+            "required": false,
+            "description": "The price of the product in paise (integer)"
+          },
+          {
+            "name": "compare_at_price",
+            "type": "number",
+            "required": false,
+            "description": "The compare-at price of the product in paise (integer)"
+          },
+          {
+            "name": "cost_per_item",
+            "type": "number",
+            "required": false,
+            "description": "The cost per item for profit calculations in paise (integer)"
+          },
+          {
+            "name": "profit",
+            "type": "number",
+            "required": false,
+            "description": "The profit for this product in paise (integer)"
+          },
+          {
+            "name": "margin",
+            "type": "number",
+            "required": false,
+            "description": "The profit margin percentage for this product"
+          },
+          {
+            "name": "charge_tax",
+            "type": "boolean",
+            "required": false,
+            "description": "Whether to charge tax on this product",
+            "default": true
+          },
+          {
+            "name": "track_inventory",
+            "type": "boolean",
+            "required": false,
+            "description": "Whether to track inventory for this product",
+            "default": true
+          },
+          {
+            "name": "continue_selling_out_of_stock",
+            "type": "boolean",
+            "required": false,
+            "description": "Whether to continue selling when out of stock",
+            "default": false
+          },
+          {
+            "name": "has_sku_or_barcode",
+            "type": "boolean",
+            "required": false,
+            "description": "Whether this product has SKU or barcode",
+            "default": false
+          },
+          {
+            "name": "sku",
+            "type": "string",
+            "required": false,
+            "description": "The SKU (Stock Keeping Unit) of the product"
+          },
+          {
+            "name": "barcode",
+            "type": "string",
+            "required": false,
+            "description": "The barcode (ISBN, UPC, GTIN, etc.) of the product"
+          },
+          {
+            "name": "is_physical_product",
+            "type": "boolean",
+            "required": false,
+            "description": "Whether the product is a physical product",
+            "default": true
+          },
+          {
+            "name": "is_deleted",
+            "type": "boolean",
+            "required": false,
+            "description": "Whether the product is marked for deletion",
+            "default": false
+          },
+          {
+            "name": "weight",
+            "type": "number",
+            "required": false,
+            "description": "The weight of the product"
+          },
+          {
+            "name": "weight_unit",
+            "type": "string",
+            "required": false,
+            "description": "The unit of weight measurement"
+          },
+          {
+            "name": "country_of_origin",
+            "type": "string",
+            "required": false,
+            "description": "The country or region of origin"
+          },
+          {
+            "name": "hs_code",
+            "type": "string",
+            "required": false,
+            "description": "The Harmonized System (HS) code for tax classification"
+          },
+          {
+            "name": "external_id",
+            "type": "string",
+            "required": false,
+            "description": "External identifier for the product from external systems"
+          },
+          {
+            "name": "shop_location",
+            "type": "string",
+            "required": false,
+            "description": "The shop location where the product is available"
+          },
+          {
+            "name": "warehouseQt",
+            "type": "object[]",
+            "required": false,
+            "description": "Warehouse quantities for inventory tracking"
+          },
+          {
+            "name": "sales_channel",
+            "type": "string[]",
+            "required": false,
+            "description": "The sales channels where the product is available"
+          },
+          {
+            "name": "categoryId",
+            "type": "string",
+            "required": false,
+            "description": "The category ID this product belongs to (UUID or Shopify GID)"
+          },
+          {
+            "name": "collectionIds",
+            "type": "string[]",
+            "required": false,
+            "description": "Array of collection IDs this product belongs to"
+          },
+          {
+            "name": "tagIds",
+            "type": "string[]",
+            "required": false,
+            "description": "Array of tag IDs associated with this product"
+          },
+          {
+            "name": "variants",
+            "type": "array",
+            "required": false,
+            "description": "Product variants"
+          },
+          {
+            "name": "options",
+            "type": "array",
+            "required": false,
+            "description": "Product options (like size, color)"
+          },
+          {
+            "name": "images",
+            "type": "array",
+            "required": false,
+            "description": "Product images"
+          },
+          {
+            "name": "product_category",
+            "type": "string",
+            "required": false,
+            "description": "Product category taxonomy information"
+          },
+          {
+            "name": "metafields",
+            "type": "array",
+            "required": false,
+            "description": "Metafields for the product"
+          }
         ]
-      },
-      "response_schema": "Product"
+      }
     },
     {
       "method": "DELETE",
       "path": "/api/v1/v1/products/:id",
       "controller_order": 5,
-      "handler_name": "deleteProduct",
+      "handler_name": "remove",
       "required_scope": "write_products",
       "summary": "Delete a product",
-      "description": "Permanently delete a product from the merchant's store.",
       "path_params": [
-        { "name": "id", "type": "string", "required": true, "description": "The product ID to delete" }
+        {
+          "name": "id",
+          "type": "string",
+          "required": true
+        }
       ],
-      "request_body": null,
-      "response_schema": null
-    }
-  ],
-  "schemas": {
-    "Product": {
-      "id": "string — unique product identifier (UUID)",
-      "title": "string — product title",
-      "body_html": "string | null — HTML description",
-      "handle": "string — URL-friendly slug",
-      "product_type": "string | null — product type/category",
-      "vendor": "string | null — vendor/brand name",
-      "status": "'draft' | 'active' | 'archived'",
-      "tags": "string — comma-separated tags",
-      "price": "number — price in paise",
-      "compare_at_price": "number | null — compare-at price in paise",
-      "sku": "string | null — stock keeping unit",
-      "barcode": "string | null — barcode",
-      "weight": "number | null — weight value",
-      "weight_unit": "string | null — weight unit",
-      "published_at": "string | null — ISO 8601 timestamp",
-      "created_at": "string — ISO 8601 timestamp",
-      "updated_at": "string — ISO 8601 timestamp",
-      "variants": "Variant[] — product variants (when show_variants=true)",
-      "images": "Image[] — product images"
+      "request_body": null
     }
-  },
-  "statuses": ["draft", "active", "archived"]
+  ]
 }