海管家海外舱单对接文档

# 发送接口

注意

此接口支持一次发送多单，同时支持一单多箱数据

# 请求地址


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

{
  "houseScac": "TXSL",
  "shipCompany": "COSCO-中远海",
  "masterBillNo": "DP17512K4AS",
  "fullMasterBillNo": "COSUDP17512K4AS",
  "vessel": "IAL 001|HK-香港",
  "vesselCode": "IAL 001|HK",
  "voyageNo": "FGHJH",
  "movementType": "Import",
  "placeOfReceipt": "24871|KINGSTOWN|VC-圣文森特和格林纳丁斯",
  "placeOfReceiptCode": "24871|KINGSTOWN",
  "portOfLoading": "09605|WALKERVILLE, ONT|CA-加拿大",
  "portOfLoadingCode": "09605|WALKERVILLE, ONT",
  "portOfTranshipment": "09671|WHITBY, ONT|CA-加拿大",
  "portOfTranshipmentCode": "09671|WHITBY, ONT",
  "portOfDischarge": "0105|VANCEBORO, MAINE|US-美国",
  "portOfDischargeCode": "0105|VANCEBORO, MAINE",
  "departureDate": "2020-12-16",
  "arrivalDate": "2021-01-06",
  "houseBills": [
    {
      "houseBillNo": "API17515",
      "shipperName": "HBGFNGBVNH",
      "shipperAddress": "NHGMJH,LKJ/;.JKYHMJFGBFHGBFDHGFTFGDHFGB",
      "shipperTel": null,
      "consigneeName": "HGBFJNHGFHB",
      "consigneeAddress": "HGFBJNHFGM GBYTRREGFJHUYKUJKMYYTYGFDHT",
      "consigneeTel": null,
      "notify1Name": "HGFJHBTBGF",
      "notify1Address": "HYTGJYTSDGFJMHJ,JK.UHIKTFYHRFHTYIJKUL",
      "notify1Tel": null,
      "containers": [
        {
          "containerNo": "NC",
          "sealNo": "NONE",
          "containerTypeSize": "NC",
          "hsCode": "",
          "cargoDescription": "FDBGFNGFHG",
          "markNumbers": "THGFDHGFB",
          "packages": "34",
          "packageUnit": "BEM",
          "weight": 43,
          "volume": 34,
          "contactName": "GHGHF",
          "undgNumber": 1234,
          "contactName2": "",
          "undgNumber2": null,
          "contactName3": "",
          "undgNumber3": null,
          "contactName4": "",
          "undgNumber4": null,
          "contactName5": "",
          "undgNumber5": null
        }
      ]
    }
  ]
}

# 请求参数说明

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

