参半对外接口文档

上海中商网络股份有限公司版权所有

参半-对外接口

目录

流向查询

请求信息

协议

HTTPS

请求方法

GET

请求路径

/trace/app/v1/open/info/flow/code

请求头

Content-Type：application/json

请求参数

名称

是否必须

参数类型

参数说明
code

是

string

 数码
direction 否

int

查询方向：0-当前数码，1-当前数码的下级数码；默认0

传出参数

名称

参数类型

参数说明

code

int

错误码，200：成功，其它为失败

message

string

 

data

object

返回信息

├─ digits

object []

 数码信息

code

string

 数码

     level

int

 数码层级

parent

string

父级码

unit

string

数码单位

productId

 string 商品id

productNo

string

商品编号

productName

string

 商品名称

productStandard

 string

商品规格

productModel

string

 商品型号
code1Quantity

int

单品数量

batchNo

 string 批次

organizationNo

 string 生产组织编号

organizationName

 string 生产组织名称

├─ details

object []

 流向信息

receiptId

 string 订单id

receiptNo

 string 单号

receiptType

 string 订单类型

receiptTypeName

 string 订单类型描述

receiptSource

 string 订单来源

receiptSourceName

 string 订单来源描述

senderId

 string 发货方id

senderCode

 string 发货方编号

senderName

 string 发货方名称

senderTypeId

 string 发货方类型

senderTypeName

 string 发货方类型描述

receiverId

 string 收货方id

receiverCode

 string 收货方编号

receiverName

 string 收货方名称

receiverTypeId

 string 收货方类型

receiverTypeName

 string 收货方类型描述

completeTime

 string 流转时间

receiptCode1Quantity

 string 单品数量

 

请求示例

https://open-fat.yesno.com.cn/trace/app/v1/open/info/flow/code?code=190472795958362362

响应示例

{
    "code": 200,
    "message": "success",
    "data": {
        "digits": [
            {
                "code": "091901069428",
                "level": 1,
                "parent": "09190152917316",
                "unit": "个",
                "productId": "ebc213e4fdf54be7b098c82652c5a767",
                "productNo": "520LC",
                "productName": "520测试商品",
                "productStandard": "",
                "productModel": "",
                "code1Quantity": 1,
                "batchNo": "1234"
            }
        ],
        "details": [
            {
                "receiptId": "1924756706724155392",
                "receiptNo": "RK2505200047",
                "receiptType": "131136",
                "receiptTypeName": "生产入库",
                "receiptSource": 1,
                "receiptSourceName": "客户新建",
                "senderId": "2",
                "senderCode": "gc",
                "senderName": "工厂",
                "senderTypeId": 11,
                "senderTypeName": "工厂",
                "receiverId": "4",
                "receiverCode": "YAMING-WDT",
                "receiverName": "上海仓",
                "receiverTypeId": 14,
                "receiverTypeName": "仓库",
                "completeTime": "2025-05-20T09:18:54.017Z",
                "receiptCode1Quantity": 1
            }
        ]
    },
    "timestamp": 1769060123004,
    "traceId": "",
    "exception": null,
    "meta": null,
    "ext": null
}

异常示例

{
    "code": 21050025,
    "message": "当前数码无法正常解析出结果，请检查所录数码是否正确",
    "data": null,
    "timestamp": 1769138423026,
    "traceId": "4f685a72-7aa4-4a8f-813a-80df0e70938f",
    "exception": null,
    "meta": null,
    "ext": null
}

 

添加用户

请求信息

协议

HTTPS

请求方法

 POST

请求路径

 /trace/app/v1/open/ram/user/add-user

请求头

Content-Type：application/json

x-request-lang：zh-CN

请求参数

名称

是否必须

参数类型

参数说明
org

是

object

 所属组织
code 是 string

组织结构编号
typeId 是 int

组织结构类型，见组织类型
lsAffiliatedOrg 否

object

 附属组织
code 是 string

组织结构编号
typeId 是 int

组织结构类型，见组织类型
userName 是 string

登录账号
petName 是 string

用户名
mobile 否 string

手机号
mail 否 string

邮箱
remark 否 string

备注

传出参数

