海管家海外舱单对接文档

# 发送接口

ISF发送主要接口

# ISF5请求地址


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

{
  "billType": 0,
  "houseScac": "TXSL",
  "cargoType": "Standard",
  "dischargingPort": "01520|HAMILTON, ONT|CA-加拿大",
  "dischargingPortCode": "01520|HAMILTON, ONT",
  "delivery": "01520|HAMILTON, ONT|CA-加拿大",
  "deliveryCode": "01520|HAMILTON, ONT",
  "amsRequestList": [
    {
      "amsType": "House bill",
      "amsNo": "ISFOPENAPI"
    }
  ],
  "shipName": "SOON PROMOTIONS LTD",
  "shipAddr": "8 THE GREEN STE R DOVER,DE 19901  AMERICA",
  "shipCity": "DOVER",
  "shipCountry": "CN-中国",
  "bookName": "YTO EXPRESS GROUP CO., LTD",
  "bookAddr": "975 OVERLAND CT SAN DIMAS CA 91773 U.S.A",
  "bookCity": "LOS ANGELES",
  "bookCountry": "US-美国",
  "bookCountryCode": "US",
  "billHsRequestList": [
    {
      "hsCode": "556786",
      "hsCountry": "CN-中国",
      "hsCountryCode": "CN"
    }
  ]
}

# ISF5请求参数说明

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

属性 类型 必填 说明 校验规则
billType number 是 ISF类型 ISF5固定为0
houseScac string 否 filer code 不传默认为企业默认配置
cargoType string 是 船运货物类型 ISF5固定为"Standard"代表"Standard or regular filings"
dischargingPort string 是 外国卸货港 外国卸货港和外国卸货港Code 二选一即可，例如“01520|HAMILTON, ONT|CA-加拿大”，参考外国卸货港和交货地列表
1.2.0dischargingPortCode string 否 外国卸货港Code 外国卸货港和外国卸货港Code 二选一即可，例如“01520|HAMILTON, ONT”, 参考外国卸货港和交货地列表
delivery string 是 交货地 交货地和交货地Code 二选一即可，例如“01520|HAMILTON, ONT|CA-加拿大”， 参考外国卸货港和交货地表列表
1.2.0deliveryCode string 否 交货地Code 交货地和交货地Code 二选一即可，例如“01520|HAMILTON, ONT”，参考外国卸货港和交货地表列表
amsRequestList string 是 B/L信息 至少一个
amsType string 是 提单类型 "House bill" 或者 "Ocean bill" 二选一
amsNo string 是 AMS B/L NO 大写字符、数字、-，不能有空格,最多16个字符
shipName string 是 货物送达的公司名称 不能有中文、小写字母、全角字符、*、~，不超过35个字符
shipAddr string 是 货物送达的公司地址 不能有中文、小写字母、全角字符、*、~，不超过105个字符
shipCity string 是 货物送达的公司城市 不能有中文、小写字母、全角字符、*、~，不超过35个字符
shipCountry string 否 货物送达的公司国家 货物送达的公司国家和货物送达的公司国家Code 二选一即可，例如”CN-中国“，参考国家列表
1.2.0shipCountryCode string 否 货物送达的公司国家Code 货物送达的公司国家和货物送达的公司国家Code 二选一即可，例如”CN“，参考国家列表
bookName string 是 订舱人名称 不能有中文、小写字母、全角字符、*、~，不超过35个字符
bookAddr string 是 订舱人地址 不能有中文、小写字母、全角字符、*、~，不超过105个字符
bookCity string 是 订舱人城市 不能有中文、小写字母、全角字符、*、~，不超过35个字符
bookCountry string 是 订舱人国家 订舱人国家和订舱人国家Code 二选一即可，例如”CN-中国“，参考国家列表
1.2.0bookCountryCode string 否 订舱人国家Code 订舱人国家和订舱人国家Code 二选一即可，例如”CN“，参考国家列表
billHsRequestList string 是 Cargos信息 至少一个
hsCode string 是 HS Code 6位数字
hsCountry string 否 货物原产国 货物原产国和货物原产国Code 二选一即可，例如”CN-中国“，参考国家列表
1.2.0hsCountryCode string 否 货物原产国Code 货物原产国和货物原产国Code 二选一即可，例如”CN“，参考国家列表

# ISF10请求地址


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

