{"openapi":"3.1.0","info":{"title":"NiMCoffee AI 下单 API","description":"让任何 AI 平台通过 HTTP 接口浏览产品、下单、支付。支持 ChatGPT Actions、Coze Plugin 等。","version":"1.0.0"},"servers":[{"url":"https://mcp.nimcoffee.com","description":"Production"}],"paths":{"/auth/send-code":{"post":{"tags":["认证"],"summary":"Api Send Code","description":"发送手机验证码","operationId":"api_send_code_auth_send_code_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/auth/verify":{"post":{"tags":["认证"],"summary":"Api Verify","description":"验证码登录并获取 token","operationId":"api_verify_auth_verify_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/products/search":{"get":{"tags":["产品"],"summary":"Api Search","description":"搜索咖啡产品","operationId":"api_search_products_search_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"keyword","in":"query","required":false,"schema":{"type":"string","description":"搜索关键词，如「耶加雪菲」「果酸」「拿铁」","default":"","title":"Keyword"},"description":"搜索关键词，如「耶加雪菲」「果酸」「拿铁」"},{"name":"category","in":"query","required":false,"schema":{"type":"string","description":"产品分类，如「精品咖啡豆」「挂耳咖啡」「咖啡浓缩液」","default":"","title":"Category"},"description":"产品分类，如「精品咖啡豆」「挂耳咖啡」「咖啡浓缩液」"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"返回条数，默认 10","default":10,"title":"Limit"},"description":"返回条数，默认 10"},{"name":"Authorization","in":"header","required":false,"schema":{"type":"string","description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。","default":"","title":"Authorization"},"description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/products/{product_id}":{"get":{"tags":["产品"],"summary":"Api Detail","description":"获取产品详情","operationId":"api_detail_products__product_id__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"integer","description":"产品 ID，来自 /products/search 返回的 id","title":"Product Id"},"description":"产品 ID，来自 /products/search 返回的 id"},{"name":"Authorization","in":"header","required":false,"schema":{"type":"string","description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。","default":"","title":"Authorization"},"description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/products/recommendations":{"get":{"tags":["产品"],"summary":"Api Recommend","description":"获取个性化推荐","operationId":"api_recommend_products_recommendations_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"type":"string","description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。","default":"","title":"Authorization"},"description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/orders/create":{"post":{"tags":["订单"],"summary":"Api Create Order","description":"创建订单（自动余额支付）","operationId":"api_create_order_orders_create_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"type":"string","description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。","default":"","title":"Authorization"},"description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/orders/payment-qrcode":{"post":{"tags":["支付"],"summary":"Api Payment Qr","description":"获取微信支付二维码","operationId":"api_payment_qr_orders_payment_qrcode_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"type":"string","description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。","default":"","title":"Authorization"},"description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/orders/pay-balance":{"post":{"tags":["支付"],"summary":"Api Pay Balance","description":"余额支付","operationId":"api_pay_balance_orders_pay_balance_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"type":"string","description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。","default":"","title":"Authorization"},"description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/orders/{order_id}/payment-status":{"get":{"tags":["支付"],"summary":"Api Payment Status","description":"查询支付状态","operationId":"api_payment_status_orders__order_id__payment_status_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"order_id","in":"path","required":true,"schema":{"type":"integer","description":"订单 ID，来自下单返回或 /orders 列表","title":"Order Id"},"description":"订单 ID，来自下单返回或 /orders 列表"},{"name":"Authorization","in":"header","required":false,"schema":{"type":"string","description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。","default":"","title":"Authorization"},"description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/orders/{order_id}":{"get":{"tags":["订单"],"summary":"Api Order Status","description":"查看订单状态","operationId":"api_order_status_orders__order_id__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"order_id","in":"path","required":true,"schema":{"type":"integer","description":"订单 ID，来自下单返回或 /orders 列表","title":"Order Id"},"description":"订单 ID，来自下单返回或 /orders 列表"},{"name":"Authorization","in":"header","required":false,"schema":{"type":"string","description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。","default":"","title":"Authorization"},"description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/orders/{order_id}/cancel":{"post":{"tags":["订单"],"summary":"Api Cancel","description":"取消订单","operationId":"api_cancel_orders__order_id__cancel_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"order_id","in":"path","required":true,"schema":{"type":"integer","description":"订单 ID，来自下单返回或 /orders 列表","title":"Order Id"},"description":"订单 ID，来自下单返回或 /orders 列表"},{"name":"Authorization","in":"header","required":false,"schema":{"type":"string","description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。","default":"","title":"Authorization"},"description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/orders":{"get":{"tags":["订单"],"summary":"Api List Orders","description":"查看历史订单","operationId":"api_list_orders_orders_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","description":"按状态筛选：pending / confirmed / preparing / completed / cancelled，留空返回全部","default":"","title":"Status"},"description":"按状态筛选：pending / confirmed / preparing / completed / cancelled，留空返回全部"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"返回条数，默认 5","default":5,"title":"Limit"},"description":"返回条数，默认 5"},{"name":"Authorization","in":"header","required":false,"schema":{"type":"string","description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。","default":"","title":"Authorization"},"description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/orders/{order_id}/reorder":{"post":{"tags":["订单"],"summary":"Api Reorder","description":"再来一单","operationId":"api_reorder_orders__order_id__reorder_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"order_id","in":"path","required":true,"schema":{"type":"integer","description":"订单 ID，来自下单返回或 /orders 列表","title":"Order Id"},"description":"订单 ID，来自下单返回或 /orders 列表"},{"name":"Authorization","in":"header","required":false,"schema":{"type":"string","description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。","default":"","title":"Authorization"},"description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/membership":{"get":{"tags":["会员"],"summary":"Api Membership","description":"查看会员信息","operationId":"api_membership_membership_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"type":"string","description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。","default":"","title":"Authorization"},"description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/coupons":{"get":{"tags":["会员"],"summary":"Api Coupons","description":"查看优惠券","operationId":"api_coupons_coupons_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"type":"string","description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。","default":"","title":"Authorization"},"description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/stores":{"get":{"tags":["门店"],"summary":"Api Stores","description":"查看门店信息","operationId":"api_stores_stores_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"Authorization","in":"header","required":false,"schema":{"type":"string","description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。","default":"","title":"Authorization"},"description":"用户身份令牌，格式 `Bearer <token>`。通过 /auth/send-code 发验证码、/auth/verify 校验后获得。浏览产品不需要；下单及查询订单/会员必须携带。"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/health":{"get":{"tags":["系统"],"summary":"Health","description":"健康检查","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"AuthRequest":{"properties":{"phone":{"type":"string","title":"Phone","description":"手机号","examples":["13800138000"]}},"type":"object","required":["phone"],"title":"AuthRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"OrderRequest":{"properties":{"product_id":{"type":"integer","title":"Product Id","description":"产品 ID"},"quantity":{"type":"integer","minimum":1.0,"title":"Quantity","description":"数量","default":1}},"type":"object","required":["product_id"],"title":"OrderRequest"},"PaymentRequest":{"properties":{"order_id":{"type":"integer","title":"Order Id","description":"订单 ID"}},"type":"object","required":["order_id"],"title":"PaymentRequest"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VerifyRequest":{"properties":{"phone":{"type":"string","title":"Phone"},"code":{"type":"string","title":"Code","description":"验证码","examples":["000000"]}},"type":"object","required":["phone","code"],"title":"VerifyRequest"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","description":"API 密钥。在 https://nimcoffee.com/open 自助签发，提交即刻生效。","in":"header","name":"X-API-Key"}}}}