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

package/src/commands/native/fulfillment/shipment/list/schema.json

@@ -0,0 +1,752 @@
+{
+  "schemaVersion": 1,
+  "input": {
+    "type": "object",
+    "required": [
+      "kdtId",
+      "orderNo"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "kdtId": {
+        "$ref": "#/definitions/shopId"
+      },
+      "orderNo": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 128,
+        "pattern": "^[^\\s\\u0000-\\u001f\\u007f-\\u009f]+$(?![\\s\\S])",
+        "description": "原始订单号，不限定前缀或位数；保留原值，不含空白或控制字符。"
+      }
+    },
+    "description": "CLI 解析参数后的订单发货单列表输入。"
+  },
+  "output": {
+    "type": "object",
+    "required": [
+      "data"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "data": {
+        "type": "object",
+        "required": [
+          "shipments"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "shipments": {
+            "type": "array",
+            "maxItems": 1000,
+            "items": {
+              "$ref": "#/definitions/shipment"
+            },
+            "description": "本次接口返回的订单发货单集合，保持顺序，零张、一张、多张均为数组。空数组不证明订单不存在、无需发货或履约完成。不表示完整历史。"
+          }
+        }
+      }
+    }
+  },
+  "preview": {
+    "type": "object",
+    "required": [
+      "scope",
+      "prerequisites",
+      "requests",
+      "result"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "scope": {
+        "type": "object",
+        "required": [
+          "kdtId"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "kdtId": {
+            "$ref": "#/definitions/shopId"
+          }
+        }
+      },
+      "prerequisites": {
+        "type": "array",
+        "minItems": 1,
+        "maxItems": 1,
+        "items": {
+          "type": "object",
+          "required": [
+            "method",
+            "path",
+            "body"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "method": {
+              "const": "POST"
+            },
+            "path": {
+              "const": "youzan.shop.basic.get/3.0.0"
+            },
+            "body": {
+              "type": "object",
+              "additionalProperties": false
+            }
+          }
+        }
+      },
+      "requests": {
+        "type": "array",
+        "minItems": 1,
+        "maxItems": 1,
+        "items": {
+          "type": "object",
+          "required": [
+            "method",
+            "path",
+            "body"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "method": {
+              "const": "POST"
+            },
+            "path": {
+              "const": "youzan.trade.dc.query.querybyorderno/1.0.1"
+            },
+            "body": {
+              "type": "object",
+              "required": [
+                "tid",
+                "include_item_delivery_status",
+                "include_dist_order"
+              ],
+              "additionalProperties": false,
+              "properties": {
+                "tid": {
+                  "type": "string",
+                  "pattern": "^\\*{3}[^\\s\\u0000-\\u001f\\u007f-\\u009f]{1,4}$(?![\\s\\S])",
+                  "description": "脱敏订单号，固定 *** 加原始订单号末尾最多四个字符，不限定数字。"
+                },
+                "include_item_delivery_status": {
+                  "const": true
+                },
+                "include_dist_order": {
+                  "const": true
+                }
+              }
+            }
+          }
+        }
+      },
+      "result": {
+        "type": "object",
+        "required": [
+          "collection",
+          "items",
+          "deliveries",
+          "pagination"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "collection": {
+            "const": "data.shipments"
+          },
+          "items": {
+            "const": true
+          },
+          "deliveries": {
+            "const": true
+          },
+          "pagination": {
+            "const": false
+          }
+        }
+      }
+    }
+  },
+  "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": [
+          "category",
+          "stage",
+          "command",
+          "targetScope",
+          "requestState",
+          "nextStep",
+          "errorVersion",
+          "recovery",
+          "execution"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "category": {
+            "enum": [
+              "validation",
+              "configuration",
+              "parameter",
+              "permission",
+              "authentication",
+              "scope_unresolved",
+              "transport",
+              "http",
+              "protocol",
+              "business_rejected",
+              "target_mismatch",
+              "budget_exceeded"
+            ]
+          },
+          "stage": {
+            "type": "string",
+            "minLength": 1
+          },
+          "command": {
+            "const": "fulfillment.shipment.list"
+          },
+          "targetScope": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "kdtId": {
+                "$ref": "#/definitions/shopId"
+              }
+            }
+          },
+          "requestState": {
+            "enum": [
+              "not_sent",
+              "sent",
+              "unknown"
+            ]
+          },
+          "nextStep": {
+            "type": "string",
+            "minLength": 1
+          },
+          "api": {
+            "type": "string"
+          },
+          "httpStatus": {
+            "type": "integer"
+          },
+          "businessCode": {
+            "anyOf": [
+              {
+                "type": "integer"
+              },
+              {
+                "type": "string"
+              }
+            ]
+          },
+          "gatewayCode": {
+            "anyOf": [
+              {
+                "type": "integer"
+              },
+              {
+                "type": "string"
+              }
+            ]
+          },
+          "trace_id": {
+            "type": "string"
+          },
+          "request_id": {
+            "type": "string"
+          },
+          "errorVersion": {
+            "const": 2,
+            "description": "本命令采用错误诊断协议第二版。"
+          },
+          "issues": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 16,
+            "items": {
+              "$ref": "#/definitions/diagnosticIssue"
+            },
+            "description": "最多十六个已定位问题，不包含收到的原值。"
+          },
+          "issuesTruncated": {
+            "const": true,
+            "description": "问题超过返回上限，当前列表没有穷尽全部问题。"
+          },
+          "recovery": {
+            "$ref": "#/definitions/diagnosticRecovery",
+            "description": "受限的恢复说明，不会自动执行。"
+          },
+          "execution": {
+            "$ref": "#/definitions/diagnosticExecution",
+            "description": "整次调用的请求观察，独立于失败阶段的 requestState。"
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "shopId": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 9007199254740991
+    },
+    "safeInteger": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "shipment": {
+      "type": "object",
+      "required": [
+        "shipmentNo",
+        "orderNo",
+        "kdtId",
+        "status",
+        "deliveryMethod",
+        "items",
+        "deliveries"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "shipmentNo": {
+          "type": "string",
+          "minLength": 1,
+          "description": "发货单身份，非空字符串，本次集合内唯一；不是配送单号。"
+        },
+        "orderNo": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "pattern": "^[^\\s\\u0000-\\u001f\\u007f-\\u009f]+$(?![\\s\\S])",
+          "description": "所属订单号，必须与请求订单号一致。"
+        },
+        "kdtId": {
+          "$ref": "#/definitions/shopId",
+          "description": "所属店铺，必须与请求及凭证核验的店铺一致。"
+        },
+        "status": {
+          "$ref": "#/definitions/safeInteger",
+          "description": "货单状态：0 待发货；1 已发货；2 无需发货。均为 JSON 数字；未来未知非负安全整数原值保留，不推断含义，不接受字符串数字。"
+        },
+        "deliveryMethod": {
+          "$ref": "#/definitions/safeInteger",
+          "description": "配送方式：1 快递；2 同城送；3 自提。均为 JSON 数字；未来未知非负安全整数原值保留，不推断含义，不接受字符串数字。"
+        },
+        "flowType": {
+          "$ref": "#/definitions/safeInteger",
+          "description": "可选流程类型：1 基于订单发货流程；2 基于货单发货流程；3 货单升级；4 多期订单发货流程；5 多地址发货流程；6 单订单、单商品、多运单发货流程。均为 JSON 数字；未来未知非负安全整数原值保留，不推断含义，不接受字符串数字。"
+        },
+        "mode": {
+          "$ref": "#/definitions/safeInteger",
+          "description": "可选发货模式：0 手动发货；1 系统自动发货。均为 JSON 数字；未来未知非负安全整数原值保留，不推断含义，不接受字符串数字。"
+        },
+        "deliveryPoint": {
+          "type": "object",
+          "required": [
+            "id",
+            "type"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "id": {
+              "type": "string",
+              "pattern": "^[1-9]\\d*$",
+              "description": "正安全整数无损编码为十进制字符串，范围 1..9007199254740991，不作为店铺 ID。"
+            },
+            "type": {
+              "$ref": "#/definitions/safeInteger",
+              "description": "出货点类型：0 门店；1 仓库；2 总店；3 网点。总店为业务对象称呼，不代表总部授权身份。均为 JSON 数字；未来未知非负安全整数原值保留，不推断含义，不接受字符串数字。"
+            }
+          },
+          "description": "出货点 ID 与类型均取得时返回，均缺失或 null 时省略，仅取得一个则失败。"
+        },
+        "remark": {
+          "type": "string",
+          "description": "可选货单备注，保留原文和空字符串；缺失或 null 时省略。"
+        },
+        "items": {
+          "type": "array",
+          "maxItems": 1000,
+          "items": {
+            "type": "object",
+            "required": [
+              "orderItemId",
+              "quantity"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "orderItemId": {
+                "type": "string",
+                "pattern": "^[1-9]\\d*$",
+                "description": "交易订单条目 ID，原始 JSON 正整数数字词元保真转字符串；不是商品主档 ID。"
+              },
+              "quantity": {
+                "$ref": "#/definitions/safeInteger",
+                "description": "本行货单商品数量，非负安全整数，保留 0，不从购买数量补值。"
+              }
+            }
+          },
+          "description": "固定返回，保留顺序与重复商品行，可为空；缺失或 null 整体失败。"
+        },
+        "deliveries": {
+          "type": "array",
+          "maxItems": 1000,
+          "items": {
+            "type": "object",
+            "required": [
+              "deliveryId",
+              "status",
+              "deliveryMethod"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "deliveryId": {
+                "type": "string",
+                "minLength": 1
+              },
+              "status": {
+                "$ref": "#/definitions/safeInteger",
+                "description": "配送引用状态：0 未发货；1 发货中；2 已发货；3 已取消。与货单状态分别解释。均为 JSON 数字；未来未知非负安全整数原值保留，不推断含义，不接受字符串数字。"
+              },
+              "deliveryMethod": {
+                "$ref": "#/definitions/safeInteger",
+                "description": "配送方式：1 快递；2 同城送；3 自提。均为 JSON 数字；未来未知非负安全整数原值保留，不推断含义，不接受字符串数字。"
+              }
+            }
+          },
+          "description": "固定返回的配送引用，可为空；缺失或 null 整体失败，不补查配送详情。配送单 ID 在本次全部货单中不得重复。"
+        }
+      }
+    },
+    "diagnosticExpected": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [],
+      "properties": {
+        "type": {
+          "anyOf": [
+            {
+              "type": "string",
+              "description": "预期的 JSON 类型。"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "description": "预期的 JSON 类型。"
+              }
+            }
+          ],
+          "description": "同版模型允许的类型。"
+        },
+        "enum": {
+          "type": "array",
+          "items": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "number"
+              },
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "契约声明的静态标量约束。"
+          },
+          "description": "同版模型允许的静态值。"
+        },
+        "const": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "number"
+            },
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "契约声明的静态标量约束。"
+        },
+        "minimum": {
+          "type": "number",
+          "description": "包含的最小值。"
+        },
+        "maximum": {
+          "type": "number",
+          "description": "包含的最大值。"
+        },
+        "exclusiveMinimum": {
+          "type": "number",
+          "description": "不包含的最小值。"
+        },
+        "exclusiveMaximum": {
+          "type": "number",
+          "description": "不包含的最大值。"
+        },
+        "minLength": {
+          "type": "integer",
+          "description": "最少字符数。"
+        },
+        "maxLength": {
+          "type": "integer",
+          "description": "最多字符数。"
+        },
+        "minItems": {
+          "type": "integer",
+          "description": "最少元素数。"
+        },
+        "maxItems": {
+          "type": "integer",
+          "description": "最多元素数。"
+        },
+        "format": {
+          "type": "string",
+          "description": "同版模型声明的格式。"
+        },
+        "pattern": {
+          "type": "string",
+          "description": "同版模型声明的字符约束。"
+        },
+        "additionalProperties": {
+          "const": false,
+          "description": "对象拒绝契约以外的属性。"
+        },
+        "contains": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "const"
+          ],
+          "properties": {
+            "const": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "number"
+                },
+                {
+                  "type": "boolean"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "契约声明的静态标量约束。"
+            }
+          }
+        },
+        "items": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "enum"
+          ],
+          "properties": {
+            "enum": {
+              "type": "array",
+              "items": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "number"
+                  },
+                  {
+                    "type": "boolean"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ],
+                "description": "契约声明的静态标量约束。"
+              },
+              "description": "元素允许的静态值。"
+            }
+          }
+        }
+      }
+    },
+    "diagnosticIssue": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "source",
+        "reason"
+      ],
+      "properties": {
+        "source": {
+          "enum": [
+            "argv",
+            "input",
+            "context",
+            "output",
+            "preview"
+          ],
+          "description": "问题所属的参数、输入、上下文、结果或预览模型。"
+        },
+        "path": {
+          "type": "string",
+          "description": "对应模型中的 JSON Pointer；不含原始输入或动态字典键。"
+        },
+        "option": {
+          "type": "string",
+          "description": "可定位时给出的已注册 CLI 选项。"
+        },
+        "reason": {
+          "enum": [
+            "required",
+            "invalid_type",
+            "invalid_choice",
+            "out_of_range",
+            "invalid_format",
+            "conditional_required",
+            "constraint",
+            "unexpected_property",
+            "unknown_option",
+            "unknown_command",
+            "excess_arguments",
+            "missing_value"
+          ],
+          "description": "字段违反的约束类型，原始值不回显。"
+        },
+        "expected": {
+          "$ref": "#/definitions/diagnosticExpected",
+          "description": "同版契约的静态预期。"
+        },
+        "relatedPaths": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "description": "关联字段的 JSON Pointer。"
+          },
+          "description": "触发条件约束的关联字段。"
+        }
+      }
+    },
+    "diagnosticRecovery": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "action",
+        "automaticBusinessRetry"
+      ],
+      "properties": {
+        "action": {
+          "enum": [
+            "correct_input",
+            "complete_authentication",
+            "request_access_review",
+            "stop_and_inspect"
+          ],
+          "description": "依次表示修正本地输入、补认证、核对权限或停止核查；仅是说明，不执行操作或授予权限。"
+        },
+        "automaticBusinessRetry": {
+          "const": false,
+          "description": "不据此自动重放业务请求。"
+        }
+      }
+    },
+    "diagnosticExecution": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "requestState",
+        "coverage",
+        "observedAttempts"
+      ],
+      "properties": {
+        "requestState": {
+          "enum": [
+            "not_sent",
+            "sent",
+            "unknown"
+          ],
+          "description": "整次调用尚未发送、已有发送记录或无法排除未知请求；不代表业务完成。"
+        },
+        "coverage": {
+          "enum": [
+            "complete",
+            "partial"
+          ],
+          "description": "请求观察覆盖全部已接入路径，或存在未观测路径；部分覆盖不能声明零请求。"
+        },
+        "observedAttempts": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "本地已进入发送边界的观测次数下界，不是服务端执行次数。"
+        }
+      }
+    }
+  },
+  "modules": {
+    "items": {
+      "base": true,
+      "upstreamPath": "data[].delivery_order_items",
+      "required": true,
+      "description": "每张发货单的订单商品明细。"
+    },
+    "deliveries": {
+      "base": true,
+      "upstreamPath": "data[].dist_order_d_t_os",
+      "required": true,
+      "description": "每张发货单的配送引用。"
+    }
+  },
+  "api": {
+    "method": "POST",
+    "path": "youzan.trade.dc.query.querybyorderno/1.0.1"
+  },
+  "notes": [
+    "--kdt-id 省略时使用本次有效上下文 shopId；显式提供的非法值不回退。两者都缺失时拒绝；目标范围、同店核验和服务端权限仍按本命令校验。",
+    "订单号通常为 E/V/C 开头加 23 位数字，仅供核对，不限定前缀、数字组合或 24 位长度；按原值传递。仅保留非空、无空白或控制字符和最多 128 字符的文本保护；服务端仍判断支持范围和对象归属。",
+    "必须提供完整订单号；店铺省略时使用当前上下文，显式非法店铺不回退；不提供 include、shipment-no、分页或旧参数别名。商品明细与配送引用固定包含。",
+    "真实执行需有效 userId/hq/shopId/orgType 上下文，目标店铺必须等于上下文 shopId，包括总部上下文；凭证店铺回读仍不代替服务端员工授权。缺上下文只可显式完整输入本地预览，无效上下文拒绝。",
+    "适用于接口支持的微商城、零售单店及相应连锁 D、L 组织；at: all 不表示查询所有店铺或跨店授权。",
+    "最多一次店铺核验与一次业务读取，每请求 10 秒，不自动重试、切店或换身份。",
+    "主响应读取后最多 10 MiB，每个集合最多 1000 条，最终 JSON 最多 5 MiB；超额整体失败，不截断。读取后阈值不代表流式硬上限。",
+    "没有分页，不构造 total、hasMore 或 pagination；固定集合缺失、重复货单、重复配送及任一关系或字段无效整体失败。",
+    "所有输出码均为 JSON 数字，已知含义按字段说明，未知非负安全整数原值保留。可选 flowType、mode、remark 缺省或 null 时省略。",
+    "预览仅保留订单号末四位，不读取 token、网关环境或网络，不证明订单存在或授权有效。"
+  ],
+  "success": {
+    "description": "店铺核验通过，主接口成功且 data 是满足固定模型的发货单数组。"
+  },
+  "errors": {
+    "description": "失败 stdout 为空，stderr 为脱敏错误 JSON；不返回部分成功，不自动重试或切换店铺。",
+    "diagnosticsVersion": 2
+  }
+}