文档中心
API调试

功能描述

海关进出口货物报关单识别

请求URL

https://api.textin.com/ai/service/v1/customs_declaration

HTTP请求方法 (Method)

HTTP POST

请求头说明 (Request Headers)

请在HTTP请求中添加以下自定义标头(Header)。

header 名
x-ti-app-id 请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-app-id
x-ti-secret-code 请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-secret-code

URL参数 (Parameters)

URL参数指以 {参数名}={参数值} 形式拼接到 URL 上的键值对。它以 ? 开头,不同参数之间使用 & 连接。形如 ?p1=v1&p2=v2

参数名 数据类型 是否必填 允许的值 描述
multipage integer 0,1 是否需要对pdf进行多页识别,0为单页识别,1为多页识别,默认为0
combine_document integer 0,1 是否需要对报关单中的多页表格识别结果进行合并,1为合并,0为不合并,默认为0;该功能要先打开multipage开关后奏效,单页识别时此参数不生效;
split_price integer 0,1 是否对表格内价格信息拆分,拆分后不输出合并字段,输出三个拆分后字段:单价,总价,币制
split_product_info integer 0,1 是否对表格内商品名称规格信息拆分,拆分后不输出合并字段,输出两个拆分后字段:商品名称,规格型号

请求体说明 (Request Body)

支持以下两种请求格式

1. Content-Type: application/octet-stream

要上传的图片,目前支持jpg, png, bmp, pdf, tiff, webp, 单帧gif等大部分格式.

请注意,请求体的数据格式为本地文件的二进制流,非 FormData 或其他格式。文件大小不超过 10M,图像宽高须介于 20 和 10000(像素)之间。文件大小不超过 10M,图像宽高须介于 20 和 10000(像素)之间。

2. Content-Type: text/plain

请求体的数据格式为文本,内容为在线文件的URL链接(支持http以及https协议)。在线文件大小不超过 10M,图像宽高须介于 20 和 10000(像素)之间。

响应体说明 (Response)

Content-Type: application/json

JSON结构说明如下:

字段名 类型 描述
code integer 错误码,详见“错误码说明”
message string 错误信息
pageNum integer 总页数
result object
+ success_count integer 成功识别次数
+ pages
++ type string 类型
- customs_declaration_for_imported_goods 海关进口货物报关单
- customs_declaration_for_export_goods 海关出口货物报关单
- other 其他
++ page_number integer 当前页
++ object_list array
+++ image_angle integer 图片角度,指原图需要经过顺时针旋转多少度,才能得到正方向的图片
+++ rotated_image_width integer 正方向时图片的宽
+++ rotated_image_height integer 正方向时图片高
+++ category string details 下字段的类型
- one_to_one: 只有单个值
- one_to_many: 有多个值
- item_list: 表格类型
+++ details string 识别结果
++++ value string 字段识别结果
++++ position array 识别的value在转正后的图中的坐标,是个长度为8的数组 [0,1,2,3,4,5,6,7]
(0, 1) 左上角坐标
(2, 3) 右上角坐标
(4, 5) 右下角坐标
(6, 7) 左下角坐标
++++ page_id integer 识别结果所属页
++++ description string 中文描述

字段说明

字段名 描述
pre_entry_number 预录入编号
customs_number 海关编号
domestic_consignor 境内发货人
domestic_consignor_code 境内发货人代码
domestic_consignee 境内收货人
domestic_consignee_code 境内收货人代码
exit_customs 出境关别
exit_customs_code 出境关别代码
import_customs 进境关别
import_customs_code 进境关别代码
export_date 出口日期
import_date 进口日期
declaration_date 申报日期
record_number 备案号
overseas_consignee 境外收货人
overseas_consignee_code 境外收货人代码
overseas_consignor 境外发货人
overseas_consignor_code 境外发货人代码
transportation_mode 运输方式
ransportation_mode_code 运输方式代码
transport_name_and_voyage_number 运输工具名称及航次号
delivery_number 提运单号
storage_place 货物存放地点
production_and_sales_company 生产销售单位
production_and_sales_company_code 生产销售单位代码
consumption_and_use_company 消费使用单位
consumption_and_use_company_code 消费使用单位代码
supervision_way 监管方式
supervision_way_code 监管方式代码
taxation 征免性质
taxation_code 征免性质代码
license 许可证号
port_of_shipment 启运港
port_of_shipment_code 启运港代码
contract_agreement_number 合同协议号
trading_country 贸易国(地区)
trading_country_code 贸易国(地区)代码
destination_country 抵运国(地区)
destination_country_code 抵运国(地区)代码
departure_country 启运国(地区)
departure_country_code 启运国(地区)代码
port_of_call 经停港
port_of_call_code 经停港代码
port_of_destination 指运港
port_of_destination_code 指运港代码
port_of_departure 离境口岸
port_of_departure_code 离境口岸代码
port_of_entry 入境口岸
port_of_entry_code 入境口岸代码
packing_type 包装种类
packing_type_code 包装种类代码
number_of_packages 件数
gross_weight 毛重
net_weight 净重
terms_of_delivery 成交方式
terms_of_delivery_code 成交方式代码
freight 运费
premium 保费
incidental 杂费
attached_documents_and_serial_number 随附单证及编号
marking_marks_and_remarks 标记唛码及备注
special_relationship_confirmation 特殊关系确认
price_impact_confirmation 价格影响确认
payment_of_royalty_confirmation 支付特许权使用费确认
self_inspection_and_payment 自报自缴
customs_broker 报关人员
certificate_number_of_customs_broker 报关人员证号
phone_number 电话
applicant_company 申报单位