{
  "billType": 1,
  "houseScac": "TSXL",
  "cargoType": "Standard",
  "amsRequestList": [
    {
      "amsType": "House bill",
      "amsNo": "ISFOPENAPI"
    }
  ],
  "bondType": "Continuous",
  "bondHolderType": "IM",
  "bondHolderId": "11-746478345",
  "suretyCode": "",
  "bondReferenceNo": "",
  "importerId": "20-268767800",
  "importerType": "EI",
  "consigneeId": "20-268767800",
  "consigneeType": "EI",
  "sellerName": "ZHEJIANG AISUN HOME TEXTILE CO,LTD",
  "sellerAddr": "ADD,HANGZHOU BAY INDUSTRIAL ZONE , SHANGYU ZONE , SHAOXING CITY ,ZHEJIANG",
  "sellerCity": "ZHEJIANG",
  "sellerCountry": "CN-中国",
  "sellerCountryCode": "CN",
  "bugerName": "AMERICAN HOME TEXTILE INC.",
  "bugerAddr": "65-75 B TRAFFIC AVE, RIDGEWOOD NY 11385",
  "bugerCity": "NY",
  "bugerCountry": "US-美国",
  "bugerCountryCode": "US",
  "shipName": "AMERICAN HOME TEXTILE INC.",
  "shipAddr": "65-75 B TRAFFIC AVE, RIDGEWOOD NY 11385",
  "shipCity": "NY",
  "shipCountry": "US-美国",
  "shipCountryCode": "US",
  "manufacturerName": "ZHEJIANG AISUN HOME TEXTILE CO,LTD",
  "manufacturerAddr": "ADD,HANGZHOU BAY INDUSTRIAL ZONE , SHANGYU ZONE , SHAOXING CITY ,ZHEJIANG",
  "manufacturerCity": "ZHEJIANG",
  "manufacturerCountry": "CN-中国",
  "manufacturerCountryCode": "CN",
  "containerName": "ZHEJIANG AISUN HOME TEXTILE CO,LTD",
  "containerAddr": "ADD,HANGZHOU BAY INDUSTRIAL ZONE , SHANGYU ZONE , SHAOXING CITY ,ZHEJIANG",
  "containerCity": "ZHEJIANG",
  "containerCountry": "CN-中国",
  "containerCountryCode": "CN",
  "consolidatorName": "GREAT LINK LOGISTICS CO.,LTD",
  "consolidatorAddr": "RM 1103 REGDB",
  "consolidatorCity": "SHENZHEN",
  "consolidatorCountry": "CN-中国",
  "consolidatorCountryCode": "CN",
  "billHsRequestList": [
    {
      "hsCode": "630140",
      "hsCountry": "CN-中国",
      "hsCountryCode": "CN"
    }
  ]
}

# ISF510请求参数说明

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

