@youzan-cloud/zan-saas-cli 0.0.0-stage → 0.1.0-beta.4

package/src/commands/native/coupon/activity/get/schema.json

@@ -0,0 +1,624 @@
+{
+  "schemaVersion": 1,
+  "input": {
+    "type": "object",
+    "required": [
+      "activityId",
+      "kdtId"
+    ],
+    "additionalProperties": false,
+    "description": "参数解析并按有效上下文补全后的业务输入；原始选项及默认值见 options。",
+    "properties": {
+      "activityId": {
+        "$ref": "#/definitions/id",
+        "description": "券发行活动 ID，不是客户持券 ID、码号或 alias。"
+      },
+      "kdtId": {
+        "$ref": "#/definitions/id",
+        "description": "目标店铺；省略选项时取有效上下文 shopId，执行时核验同店凭证。"
+      }
+    }
+  },
+  "output": {
+    "type": "object",
+    "required": [
+      "data"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "data": {
+        "type": "object",
+        "required": [
+          "activity"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "activity": {
+            "type": "object",
+            "required": [
+              "activityId",
+              "ownerKdtId",
+              "title",
+              "activityType",
+              "status",
+              "offer"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "activityId": {
+                "$ref": "#/definitions/id",
+                "description": "必须与输入活动 ID 一致。"
+              },
+              "ownerKdtId": {
+                "$ref": "#/definitions/id",
+                "description": "活动归属店铺，必须与目标一致；不是领取或使用店铺。"
+              },
+              "title": {
+                "type": "string",
+                "minLength": 1,
+                "pattern": "\\S"
+              },
+              "activityType": {
+                "$ref": "#/definitions/integer",
+                "description": "7 优惠券，9 共享码，10 唯一码；未知整数保留，不赋予已知含义。"
+              },
+              "status": {
+                "$ref": "#/definitions/integer",
+                "description": "-1 无法发放和使用，0 正常可发放，1 已失效，2 审核中，3 已作废；未知整数保留，不当正常。0 不证明客户资格或订单可用。"
+              },
+              "remark": {
+                "type": "string",
+                "description": "可选文本；空串保留，缺失省略，null 不合法。"
+              },
+              "description": {
+                "type": "string",
+                "description": "可选规则原文，只作文本，不是结构化日期或资格结果。"
+              },
+              "offer": {
+                "$ref": "#/definitions/offer"
+              },
+              "threshold": {
+                "$ref": "#/definitions/threshold",
+                "description": "取得门槛类型时出现；缺失省略，不补默认门槛。"
+              }
+            }
+          },
+          "budget": {
+            "type": "object",
+            "minProperties": 1,
+            "additionalProperties": false,
+            "description": "取得任一预算字段时出现，仅保留已返回字段；不是客户余额，不推算库存。缺失省略，null 或错型失败。",
+            "properties": {
+              "takenQty": {
+                "$ref": "#/definitions/count",
+                "description": "已领取数量，不是去重客户数。"
+              },
+              "usedQty": {
+                "$ref": "#/definitions/count",
+                "description": "已使用数量。"
+              },
+              "sendTotalQty": {
+                "$ref": "#/definitions/integer",
+                "description": "发放预算，保留原整数，不解释负数哨兵。"
+              },
+              "useTotalQty": {
+                "$ref": "#/definitions/integer",
+                "description": "使用预算，保留原整数，不解释负数哨兵。"
+              },
+              "sendStockQty": {
+                "$ref": "#/definitions/integer",
+                "description": "发放库存，保留原整数，不由预算推算。"
+              },
+              "useStockQty": {
+                "$ref": "#/definitions/integer",
+                "description": "使用库存，保留原整数，不由预算推算。"
+              }
+            }
+          },
+          "scope": {
+            "type": "object",
+            "minProperties": 1,
+            "additionalProperties": false,
+            "description": "取得任一范围字段时出现，仅为本次返回的配置引用；不补齐渠道或成员，不证明最终可用性或完整经营商品集合，不可直接回写覆盖。",
+            "properties": {
+              "shops": {
+                "type": "object",
+                "minProperties": 1,
+                "additionalProperties": false,
+                "properties": {
+                  "type": {
+                    "type": "integer",
+                    "enum": [
+                      1,
+                      2,
+                      3
+                    ],
+                    "description": "1 仅本店，2 部分店铺，3 全部店铺；未知类型失败，省略不推断。"
+                  },
+                  "kdtIds": {
+                    "$ref": "#/definitions/ids",
+                    "description": "已返回的使用店铺 ID；保留顺序和实际空数组，不用空数组反推类型。"
+                  }
+                }
+              },
+              "online": {
+                "$ref": "#/definitions/channel",
+                "description": "网店配置，取得该渠道任一字段时出现。"
+              },
+              "offline": {
+                "$ref": "#/definitions/channel",
+                "description": "门店配置，取得该渠道任一字段时出现。"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "preview": {
+    "type": "object",
+    "required": [
+      "scope",
+      "prerequisites",
+      "requests"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "scope": {
+        "$ref": "#/definitions/scope"
+      },
+      "prerequisites": {
+        "type": "array",
+        "const": [
+          "context",
+          "token-shop-binding"
+        ],
+        "items": {
+          "type": "string"
+        }
+      },
+      "requests": {
+        "type": "array",
+        "minItems": 2,
+        "maxItems": 2,
+        "additionalItems": false,
+        "items": [
+          {
+            "type": "object",
+            "required": [
+              "method",
+              "api",
+              "body"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "method": {
+                "const": "POST"
+              },
+              "api": {
+                "const": "youzan.shop.basic.get/3.0.0"
+              },
+              "body": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {}
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": [
+              "method",
+              "api",
+              "body"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "method": {
+                "const": "POST"
+              },
+              "api": {
+                "const": "youzan.ump.voucheractivity.detail.query/3.0.4"
+              },
+              "body": {
+                "type": "object",
+                "required": [
+                  "activity_id"
+                ],
+                "additionalProperties": false,
+                "properties": {
+                  "activity_id": {
+                    "$ref": "#/definitions/id"
+                  }
+                }
+              }
+            }
+          }
+        ]
+      }
+    }
+  },
+  "error": {
+    "type": "object",
+    "required": [
+      "success",
+      "code",
+      "message",
+      "details"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "success": {
+        "const": false
+      },
+      "code": {
+        "const": -10001
+      },
+      "message": {
+        "type": "string",
+        "minLength": 1
+      },
+      "details": {
+        "type": "object",
+        "required": [
+          "command",
+          "category",
+          "stage",
+          "targetScope",
+          "requestState",
+          "nextStep"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "command": {
+            "const": "coupon.activity.get"
+          },
+          "category": {
+            "enum": [
+              "parameter",
+              "validation",
+              "configuration",
+              "authentication",
+              "permission",
+              "scope_unresolved",
+              "transport",
+              "http",
+              "protocol",
+              "business_rejected",
+              "not_found"
+            ]
+          },
+          "stage": {
+            "enum": [
+              "input",
+              "configuration",
+              "shop-binding",
+              "query",
+              "response"
+            ]
+          },
+          "targetScope": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "kdtId": {
+                "$ref": "#/definitions/id"
+              }
+            }
+          },
+          "requestState": {
+            "enum": [
+              "not_sent",
+              "sent",
+              "unknown"
+            ]
+          },
+          "nextStep": {
+            "type": "string",
+            "minLength": 1
+          },
+          "api": {
+            "type": "string",
+            "minLength": 1
+          },
+          "httpStatus": {
+            "type": "integer",
+            "minimum": 100,
+            "maximum": 599
+          },
+          "businessCode": {
+            "$ref": "#/definitions/code"
+          },
+          "gatewayCode": {
+            "$ref": "#/definitions/code"
+          },
+          "trace_id": {
+            "$ref": "#/definitions/trace"
+          },
+          "request_id": {
+            "$ref": "#/definitions/trace"
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "id": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 9007199254740991
+    },
+    "integer": {
+      "type": "integer",
+      "minimum": -9007199254740991,
+      "maximum": 9007199254740991
+    },
+    "count": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "ids": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/id"
+      }
+    },
+    "scope": {
+      "type": "object",
+      "required": [
+        "kdtId"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "kdtId": {
+          "$ref": "#/definitions/id"
+        }
+      }
+    },
+    "money": {
+      "type": "string",
+      "pattern": "^(?:0|[1-9][0-9]*)\\.[0-9]{2}$",
+      "description": "人民币 CNY 元两位十进制文本，非负，不舍入；缺失不补零，null 不合法。",
+      "$comment": "upstream-money:fen"
+    },
+    "offer": {
+      "description": "互斥优惠分支；未知方式或不支持的代金券面额规则失败，不混用金额与折扣。",
+      "oneOf": [
+        {
+          "type": "object",
+          "required": [
+            "mode",
+            "valueRule",
+            "amount"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "mode": {
+              "const": 1,
+              "description": "1 代金券。"
+            },
+            "valueRule": {
+              "const": 1,
+              "description": "1 固定面额。"
+            },
+            "amount": {
+              "$ref": "#/definitions/money"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "mode",
+            "valueRule",
+            "minAmount",
+            "maxAmount"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "mode": {
+              "const": 1,
+              "description": "1 代金券。"
+            },
+            "valueRule": {
+              "type": "integer",
+              "enum": [
+                2,
+                3
+              ],
+              "description": "2 指定范围，3 范围随机；不代表已确定的随机金额。"
+            },
+            "minAmount": {
+              "$ref": "#/definitions/money",
+              "description": "金额下限，必须小于或等于上限。"
+            },
+            "maxAmount": {
+              "$ref": "#/definitions/money",
+              "description": "金额上限。"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "mode",
+            "discountTenths"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "mode": {
+              "const": 2,
+              "description": "2 折扣券。"
+            },
+            "discountTenths": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 100,
+              "description": "十分之一折，88=8.8折，100=10折，不是金额。"
+            },
+            "maxDiscountAmount": {
+              "$ref": "#/definitions/money",
+              "description": "可选折扣金额上限，0.00 表示未设金额上限；省略不作此推断。"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "mode"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "mode": {
+              "const": 3,
+              "description": "3 兑换券；不输出占位金额或折扣，兑换引用见范围。"
+            }
+          }
+        }
+      ]
+    },
+    "threshold": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "type": {
+              "const": 0,
+              "description": "0 无门槛。"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "amount"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "type": {
+              "const": 1,
+              "description": "1 满金额。"
+            },
+            "amount": {
+              "$ref": "#/definitions/money"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "minPieces"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "type": {
+              "const": 2,
+              "description": "2 满件数。"
+            },
+            "minPieces": {
+              "$ref": "#/definitions/count",
+              "description": "件数下限；0 按数值保留，不解释为不限。"
+            },
+            "maxPieces": {
+              "$ref": "#/definitions/count",
+              "description": "可选件数上限；0 按数值保留，不解释为不限。"
+            }
+          }
+        }
+      ]
+    },
+    "channel": {
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": false,
+      "description": "只保留已取得的字段；缺失不填空数组，缺少类型或关联集合时不推断具体适用商品。",
+      "properties": {
+        "type": {
+          "type": "integer",
+          "enum": [
+            0,
+            1,
+            2,
+            3
+          ],
+          "description": "0 不可用，1 不限制，2 部分可用，3 部分不可用；未知失败，省略不推断。"
+        },
+        "channel_item_ids": {
+          "$ref": "#/definitions/ids",
+          "description": "该网店或门店渠道的旧商品ID配置引用；类型2纳入、3排除，保留顺序及空数组，不直接作为OneID。"
+        },
+        "groupIds": {
+          "$ref": "#/definitions/ids",
+          "description": "商品分组配置引用，不展开成员。"
+        },
+        "exchange_channel_item_ids": {
+          "$ref": "#/definitions/ids",
+          "description": "该渠道可兑换的旧商品ID配置引用，不代表OneID或商品当前可售。"
+        },
+        "exchangeGroupIds": {
+          "$ref": "#/definitions/ids",
+          "description": "可兑换商品分组配置引用，不展开成员。"
+        }
+      }
+    },
+    "code": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/integer"
+        },
+        {
+          "type": "string",
+          "pattern": "^-?[0-9]{1,12}$"
+        }
+      ]
+    },
+    "trace": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9_-]{1,128}$"
+    }
+  },
+  "modules": {
+    "activity": {
+      "base": true,
+      "upstreamPath": "data",
+      "required": true,
+      "description": "已知活动的身份、状态、优惠及可选门槛。"
+    },
+    "budget": {
+      "base": true,
+      "upstreamPath": "data",
+      "required": false,
+      "description": "同次结果中已有的活动预算；源全部缺失则省略。"
+    },
+    "scope": {
+      "base": true,
+      "upstreamPath": "data",
+      "required": false,
+      "description": "同次结果中已有的使用范围引用；源全部缺失则省略。"
+    }
+  },
+  "api": {
+    "method": "POST",
+    "path": "youzan.ump.voucheractivity.detail.query/3.0.4"
+  },
+  "success": {
+    "description": "活动标识与输入一致、归属店铺与目标一致、必需锚点与优惠分支有效，所有已取得的可选预算和范围字段符合模型后整体成功。"
+  },
+  "errors": {
+    "description": "明确活动不存在时为 not_found；空对象、null、错型或缺必需字段为 protocol；归属不符或未知规则为 scope_unresolved。仅诊断业务码，不按自由消息猜权限；失败不输出部分成功结果。"
+  },
+  "notes": [
+    "只读券发行活动，不查询客户持券，不证明领取资格、持券状态或订单用券结果；不是可直接回写的编辑快照。",
+    "默认投影已有预算与范围，源缺失省略，实际空数组和零值保留，已返回字段错型或 null 失败；不提供 include 或任意字段选择。",
+    "不输出结构化活动日期、领取限制、平台信息或未承诺扩展字段。支持微商城/零售单店、连锁 D 总部/网店/合伙人，不承诺连锁 L。",
+    "最多两次请求，同一凭证先核验店铺再读取详情；无补查、自动重试、切店或换身份，不承诺跨归属店铺。",
+    "真实执行需有效四字段上下文和同店凭证，位置准入不证明员工授权；缺上下文仅显式合法目标可本地预览。"
+  ]
+}