API 文档

Appearance

创建货源 ​

请求地址 ​

https://www.xxyb.cn/union/api/wlpt/consignor/createGoods

参数名必选类型说明
Token是string应用令牌
cid是string合作ID
corpId是string企业ID

请求参数 ​

参数名必选类型层级说明备注
basic是object1货源基础信息
bodyId是string2承运平台
goodsCode否string2客户货源单号
isInvoice是enum2是否开票如无特殊需求，请选择SPECIAL_INVOICE 见下方是否开票代码
line是object1线路信息
sendProvince是string2发货省
sendCity是string2发货市
sendCity是string2发货市
sendArea是string2发货区
sendAddress是string2发货详细地址
sendAddressRemark否string2发货详细地址备注
sendLon是decimal2发货经度
sendLat是decimal2发货纬度
sendPerson否string2发货联系人
sendPhone是string2发货联系手机号^((1[3-9]\d{9})
sendPlanTime否date2计划发货时间
deliveryProvince是string2收货省
deliveryCity是string2收货市
deliveryArea是string2收货区
deliveryAddress是string2收货详细地址
deliveryAddressRemark否string2收货详细地址备注
deliveryLon是decimal2收货经度
deliveryLat是decimal2收货纬度
deliveryPerson否string2收货联系人
deliveryPhone是string2收货联系手机号
deliveryPlanTime否date2计划收货时间
goods是object1货物信息
goodsType是string2货物类型
goodsPrice是decimal2货值货值必须大于0
goodsName是string2货物名称
goodsWeight是decimal2货物重量货物重量必须大于0
goodsNumber否decimal2货物数量货物数量,按方必填
settlement否object1结算信息
settlementMethod是enum2结算吨重见下方 结算吨重代码
feeUnit是decimal2运输单价运输单价必需要大于0
reasonableLosses否decimal2合理亏损,自动亏损必填非必填,如果传了必须大于0
reasonableMethod否enum2合理亏损计算方式 按自动亏损计算运费必填见下方 合理亏损计算方式代码
goodsUnitPrice否decimal2货物单价,自动亏损必填非必填,如果传了必须大于0
detailMethod是string2计价单位按车结算：车 按重量结算：吨
customFeeList否array2自定义费用
feeType是enum3费用类型见下方 费用类型代码
customName是string3自定义费用名称
customUnit是decimal3自定义单价自定义单价不能小于0
customMethod否enum3自定义费用计价方式见下方 合理亏损计算方式代码
detailTotalAmount否decimal3自定义费用总额
require是object1发货要求
carTotal是int2所需车辆
carReq是enum2车辆要求见下方 车辆要求代码
carType否array2车型
carLength否array2车长
protect否array2防护要求
otherAsk否string2其他要求
linkPerson否string2联系人
linkPhone否string2联系电话
insureType否enum2投保类型见下方 保险购买方代码
insuranceId否string2保险产品id
coverage否decimal2保额
insuranceFee否decimal2保险费用
insured否string2被投保人
insuredCardType否enum2被投保人证件类型见下方 被投保人证件类型代码
insuredCardNumber否string2被投保人证件号码
insuredPhone否string2被投保人电话
liquidatedDamages否decimal2违约金
sourceInfoFee否decimal2货源信息费
scopeType是enum2范围类型见下方 下线时限类型代码
publishScopes是array2发布范围见下方 发布范围代码
encryptionCode否string2加密码
offlineScope否decimal2下线时限
offlineType否enum2下线时限类型见下方 下线时限类型代码
offlineDatetime否date2下线时间

入参示例 ​

json
{
  "basic": {
    "bodyId": "CARRIER123",
    "goodsCode": "G123456789",
    "isInvoice": "SPECIAL_INVOICE"
  },
  "line": {
    "sendProvince": "北京市",
    "sendCity": "北京市",
    "sendArea": "海淀区",
    "sendAddress": "北京市海淀区中关村大街1号",
    "sendAddressRemark": "近地铁站",
    "sendLon": 116.3182,
    "sendLat": 39.9978,
    "sendPerson": "张三",
    "sendPhone": "13800138000",
    "sendPlanTime": "2023-10-01",
    "deliveryProvince": "上海市",
    "deliveryCity": "上海市",
    "deliveryArea": "浦东新区",
    "deliveryAddress": "上海市浦东新区世纪大道100号",
    "deliveryAddressRemark": "近地铁站",
    "deliveryLon": 121.4737,
    "deliveryLat": 31.2304,
    "deliveryPerson": "李四",
    "deliveryPhone": "13900139000",
    "deliveryPlanTime": "2023-10-10"
  },
  "goods": {
    "goodsType": "大宗",
    "goodsPrice": 10000.00,
    "goodsName": "煤炭",
    "goodsWeight": 100.00,
    "goodsNumber": 5.00
  },
  "settlement": {
    "settlementMethod": "DELIVERY",
    "feeUnit": 100.00,
    "reasonableLosses": 50.00,
    "reasonableMethod": "TON",
    "goodsUnitPrice": 200.00,
    "detailMethod": "吨",
    "customFeeList": [
      {
        "feeType": "FREIGHT_CUSTOM",
        "customName": "预付",
        "customUnit": 100.00,
        "customMethod": "TON",
        "detailTotalAmount": 1000.00,
        "augmentAmount": 50.00,
        "deductionAmount": 20.00,
        "augmentDeductionReason": "额外费用"
      }
    ]
  },
  "require": {
    "carTotal": 1,
    "carReq": "YES",
    "carType": [
      "HEAVY_SEMI_TRAILER"
    ],
    "carLength": [
      "12.5"
    ],
    "protect": [
      "保温"
    ],
    "otherAsk": "请确保货物安全",
    "linkPerson": "王五",
    "linkPhone": "13700137000",
    "insureType": "OWNER",
    "insuranceId": "INS123456789",
    "coverage": 50000.00,
    "insuranceFee": 500.00,
    "insured": "张三",
    "insuredCardType": "IDENTITY_CARD",
    "insuredCardNumber": "11010519900101001X",
    "insuredPhone": "13800138000",
    "liquidatedDamages": 2000.00,
    "sourceInfoFee": 100.00,
    "scopeType": "PUBLIC",
    "publishScopes": [
      "CAR_BOSS",
      "DRIVER"
    ],
    "encryptionCode": "abc123",
    "offlineScope": 7,
    "offlineType": "DAY",
    "offlineDatetime": "2023-10-15"
  }
}

返回参数 ​

参数名类型层级说明
codeint1状态码
msgstring1请求结果
totalint1返回总条数
requestIdstring1请求编号
dataobject1返回数据
idstring2业务数据ID
goodsCodestring2货源编号
encryptionCodestring2货源加密码

反参示例 ​

json
{
  "code": 200,
  "data": {
    "id": "1312321321321321",
    "goodsCode": "3213213213213123",
    "encryptionCode": "123456"
  },
  "msg": "业务处理成功",
  "total": null,
  "requestId": "1eb7cb0e"
}

是否开票代码（IsInvoiceEnum）：

| NO_INVOICING | 不开票 | | SPECIAL_INVOICE | 增值税专用发票 | | ORDINARY_INVOICE| 增值税普通发票 |

结算吨重代码（SettlementMethodEnum）：

NameMessage
SEND发货吨重
DELIVERY收货吨重
AUTO自动亏损

合理亏损计算方式代码（DetailMethodEnum）：

NameMessage
TON吨
VOLUME方
VEHICLE车
BILL单
PROPORTION比例
WEIGHT重量

费用类型代码（FeeTypeEnum）：

NameMessage
FREIGHT现金运费
SERVICE_FEE服务费
COMMISSION_FEE佣金
OIL_FEE_ONLINE线上油卡
OIL_FEE_OFFLINE线下油卡
RECEIPT_DEPOSIT_SERVICE回单押金-交押金
RECEIPT_DEPOSIT_TRANSPORT回单押金-回单付
CREATE_BILL_FEE建单费
LOCATION_FEE定位费
INFO_FEE信息费
FREIGHT_CUSTOM自定义运费

保险购买方代码（InsureBuyerEnum）：

NameMessage
OWNER货主
DRIVER司机

被投保人证件类型代码（CardTypeEnum）：

NameMessage
IDENTITY_CARD身份证
BUSINESS_LICENSE营业执照

车辆要求代码（YesOrNoEnum）：

NameMessage
YES是
NO否

发布范围代码（PublishScopeEnum）：

NameMessage
CAR_BOSS车队长
AGENT经纪人
DRIVER司机
CAPTAIN船长

发布范围类型代码（ScopeTypeEnum）：

NameMessage
PARTIALLY部分可见
PUBLIC公开所有
ENCRYPTION加密

下线时限类型代码（TimeUnitEnum）：

NameMessage
SECOND秒
MINUTE分钟
HOUR小时
DAY天
MONTH月
YEAR年