属性 类型 必填 说明 校验规则
billType number 是 ISF类型 ISF10固定为1
1.2.7 houseScac string 否 FILER CODE 不传默认为企业默认配置
cargoType string 是 船运货物类型 "Standard" 或者 "ToOrder" 二选一，"Standard"代表"Standard or regular filings"；"ToOrder"代表"To Order Shipments"
amsRequestList string 是 B/L信息 至少一个
amsType string 是 提单类型 "House bill" 或者 "Ocean bill" 二选一
amsNo string 是 AMS B/L NO 前四个字符必须是大写字母；只允许大写字符、数字、-，不能有空格,最多16个字符
bondType string 是 Bond类型 "Continuous","Hgj_Continuous","Single" 三选一,"Continuous"代表"我有年Bond","Hgj_Continuous"代表"我要使用海管家年Bond","Single"代表"我要使用单次Bond"
bondHolderType string 条件必填 Bond Holder Type 当bondType是"Continuous"，必填；参考Bond Holder Type列表
bondHolderId string 条件必填 Bond Holder ID 当bondType是"Continuous"或者"Single"，必填；格式：NN-NNNNNNNXX或YYDDPP-NNNNN或NNN-NN-NNNN，N代表数字，X代表字母或数字，YY为年份的最后两位，DDPP为地区或港口代码。
suretyCode string 条件必填 SuretyCode 当bondType是"Single"，必填；只能是三位数字
bondReferenceNo string 条件必填 BondReferenceNo 当bondType是"Single"，必填；只能输入数字，不超过50位
importerId string 条件必填 进口商ID 当bondType是"Continuous"或"Single"时必填，ID类型列表
importerType string 条件必填 进口商ID类型 当bondType是"Continuous"或"Single"时必填，参考ID类型列表
consigneeId string 条件必填 收货人ID 当bondType是"Continuous"或"Single"时必填，参考ID类型列表
consigneeType string 条件必填 当bondType是"Continuous"或"Single"时必填，收货人ID类型 参考ID类型列表
sellerName string 是 卖方公司名称 不能有中文、小写字母、全角字符、*、~,不超过35个字符
sellerAddr string 是 卖方公司地址 不能有中文、小写字母、全角字符、*、~,不超过105个字符
sellerCity string 是 卖方公司城市 不能有中文、小写字母、全角字符、*、~,不超过35个字符
sellerCountry string 是 卖方公司国家 卖方公司国家和卖方公司国家Code 二选一即可，例如"CN-中国"参考国家列表
1.2.0sellerCountryCode string 否 卖方公司国家Code 卖方公司国家和卖方公司国家Code 二选一即可，例如"CN"，参考国家列表
bugerName string 是 买方公司名称 不能有中文、小写字母、全角字符、*、~,不超过35个字符
bugerAddr string 是 买方公司地址称 不能有中文、小写字母、全角字符、*、~,不超过105个字符
bugerCity string 是 买方公司城市 不能有中文、小写字母、全角字符、*、~,不超过35个字符
bugerCountry string 是 买方公司国家 bugerCountry和买方公司国家Code二选一接口，例如"CN-中国"，参考国家列表
1.2.0bugerCountryCode string 否 买方公司国家Code bugerCountry和买方公司国家Code二选一接口，例如"CN"，参考国家列表
shipName string 是 货物送达的公司名称 不能有中文、小写字母、全角字符、*、~,不超过35个字符
shipAddr string 是 货物送达的公司地址 不能有中文、小写字母、全角字符、*、~,不超过105个字符
shipCity string 是 货物送达的公司城市 不能有中文、小写字母、全角字符、*、~,不超过35个字符
shipCountry string 是 货物送达的公司国家 货物送达的公司国家和货物送达的公司国家Code 二选一即可，例如"CN-中国"，参考国家列表
1.2.0shipCountryCode string 否 货物送达的公司国家Code 货物送达的公司国家和货物送达的公司国家Code 二选一即可，例如"CN"，参考国家列表
manufacturerName string 是 工厂的公司名称 不能有中文、小写字母、全角字符、*、~,不超过35个字符
manufacturerAddr string 是 工厂的公司地址 不能有中文、小写字母、全角字符、*、~,不超过105个字符
manufacturerCity string 是 工厂的公司城市 不能有中文、小写字母、全角字符、*、~,不超过35个字符
manufacturerCountry string 是 工厂的公司国家 工厂的公司国家和工厂的公司国家Code 二选一即可，例如"CN-中国"，参考国家列表
1.2.0manufacturerCountryCode string 否 工厂的公司国家Code 工厂的公司国家和工厂的公司国家Code 二选一即可，例如"CN"，参考国家列表
containerName string 是 货柜装柜的公司名称 不能有中文、小写字母、全角字符、*、~,不超过35个字符
containerAddr string 是 货柜装柜的公司地址 不能有中文、小写字母、全角字符、*、~,不超过105个字符
containerCity string 是 货柜装柜的公司城市 不能有中文、小写字母、全角字符、*、~,不超过35个字符
containerCountry string 是 货柜装柜的公司国家 货柜装柜的公司国家和货柜装柜的公司国家Code 二选一即可，例如"CN-中国"，参考国家列表
1.2.0containerCountryCode string 否 货柜装柜的公司国家Code 货柜装柜的公司国家和货柜装柜的公司国家Code 二选一即可，例如"CN"，参考国家列表
consolidatorName string 是 拼箱的公司名称 不能有中文、小写字母、全角字符、*、~,不超过35个字符
consolidatorAddr string 是 拼箱的公司名称 不能有中文、小写字母、全角字符、*、~,不超过105个字符
consolidatorCity string 是 拼箱的公司城市 不能有中文、小写字母、全角字符、*、~,不超过35个字符
consolidatorCountry string 是 拼箱的公司国家 拼箱的公司国家和拼箱的公司国家Code 二选一即可，例如"CN-中国"，参考国家列表
1.2.0consolidatorCountryCode string 否 拼箱的公司国家Code 拼箱的公司国家和拼箱的公司国家Code 二选一即可，例如"CN"，参考国家列表
billHsRequestList string 是 Cargos信息 至少一个
hsCode number 是 HS Code 6位数字
hsCountry string 是 货物原产国 货物原产国和货物原产国Code 二选一即可，，例如"CN-中国"，参考国家列表
1.2.0hsCountryCode string 否 货物原产国Code 货物原产国和货物原产国Code 二选一即可，，例如"CN"，参考国家列表

# 返回数据示例

正常返回 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"
}

← 修改接口 →