# 接口字段定义
# 一，基础字段
# 1，系统字段
# 1.1 返回
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| code | 错误码 | int | 20 | 返回错误码标准表 |
| result | 是否正常返回 | boolean | 1 | |
| message | 返回信息 | string | 200 | |
| data | 返回数据 | object | 接口数据返回 | |
| requestId | 请求Id | string | 48 | 标记请求，用于日志查询错误 |
# 1.2 分页
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| pageNum | 当前页数 | int | 20 | |
| pageSize | 每页返回多少条 | int | 20 | |
| total | 总条数 | int | 20 | |
| list | list |
# 2，公共字段
# 2.1 地区
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| areaId | 区域id | string | 200 | |
| areaEn | 区域名称 | string | 200 | |
| countryCode | 国家代码 | string | 200 |
# 2.2 人员
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| creater | 创建人 | string | 200 | |
| createTime | 创建时间 | string | 200 | |
| updater | 修改人 | string | 200 | |
| updateTime | 修改时间 | string | 200 |
# 2.3 其他
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| sourceFrom | 来源 | byte | 4 | |
| remark | 备注 | string | 200 |
# 二，业务字段
# 1，鉴权相关字段
# 1.1 授权
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| 邮箱 | string | 200 | ||
| password | 密码 | string | 200 |
# 1.2 Token
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| accessToken | Access Token | string | 200 | |
| accessTokenExpiryDate | Access Token 过期时间 | string | 200 | 默认时间 7 天 |
| refreshToken | Refresh Token | string | 200 | |
| refreshTokenExpiryDate | Refresh Token 过期时间 | string | 200 | 默认时间 180 天 |
# 2，设置相关字段
# 2.1 账户
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| openId | 账户 ID | string | 200 | |
| openName | 账户名称 | string | 200 | |
| openEmail | 账户邮箱 | string | 200 | |
| root | 账户权限 | string | 200 | 权限：NO_PERMISSION - 无权限 |
| GENERAL - 普通用户 | ||||
| VIP - VIP 用户 | ||||
| ADMIN - 管理员 | ||||
| isSandbox | 是否沙箱账户 | byte | 4 |
# 2.2 API 相关设置
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| setting | 设置 | list | 200 | |
| quotaLimits | API 限额 | list | 一些特殊的接口有访问限额 | |
| quotaUrl | 限制的 URL | string | 200 | |
| quotaLimit | 限额 | int | 20 | |
| quotaType | 限额控制类型 | byte | 4 | 0-总次数，1-每年，2-每季，3-每月，4-每天，5-每小时 |
| qpsLimit | QPS 限制 | int | 20 | 账户每秒请求限额 |
# 3，商品相关字段
# 3.1 商品
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| pid | 商品id | string | 200 | |
| productName | 商品名称 | list | 20 | |
| productNameEn | 商品名称（英文） | string | 200 | |
| productSku | 商品SKU | string | 200 | |
| productImage | 商品图像 | string | 200 | |
| productWeight | 商品重量 | int | 200 | 单位: g |
| productType | 商品类型 | byte | 200 | |
| productUnit | 商品单位 | string | 48 | |
| categoryId | 商品种类 | string | 200 | |
| categoryName | 商品名称 | string | 200 | |
| entryCode | 海关代码 | string | 200 | |
| entryName | 海关名称 | string | 200 | |
| entryNameEn | 海关名称（英文） | string | 200 | |
| materialName | 材料名称 | string | 200 | |
| materialNameEn | 材料名称（英文） | string | 200 | |
| materialKey | 材料属性 | string | 200 | |
| packWeight | 包装重量 | int | 200 | 单位: g |
| packingName | 包装名称 | string | 200 | |
| packingNameEn | 包装名称（英文） | string | 200 | |
| packingKey | 包装属性 | string | 200 | |
| isActive | 是否已激活 | boolean | 1 | |
| description | 描述 | string | 200 |
商品类型
| 商品类型 | 类型意义 |
|---|---|
| ORDINARY_PRODUCT | 普通商品 |
| SERVICE_PRODUCT | 服务商品 |
| PACKAGING_PRODUCT | 包装商品 |
| SUPPLIER_PRODUCT | 供应商商品 |
| SUPPLIER_SHIPPED_PRODUCT | 供应商自发货商品 |
# 3.2 变体
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| vid | 变体id | string | 200 | |
| variantName | 变体名称 | string | 200 | |
| variantNameEn | 变体名称（英文） | string | 200 | |
| variantSku | 变体SKU | string | 200 | |
| variantNum | 变体重量 | int | 200 | 单位: g |
| variantUnit | 变体单位 | string | 200 | |
| variantProperty | 变体类型 | string | 200 | |
| variantKey | 变体关键字 | string | 200 | |
| variantLength | 变体长度 | string | 200 | 单位: cm |
| variantWidth | 变体宽度 | string | 200 | 单位: cm |
| variantHeight | 变体高度 | string | 200 | 单位: cm |
| variantVolume | 变体体积 | int | 200 | 单位: cm3 |
| variantWeight | 变体重量 | int | 200 | 单位: g |
| variantSellPrice | 变体售价 | BigDecimal | （18，2） | 单位：$（美元） |
# 3.3 供应商
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|
# 3.4 库存
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| storageNum | 库存总数 | int | 20 | |
| queryTime | 库存刷新时间 | string | 200 |
# 4，库存相关字段
# 4.1 仓库
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| storageId | 仓库id | string | 200 | |
| storageName | 仓库名称 | string | 200 |
# 5，交易相关字段
# 5.1 订单
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| orderId | 订单id | string | 200 | |
| orderWeight | order weight | string | 200 | |
| orderAmount | order amount | string | 200 | |
| orderStatus | order status | string | 200 |
订单状态
| 订单状态 | 状态 |
|---|---|
| CREATED | 创建订单 |
| IN_CART | 加入购物车 |
| UNPAID | 未支付 |
| UNSHIPPED | 未发货 |
| SHIPPED | 发货 |
| DELIVERED | 已完成 |
| CANCELLED | 取消 |
# 5.2 金额
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| noWithdrawalAmount | 充值奖励金额 | BigDecimal | （18，2） | 单位：$（美元） |
| freezeAmount | 冻结金额 | BigDecimal | （18，2） | 单位：$（美元） |
| amount | 余额 | BigDecimal | （18，2） | 单位：$（美元） |
备注：
- 1，BigDecimal（18，2）长度 20，保留 2位小数
- 2，CJ 系统国际货币单位为：美元（$）
# 5.3 交易
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| shippingCountryCode | 交易国家简码 | string | 200 | |
| shippingCountry | 交易国家 | string | 200 | |
| shippingProvince | 交易省 | string | 200 | |
| shippingCity | 交易城市 | string | 200 | |
| shippingAddress | 交易地址 | string | 200 | |
| shippingZip | 交易邮编 | string | 200 | |
| shippingPhone | 交易电话 | string | 200 |
# 6，物流相关字段
# 6.1 物流
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| logisticPrice | 物流费用 | BigDecimal | （18，2） | 单位：$（美元） |
| logisticPriceCn | 物流费用 | BigDecimal | （18，2） | 单位：¥（人民币） |
| logisticAging | 物流时间 | string | 20 | |
| logisticName | 物流名称 | string | 20 |
# 6.2 追踪单
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| deliveryDay | 交付天数 | string | 200 | |
| deliveryTime | 交付时间 | string | 200 | |
| trackingNumber | 追踪单号 | string | 200 | |
| trackingFrom | 起始地 | string | 20 | |
| trackingTo | 目的地 | string | 20 | |
| trackingStatus | 追踪单状态 | string | 200 |
# 7，消息相关字段
# 7.1 商品消息
| 字段 | 字段意思 | 字段类型 | 长度 | 备注 |
|---|---|---|---|---|
| productType | 商品回调类型 | string | 20 | 商品回调类型 |
| productCallbackUrls | 商品回调接口 | list | 20 | 支持多个 |