WebEDI API 接口文档

修订纪录

日期	功能模块	说明	相关文档
2024/07/15	发货通知	新增发送发货通知接口 API；	发送发货通知 API
2024/07/29	发货通知	新增 Body 请求参数字段；	新增接口字段详见请求参数说明。
2024/09/12	发货通知	修改日期时间格式；新增 Body 请求参数字段；	新增接口字段详见请求参数说明。
2024/10/17	发货通知	增加 ASN 编号参数字段；	新增接口字段详见请求参数说明。
2024/12/20	API 请求示例	增加登录授权接口；增加接口 API 请求示例；
2024/12/26	订单详情	增加订单列表接口 API；增加订单查询接口 API；	订单列表 API 订单详情 API 订单查询 API
2025/03/20	发票	新增发送发票接口 API；	发送发票 API
2025/04/10	发送交付单	新增发送交付单接口 API；	发送交付单 API
2025/05/27	参与方地址	新增参与方地址信息接口 API；	参与方地址信息 API

登录授权接口

登录授权，用于获取 access_token 参数

请求说明

请求地址	https://xxx.xxx.xxx.xxx:8481/api/auth/token
请求方法	POST

请求参数

Body 参数

参数名称	描述	描述	是否必选	示例值	说明
admin	String	用户名	是	xxx
password	String	密码	是	xxx

返回参数

参数名称	类型	描述	示例值	说明
status	Boolean	返回状态	true	true or false
message	String	返回消息内容	Failed to obtain token.
access_token	String	Token	eyJhbGciOi...
expiration	Number	Token 有效期(单位: 秒)	28800
expired_at	Number	Token 到期时间戳	1704508394000

返回示例

正常返回示例

json5

{
    "access_token": "eyJhbGciOi...",
    "success": true,
    "expiration": 28800,
    "expired_at": 1704508394000
}

异常返回示例

json5

{
    "code": 403,
    "success": false,
    "message": "Failed to obtain token.",
}

API 请求示例

订单列表-仅包含订单主信息（分页查询）

请求说明

请求地址	https://xxx.xxx.xxx.xxx:8481/api/order/page
请求方法	POST

请求参数

Bearer auth 认证参数

参数名称	描述	描述	是否必选	示例值	说明
access_token	String	Token	是	eyJhbGciOi...	通过登录授权接口获取

参数名称	描述	描述	是否必选	示例值	说明
Return-Type	String	接口返回类型	是	DocumentData	固定值

Body 参数

参数名称	描述	描述	是否必选	示例值	说明
project_key	String	项目标识	是	ChinLink	项目标识由畅链科技分配
pagination	Object	分页参数	是
pagination.current	Number	当前页	是	1
pagination.pageSize	Number	每页大小	是	20

返回参数

参数名称	类型	描述	示例值	说明
status	Boolean	返回状态	true	true or false
message	String	返回消息内容	xxx
data	Object	返回数据
data.records	Array	订单数据集合

data.records 参数说明

参数名称	类型	描述	示例值	说明
serial_number	String	订单序列编号	135963345397353472	订单唯一标识
document_number	String	报文序号	1300001	客户发送报文编号
document_type	String	报文类型	850	客户发送报文类型： 850-采购订单； 860-采购订单变更； 830-长期预测订单； 862-短期预测订单；
order_number	String	订单编号	10193220643

API 请求示例

订单列表-包含订单详情（分页查询）

请求说明

请求地址	https://xxx.xxx.xxx.xxx:8481/api/order/pageInfo
请求方法	POST

请求参数

Bearer auth 认证参数

参数名称	描述	描述	是否必选	示例值	说明
access_token	String	Token	是	eyJhbGciOi...	通过登录授权接口获取

参数名称	描述	描述	是否必选	示例值	说明
Return-Type	String	接口返回类型	是	DocumentData	固定值

Body 参数

参数名称	描述	描述	是否必选	示例值	说明
project_key	String	项目标识	是	ChinLink	项目标识由畅链科技分配
date	String	查询日期	否	2025-11-06	按照订单接收日期查询，日期格式: yyyy-MM-DD, 默认值：当天日期
document_type	String	报文类型	否	DELFOR	按照报文类型查询，默认为空，查询所有报文类型订单
current	Number	当前页	否	1	默认值： 1
page_size	Number	每页大小	否	100	默认值: 100

返回参数

参数名称	类型	描述	示例值	说明
status	Boolean	返回状态	true	true or false
message	String	返回消息内容	xxx
data	Object	返回数据
data.records	Array	订单数据集合
data.total	Number	总数
data.size	Number	每页大小
data.current	Number	当前页

data.records 参数说明