item_list中识别字段说明

字段名 描述
item_number 项号
product_id 商品编号
product_name_and_specification_model 商品名称及规格型号
product_name 商品名称
specification_model 规格型号
quantity_and_unit 数量及单位
unit_price_total_price_currency_value 单价/总价/币值
unit_price 单价
total_price 总价
currency 币值
country_of_origin 原产国(地区)
country_of_final_destination 最终目的国(地区)
domestic_place_of_delivered_goods 境内货源地
domestic_destination 境内目的地
tax_exemption 征免

JSON结构示例

{"duration":100,"result":{"image_angle":90,"rotated_image_width":1920,"rotated_image_height":1080,"details":{"pre_entry_number":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"customs_number":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"domestic_consignor":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"domestic_consignor_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"domestic_consignee":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"domestic_consignee_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"exit_customs":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"exit_customs_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"import_customs":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"import_customs_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"export_date":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"import_date":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"declaration_date":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"record_number":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"overseas_consignee":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"overseas_consignee_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"overseas_consignor":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"overseas_consignor_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"transportation_mode":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"transportation_mode_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"transport_name_and_voyage_number":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"delivery_number":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"storage_place":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"production_and_sales_company":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"production_and_sales_company_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"consumption_and_use_company":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"consumption_and_use_company_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"supervision_way":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"supervision_way_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"taxation":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"taxation_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"license":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"port_of_shipment":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"port_of_shipment_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"contract_agreement_number":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"trading_country":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"trading_country_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"destination_country":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"destination_country_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"departure_country":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"departure_country_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"port_of_call":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"port_of_call_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"port_of_destination":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"port_of_destination_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"port_of_departure":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"port_of_departure_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"port_of_entry":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"port_of_entry_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"packing_type":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"packing_type_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"number_of_packages":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"gross_weight":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"net_weight":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"terms_of_delivery":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"terms_of_delivery_code":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"freight":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"premium":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"incidental":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"attached_documents_and_serial_number":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"marking_marks_and_remarks":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"special_relationship_confirmation":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"price_impact_confirmation":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"payment_of_royalty_confirmation":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"self_inspection_and_payment":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"customs_broker":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"certificate_number_of_customs_broker":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"phone_number":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"applicant_company":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"item_list":[{"item_number":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"product_id":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"product_name_and_specification_model":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"product_name":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"specification_model":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"quantity_and_unit":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"unit_price_total_price_currency_value":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"unit_price":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"total_price":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"currency":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"country_of_origin":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"country_of_final_destination":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"domestic_place_of_delivered_goods":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"domestic_destination":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0},"tax_exemption":{"value":"字段识别结果","position":[0,0,50,0,50,30,0,30],"description":"中文描述","page_id":0}}]},"category":{"DETAILS_KEY1":"one_to_one","DETAILS_KEY2":"one_to_many","DETAILS_KEY3":"item_list"},"type":"customs_declaration_for_imported_goods"}}

错误码说明

错误码 描述
40101 x-ti-app-id 或 x-ti-secret-code 为空
40102 x-ti-app-id 或 x-ti-secret-code 无效,验证失败
40103 客户端IP不在白名单
40003 余额不足,请充值后再使用
40004 参数错误,请查看技术文档,检查传参
40007 机器人不存在或未发布
40008 机器人未开通,请至市场开通后重试
40301 图片类型不支持
40302 上传文件大小不符,文件大小不超过 10M
40303 文件类型不支持
40304 图片尺寸不符,图像宽高须介于 20 和 10000(像素)之间
40305 识别文件未上传
40400 无效的请求链接,请检查链接是否正确
30203 基础服务故障,请稍后重试
500 服务器内部错误
人工咨询
技术交流群

联系我们