tencentcloud-sdk-nodejs
Version:
3,241 lines (3,235 loc) • 65.9 kB
TypeScript
/**
* 批次
*/
export interface CodeBatch {
/**
* 批次号
*/
BatchId?: string;
/**
* 企业ID
*/
CorpId?: number;
/**
* 批次编码(未使用)
*/
BatchCode?: string;
/**
* 码数量
*/
CodeCnt?: number;
/**
* 所属商户ID
*/
MerchantId?: string;
/**
* 产品ID
*/
ProductId?: string;
/**
* 批次类型
*/
BatchType?: number;
/**
* 备注
*/
Remark?: string;
/**
* 微信模板
*/
MpTpl?: string;
/**
* 批次状态 0: 未激活 1: 已激活 -1: 已冻结
*/
Status?: number;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 修改时间
*/
UpdateTime?: string;
/**
* 所属商户名称
*/
MerchantName?: string;
/**
* 产品名称
*/
ProductName?: string;
/**
* 未使用
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
Ext?: Ext;
/**
* 模板名称
*/
TplName?: string;
/**
* 调度任务
注意:此字段可能返回 null,表示取不到有效值。
*/
Job?: Job;
/**
* 生产日期
注意:此字段可能返回 null,表示取不到有效值。
*/
ProductionDate?: string;
/**
* 有效期
注意:此字段可能返回 null,表示取不到有效值。
*/
ValidDate?: string;
/**
* 扩展属性
*/
Attrs?: Array<AttrItem>;
}
/**
* DescribeScanStats请求参数结构体
*/
export interface DescribeScanStatsRequest {
/**
* 企业ID
*/
CorpId?: number;
/**
* 分页数量
*/
PageSize?: number;
/**
* 当前分页
*/
PageNumber?: number;
/**
* 商户ID
*/
MerchantId?: string;
/**
* 产品ID
*/
ProductId?: string;
/**
* 批次ID
*/
BatchId?: string;
/**
* 安心码
*/
Code?: string;
}
/**
* DescribeScanLogs返回参数结构体
*/
export interface DescribeScanLogsResponse {
/**
* 【弃用】
* @deprecated
*/
Products?: Array<ScanLog>;
/**
* 条数
*/
TotalCount?: number;
/**
* 扫描记录
*/
ScanLogs?: Array<ScanLog>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 企业配额信息
*/
export interface Quota {
/**
* 服务开始时间
*/
StartTime: string;
/**
* 服务结束时间
*/
EndTime: string;
/**
* 配额ID
*/
QuotaId?: number;
/**
* 企业ID
*/
CorpId?: number;
/**
* 开通服务
*/
Services?: Array<string>;
/**
* 商户配额
*/
FactoryQuota?: number;
/**
* 商品配额
*/
ItemQuota?: number;
/**
* 溯源码配额
*/
TrackQuota?: number;
/**
* 销售码配额
*/
SaleQuota?: number;
/**
* 上链配额
*/
ChainQuota?: number;
/**
* 风控配额
*/
RiskQuota?: number;
/**
* AI文字数量
*/
AigcTextQuota?: number;
/**
* AI图片数量
*/
AigcImageQuota?: number;
/**
* 溯源类型
*/
TrackType?: number;
/**
* 开通版本 lite:轻量版, basic:基础版, standard:标准版
*/
Version?: string;
/**
* 是否开启企业认证
*/
ProductCertify?: number;
}
/**
* 安心计划二维码
*/
export interface PlanQRCode {
/**
* 二维码
*/
Url: string;
/**
* 状态,0:未激活 1:已激活 2:已冻结
*/
Status: number;
}
/**
* 扫码明细
*/
export interface ScanLog {
/**
* 行ID
*/
LogId?: number;
/**
* 微信openid
*/
Openid?: string;
/**
* 微信昵称
*/
Nickname?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 码
*/
Code?: string;
/**
* 企业ID
*/
CorpId?: number;
/**
* 商户ID
*/
MerchantId?: string;
/**
* 商品ID
*/
ProductId?: string;
/**
* ip地址
*/
Ip?: string;
/**
* 国家
*/
Country?: string;
/**
* 省份
*/
Province?: string;
/**
* 城市
*/
City?: string;
/**
* 县/区
*/
District?: string;
/**
* 微信 unionid
*/
Unionid?: string;
/**
* 首次扫码 0:否, 1:是
*/
First?: number;
/**
* 批次ID
*/
BatchId?: string;
/**
* 扫码类型 0:无效扫码 1: 小程序扫码 2: 商家扫码
*/
Type?: number;
/**
* 商户名称
*/
MerchantName?: string;
/**
* 产品名称
*/
ProductName?: string;
/**
* 产品Logo
*/
ProductLogo?: string;
/**
* 风险状态
0: 未知, 1:通过, 2:失败/风险, 3:存疑
*/
Status?: number;
/**
* 是否开启验证
0:否, 1:是
*/
Verify?: number;
}
/**
* DescribeProducts请求参数结构体
*/
export interface DescribeProductsRequest {
/**
* 商品名称
*/
Name?: string;
/**
* 条数
*/
PageSize?: number;
/**
* 页数
*/
PageNumber?: number;
/**
* 商品ID
*/
MerchantId?: string;
/**
* 企业ID
*/
CorpId?: number;
/**
* 认证状态
*/
CertState?: number;
}
/**
* CreateCorporationOrder返回参数结构体
*/
export interface CreateCorporationOrderResponse {
/**
* 企业ID
*/
CorpId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyProduct返回参数结构体
*/
export interface ModifyProductResponse {
/**
* 商品ID
*/
ProductId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyProduct请求参数结构体
*/
export interface ModifyProductRequest {
/**
* 商品名称
*/
Name: string;
/**
* 商品ID
*/
ProductId: string;
/**
* 备注
*/
Remark?: string;
/**
* 商品规格
*/
Specification?: string;
/**
* 商品图片
*/
Logo?: Array<string>;
/**
* 企业ID
*/
CorpId?: number;
/**
* 预留字段
*/
Ext?: Ext;
}
/**
* ModifyCustomRule请求参数结构体
*/
export interface ModifyCustomRuleRequest {
/**
* 码规则ID
*/
CustomId: string;
/**
* 规则名称
*/
Name: string;
/**
* 码长度
*/
CodeLength: number;
/**
* 码段配置
*/
CodeParts: Array<CodePart>;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* 码段配置
*/
export interface CodePart {
/**
* 码段名称
*/
Name: string;
/**
* 码段类型
*/
Type: string;
/**
* 码段内容
*/
Value: string;
/**
* 码段长度
*/
Length: number;
/**
* 扩展字段
*/
Ext: string;
}
/**
* 码包类型
*/
export interface CodePack {
/**
* 码id
*/
PackId?: string;
/**
* 企业id
*/
CorpId?: number;
/**
* 商户id
*/
MerchantId?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 制码状态 init: 初始化, pending: 执行中, done: 完成, error: 失败
*/
Status?: string;
/**
* 执行日志
*/
Log?: string;
/**
* 创建人
*/
CreateUser?: string;
/**
* 码数
*/
Amount?: number;
/**
* 防伪码长度
*/
CodeLength?: number;
/**
* 码类型
*/
CodeType?: string;
/**
* 是否暗码
*/
Cipher?: number;
/**
* [弃用] 文字码地址,通过另一个接口查
*/
TextUrl?: string;
/**
* [弃用] 二维码地址,通过另一个接口查
*/
PackUrl?: string;
/**
* 商户名
*/
MerchantName?: string;
/**
* 码规则类型 0: 默认, 1: 自定义
*/
RuleType?: number;
/**
* 自定义码规则ID
*/
CustomId?: string;
/**
* 码包类型 0: 普通码包 1: 层级码包
*/
PackType?: number;
/**
* 生码层级
*/
PackLevel?: number;
/**
* 层级码配置
*/
PackSpec?: Array<PackSpec>;
/**
* 商品名称
*/
ProductName?: string;
/**
* 商品规格
*/
ProductSpecification?: string;
/**
* 商品ID
*/
ProductId?: string;
/**
* 码关系是否预关联
0:否, 1:是
*/
RelateType?: number;
/**
* 场景码
*/
SceneCode?: number;
/**
* 码规则
*/
CodeRule?: string;
/**
* 已使用码数
*/
UsedAmount?: number;
/**
* 开始流水号
*/
SerialStart?: number;
/**
* 结束流水号
*/
SerialEnd?: number;
}
/**
* DeleteCodeBatch请求参数结构体
*/
export interface DeleteCodeBatchRequest {
/**
* 企业ID
*/
CorpId?: number;
/**
* 批次ID
*/
BatchId?: string;
}
/**
* DescribeMerchants请求参数结构体
*/
export interface DescribeMerchantsRequest {
/**
* 搜索商户名称
*/
Name?: string;
/**
* 条数
*/
PageSize?: number;
/**
* 页数
*/
PageNumber?: number;
/**
* 企业ID
*/
CorpId?: number;
/**
* 码来源类型 0:自建, 1:第三方
*/
CodeType?: number;
}
/**
* ModifyTraceCode请求参数结构体
*/
export interface ModifyTraceCodeRequest {
/**
* 二维码
*/
Code: string;
/**
* 企业ID
*/
CorpId?: number;
/**
* 状态 0: 冻结 1: 激活
*/
Status?: number;
}
/**
* DescribePlanQRCodes返回参数结构体
*/
export interface DescribePlanQRCodesResponse {
/**
* 返回码
*/
Ret?: number;
/**
* 总数
*/
Total?: number;
/**
* 数据
*/
Data?: Array<PlanQRCode>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateMerchant请求参数结构体
*/
export interface CreateMerchantRequest {
/**
* 商户名称
*/
Name: string;
/**
* 备注
*/
Remark?: string;
/**
* 企业ID
*/
CorpId?: number;
/**
* 码包来源 0:自建, 1:第三方
*/
CodeType?: number;
/**
* 码包前缀地址 第三方码包时必填
*/
CodeUrl?: string;
}
/**
* DescribeCodeBatchById请求参数结构体
*/
export interface DescribeCodeBatchByIdRequest {
/**
* 企业ID
*/
CorpId?: number;
/**
* 批次ID
*/
BatchId?: string;
}
/**
* DescribeTraceCodeById返回参数结构体
*/
export interface DescribeTraceCodeByIdResponse {
/**
* 无
*/
TraceCode?: TraceCode;
/**
* 码路径,如level是2,则为 [1级, 2级]
*/
CodePath?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 码规则
*/
export interface CustomRule {
/**
* 码规则ID
*/
CustomId?: string;
/**
* 码规则名
*/
Name?: string;
/**
* 企业ID
*/
CorpId?: number;
/**
* 商户ID
*/
MerchantId?: string;
/**
* 码ID长度
*/
CodeLength?: number;
/**
* 规则状态
*/
Status?: number;
/**
* 码段配置
*/
CodeParts?: Array<CodePart>;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 更新时间
*/
UpdateTime?: string;
}
/**
* DescribeProducts返回参数结构体
*/
export interface DescribeProductsResponse {
/**
* 商品列表
*/
Products?: Array<Product>;
/**
* 总数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateTraceChain返回参数结构体
*/
export interface CreateTraceChainResponse {
/**
* 溯源ID
*/
TraceId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTraceDataList返回参数结构体
*/
export interface DescribeTraceDataListResponse {
/**
* 溯源阶段数量
*/
TotalCount?: number;
/**
* 溯源明细
*/
TraceDataList?: Array<TraceData>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 通用属性
Type 的枚举值
text:文本类型, longtext:长文本类型, banner:单图片类型, image:多图片类型, video:视频类型, mp:小程序类型
具体组合如下
- Type: "text" 文本类型, 对应值 Value: "文本字符串"
- Type: "longtext" 长文本类型, 对应值 Value: "长文本字符串, 支持换行\n"
- Type: "banner" 单图片类型, 对应图片地址 Value: "https://sample.cdn.com/xxx.jpg"
- Type: "image" 多图片类型, 对应图片地址 Values: ["https://sample.cdn.com/1.jpg", "https://sample.cdn.com/2.jpg"]
- Type: "video" 视频类型, 对应视频地址 Value: "https://sample.cdn.com/xxx.mp4"
- Type: "mp" 小程序类型, 对应配置 Values: ["WXAPPID", "WXAPP_PATH", "跳转说明"]
*/
export interface AttrItem {
/**
* 字段名称
*/
Name: string;
/**
* 字段值
*/
Value: string;
/**
* 字段类型
text:文本类型,
longtext:长文本类型, banner:单图片类型, image:多图片类型,
video:视频类型,
mp:小程序类型
*/
Type: string;
/**
* 只读
*/
ReadOnly: boolean;
/**
* 扫码展示
*/
Hidden: boolean;
/**
* 多个值
*/
Values: Array<string>;
/**
* 类型标识
*/
Key: string;
/**
* 扩展字段
*/
Ext: string;
}
/**
* DescribeTraceCodes请求参数结构体
*/
export interface DescribeTraceCodesRequest {
/**
* 搜索关键字 码标识,或者批次ID
*/
Keyword?: string;
/**
* 条数
*/
PageNumber?: number;
/**
* 页码
*/
PageSize?: number;
/**
* 批次ID,弃用
*/
BatchId?: string;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* CreateTraceCodesAsync请求参数结构体
*/
export interface CreateTraceCodesAsyncRequest {
/**
* 企业ID
*/
CorpId?: number;
/**
* 批次ID
*/
BatchId?: string;
/**
* 上传文件Key,仅支持 csv 或者 zip 类型
*/
FileKey?: string;
}
/**
* ModifyTraceData返回参数结构体
*/
export interface ModifyTraceDataResponse {
/**
* 溯源ID
*/
TraceId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AuthorizedTransfer返回参数结构体
*/
export interface AuthorizedTransferResponse {
/**
* 业务出参。
*/
Data?: OutputAuthorizedTransfer;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCodeBatch返回参数结构体
*/
export interface CreateCodeBatchResponse {
/**
* 批次ID
*/
BatchId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCustomRules请求参数结构体
*/
export interface DescribeCustomRulesRequest {
/**
* 搜索关键字
*/
Keyword?: string;
/**
* 条数
*/
PageSize?: number;
/**
* 页数
*/
PageNumber?: number;
/**
* 企业ID
*/
CorpId?: number;
/**
* 码规则状态 0:未生效 1:已生效 -1:已失效
*/
Status?: number;
/**
* 商户ID
*/
MerchantId?: string;
}
/**
* 渠道商的子企业额度使用情况
*/
export interface CorpQuota {
/**
* 企业ID
*/
CorpId: number;
/**
* 企业名称
*/
CorpName: string;
/**
* 额度
*/
Quota: Quota;
/**
* 额度使用量
*/
UsageQuota: UsageQuota;
}
/**
* 扫码统计
*/
export interface ScanStat {
/**
* 安心码
*/
Code?: string;
/**
* 企业ID
*/
CorpId?: number;
/**
* 商户ID
*/
MerchantId?: string;
/**
* 产品ID
*/
ProductId?: string;
/**
* 批次ID
*/
BatchId?: string;
/**
* 扫码次数
*/
Pv?: number;
/**
* 扫码人数
*/
Uv?: number;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 商户名称
*/
MerchantName?: string;
/**
* 产品名称
*/
ProductName?: string;
}
/**
* CreateCustomRule请求参数结构体
*/
export interface CreateCustomRuleRequest {
/**
* 规则名称
*/
Name: string;
/**
* 商户ID
*/
MerchantId: string;
/**
* 码长度
*/
CodeLength: number;
/**
* 码段配置
*/
CodeParts: Array<CodePart>;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* DescribeCodePackStatus请求参数结构体
*/
export interface DescribeCodePackStatusRequest {
/**
* 码包ID
*/
PackId: string;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* ModifyTraceData请求参数结构体
*/
export interface ModifyTraceDataRequest {
/**
* 溯源ID
*/
TraceId?: string;
/**
* 批次ID
*/
BatchId?: string;
/**
* 生产溯源任务ID
*/
TaskId?: string;
/**
* 溯源信息
*/
TraceItems?: Array<TraceItem>;
/**
* 溯源阶段名称
*/
PhaseName?: string;
/**
* 环节数据
*/
PhaseData?: PhaseData;
/**
* 溯源状态 0: 无效, 1: 有效
*/
Status?: number;
/**
* 排序
*/
Rank?: number;
/**
* [无效] 类型
*/
Type?: number;
/**
* [无效] 溯源码
*/
Code?: string;
/**
* [无效] 溯源阶段 0:商品 1:通用 2:生产溯源 3:销售溯源
*/
Phase?: number;
/**
* [无效] 溯源时间
*/
TraceTime?: string;
/**
* [无效] 创建时间
*/
CreateTime?: string;
/**
* [无效] 上链状态
*/
ChainStatus?: number;
/**
* [无效] 上链时间
*/
ChainTime?: string;
/**
* [无效] 上链数据
*/
ChainData?: ChainData;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* DescribeCodeBatchs请求参数结构体
*/
export interface DescribeCodeBatchsRequest {
/**
* 查询商户ID
*/
MerchantId?: string;
/**
* 查询商品ID
*/
ProductId?: string;
/**
* 查询关键字
*/
Keyword?: string;
/**
* 条数
*/
PageSize?: number;
/**
* 页数
*/
PageNumber?: number;
/**
* 批次类型 0:溯源 1:营销
*/
BatchType?: string;
/**
* 企业ID
*/
CorpId?: number;
/**
* 批次状态
*/
Status?: number;
}
/**
* DescribeAgentCorps返回参数结构体
*/
export interface DescribeAgentCorpsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyTraceDataRanks返回参数结构体
*/
export interface ModifyTraceDataRanksResponse {
/**
* 批次ID
*/
BatchId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateTraceCodes请求参数结构体
*/
export interface CreateTraceCodesRequest {
/**
* 批次ID
*/
BatchId: string;
/**
* 企业ID
*/
CorpId?: number;
/**
* 码
*/
Codes?: Array<CodeItem>;
/**
* 码绑定激活策略,默认 0
0: 传什么码就激活什么码
1: 层级码 + 层级子码
*/
CodeType?: number;
/**
* 错误检查类型,默认 0
0: 没有新导入码时正常返回
1: 没有新导入码时报错,并返回没有导入成功的原因
*/
CheckType?: number;
}
/**
* DescribeCodeBatchById返回参数结构体
*/
export interface DescribeCodeBatchByIdResponse {
/**
* 批次
*/
CodeBatch?: CodeBatch;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCorpQuotas返回参数结构体
*/
export interface DescribeCorpQuotasResponse {
/**
* 子企业额度使用情况
*/
CorpQuotas?: Array<CorpQuota>;
/**
* 记录总数量
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCodePackStatus返回参数结构体
*/
export interface DescribeCodePackStatusResponse {
/**
* 码包状态 init: 初始化, pending: 执行中, done: 完成, error: 失败
*/
Status?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 通用调度任务
*/
export interface Job {
/**
* 调度ID
*/
JobId?: number;
/**
* 执行状态 init:初始化, pending: 执行中, done: 执行成功, error: 执行失败
*/
Status?: string;
/**
* 任务错误信息
*/
ErrorMessage?: string;
}
/**
* 溯源数据
*/
export interface TraceData {
/**
* 溯源ID
*/
TraceId: string;
/**
* 企业ID
*/
CorpId: number;
/**
* 码类型 0: 批次, 1: 码, 2: 生产任务
*/
Type: number;
/**
* 码值,跟码类型一一对应
*/
Code: string;
/**
* 排序,在Phase相同情况下,值越小排名靠前
*/
Rank: number;
/**
* 溯源阶段 0:商品 1:通用 2:生产溯源 3:销售溯源
*/
Phase: number;
/**
* 溯源环节名称
*/
PhaseName: string;
/**
* 溯源时间
*/
TraceTime: string;
/**
* 创建时间
*/
CreateTime: string;
/**
* 上链状态 0: 未上链 1: 上链中 2: 已上链 -1: 异常
*/
ChainStatus: number;
/**
* 上链时间
*/
ChainTime: string;
/**
* 上链数据
*/
ChainData: ChainData;
/**
* 溯源阶段配置
*/
PhaseData: PhaseData;
/**
* 溯源阶段状态 0: 无效, 1: 有效
*/
Status: number;
/**
* 无
*/
TraceItems?: Array<TraceItem>;
}
/**
* EffectFeedback返回参数结构体
*/
export interface EffectFeedbackResponse {
/**
* 业务出参。
*/
Data?: OutputAuthorizedTransfer;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 层级码配置
*/
export interface PackSpec {
/**
* 层级
*/
Level: number;
/**
* 比例
*/
Rate: number;
/**
* 数量
*/
Amount: number;
/**
* 码规则ID
*/
CustomId?: string;
/**
* 码段配置
*/
CodeParts?: Array<CodePart>;
/**
* 包装单位
*/
Unit?: string;
/**
* 场景值
*/
SceneCode?: number;
}
/**
* ModifyCustomRule返回参数结构体
*/
export interface ModifyCustomRuleResponse {
/**
* 码规则ID
*/
CustomId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyMerchant返回参数结构体
*/
export interface ModifyMerchantResponse {
/**
* 商户标识码
*/
MerchantId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCodesByPack返回参数结构体
*/
export interface DescribeCodesByPackResponse {
/**
* 码列表
*/
Codes?: Array<CodeItem>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateProduct返回参数结构体
*/
export interface CreateProductResponse {
/**
* 商品ID
*/
ProductId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateTraceData请求参数结构体
*/
export interface CreateTraceDataRequest {
/**
* 企业ID
*/
CorpId?: number;
/**
* 批次ID
*/
BatchId?: string;
/**
* 任务ID
*/
TaskId?: string;
/**
* 溯源阶段 0:商品 1:通用 2:生产溯源 3:销售溯源
*/
Phase?: number;
/**
* 溯源阶段名称
*/
PhaseName?: string;
/**
* [无效] 上链状态
*/
ChainStatus?: number;
/**
* [无效] 码类型 0: 批次, 1: 码, 2: 生产任务, 3: 物流信息
*/
Type?: number;
/**
* [无效] 溯源ID
*/
TraceId?: string;
/**
* 溯源信息
*/
TraceItems?: Array<TraceItem>;
/**
* 溯源状态 0: 无效, 1: 有效
*/
Status?: number;
/**
* 环节数据
*/
PhaseData?: PhaseData;
}
/**
* CreateCodePack请求参数结构体
*/
export interface CreateCodePackRequest {
/**
* 商户ID
*/
MerchantId: string;
/**
* 码长度
*/
CodeLength: number;
/**
* 码类型 alphabet 字母, number 数字, mixin 混合
*/
CodeType: string;
/**
* 生码数量 普通码包时必填
*/
Amount?: number;
/**
* 企业ID
*/
CorpId?: number;
/**
* 码包类型 0: 普通码包 1: 层级码包
*/
PackType?: number;
/**
* 码包层级
*/
PackLevel?: number;
/**
* 码包规格
*/
PackSpec?: Array<PackSpec>;
/**
* 批次ID,如果传了生码后会同时绑定批次,并激活码
*/
BatchId?: string;
/**
* 是否有流水码 0:无 1:有
*/
SerialType?: number;
/**
* 关联产品ID
*/
ProductId?: string;
/**
* 层级码时是否提前生成关联关系,默认为 1
*/
RelateType?: number;
/**
* 场景值
*/
SceneCode?: number;
}
/**
* DescribeCorpQuotas请求参数结构体
*/
export interface DescribeCorpQuotasRequest {
/**
* 渠道商ID,不要传
*/
AgentId?: number;
/**
* 页数
*/
PageNumber?: number;
/**
* 每页数量
*/
PageSize?: number;
/**
* 搜索企业ID
*/
Keyword?: string;
}
/**
* AuthorizedTransfer请求参数结构体
*/
export interface AuthorizedTransferRequest {
/**
* 业务加密入参。
*/
BusinessSecurityData: InputEncryptData;
}
/**
* ReportBatchCallbackStatus请求参数结构体
*/
export interface ReportBatchCallbackStatusRequest {
/**
* 业务加密入参。
*/
BusinessSecurityData: InputEncryptData;
}
/**
* DescribeCodeBatches返回参数结构体
*/
export interface DescribeCodeBatchesResponse {
/**
* 批次列表
*/
CodeBatches?: Array<CodeBatch>;
/**
* 总条数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 上链数据
*/
export interface Chain {
/**
* 码url
*/
Code: string;
/**
* 上链数据
*/
Data: Array<ChainValue>;
}
/**
* CreateProduct请求参数结构体
*/
export interface CreateProductRequest {
/**
* 商品名称
*/
Name: string;
/**
* 商户ID
*/
MerchantId: string;
/**
* 备注
*/
Remark?: string;
/**
* 商户名称
*/
MerchantName?: string;
/**
* 商品规格
*/
Specification?: string;
/**
* 商品图片
*/
Logo?: Array<string>;
/**
* 企业ID
*/
CorpId?: number;
/**
* 预留字段
*/
Ext?: Ext;
}
/**
* CreateCustomPack请求参数结构体
*/
export interface CreateCustomPackRequest {
/**
* 商户ID
*/
MerchantId: string;
/**
* 生码数量, 普通码包时必填
*/
Amount?: number;
/**
* 企业ID
*/
CorpId?: number;
/**
* 码包类型 0: 普通码包 1: 层级码包
*/
PackType?: number;
/**
* 码包层级
*/
PackLevel?: number;
/**
* 层级码包规则
*/
PackSpec?: Array<PackSpec>;
/**
* 码规则ID, 和CodeParts二选一必填
*/
CustomId?: string;
/**
* 码段配置,和CustomId二选一必填
*/
CodeParts?: Array<CodePart>;
/**
* 批次ID,如果传了生码后会同时绑定批次,并激活码
*/
BatchId?: string;
/**
* 是否有流水码 0:无 1:有
*/
SerialType?: number;
/**
* 产品ID
*/
ProductId?: string;
/**
* 是否预生成码关系
0: 否, 1:是
默认为1,仅对层级码有效
*/
RelateType?: number;
/**
* 场景值
*/
SceneCode?: number;
}
/**
* 预留字段
*/
export interface Ext {
/**
* 字符串
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
Value?: string;
}
/**
* CreateCodeBatch请求参数结构体
*/
export interface CreateCodeBatchRequest {
/**
* 企业ID
*/
CorpId?: number;
/**
* 商户ID
*/
MerchantId?: string;
/**
* 产品ID
*/
ProductId?: string;
/**
* 批次类型 0:溯源 1:营销
*/
BatchType?: number;
/**
* 批次ID,留空时系统自动生成
*/
BatchId?: string;
/**
* 备注
*/
Remark?: string;
/**
* 模板ID,或者活动ID
*/
MpTpl?: string;
/**
* 克隆批次ID,同时会复制溯源信息
*/
CloneId?: string;
/**
* 批次编号,业务字段不判断唯一性
*/
BatchCode?: string;
/**
* 有效期
*/
ValidDate?: string;
/**
* 生产日期
*/
ProductionDate?: string;
}
/**
* 溯源数据项 Type 的枚举值
text:文本类型, longtext:长文本类型, banner:单图片类型, image:多图片类型, video:视频类型, mp:小程序类型
具体组合如下
- Type: "text" 文本类型, 对应值 Value: "文本字符串"
- Type: "longtext" 长文本类型, 对应值 Value: "长文本字符串, 支持换行\n"
- Type: "banner" 单图片类型, 对应图片地址 Value: "https://sample.cdn.com/xxx.jpg"
- Type: "image" 多图片类型, 对应图片地址 Values: ["https://sample.cdn.com/1.jpg", "https://sample.cdn.com/2.jpg"]
- Type: "video" 视频类型, 对应视频地址 Value: "https://sample.cdn.com/xxx.mp4"
- Type: "mp" 小程序类型, 对应配置 Values: ["WXAPPID", "WXAPP_PATH", "跳转说明"]
*/
export interface TraceItem {
/**
* 字段名称
*/
Name: string;
/**
* 字段值
*/
Value: string;
/**
* 字段类型
text:文本类型,
longtext:长文本类型, banner:单图片类型, image:多图片类型,
video:视频类型,
mp:小程序类型
*/
Type: string;
/**
* 多个值
*/
Values: Array<string>;
/**
* 只读
*/
ReadOnly?: boolean;
/**
* 扫码展示
*/
Hidden?: boolean;
/**
* 类型标识
*/
Key?: string;
/**
* 扩展字段
*/
Ext?: string;
/**
* 额外属性
*/
Attrs?: Array<TraceItem>;
/**
* 子页面,只读
*/
List?: Array<TraceData>;
}
/**
* DescribeCustomRuleById请求参数结构体
*/
export interface DescribeCustomRuleByIdRequest {
/**
* 码规则ID
*/
CustomId: string;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* DescribeAgentCorps请求参数结构体
*/
export interface DescribeAgentCorpsRequest {
/**
* 每页数量
*/
PageSize?: number;
/**
* 页数
*/
PageNumber?: number;
/**
* 渠道ID
*/
AgentId?: number;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* ReportBatchCallbackStatus返回参数结构体
*/
export interface ReportBatchCallbackStatusResponse {
/**
* 业务出参。
*/
Data?: OutputAuthorizedTransfer;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 上链数据
*/
export interface ChainData {
/**
* 区块hash
*/
BlockHash?: string;
/**
* 区块高度
*/
BlockHeight?: string;
/**
* 区块时间
*/
BlockTime?: string;
}
/**
* 环节数据
*/
export interface PhaseData {
/**
* 启用头
*/
HeadEnabled?: boolean;
/**
* 标题
*/
HeadTitle?: string;
/**
* 标识符
*/
Key?: string;
/**
* 小程序AppId
*/
AppId?: string;
/**
* 小程序AppPath
*/
AppPath?: string;
/**
* 小程序名称AppName
*/
AppName?: string;
}
/**
* DescribeRawScanLogs请求参数结构体
*/
export interface DescribeRawScanLogsRequest {
/**
* 企业ID, 默认为当前企业
如果有渠道权限,可以传 0 会查渠道下所有的企业
*/
CorpId?: number;
/**
* 分页数量,默认为 20,最大为 1000
*/
PageSize?: number;
/**
* 当前分页,默认为 1
*/
PageNumber?: number;
/**
* 从哪个日志后查询
即: LogId > $AfterLogId
*/
AfterLogId?: number;
/**
* 开始时间 >= StartTime
*/
StartTime?: string;
/**
* 结束时间 < EndTime
*/
EndTime?: string;
}
/**
* DeleteProduct请求参数结构体
*/
export interface DeleteProductRequest {
/**
* 商品ID
*/
ProductId: string;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* ModifyTraceDataRanks请求参数结构体
*/
export interface ModifyTraceDataRanksRequest {
/**
* 企业ID
*/
CorpId?: number;
/**
* 批次ID
*/
BatchId?: string;
/**
* 生产任务ID
*/
TaskId?: string;
/**
* 溯源ID
*/
TraceIds?: Array<string>;
}
/**
* ModifyCustomRuleStatus返回参数结构体
*/
export interface ModifyCustomRuleStatusResponse {
/**
* 码规则ID
*/
CustomId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCustomPack返回参数结构体
*/
export interface CreateCustomPackResponse {
/**
* 码包ID
*/
PackId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyMerchant请求参数结构体
*/
export interface ModifyMerchantRequest {
/**
* 商户名称
*/
Name: string;
/**
* 商户标识码
*/
MerchantId: string;
/**
* 备注
*/
Remark?: string;
/**
* 企业ID
*/
CorpId?: number;
/**
* 码包来源 0:自建, 1:第三方码包,暂不支持修改
*/
CodeType?: number;
/**
* 码包前缀地址 第三方码包时必填
*/
CodeUrl?: string;
}
/**
* DescribeTmpToken返回参数结构体
*/
export interface DescribeTmpTokenResponse {
/**
* 临时token
*/
Token?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCodePackUrl请求参数结构体
*/
export interface DescribeCodePackUrlRequest {
/**
* 码包ID
*/
PackId: string;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* DeleteProduct返回参数结构体
*/
export interface DeleteProductResponse {
/**
* 商品ID
*/
ProductId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateChainBatch请求参数结构体
*/
export interface CreateChainBatchRequest {
/**
* 企业ID
*/
CorpId: number;
/**
* 溯源ID
*/
ChainList: Array<Chain>;
}
/**
* 业务出参
*/
export interface OutputAuthorizedTransfer {
/**
* 推送状态,0表示成功。
*/
Code?: number;
/**
* 错误码。
*/
Message?: string;
/**
* 错误信息描述。
*/
Value?: string;
}
/**
* DeleteTraceData返回参数结构体
*/
export interface DeleteTraceDataResponse {
/**
* 溯源id
*/
TraceId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyCustomRuleStatus请求参数结构体
*/
export interface ModifyCustomRuleStatusRequest {
/**
* 码规则ID
*/
CustomId: string;
/**
* 码规则状态 0:未生效 1:已生效 -1:已失效
*/
Status: number;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* CreateCodePack返回参数结构体
*/
export interface CreateCodePackResponse {
/**
* 码包ID
*/
PackId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeMerchantById返回参数结构体
*/
export interface DescribeMerchantByIdResponse {
/**
* 商户信息
*/
Merchant?: Merchant;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* EffectFeedback请求参数结构体
*/
export interface EffectFeedbackRequest {
/**
* 业务加密入参。
*/
BusinessSecurityData: InputEncryptData;
}
/**
* DescribeTraceDataById返回参数结构体
*/
export interface DescribeTraceDataByIdResponse {
/**
* 无
*/
TraceData?: TraceData;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 码类型
*/
export interface CodeItem {
/**
* 无
*/
Code?: string;
}
/**
* CreateTraceData返回参数结构体
*/
export interface CreateTraceDataResponse {
/**
* 溯源ID
*/
TraceId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCustomRuleById返回参数结构体
*/
export interface DescribeCustomRuleByIdResponse {
/**
* 码规则信息
*/
CustomRule?: CustomRule;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCodeBatchs返回参数结构体
*/
export interface DescribeCodeBatchsResponse {
/**
* 批次列表
*/
CodeBatchs?: Array<CodeBatch>;
/**
* 总条数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCustomRule返回参数结构体
*/
export interface CreateCustomRuleResponse {
/**
* 码规则ID
*/
CustomId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePlanQRCodeScanRecords返回参数结构体
*/
export interface DescribePlanQRCodeScanRecordsResponse {
/**
* 返回码
*/
Ret?: number;
/**
* 总数
*/
Total?: number;
/**
* 数据
*/
Data?: Array<PlanQRCodeRecord>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyTraceCodeUnlink请求参数结构体
*/
export interface ModifyTraceCodeUnlinkRequest {
/**
* 批次ID
*/
BatchId: string;
/**
* 溯源码列表
*/
Codes: Array<string>;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* DescribeCodePacks返回参数结构体
*/
export interface DescribeCodePacksResponse {
/**
* 码列表
*/
CodePacks?: Array<CodePack>;
/**
* 总数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCodesByPack请求参数结构体
*/
export interface DescribeCodesByPackRequest {
/**
* 码包ID
*/
PackId: string;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* DescribeJobFileUrl请求参数结构体
*/
export interface DescribeJobFileUrlRequest {
/**
* 调度ID
*/
JobId: number;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* CreateTraceCodesAsync返回参数结构体
*/
export interface CreateTraceCodesAsyncResponse {
/**
* 批次ID
*/
BatchId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePlanQRCodeScanRecords请求参数结构体
*/
export interface DescribePlanQRCodeScanRecordsRequest {
/**
* 开始时间
*/
StartTime: string;
/**
* 结束时间
*/
EndTime: string;
/**
* 页码
*/
PageNo: number;
/**
* 页大小
*/
PageSize: number;
}
/**
* 原始扫码日志
*/
export interface RawScanLog {
/**
* 日志ID
*/
LogId?: number;
/**
* 微信小程序openid
*/
Openid?: string;
/**
* 扫码时间
*/
CreateTime?: string;
/**
* 溯源码
*/
Code?: string;
/**
* 企业ID
*/
CorpId?: number;
/**
* 商户ID
*/
MerchantId?: string;
/**
* 商品ID
*/
ProductId?: string;
/**
* 批次ID
*/
BatchId?: string;
/**
* 省份
*/
Province?: string;
/**
* 地市
*/
City?: string;
/**
* 区/县
*/
District?: string;
}
/**
* DescribePlanQRCodes请求参数结构体
*/
export interface DescribePlanQRCodesRequest {
/**
* 计划ID
*/
PlanId: number;
/**
* 开始时间
*/
StartTime: string;
/**
* 结束时间
*/
EndTime: string;
/**
* 页码
*/
PageNo: number;
/**
* 页大小
*/
PageSize: number;
}
/**
* CreateChainBatch返回参数结构体
*/
export interface CreateChainBatchResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyCodeBatch请求参数结构体
*/
export interface ModifyCodeBatchRequest {
/**
* 批次ID
*/
BatchId: string;
/**
* 企业ID
*/
CorpId?: number;
/**
* 状态 0: 未激活 1: 已激活 -1: 已冻结
*/
Status?: number;
/**
* 模板ID,或者活动ID
*/
MpTpl?: string;
/**
* 商户ID
*/
MerchantId?: string;
/**
* 商品ID
*/
ProductId?: string;
/**
* 备注
*/
Remark?: string;
/**
* 批次编码,业务字段不判断唯一性
*/
BatchCode?: string;
/**
* 有效期
*/
ValidDate?: string;
/**
* 生产日期
*/
ProductionDate?: string;
}
/**
* DescribeProductById请求参数结构体
*/
export interface DescribeProductByIdRequest {
/**
* 商品ID
*/
ProductId: string;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* DescribeTraceCodes返回参数结构体
*/
export interface DescribeTraceCodesResponse {
/**
* 标识列表
*/
TraceCodes?: Array<TraceCode>;
/**
* 条数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 付费信息使用量
*/
export interface UsageQuota {
/**
* 企业ID
*/
CorpId?: number;
/**
* 商户配额
*/
FactoryCnt?: number;
/**
* 商品数量
*/
ItemCnt?: number;
/**
* 溯源码量
*/
TrackCnt?: number;
/**
* 营销码额度
*/
SaleCnt?: number;
/**
* 区块链上链次数
*/
ChainCnt?: number;
/**
* 风险检测次数
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
RiskCnt?: number;
/**
* 时间
*/
UpdateTime?: string;
}
/**
* CreateCorporationOrder请求参数结构体
*/
export interface CreateCorporationOrderRequest {
/**
* 企业名称
*/
CorpName: string;
/**
* 所有者ID
*/
Owner: string;
/**
* 溯源码额度
*/
CodeQuota: number;
/**
* 额度过期时间
*/
ExpireTime: string;
/**
* 金额
*/
Amount: number;
/**
* 企业ID
*/
CorpId?: number;
/**
* 联系人
*/
ContactPerson?: string;
/**
* 联系电话
*/
ContactNumber?: string;
/**
* 备注
*/
Remark?: string;
}
/**
* CreateTraceCodes返回参数结构体
*/
export interface CreateTraceCodesResponse {
/**
* 批次ID
*/
BatchId?: string;
/**
* 导入成功码数量
*/
ActiveCnt?: number;
/**
* 批次码数量
*/
CodeCnt?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteTraceData请求参数结构体
*/
export interface DeleteTraceDataRequest {
/**
* 溯源ID
*/
TraceId: string;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* DescribeScanLogs请求参数结构体
*/
export interface DescribeScanLogsRequest {
/**
* 企业ID
*/
CorpId?: number;
/**
* 分页数量
*/
PageSize?: number;
/**
* 当前分页
*/
PageNumber?: number;
/**
* 安心码
*/
Code?: string;
/**
* 小程序用户ID
*/
Openid?: string;
}
/**
* ModifyTraceCodeUnlink返回参数结构体
*/
export interface ModifyTraceCodeUnlinkResponse {
/**
* 成功解绑溯源码的数量
*/
UnlinkCnt?: number;
/**
* 当前批次的码数量
*/
CodeCnt?: number;
/**
* 批次ID
*/
BatchId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCodeBatches请求参数结构体
*/
export interface DescribeCodeBatchesRequest {
/**
* 查询商户ID
*/
MerchantId?: string;
/**
* 查询商品ID
*/
ProductId?: string;
/**
* 查询关键字
*/
Keyword?: string;
/**
* 条数
*/
PageSize?: number;
/**
* 页数
*/
PageNumber?: number;
/**
* 批次类型 0:溯源 1:营销
*/
BatchType?: string;
/**
* 企业ID
*/
CorpId?: number;
/**
* 批次状态 0: 未激活 1: 已激活 -1: 已冻结
*/
Status?: number;
}
/**
* 业务加密入参
*/
export interface InputEncryptData {
/**
* 加密方式,0:AES加密;
*/
EncryptMethod: number;
/**
* 加密算法中的块处理模式,1:CBC模式; 目前只支持CBC模式
*/
EncryptMode: number;
/**
* 填充模式,0:ZeroPadding;1:PKCS5Padding;2:
PKCS7Padding。
*/
PaddingType: number;
/**
* 加密数据,将AuthorizedData结构体数组(数组最大长度不超过20)序列化成JSON字符串,对得到的字符串加密并填充到该字段。
*/
EncryptData: string;
/**
* 用户是否授权,本接口取值:1,已授权。
*/
IsAuthorized?: number;
}
/**
* 商户信息
*/
export interface Merchant {
/**
* 商户标识码
*/
MerchantId?: string;
/**
* 企业id
*/
CorpId?: number;
/**
* 商户名称
*/
Name?: string;
/**
* 备注
*/
Remark?: string;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 更新时间
*/
UpdateTime?: string;
/**
* 商户码规则
*/
CodeRule?: string;
/**
* 码来源类型 0: 安心平台 1: 第三方码
*/
CodeType?: number;
/**
* 第三方码域名前缀
*/
CodeUrl?: string;
}
/**
* 商品信息
*/
export interface Product {
/**
* 商户标识码
*/
MerchantId: string;
/**
* 商品名称
*/
Name: string;
/**
* 商品id
*/
ProductId?: string;
/**
* 企业id
*/
CorpId?: number;
/**
* 商品编号
*/
ProductCode?: string;
/**
* 商品规格
*/
Specification?: string;
/**
* 备注
*/
Remark?: string;
/**
* 商品图片
*/
Logo?: Array<string>;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 修改时间
*/
UpdateTime?: string;
/**
* 预留字段
*/
Ext?: Ext;
/**
* 商户名称
*/
MerchantName?: string;
/**
* 认证状态
*/
CertState?: number;
}
/**
* DescribeTmpToken请求参数结构体
*/
export interface DescribeTmpTokenRequest {
/**
* 企业ID
*/
CorpId?: number;
}
/**
* 溯源码
*/
export interface TraceCode {
/**
* 二维码
*/
Code?: string;
/**
* 企业ID
*/
CorpId?: number;
/**
* 码包ID
*/
PackId?: string;
/**
* 批次ID
*/
BatchId?: string;
/**
* 所属商户ID
*/
MerchantId?: string;
/**
* 产品ID
*/
ProductId?: string;
/**
* 码状态 0: 冻结 1: 激活
*/
Status?: number;
/**
* 创建时间
*/
CreateTime?: string;
/**
* 修改时间
*/
UpdateTime?: string;
/**
* 商户名称
*/
MerchantName?: string;
/**
* 产品名称
*/
ProductName?: string;
/**
* 渠道商ID
*/
AgentId?: number;
/**
* 码层级 0: 最小级, 1: 一级, 2: 二级
*/
Level?: number;
/**
* 码层级详情
*/
PackSpec?: Array<PackSpec>;
/**
* 场景码
*/
SceneCode?: number;
/**
* 流水码
*/
SerialCode?: number;
}
/**
* DescribeScanStats返回参数结构体
*/
export interface DescribeScanStatsResponse {
/**
* 统计记录
*/
ScanStats?: Array<ScanStat>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateMerchant返回参数结构体
*/
export interface CreateMerchantResponse {
/**
* 商户标识码
*/
MerchantId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeMerchants返回参数结构体
*/
export interface DescribeMerchantsResponse {
/**
* 商户列表
*/
Merchants?: Array<Merchant>;
/**
* 总数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRawScanLogs返回参数结构体
*/
export interface DescribeRawScanLogsResponse {
/**
* 原始扫码日志
*/
ScanLogs?: Array<RawScanLog>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTraceDataList请求参数结构体
*/
export interface DescribeTraceDataListRequest {
/**
* 企业ID
*/
CorpId?: number;
/**
* 批次ID
*/
BatchId?: string;
/**
* 任务ID 用于外部溯源
*/
TaskId?: string;
/**
* 页数
*/
PageNumber?: number;
/**
* 溯源码
*/
Code?: string;
/**
* 溯源阶段 0:商品 1:通用 2:内部溯源 3:外部溯源
*/
Phase?: number;
/**
* 数量
*/
PageSize?: number;
}
/**
* 上链数据 key-value
*/
export interface ChainValue {
/**
* 标题名字
*/
Label: string;
/**
* 类型,文字:"text",图片:"image"
*/
Type: string;
/**
* 值,文字类型:"abc",图片类型:""/images/img.png"
*/
Value: string;
}
/**
* DeleteMerchant返回参数结构体
*/
export interface DeleteMerchantResponse {
/**
* 商户标识码
*/
MerchantId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCodeBatch返回参数结构体
*/
export interface DeleteCodeBatchResponse {
/**
* 批次ID
*/
BatchId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateTraceChain请求参数结构体
*/
export interface CreateTraceChainRequest {
/**
* 企业ID
*/
CorpId?: number;
/**
* 溯源ID
*/
TraceId?: string;
}
/**
* DescribeMerchantById请求参数结构体
*/
export interface DescribeMerchantByIdRequest {
/**
* 商户标识码
*/
MerchantId: string;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* DescribeTraceDataById请求参数结构体
*/
export interface DescribeTraceDataByIdRequest {
/**
* 溯源ID
*/
Id: string;
/**
* 企业ID
*/
CorpId?: number;
}
/**
* DescribeProductById返回参数结构体
*/
export interface DescribeProductByIdResponse {
/**
* 商品信息
*/
Product?: Product;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCodePacks请求参数结构体
*/
export interface DescribeCodePacksRequest {
/**
* 每页数量
*/
PageSize?: number;
/**
* 页数
*/
PageNumber?: number;
/**
* 查询关键字
*/
Keyword?: string;
/**
* 企业ID
*/
CorpId?: number;
/**
* 是否有流水码 0:无 1:有
*/
SerialType?: number;
/**
* 资源类型 batch:批次, order_in 入库, order_out: 出入
*/
ResType?: string;
/**
* 资源ID ResType是 batch 时对应是批次ID, 是 order_in, order_out时,则是订单ID
*/
ResId?: string;
/**
* 应用场景
*/
SceneCode?: number;
/**
* 码包状态
*/
Status?: string;
}
/**
* DescribeJobFileUrl返回参数结构体
*/
export interface DescribeJobFileUrlResponse {
/**
* 码包地址
*/
Url?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCustomRules返回参数结构体
*/
export interface DescribeCustomRulesResponse {
/**
* 码规则列表
*/
CustomRules?: Array<CustomRule>;
/**
* 总数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTraceCodeById请求参数结构体
*/
export interface DescribeTraceCodeByIdRequest {
/**
* 企业ID
*/
CorpId?: number;
/**
* 二维码
*/
Code?: string;
}
/**
* ModifyCodeBatch返回参数结构体
*/
export interface ModifyCodeBatchResponse {
/**
* 批次ID
*/
BatchId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 安心计划二维码扫码记录
*/
export interface PlanQRCodeRecord {
/**
* 二维码
*/
Url: string;
/**
* OpenID
*/
OpenId: string;
/**
* 扫码时间
*/
ScanTime: st