参数名称	类型	描述	示例值	说明
Serial_Number	String	订单序列编号	135963345397353472	订单唯一标识
Document_Number	String	报文序号	1300001	客户发送报文编号
Document_Type	String	报文类型	850	客户发送报文类型： 850-采购订单； 860-采购订单变更； 830-长期预测订单； 862-短期预测订单；
...	String	其他参数属于业务参数，与实际业务相关

API 请求示例

订单详情（通过订单序列编号查询）

请求说明

请求地址	https://xxx.xxx.xxx.xxx:8481/api/order/info/{serial_number}
请求方法	GET

请求参数

Bearer auth 认证参数

参数名称	描述	描述	是否必选	示例值	说明
access_token	String	Token	是	eyJhbGciOi...	通过登录授权接口获取

参数名称	描述	描述	是否必选	示例值	说明
Return-Type	String	接口返回类型	是	DocumentData	固定值

Path 参数

参数名称	描述	描述	是否必选	示例值	说明
serial_number	String	订单序列编号	是	135963345397353472	订单唯一标识

返回参数

参数名称	类型	描述	示例值	说明
status	Boolean	返回状态	true	true or false
message	String	返回消息内容	xxx
data	Object	返回数据
data.document_data	Array	报文/订单数据内容

data.document_data 参数说明

参数名称	类型	描述	示例值	说明
Sender_Id	String(36)	发送方ID标识	958755
Sender_Internal_Id	String(36)	发送方内部ID标识	LM485	非必须，可空
Document_Type	String(36)	报文类型	850	客户发送报文类型： 850/ORDERS-采购订单； 860/ORDCHG-采购订单变更； 830/DELFOR-长期预测订单； 862/DELJIT-短期预测订单；
Document_Number	String(36)	报文序号	1300001	客户发送报文编号
Document_Datetime	String(36)	报文日期/时间	20240509	客户发送报文日期格式：CCYYMMDD 或 CCYYMMDDHHmm
Purchase_Order_Number	String(36)	采购订单编号	10193220643
Purchase_Order_Date	String(36)	采购订单日期	20240509	采购订单日期格式：CCYYMMDD
Buyer_Id	String(36)	买方/采购方编码
Buyer_Agency_Code	String(10)	买方/采购方编码类型
Buyer_Name	String(70)	买方/采购方名称
Buyer_Address	String(36)	买方/采购方地址
Buyer_Address_Info	String(36)	买方/采购方详细地址
Buyer_Street	String(256)	买方/采购方街道
Buyer_City	String(36)	买方/采购方城市
Buyer_State_Province	String(36)	买方/采购方省/州编码
Buyer_Postcode	String(18)	买方/采购方邮政编码
Buyer_Country	String(10)	买方/采购方国家/地区编号
Seller_xxx	String	卖方/销售方信息		参考 Buyer 参数
Ship_From_xxx	String	发货地信息		参考 Buyer 参数
Ship_To_xxx	String	收货地信息		参考 Buyer 参数
Bill_To_xxx	String	付款方信息		参考 Buyer 参数
Sold_To_xxx	String	实际收货方信息		参考 Buyer 参数
Currency_Code	String(10)	货币代码	USD	发送发票 810 时，必选值
Detail_Items. Detail_Item_Loop	Array	物料数据集合

Detail_Items.Detail_Item_Loop 参数说明

参数名称	类型	描述	示例值	说明
Line_Item_Number	String(6)	物料行号	00010
Buyer_Item_Number	String(36)	买方/采购方物料编号	PA123456
Purchase_Order_Number	String(70)	采购订单号	991935452615
Purchase_Order_Line _Number	String(6)	订单行号	00010
Unit_Price	String(18)	物料单价	163.12	发送发票 810 时，必选值
Unit_Price_Basis_Code	String(3)	价格基数代码	PN	(PE) Price per Each (PN) Price per Ten (HP) Price per Hundred (TP) Price per Thousand
Place_Of_Delivery	String(256)	交货地点	ED05	发送发货通知 DESADEV 时，必选值
Place_Port_Discharge	String(256)	卸货港口代码	WEDJ	发送发货通知 DESADEV 时，必选值
Additional_Internal _Destination	String(256)	内部目的地代码	3256	发送发货通知 DESADEV 时，必选值
Item_Description	String(256)	描述信息
Delivery_Schedule_Number	String(70)	交货计划编号	392
Delivery_Schedule_Date	String(36)	交货计划日期	格式：CCYYMMDD 或 CCYYMMDDHHmm
Plan_Items. Plan_Item_Loop	Array	预测/订单数据集合

Plan_Items.Plan_Item_Loop 参数说明

