工单 (交易接口)

创建工单

创建工单

请求

接口路径：v1/workorder
请求方法：POST
请求头内容：
- Content-Type: application/json
请求Body内容

{
    "businessCode": "TRUST_ACCEPT",
    "refNo": "客户唯一单号",
    "form": {
      "data": {
        "additionalInfo": "客户查询单号,如 SO001,SO002,SO003",
        "customerName": "固定值， 在客户管理中配置",
        "trustName": "委托人",
        "lclFlag": "拼柜类型，固定 0",
        "businessTypeId": "订单类型(进口: 02, 出口： 01)",
        "iePort": "进出关别，4位编码或名称，如（蛇口海关或5304）",
        "transitDate": "任务日期，格式yyyyMMdd",
        "tradeCode": "10位收发货人代码",
        "tradeScc": "18位收发货人信用代码",
        "tradeCiqCode": "10位收发货人商检代码",
        "tradeName": "收发货人名称",
        "remark": "备注",
        "attachmentList":  {
          "attachments": [
            {
              "name": "文件名.pdf",
              "customsCode": "00000001",
              "content": "base64encoded-text"
            }
          ]
        }
      }
    }
}

当中 form.data 中的字段是根据工单业务类型（businessCode）的表单配置，具体配置请联系您的客户经理。

属性	类型	是否必填	说明
businessCode	String	必填	业务类型，如：TRUST_ACCEPT
refNo	String(36)	必填	客户唯一单号，后续回执会返回该值
additionalInfo	String(200)	非必填	委托单号，供客户订单或报关单查询使用
customerName	String(100)	必填	客户名称在客户管理中配置
trustName	String(100)	非必填	委托人
lclFlag	String(1)	必填	拼柜类型，整柜(0),拼柜(2)
businessTypeId	String(2)	必填	订单类型，出口(01),进口(02)
iePort	String(10)	非必填	进出关别，4位编码或名称，如（蛇口海关或5304）
transitDate	String(8)	非必填	任务日期，格式yyyyMMdd
tradeCode	String(10)	非必填	10位收发货人代码
tradeScc	String(18)	非必填	18位收发货人信用代码
tradeCiqCode	String(10)	非必填	10位收发货人商检代码
tradeName	String(100)	非必填	收发货人名称
remark	String(300)	非必填	备注
attachmentList/attachments/name	String(100)	必填	附件文件名,含后缀
attachmentList/attachments/customsCode	String(15)	非必填	附件类型：合同(00000004)，箱单(00000002)，发票(00000001)，提运单(00000003)
attachmentList/attachments/content	ByteArray	必填	附件内容（以base64编码）,单个附件不能大于4M

响应

HTTP状态: 200 代表调用成功
响应正文：

{
    "success": true,
    "message": "调用成功",
    "result": {
      "workOrderNo": "202207290004",
      "forms": [
        {
          "formType": "trust",
          "formId": "134"
        }
      ]
    },
    "error": null
}

{
    "success": false,
    "message": "存在相同refNo",
    "result": null,
    "error": null
}

属性	类型	说明
success	Boolean	创建是否成功 true成功 false 失败
message	String	创建失败返回错误消息
result/workOrderNo	String	返回唯一工单号,后续如果修改需要提供该工单号
result/forms/formType	String	返回平台业务单类型, 客户订单固定为 trust
result/forms/formId	String	返回平台业务单类型对应的业务单号
error	String

示例

curl -X POST http://cheetah.test.yunbaoguan.cn/api/openapi/v1/workorder \
  -H 'Authorization: ACCESS_KEY 4a9d1eb7-eee0-434b-9d36-38bbc68a2dce' \
  -H 'Content-TYpe: application/json' \
  --data '{"businessCode":"TRUST_ACCEPT","refNo":"2022093112334","form":{"data":{"additionalInfo":"KG0091,AG9875,OK9875","customerName":"物流","trustName":"红花会陈家洛","lclFlag":"0","businessTypeId":"01","iePort":"蛇口海关","transitDate":"20220815","tradeCode":"4403961C9H","tradeScc":"91440300MA5F650U1Q","tradeCiqCode":"4777207124","tradeName":"深圳歪猫网络科技有限公司","remark":"通关一体化","attachmentList":{"attachments":[{"name":"导入模板.docx","content":"SGVsbG9Xb3JsZAo="}}}}'