名称

参数类型

参数说明

code

int

错误码，200：成功，其它为失败

message

string

 

data

 string

用户id

请求示例

{
    "org": {
        "code": "A123",
        "typeId": 18
    },
    "lsAffiliatedOrg": [{
        "code": "CK002",
        "typeId": 14
    }],
    "userName": "cb_user",
    "petName": "参半用户",
    "mobile": "",
    "mail": "",
    "remark": ""
}

响应示例

{
    "code": 200,
    "message": "success",
    "data": "2014539540685398016",
    "timestamp": 1769138629665,
    "traceId": "51e55cfa-b7f8-4cf3-bfda-0cc1f61e42ab",
    "exception": null,
    "meta": null,
    "ext": null
}

异常示例

{
    "code": 20253023,
    "message": "用户名已存在",
    "data": null,
    "timestamp": 1769139836123,
    "traceId": "6d8cb252-da78-487d-9b28-ab92f85e3175",
    "exception": "用户名已存在",
    "meta": null,
    "ext": null
}

 

修改用户

请求信息

协议

HTTPS

请求方法

 POST

请求路径

 /trace/app/v1/open/ram/user/update-user

请求头

Content-Type：application/json

x-request-lang：zh-CN

请求参数

名称

是否必须

参数类型

参数说明
org

是

object

 所属组织
code 是 string

组织结构编号
typeId 是 int

组织结构类型，见组织类型
lsAffiliatedOrg 否

object

 附属组织
code 是 string

组织结构编号
typeId 是 int

组织结构类型，见组织类型
userName 是 string

登录账号
petName 是 string

用户名
mobile 否 string

手机号
mail 否 string

邮箱
remark 否 string

备注
userId 是 string

用户id

传出参数

名称

参数类型

参数说明

code

int

错误码，200：成功，其它为失败

message

string

 

data

 string  

请求示例

{
    "org": {
        "code": "A123",
        "typeId": 18
    },
    "lsAffiliatedOrg": [{
        "code": "CK002",
        "typeId": 14
    }],
    "userName": "cb_user",
    "petName": "参半用户",
    "mobile": "",
    "mail": "",
    "remark": "",
    "userId":"2014531856600342528"
}

响应示例

{
    "code": 200,
    "message": "success",
    "data": null,
    "timestamp": 1769136863804,
    "traceId": "21b284a1-f3d3-4e44-93d0-6ad595e3a24b",
    "exception": null,
    "meta": null,
    "ext": null
}

异常示例

 

启用用户

请求信息

协议

HTTPS

请求方法

 POST

请求路径

 /trace/app/v1/open/ram/user/enable-user

请求头

Content-Type：application/json

x-request-lang：zh-CN

请求参数

名称

是否必须

参数类型

参数说明
lsUserId

是

object[]

 用户id
  是 string

用户id

传出参数

名称

参数类型

参数说明

code

int

错误码，200：成功，其它为失败

message

string

 

data

 string  

请求示例

{"lsUserId":["2014531856600342528"]}

响应示例

{
    "code": 200,
    "message": "success",
    "data": null,
    "timestamp": 1769136863804,
    "traceId": "21b284a1-f3d3-4e44-93d0-6ad595e3a24b",
    "exception": null,
    "meta": null,
    "ext": null
}

异常示例

 

禁用用户

请求信息

协议

HTTPS

请求方法

 POST

请求路径

 /trace/app/v1/open/ram/user/disable-user

请求头

Content-Type：application/json

x-request-lang：zh-CN

请求参数

名称

是否必须

参数类型

参数说明
lsUserId

是

object[]

 用户id
  是 string

用户id

传出参数

名称

参数类型

参数说明

code

int

错误码，200：成功，其它为失败

message

string

 

data

 string  

请求示例

{"lsUserId":["2014531856600342528"]}

响应示例

{
    "code": 200,
    "message": "success",
    "data": null,
    "timestamp": 1769136863804,
    "traceId": "21b284a1-f3d3-4e44-93d0-6ad595e3a24b",
    "exception": null,
    "meta": null,
    "ext": null
}

异常示例

weizejun 2026年1月28日 14:18 收藏文档