参数名称	类型	描述	示例值	说明
Delivery_Plan_Status	String(10)	交付计划状态编码	4	1-Firm 4-Planning/forecast
Delivery_Plan_Status_View	String(256)	交付计划状态描述	Planning/forecast	1-Firm 4-Planning/forecast
Discrete_Quantity	String(36)	交付数量	162	预测/订单数量
Discrete_Unit	String(8)	数量单位	EA
Outstanding_Quantity	String(36)	未完成数量	0	未完成数量（延期订单）
Quantity_To_Be_Delivered	String(36)	待交付数量	0	待交付数量
Request_Delivery_Date	String(36)	买方要求交货日期	20250529	格式：CCYYMMDD 或 CCYYMMDDHHmm

响应示例

json5

{
  "data": {
    "document_number": "20250426150038",
    "document_data": {
      "Sender_Id": "000987654321",
      "Sender_Type": "ZZZ",
      "Sender_Internal_Id": "",
      "Receiver_Id": "O01234567890",
      "Receiver_Type": "ZZZ",
      "Receiver_Internal_Id": "",
      "Number": "27041508",
      "Test_Indicator": "",
      "Serial_Number": "1365985846678032384",
      "Document_Type": "DELFOR",
      "Document_Number": "20250426150038",
      "Document_Datetime": "202504270257",
      "Document_Date_Format": "203",
      "Expiry_Date": "20251217",
      "Validity_Start_Date": "202504270257",
      "Effective_From_Date": "202504270257",
      "Effective_To_Date": "20251217",
      "Delivery_Schedule_Number": "20250426150038",
      "Buyer_Id": "PO001",
      "Buyer_Agency_Code": "92",
      "Buyer_Name": "",
      "Buyer_Address": "",
      "Buyer_Address_Info": "",
      "Buyer_Street": "",
      "Buyer_City": "",
      "Buyer_State_Province": "",
      "Buyer_Postcode": "",
      "Buyer_Country": "",
      "Seller_Id": "QA002",
      "Seller_Agency_Code": "92",
      "Seller_Address": "",
      "Seller_Address_Info": "",
      "Seller_Name": "",
      "Seller_Street": "",
      "Seller_City": "",
      "Seller_State_Province": "",
      "Seller_Postcode": "",
      "Seller_Country": "",
      "Ship_From_Id": "",
      "Ship_From_Agency_Code": "",
      "Ship_From_Address": "",
      "Ship_From_Address_Info": "",
      "Ship_From_Name": "",
      "Ship_From_Street": "",
      "Ship_From_City": "",
      "Ship_From_State_Province": "",
      "Ship_From_Postcode": "",
      "Ship_From_Country": "",
      "Ship_To_Id": "",
      "Ship_To_Agency_Code": "",
      "Ship_To_Address": "",
      "Ship_To_Address_Info": "",
      "Ship_To_Name": "",
      "Ship_To_Street": "",
      "Ship_To_City": "",
      "Ship_To_State_Province": "",
      "Ship_To_Postcode": "",
      "Ship_To_Country": "",
      "Detail_Items": {
        "Detail_Item_Loop": [
          {
            "Line_Item_Number": "",
            "Buyer_Item_Number": "8579552554",
            "Purchase_Order_Number": "9958745411225",
            "Purchase_Order_Line_Number": "",
            "Calculation_Date": "202504270257",
            "Place_Port_Discharge": "WEDJ",
            "Additional_Internal_Destination": "3256",
            "Plan_Items": {
              "Plan_Item_Loop": [
                {
                  "Delivery_Plan_Status": "4",
                  "Delivery_Plan_Status_View": "Planning/forecast",
                  "Discrete_Quantity": "28",
                  "Discrete_Unit": "EA",
                  "Quantity_To_Be_Delivered": "28",
                  "Request_Delivery_Date": "202505161200"
                },
                {
                  "Delivery_Plan_Status": "4",
                  "Delivery_Plan_Status_View": "Planning/forecast",
                  "Discrete_Quantity": "50",
                  "Discrete_Unit": "EA",
                  "Request_Delivery_Date": "202505181200"
                },
                {
                  "Delivery_Plan_Status": "4",
                  "Delivery_Plan_Status_View": "Planning/forecast",
                  "Discrete_Quantity": "200",
                  "Discrete_Unit": "EA",
                  "Quantity_To_Be_Delivered": "200",
                  "Request_Delivery_Date": "202512171200"
                }
              ]
            }
          },
          {
            "Line_Item_Number": "",
            "Buyer_Item_Number": "8579552998",
            "Purchase_Order_Number": "9958745411225",
            "Purchase_Order_Line_Number": "",
            "Calculation_Date": "202504270257",
            "Place_Port_Discharge": "TUYS",
            "Additional_Internal_Destination": "TUYS",
            "Plan_Items": {
              "Plan_Item_Loop": [
                {
                  "Delivery_Plan_Status": "4",
                  "Delivery_Plan_Status_View": "Planning/forecast",
                  "Discrete_Quantity": "162",
                  "Discrete_Unit": "EA",
                  "Quantity_To_Be_Delivered": "162",
                  "Request_Delivery_Date": "202512151200"
                },
                {
                  "Delivery_Plan_Status": "4",
                  "Delivery_Plan_Status_View": "Planning/forecast",
                  "Discrete_Quantity": "162",
                  "Discrete_Unit": "EA",
                  "Quantity_To_Be_Delivered": "162",
                  "Request_Delivery_Date": "202512161200"
                },
                {
                  "Delivery_Plan_Status": "4",
                  "Delivery_Plan_Status_View": "Planning/forecast",
                  "Discrete_Quantity": "162",
                  "Discrete_Unit": "EA",
                  "Quantity_To_Be_Delivered": "162",
                  "Request_Delivery_Date": "202512171200"
                }
              ]
            }
          }
        ]
      }
    }
  },
  "code": 0,
  "message": null,
  "success": true
}