属性 类型 必填 说明 校验规则
1.3.4 houseScac string 否 House Scac 使用非默认的houseScac时，传入
shipCompany string 否 船公司，与masterBillNo一起填写;和fullMasterBillNo二选一 参考船公司列表
masterBillNo string 否 船东提单号(MBL)，与shipCompany一起填写;和fullMasterBillNo二选一 只能大写字母和数字,不超过26字符;船东提单号前四个字符不能和船公司四字码相同
fullMasterBillNo string 否 包含船公司scac四字码的船东提单号(MBL)，此字段优先级高于shipCompany masterBillNo，填写此字段 shipCompany masterBillNo 将被忽略 只能大写字母和数字,不超过30字符;
vessel string 是 船名 船名和船名Code 二选一即可，例如’IAL 001|HK-香港‘，参考船名列表
2022-02-16
vesselCode		 string 否 船名Code 船名和船名Code 二选一即可，例如’IAL 001|HK‘，参考船名列表
voyageNo boolean 是 航次 大写字符和数字,不能有空格,不超过5个字符
movementType string 是 运输方式 Import/FROB,Import代表非FROB;FROB代表不下船过境美国
placeOfReceipt string 是 发货地 发货地和发货地Code 二选一即可，例如’24871|KINGSTOWN|VC-圣文森特和格林纳丁斯‘，参考发货地，装货港和最后中转的外国港列表列表
2022-02-16
placeOfReceiptCode		 string 否 发货地Code 发货地和发货地Code 二选一即可，例如’24871|KINGSTOWN‘，参考发货地，装货港和最后中转的外国港列表列表
portOfLoading string 是 装货港 装货港和装货港Code 二选一即可，例如‘09605|WALKERVILLE, ONT|CA-加拿大’, 参考发货地，装货港和最后中转的外国港列表列表
2022-02-16
portOfLoadingCode		 string 否 装货港Code 装货港和装货港Code 二选一即可，例如‘09605|WALKERVILLE, ONT’,参考发货地，装货港和最后中转的外国港列表列表
portOfTranshipment string 否 最后中转的外国港口 最后中转的外国港口和最后中转的外国港口Code 二选一接口，例如‘09605|WALKERVILLE, ONT|CA-加拿大’， 参考发货地，装货港和最后中转的外国港列表列表
2022-02-16
portOfTranshipmentCode		 string 否 最后中转的外国港口Code 最后中转的外国港口和最后中转的外国港口Code 二选一接口，例如‘09605|WALKERVILLE, ONT’， 参考发货地，装货港和最后中转的外国港列表列表
portOfDischarge string 是 卸货港 卸货港和卸货港Code 二选一即可，例如‘0105|VANCEBORO, MAINE|US-美国’，参考卸货港列表
2022-02-16
portOfDischargeCode		 string 是 卸货港Code 卸货港和卸货港Code 二选一即可，例如‘0105|VANCEBORO, MAINE&’，参考卸货港列表
departureDate string 是 预计出发 格式：2021-01-14
arrivalDate string 是 预计到达 格式：2021-01-14;预计到达日期必须晚于预计出发日期;预计到达日期必须晚于今天
houseBills string 是 House单信息
houseBillNo string 是 货代提单号(HBL) 大写字符和数字,不能有空格,不超过12字符
shipperName string 是 发货人名称 不能有中文&小写字母&全角字符,不超过35个字符。如超过,可适当删减,去除尾部的CO.,LTD,或使用缩写
shipperAddress string 是 发货人地址 不能有中文&小写字母&全角字符,36~105个字符
shipperTel string 否 发货人联系电话 只包含数字和-,不超过35个字符
consigneeName string 是 收货人名称 不能有中文&小写字母&全角字符,不超过35个字符。如超过,可适当删减,去除尾部的CO.,LTD,或使用缩写
consigneeAddress string 是 收货人地址 不能有中文&小写字母&全角字符,36~105个字符
consigneeTel string 否 收货人联系电话 只包含数字和-,不超过35个字符
notify1Name string 是 通知人名称 不能有中文&小写字母&全角字符,不超过35个字符。如超过,可适当删减,去除尾部的CO.,LTD,或使用缩写
notify1Address string 是 通知人地址 不能有中文&小写字母&全角字符,36~105个字符
notify1Tel string 否 通知人联系电话 只包含数字和-,不超过35个字符
containers string 是 集装箱信息
containerNo string 是 箱号 大写字符和数字，不超过14位(NC代表非集装箱)
sealNo string 是 封号 只能大写字符和数字,不能超过15个字符
containerTypeSize string 是 箱型 参考箱型和包装单位列表
hsCode string 否 HS code 6位数字，当运输类型为FROB，hsCode必须填
cargoDescription string 是 品名 不可包含中文&小写字符&全角字符,如有多种货物,请用英文逗号分隔;不能超过2000个字符
markNumbers string 是 唛头 不可包含中文&小写字符&全角字符
packages number 是 件数 1-9999999999的整数
packageUnit string 是 包装单位 参考箱型和包装单位列表
weight number 是 毛重 小数不超过3位,不超过10字符
volume number 是 体积 小数不超过3位,不超过10字符
undgNumber string 否 联合国危险品编号 范围:1001-9999整数,如已填危险品联系人姓名,则必填
contactName string 否 危险品联系人姓名 不超过60字符,如已填联合国危险品编号,则必填
undgNumber2 string 否 联合国危险品编号2 范围:1001-9999,如已填危险品联系人姓名2,则必填
contactName2 string 否 危险品联系人姓名2 不超过60字符,如已填联合国危险品编号2,则必填
undgNumber3 string 否 联合国危险品编号3 范围:1001-9999,如已填危险品联系人姓名3,则必填
contactName3 string 否 危险品联系人姓名3 不超过60字符,如已填联合国危险品编号3,则必填
undgNumber4 string 否 联合国危险品编号4 范围:1001-9999,如已填危险品联系人姓名4,则必填
contactName4 string 否 危险品联系人姓名4 不超过60字符,如已填联合国危险品编号4,则必填
undgNumber5 string 否 联合国危险品编号5 范围:1001-9999,如已填危险品联系人姓名5,则必填
contactName5 string 否 危险品联系人姓名5 不超过60字符,如已填联合国危险品编号5,则必填

# 返回数据示例

正常返回 Http状态码200，cost是花费海币，coupon是优惠券抵扣海币数，remaining是剩余海币。

{
  "cost": 50,
  "coupon": 0,
  "remaining": 1000
}

错误时返回 (令牌有误)

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

错误时返回 (参数有误)

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

← 修改接口 →