海管家海外舱单对接文档

# 发送接口

AFR发送主要接口

注意

此接口支持一单多箱数据

# 请求地址


POST https://beta-callback.hgj.com/ingress-ng/afr/openapi/bill/send
Content-Type: application/json
Access-Token: f6645125abaa4e0ab12d1b638843ff5b
Timestamp: 1592364092493
Nonce: 1592364092493
Sign: d72bfe24c25f0d19dc8e8df81b10798e
Staff: 18036094790

{
  "shipCompany": "IAL—运达",// 被 scac 代替，但仍然可用，未来会移除
  "scac": "12AT",
  "billNo": "MASTER",
  "vessel": "A.BEDEVI|4LK02|GE-佐治亚州",
  "vesselCode": "A.BEDEVI|4LK02|GE",
  "voyageNo": "HFGHG",
  "portOfLoading": "SHANGRI-LA OK|USNRI",
  "departureDate": "2020-09-18 00:00:00",
  "portOfDischarge": "AOMORI - AOMORI|JPAOM",
  "arrivalDate": "2021-01-14",
  "placeOfDelivery": "AABENRAA|DKAAB",
  "manifestSubs": [
    {
      "billNo": "SUBBILLNO", 
      "shipperName": "GNFJKH",
      "shipperAddress": "HGJHBDITR",
      "shipperCountry": "CN",
      "shipperTel": "12564599",
      "consigneeName": "GHJKFTUHG",
      "consigneeAddress": "GJIRHNHKJEOW",
      "consigneeTel": "234356567",
      "consigneeCountry": "JP",
      "notifierName": "JHKFHIJ",
      "notifierAddress": "GHGHGHGHGHGHGHKI",
      "notifierTel": "57434767889999",
      "notifierCountry": "JP",
      "draftContainers": [
        {
          "containerNo": "NCFDVGSFDFR",
          "sealNo": "GDNBNF",
          "containerTypeSize": "22T0",
          "supplierCode": "COC",
          "hsCode": "234565",
          "cargoDescription": "HFDGHB",
          "markNumbers": "GFFHJ",
          "packages": 1,
          "packageUnit": "BN",
          "weight": 1,
          "volume": 1,
          "imdgCode": null,
          "undgNumber": null,
          "imdgCode2": null,
          "undgNumber2": null,
          "imdgCode3": null,
          "undgNumber3": null,
          "imdgCode4": null,
          "undgNumber4": null,
          "imdgCode5": null,
          "undgNumber5": null
        }
      ]
    }
  ]
}

# 请求参数说明

API接口会对参数进行校验, 用户系统可以提前对调用参数进行校验, 防止被API接口校验拦截.

属性 类型 必填 说明 校验规则
shipCompany string 否 船公司 参考船公司，被 scac 代替，仍然可用，未来会移除
scac string 是 船公司scac 参考船公司
billNo string 是 主提单号 只能大写字母和数字,不能超过16个字符;不包含船公司4位SCAC CODE
vessel string 是 船名 参考船名列表
voyageNo string 是 航次 只能大写字母,数字和-,不能超过10个字符
portOfLoading string 是 装货港 参考装货港列表
departureDate string 是 预计出发日期 格数：2020-09-18 00:00:00
portOfDischarge string 是 卸货港 参考卸货港列表
arrivalDate string 是 预计到达日期 格式：2021-01-14,预计到达时间必须晚于今天，并且晚于预计出发时间
placeOfDelivery string 是 交货地 参考交货地列表
manifestSubs string 是 分单信息
billNo string 是 分提单号 只能大写字母,数字和-,不能超过16个字符
shipperName string 是 发货人名称 输入不能有中文,小写字母,全角字符,不能超过70个字符
shipperAddress string 是 发货人地址 输入不能有中文,小写字母,全角字符,不能超过140个字符
shipperCountry string 是 发货人国家代码 参考国家代码列表
shipperTel string 是 发货人联系电话 只包含数字和-
consigneeName string 是 收货人名称 输入不能有中文,小写字母,全角字符,不能超过70个字符
consigneeAddress string 是 收货人地址 输入不能有中文,小写字母,全角字符,不能超过140个字符
consigneeTel string 是 收货人联系电话 只包含数字和-,不能超过14个字符
consigneeCountry string 是 收货人国家代码 参考国家代码列表
notifierName string 是 通知人名称 输入不能有中文,小写字母,全角字符,不能超过70个字符
notifierAddress string 是 通知人地址 输入不能有中文,小写字母,全角字符,不能超过140个字符
notifierTel string 是 通知人联系电话 只包含数字和-,不能超过14个字符,不能超过14个字符
notifierCountry string 是 通知人国家代码 参考国家代码列表
draftContainers string 是 集装箱信息
containerNo string 是 箱号 只能大写字符和数字,不能超过11个字符
sealNo string 是 封号 只能大写字符和数字,不能超过15个字符
containerTypeSize string 是 箱型 参考箱型和包装单位列表
supplierCode string 是 货主箱标记 COC/SOC
hsCode string 是 HS code 6位数字
cargoDescription string 是 品名 非中文字符,如有多种货物,请用英文逗号分隔;不能超过350个字符
markNumbers string 是 唛头 非中文字符,不能超过140个字符
packages number 是 件数 1-99999999的整数
packageUnit string 是 包装单位 参考箱型和包装单位列表
weight number 是 毛重 毛重整数部分不超过6位，小数不超过3位
volume number 是 体积 体积整数部分不超过6位，小数不超过3位
imdgCode string 否 危险品类型 范围:1-9.9,危险品编号与危险品类型必须同时填写
undgNumber string 否 危险品编号 范围:1001-9999,危险品编号与危险品类型必须同时填写
imdgCode2 string 否 危险品类型2 范围:1-9.9,危险品编号与危险品类型必须同时填写
undgNumber2 string 否 危险品编号2 范围:1001-9999,危险品编号与危险品类型必须同时填写
imdgCode3 string 否 危险品类型3 范围:1-9.9,危险品编号与危险品类型必须同时填写
undgNumber3 string 否 危险品编号3 范围:1001-9999,危险品编号与危险品类型必须同时填写
imdgCode4 string 否 危险品类型4 范围:1-9.9,危险品编号与危险品类型必须同时填写
undgNumber4 string 否 危险品编号4 范围:1001-9999,危险品编号与危险品类型必须同时填写
imdgCode5 string 否 危险品类型5 范围:1-9.9,危险品编号与危险品类型必须同时填写
undgNumber5 string 否 危险品编号5 范围:1001-9999,危险品编号与危险品类型必须同时填写

# 返回数据示例

正常返回 Http状态码200，cost是花费海币，remaining是剩余海币。

{
  "cost": 20,
  "remaining": 4734
}

错误时返回 (令牌有误)

{
  "code": 400,
  "message": "The token is invalid",
  "timestamp": "2021-01-11 19:48:58"
}

错误时返回 (参数有误)

{
  "code": 400,
  "message": "船公司不能为空",
  "timestamp": "2021-01-11 19:51:12"
}

← 修改接口 →