API 请求示例

订单查询（通过订单编号查询）

请求说明

请求地址	https://xxx.xxx.xxx.xxx:8481/api/order/info/order/{order_number}?project_key={project_key}
请求方法	GET

请求参数

Bearer auth 认证参数

参数名称	描述	描述	是否必选	示例值	说明
access_token	String	Token	是	eyJhbGciOi...	通过登录授权接口获取

参数名称	描述	描述	是否必选	示例值	说明
Return-Type	String	接口返回类型	是	DocumentData	固定值

Path 参数

参数名称	描述	描述	是否必选	示例值	说明
order_number	String	订单编号	是	10193220643	如果有重复的订单，默认获取最近一次订单

Request 参数

参数名称	描述	描述	是否必选	示例值	说明
project_key	String	项目标识	是	ChinLink	项目标识由畅链科技分配

返回参数

参考订单详情（通过订单序列编号查询）

API 请求示例

创建发货通知单

💡

通过 API 接口，将线下发货信息，提交给 EDI 系统，通过 EDI 系统生成 856 或 DESADV 报文，并发送给客户。

请求说明

请求地址	https://xxx.xxx.xxx.xxx:8481/api/delivery/saveData
请求方法	POST

请求参数

Body 参数

参数名称	描述	描述	是否必选	示例值	说明
project_key	String	项目标识	是	ChinLink	项目标识由畅链科技分配
action_type	String	发送报文类型标识	是	delivery	固定值
content	Json	发送报文内容	是

content 参数

参数名称	描述	描述	是否必选	示例值	说明
despatch_datetime	String	发货日期/时间	是	20240627	格式：CCYYMMDD
delivery_datetime	String	交货日期/时间	否	20240715	格式：CCYYMMDD
estimated_arrival_date	String	预计到货日期/时间	是	20240715	格式：CCYYMMDD
bill_of_lading	String	提货单编号	是	PL123456987
packing_list_number	String	装运箱编号	是	PL2404120011
carrier_gross_weight	Number	装运毛重（单位：KG）	是	520.00	ASN 中所有货物总毛重（精确到小数点后两位）
carrier_net_weight	Number	装运净重（单位：KG）	否	480.00	ASN 中所有货物总净重（精确到小数点后两位）
weight_unit	String	重量单位	是	KG
quantity_of_pack	String	装运包裹数量	是	33
package_type	String	包裹类型	是	PCK90
carrier_bill_number	String	承运人编号	否	CN00001
carrier_scac	String	承运人 SCAC 代码	否	UPSN	一般由四位字母组成
transport_mode	String	运输方式	否	A	(A) Air (AE) Air Express (LT) Less than trailer load (M) Motor (Full truck) (R) Rail (SE) Sea
equipment_unit	String	运输设备代码 (Equipment Description Code)	否	TL	(CN) Container (RR) Railcar (TE) Trailer (TL) Trailer (not otherwise specified)
equipment_initial	String	运输识别编号或前缀	是	UPSN
equipment_number	String	运输设备编号 (运输车号或海运集装箱编号)	是	200003211	客户运输设备编号
ship_from_party_id	String	发货地 ID	是		根据 agency_code 参数，一般是 92，由客户 (买方) 提供
ship_from_party_name	String	发货地名称	是
ship_from_agency_code	String	发货地编号类型	是	91	(91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent
ship_from_address	String	地址	是
ship_from_address_info	String	详细地址	否
ship_from_city_name	String	城市	否
ship_from_state_province_code	String	省/州编码	否
ship_from_postal_code	String	邮政编码	否
ship_from_country_code	String	国家/地区编号	否
ship_to_party_id	String	收货地 ID	是		根据 agency_code 参数，一般是 92，由客户 (买方) 提供
ship_to_party_name	String	收货地名称	是
ship_to_agency_code	String	收货地编号类型	是	92	(91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent
ship_to_address	String	地址	是
ship_to_address_info	String	详细地址	否
ship_to_city_name	String	城市	否
ship_to_state_province_code	String	省/州编码	否
ship_to_postal_code	String	邮政编码	否
ship_to_country_code	String	国家/地区编号	否
no_packages.no_packages_loop	Array	产品明细

no_packages_loop 参数

参数名称	描述	描述	是否必选	示例值	说明
no_package_type	String	包装类型	是	PCK90
no_package_type_agency_code	String	包装类型代码	是	92	(91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent
quantity_of_pack	String	包裹数量	是	33
package_gross_weight	String	每包净重	是	15
package_net_weight	String	每包毛重	否	13
weight_unit	String	重量单位	是	KG
purchase_order_number	String	采购订单编号	是	5526931007
purchase_order_date	String	订单日期	是	20240706	格式：CCYYMMDD
line_items.line_item_loop	Array	物料明细	是

line_item_loop 参数

参数名称	描述	描述	是否必选	示例值	说明
buyer_item_number	String	买方/采购方物料编号	是	89519892
seller_catalog_number	String	卖方产品编号	是	PK10001
quantity	Number	发货数量	是	8808	包装中物料数量（整数）
quantity_unit	String	数量单位	是	EA
order_line_number	String	订单行号	是	00010	来自采购订单中的物料行号
country_origin	String	原产国	是	CN

返回参数

参数名称	类型	描述	示例值	说明
status	Boolean	返回状态	true	true or false
message	String	返回消息内容	xxx
data	Object	返回数据
data.serial_number	String	交付单序列编号	1360053108683337728

示例

请求示例

此处为通用配置下的请求示例，可选字段可设置为空字符串。

json5

{
  "project_key": "ChinLink",
  "action_type": "delivery",
  "content": {
    "despatch_datetime": "20250218",
    "delivery_datetime": "",
    "estimated_arrival_date": "20250228",
    "bill_of_lading": "PL00001",
    "carrier_gross_weight": "407.2",
    "weight_unit": "KG",
    "package_type": "PCK90",
    "quantity_of_pack": "33",
    "quantity_unit": "EA",
    "carrier_bill_number": "CN00001",
    "transport_mode": "A",
    "carrier_scac": "UPSN",
    "no_packages": {
      "no_package_loop": [
        {
          "no_package_type": "PCK90",
          "no_package_type_agency_code": "92",
          "quantity_of_pack": "12",
          "package_gross_weight": "15",
          "weight_unit": "KG",
          "purchase_order_number": "5526931007",
          "purchase_order_date": "20240706",
          "line_items": {
            "line_item_loop": [
              {
                "buyer_item_number": "89519892",
                "seller_catalog_number": "PK10001",
                "quantity": "8808",
                "quantity_unit": "EA",
                "order_line_number": "00010",
                "country_origin": "CN"
              }
            ]
          }
        },
        {
          "no_package_type": "PCK90",
          "no_package_type_agency_code": "92",
          "quantity_of_pack": "11",
          "package_gross_weight": "15",
          "weight_unit": "KG",
          "purchase_order_number": "5526931008",
          "purchase_order_date": "20240706",
          "line_items": {
            "line_item_loop": [
              {
                "buyer_item_number": "89519893",
                "seller_catalog_number": "PK10002",
                "quantity": "8720",
                "quantity_unit": "EA",
                "order_line_number": "00010",
                "country_origin": "CN"
              }
            ]
          }
        }
      ]
    },
    "ship_from_party_id": "1001",
    "ship_from_agency_code": "91",
    "ship_from_address": "Fenghui South Road, High tech Zone",
    "ship_from_address_info": "1107B, Building B, Huajing Plaza, No. 20",
    "ship_from_party_name": "Xi'an ChinLink Technology Co., Ltd.",
    "ship_from_city_name": "Xi'an",
    "ship_from_street": "",
    "ship_from_state_province_code": "XA",
    "ship_from_postal_code": "710075",
    "ship_from_country_code": "CN",
    "ship_to_party_id": "1101",
    "ship_to_agency_code": "92",
    "ship_to_address": "Ship To Address",
    "ship_to_address_info": "Ship To Address Info",
    "ship_to_party_name": "Ship To Name",
    "ship_to_city_name": "Ship To City",
    "ship_to_street": "",
    "ship_to_state_province_code": "",
    "ship_to_postal_code": "111000",
    "ship_to_country_code": "US"
  }
}

返回示例

正常返回示例

json5

{
    "success": true,
    "message": "",
    "data": {
        "serial_number": "1360053108683337728",
    }
}

异常返回示例

json5

{
    "status": false,
    "message": " Failed message."
}

API 请求示例

创建发票单据

💡

通过 API 接口，将线下发票信息，提交给 EDI 系统，通过 EDI 系统生成 810 或 INVOIC 报文，并发送给客户。

请求说明

请求地址	https://xxx.xxx.xxx.xxx:8481/api/delivery/saveData
请求方法	POST

请求参数

Body 参数

参数名称	描述	描述	是否必选	示例值	说明
project_key	String	项目标识	是	ChinLink	项目标识由畅链科技分配
action_type	String	发送报文类型标识	是	invoice	固定值
content	Json	发送报文内容	是

content 参数

参数名称	描述	描述	是否必选	示例值	说明
purchase_order_number	String	采购订单编号	是	10193220643
purchase_order_date	String	订单日期	是	20240627	格式：CCYYMMDD
invoice_number	String	发票号	是	20240715120603
total_invoice_amount	Number	发票总额	是	547.04
currency_code	String	货币代码	是	USD
trade_tax_type_code	String	贸易税类型代码	否	LS	(LS) State and Local Sales Tax
trade_tax_amount	String	税额	否
ship_to_party_id	String	收货地 ID	是
ship_to_party_name	String	收货地名称	是
ship_to_agency_code	String	收货地编号类型	是	92	(91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent
ship_to_address	String	地址	是
ship_to_address_info	String	详细地址	否
ship_to_city_name	String	城市	否
ship_to_state_province_code	String	省/州编码	否
ship_to_postal_code	String	邮政编码	否
ship_to_country_code	String	国家/地区编号	否
bill_to_party_id	String	付款方 ID	是
bill_to_party_name	String	付款方名称	是
bill_to_agency_code	String	付款方编号类型	是	92	(91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent
bill_to_address	String	地址	是
bill_to_address_info	String	详细地址	否
bill_to_city_name	String	城市	否
bill_to_state_province_code	String	省/州编码	否
bill_to_postal_code	String	邮政编码	否
bill_to_country_code	String	国家/地区编号	否
invoice_issuer_party_id	String	发票开具人 ID	是
invoice_issuer_party_name	String	发票开具人名称	是
invoice_issuer_agency_code	String	发票开具人编号类型	是	91	(91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent
invoice_issuer_address	String	地址	是
invoice_issuer_address_info	String	详细地址	否
invoice_issuer_city_name	String	城市	否
invoice_issuer_state_province_code	String	省/州编码	否
invoice_issuer_postal_code	String	邮政编码	否
invoice_issuer_country_code	String	国家/地区编号	否
invoice_items.invoice_item_loop	Array		是
spac_items.spac_item_loop	Array		否

invoice_items.invoice_item_loop 参数

参数名称	描述	描述	是否必选	示例值	说明
line_item_number	String	物料行号	是	00010	来自采购订单中的物料行号
buyer_part_number	String	买方/采购方物料编号	是	5800000001
quantity_invoiced	String	已开票数量	是	32
quantity_unit	String	数量单位	是	EA
unit_price	String	单价	是	16.47
unit_price_basis_code	String	价格基数代码	是	PE	(PE) Price per Each (PN) Price per Ten (HP) Price per Hundred (TP) Price per Thousand
invoice_item_amount	String	开票金额	是	527.04

spac_items.spac_item_loop 参数

参数名称	描述	描述	是否必选	示例值	说明
allowance_charge_indicator	String	服务津贴或费用类型	是	C	(A) Allowance (C) Charge (N) No Allowance or Charge (P) Promotion (Q) Charge Request (R) Allowance Request (S) Service
service_charge_type	String	付费类型(服务、促销、津贴或收费)	是	D500	(C310) Discount (D240) Freight (D500) Handling
service_charge_amount	String	付费金额	是	20

返回参数

参数名称	类型	描述	示例值	说明
status	Boolean	返回状态	true	true or false
message	String	返回消息内容	xxx
data	Object	返回数据
data.serial_number	String	交付单序列编号	1360053108683337728

示例

请求示例

此处为通用配置下的请求示例，可选字段可设置为空字符串。

json5

{
  "project_key": "ChinLink",
  "action_type": "invoice",
  "content": {
    "purchase_order_number": "10193220643",
    "purchase_order_date": "20240627",
    "invoice_number": "20240715120603",
    "total_invoice_amount": "520.04",
    "currency_code": "USD",
    "invoice_items": {
      "invoice_item_loop": [
        {
          "line_item_number": "00010",
          "buyer_part_number": "5800000001",
          "quantity_invoiced": "32",
          "quantity_unit": "EA",
          "unit_price": "16.47",
          "unit_price_basis_code": "PE",
          "invoice_item_amount": "527.04"
        }
      ]
    },
    "spac_items": {
      "spac_item_loop": [
        {
          "allowance_charge_indicator": "C",
          "service_charge_type": "D500",
          "service_charge_amount": "20"
        }
      ]
    },
    "ship_to_party_id": "1101",
    "ship_to_agency_code": "92",
    "ship_to_address": "Ship To Address",
    "ship_to_address_info": "Ship To Address Info",
    "ship_to_party_name": "Ship To Name",
    "ship_to_city_name": "Ship To City",
    "ship_to_street": "",
    "ship_to_state_province_code": "",
    "ship_to_postal_code": "111000",
    "ship_to_country_code": "US",
    "bill_to_party_id": "1102",
    "bill_to_agency_code": "92",
    "bill_to_address": "Bill To Address",
    "bill_to_address_info": "Bill To Address Info",
    "bill_to_party_name": "Bill To Name",
    "bill_to_city_name": "Bill To City",
    "bill_to_street": "",
    "bill_to_state_province_code": "NL",
    "bill_to_postal_code": "111222",
    "bill_to_country_code": "MX",
    "invoice_issuer_party_id": "1001",
    "invoice_issuer_agency_code": "91",
    "invoice_issuer_address": "Fenghui South Road, High tech Zone",
    "invoice_issuer_address_info": "1107B, Building B, Huajing Plaza, No. 20",
    "invoice_issuer_party_name": "Xi'an ChinLink Technology Co., Ltd.",
    "invoice_issuer_city_name": "Xi'an",
    "invoice_issuer_street": "",
    "invoice_issuer_state_province_code": "XA",
    "invoice_issuer_postal_code": "710075",
    "invoice_issuer_country_code": "CN"
  }
}

返回示例

正常返回示例

json5

{
    "success": true,
    "message": "",
    "data": {
        "serial_number": "1360053108683337728",
    }
}

异常返回示例

json5

{
    "status": false,
    "message": " Failed message."
}

API 请求示例

发送交付单（发货通知/发票）

💡

通过发送接口 API，将已创建成功的发货通知单或发票单据，通过 EDI 发送给客户。
发送报文业务处理逻辑，异步执行

请求说明

请求地址	https://xxx.xxx.xxx.xxx:8481/api/file/action/delivery
请求方法	POST

请求参数

Bearer auth 认证参数

参数名称	描述	描述	是否必选	示例值	说明
access_token	String	Token	是	eyJhbGciOi...	通过登录授权接口获取

Body 参数

参数名称	描述	描述	是否必选	示例值	说明
project_key	String	项目标识	是	ChinLink	项目标识由畅链科技分配
action_type	String	发送报文类型	是	send-inv	send-inv：发送发票 send-asn：发送发货通知
serial_number	String	交付单序列编号	是	1355079589866352640	创建发货通知单或者发票单据接口时，返回的交付单序列编号

返回参数

参数名称	类型	描述	示例值	说明
status	Boolean	返回状态	true	true or false
message	String	返回消息内容	xxx

返回示例

正常返回示例

json5

{
  "data": true,
  "code": 0,
  "message": null,
  "success": true
}

异常返回示例

json5

{
    "data": null,
    "code": 500,
    "message": "Please configure the root directory of the project.",
    "success": false
}

参与方地址信息列表

请求说明

请求地址	https://xxx.xxx.xxx.xxx:8481/api/location/list
请求方法	GET

请求参数

Bearer auth 认证参数

参数名称	描述	描述	是否必选	示例值	说明
access_token	String	Token	是	eyJhbGciOi...	通过登录授权接口获取

参数名称	描述	描述	是否必选	示例值	说明
Return-Type	String	接口返回类型	是	DocumentData	固定值

返回参数

参数名称	类型	描述	示例值	说明
status	Boolean	返回状态	true	true or false
message	String	返回消息内容	xxx
data	Array	返回地址信息集合

data 参数说明

参数名称	类型	描述	示例值	说明
location_id	String	地址信息 ID	24	地址信息唯一标识
party_id	String	参与方 ID 标识	1001
party_name	String	参与方名称	Xi'an ChinLink Technology Co., Ltd.
agency_code	String	机构编码(用于标识参与方信息来源)	92	(1) D-U-N-S Number, Dun & Bradstreet (9) D-U-N-S+4, D-U-N-S Number with Four Character Suffix (10) ODETTE (14) UCC/EAN Location Code Prefix (16) DUNS (91) Assigned by seller or seller's agent (92) Assigned by buyer or buyer's agent (ZZ) Mutually Defined
address	String	地址信息	Fenghui South Road, High tech Zone	不超过 35 个字符
address_info	String	地址信息详情	1107B, Building B,	不超过 35 个字符
street	String	街道信息	Huajing Plaza, No. 20
city_name	String	城市名称	Xi'an
state_province_code	String	州/省编码	XA
postal_code	String	邮政区号	710065
country_code	String	国家/地区代码	CN	例如： CN、US、HK

API 请求示例

参与方地址信息（通过 ID 查询）

请求说明

请求地址	https://xxx.xxx.xxx.xxx:8481/api/location/info/{location_id}
请求方法	GET

请求参数

Bearer auth 认证参数

参数名称	描述	描述	是否必选	示例值	说明
access_token	String	Token	是	eyJhbGciOi...	通过登录授权接口获取

参数名称	描述	描述	是否必选	示例值	说明
Return-Type	String	接口返回类型	是	DocumentData	固定值

Path 参数

参数名称	描述	描述	是否必选	示例值	说明
location_id	String	地址信息 ID	是	44	地址信息唯一标识

返回参数

参数名称	类型	描述	示例值	说明
status	Boolean	返回状态	true	true or false
message	String	返回消息内容	xxx
data	Object	返回数据

data 参数说明

参考 参与方地址信息列表 接口文档中 data 参数说明。

返回示例

json5

{
  "data": {
    "location_id": 24,
    "name": "ChinLink",
    "party_id": "1001",
    "party_name": "Xi'an ChinLink Technology Co., Ltd.",
    "agency_code": "92",
    "address": "Fenghui South Road, High tech Zone",
    "address_info": "1107B, Building B",
    "street": "Huajing Plaza, No. 20",
    "city_name": "Xi'an",
    "state_province_code": "XA",
    "postal_code": "710065",
    "country_code": "CN"
  },
  "code": 0,
  "success": true
}

WebEDI API 接口文档 ​

登录授权接口 ​

请求说明 ​

请求参数 ​

Body 参数 ​

返回参数 ​

返回示例 ​

API 请求示例 ​

订单列表-仅包含订单主信息（分页查询） ​

请求说明 ​

请求参数 ​

Bearer auth 认证参数 ​

Header 参数 ​

Body 参数 ​

返回参数 ​

data.records 参数说明 ​

API 请求示例 ​

订单列表-包含订单详情（分页查询） ​

请求说明 ​

请求参数 ​

Bearer auth 认证参数 ​

Header 参数 ​

Body 参数 ​

返回参数 ​

data.records 参数说明 ​

API 请求示例 ​

订单详情（通过订单序列编号查询） ​

请求说明 ​

请求参数 ​

Bearer auth 认证参数 ​

Header 参数 ​

Path 参数 ​

返回参数 ​

data.document_data 参数说明 ​

Detail_Items.Detail_Item_Loop 参数说明 ​

Plan_Items.Plan_Item_Loop 参数说明 ​

响应示例 ​

API 请求示例 ​

订单查询（通过订单编号查询） ​

请求说明 ​

请求参数 ​

Bearer auth 认证参数 ​

Header 参数 ​

Path 参数 ​

Request 参数 ​

返回参数 ​

API 请求示例 ​

创建发货通知单 ​

请求说明 ​

请求参数 ​

Body 参数 ​

content 参数 ​

no_packages_loop 参数 ​

line_item_loop 参数 ​

返回参数 ​

示例 ​

请求示例 ​

返回示例 ​

API 请求示例 ​

创建发票单据 ​

请求说明 ​

请求参数 ​

Body 参数 ​

content 参数 ​

invoice_items.invoice_item_loop 参数 ​

spac_items.spac_item_loop 参数 ​

返回参数 ​

示例 ​

请求示例 ​

返回示例 ​

API 请求示例 ​

发送交付单（发货通知/发票） ​

请求说明 ​

请求参数 ​

Bearer auth 认证参数 ​

Body 参数 ​

返回参数 ​

返回示例 ​

参与方地址信息列表 ​

请求说明 ​

WebEDI API 接口文档

登录授权接口

请求说明

请求参数

Body 参数

返回参数

返回示例

API 请求示例

订单列表-仅包含订单主信息（分页查询）

请求说明

请求参数

Bearer auth 认证参数

Header 参数

Body 参数

返回参数

data.records 参数说明

API 请求示例

订单列表-包含订单详情（分页查询）

请求说明

请求参数

Bearer auth 认证参数

Header 参数

Body 参数

返回参数

data.records 参数说明

API 请求示例

订单详情（通过订单序列编号查询）

请求说明

请求参数

Bearer auth 认证参数

Header 参数

Path 参数

返回参数

data.document_data 参数说明

Detail_Items.Detail_Item_Loop 参数说明

Plan_Items.Plan_Item_Loop 参数说明

响应示例

API 请求示例

订单查询（通过订单编号查询）

请求说明

请求参数

Bearer auth 认证参数

Header 参数

Path 参数

Request 参数

返回参数

API 请求示例

创建发货通知单

请求说明

请求参数

Body 参数

content 参数

no_packages_loop 参数

line_item_loop 参数

返回参数

示例

请求示例

返回示例

API 请求示例

创建发票单据

请求说明

请求参数

Body 参数

content 参数

invoice_items.invoice_item_loop 参数

spac_items.spac_item_loop 参数

返回参数

示例

请求示例

返回示例

API 请求示例

发送交付单（发货通知/发票）

请求说明

请求参数

Bearer auth 认证参数

Body 参数

返回参数

返回示例

参与方地址信息列表

请求说明