领航思域业务系统
  1. 运单管理
领航思域业务系统
  • 对接说明
  • 令牌管理
    • 令牌获取
      POST
  • 基础管理
    • 业务类型列表
      GET
    • 仓库资料列表
      GET
    • 渠道资料列表
      GET
  • 产品管理
    • 产品资料新建
      POST
    • 产品资料列表
      POST
  • 库存管理
    • 单个库存查询
      POST
    • 批量库存查询
      POST
  • 入库管理
    • 入库委托新建
      POST
    • 入库委托取消
      POST
    • 入库委托查询
      POST
  • 出库管理
    • 出库委托创建
      POST
    • 出库委托取消
      POST
    • 出库委托查询
      POST
  • 运单管理
    • 运单委托新建
      POST
    • 运单委托取消
      POST
    • 运单委托查询
      POST
  1. 运单管理

运单委托新建

POST
/api/v1/shipment/create

请求参数

Header 参数
Authorization
string 
可选
默认值:
Bearer {{token}}
Content-Type
string 
可选
默认值:
application/json
Body 参数application/json
referenceNumber
string 
参考单号
必需
参考单号需要是唯一值,可以是平台唯一订单号,内部ERP唯一单号等,运单委托取消后,参考单号不可重复利用
businessCode
string 
业务编码
必需
FBWS=仓储服务,FBTS=中转服务,FBRS=退件服务,FBDS=直发服务,FBSS=报废服务,FBPS=打单服务,FBLS=换标服务,FBCS=集运服务
warehouseCode
string 
仓库编码
必需
channelCode
string 
渠道编码
必需
confirmFlag
boolean 
确认标识
必需
true=自动确认,false=手动确认(出库委托创建成功后,需要登录OMS系统手动确认)
platformCode
string 
平台编码
可选
shopCode
string 
店铺编码
可选
cargoType
string 
货物类型
必需
PACKAGE=包裹,PALLET=托盘,CONTAINER=柜子,BAG=袋子,FILE=文件
incotermType
string 
贸易条款
可选
DDP,DDU
signatureType
string 
签名类型
可选
insuranceType
string 
保险类型
可选
insuranceAmount
number 
保险金额
可选
insuranceCurrency
string 
保险币种
可选
codAmount
number 
COD金额
可选
codCurrency
string 
COD币种
可选
declareType
string 
申报类型
可选
batteryFlag
boolean 
是否带电池标识
必需
true=带电池,false=不带电池
batteryType
string 
电池类型
可选
PI966=锂电池(锂离子电池与产品设备分开包装,电池不安装在产品设备上),PI967=内锂电池(锂电池安装在产品设备上包装),PI969=锂金属电池(锂金属电池与产品设备分开包装,电池不安装在产品设备上),PI970=内金属电池(锂金属安装在产品设备上包装)
remark
string 
备注
可选
sender
object 
发件信息
可选
name
string 
姓名
必需
tag
string 
地址标签
可选
Commercial=商业,Residential=住宅
company
string 
公司
可选
phone
string 
电话
必需
email
string 
邮箱
可选
country
string 
国家/地区
必需
province
string 
省/州
可选
city
string 
城市
必需
county
string 
区/县
可选
address1
string 
地址1
必需
address2
string 
地址2
可选
address3
string 
地址3(门牌号)
可选
zipCode
string 
邮编
必需
identificationNumber
string 
证件号码/统一社会信用代码
可选
registrationNumber
string 
注册号/税号
可选
registrationType
string 
注册号/税号类别
可选
VAT,IOSS,DAN,DTF,TAN,DUN,EIN,EOR,FED,FTZ,RGP,SSN,STA,CNP,SDT,DLI,NID,PAS
registrationCountry
string 
注册号/税号国家
可选
receiver
object 
收件信息
必需
name
string 
姓名
必需
tag
string 
地址标签
可选
Commercial=商业,Residential=住宅
company
string 
公司
可选
phone
string 
电话
必需
email
string 
邮箱
可选
country
string 
国家/地区
必需
province
string 
省/州
可选
city
string 
城市
必需
county
string 
区/县
可选
address1
string 
地址1
必需
address2
string 
地址2
可选
address3
string 
地址3(门牌号)
可选
zipCode
string 
邮编
必需
identificationNumber
string 
证件号码/统一社会信用代码
可选
registrationNumber
string 
注册号/税号
可选
registrationType
string 
注册号/税号类别
可选
VAT,IOSS,DAN,DTF,TAN,DUN,EIN,EOR,FED,FTZ,RGP,SSN,STA,CNP,SDT,DLI,NID,PAS
registrationCountry
string 
注册号/税号国家
必需
packages
array [object {8}] 
包裹信息
必需
packageIndex
integer 
包裹序号
必需
packageWeight
integer 
包裹重量
可选
packageLength
integer 
包裹长度
可选
packageWidth
integer 
包裹宽度
可选
packageHeight
integer 
包裹高度
可选
originalNumber
string 
原始单号
可选
对应客户原始包裹单号/原始分箱单号,不可重复
trackNumber
string 
跟踪单号
可选
products
array [object {24}] 
产品信息
必需
示例
{
	"referenceNumber": "11206808302",
	"businessCode": "FBDS",
	"warehouseCode": "USNJ",
	"channelCode": "SELF-4PX",
	"confirmFlag": true,
	"platformCode": "Shopify",
	"shopCode": null,
	"cargoType": "PACKAGE",
	"incotermType": null,
	"signatureType": "",
	"insuranceType": "",
	"insuranceAmount": 0.0,
	"declareType": "",
	"batteryFlag": "false",
	"batteryType": "",
	"remark": "",
	"sender": {
		"name": "TEST",
		"tag": null,
		"company": null,
		"email": "lingwu.zeng@foxmail.com",
		"phone": "18318057375",
		"country": "CN",
		"province": "guangdong",
		"city": "shenzhen",
		"county": "baoan",
		"address1": "fuhai streest junfeng build B101",
		"address2": null,
		"address3": null,
		"zipCode": "518003",
		"identificationNumber": null,
		"registrationNumber": null,
		"registrationType": null,
		"registrationCountry": null
	},
	"receiver": {
		"name": "Liam Tubach",
		"tag": null,
		"company": "",
		"email": "",
		"phone": "111-1111-111",
		"country": "US",
		"province": "OH",
		"city": "Loudonville",
		"county": "",
		"address1": "325 e Haskell st",
		"address2": "",
		"address3": "",
		"zipCode": "44842",
		"identificationNumber": null,
		"registrationNumber": "",
		"registrationType": "",
		"registrationCountry": ""
	},
	"packages": [
		{
			"packageIndex": 1,
			"packageWeight": 0.2,
			"packageLength": 10.0,
			"packageWidth": 8.0,
			"packageHeight": 5.0,
			"originalNumber": "",
			"trackNumber": "",
			"remark": null,
			"products": [
				{
					"productIndex": 1,
					"productSku": "03050606",
					"productFnsku": null,
					"productName": "2.4G无线电遥控设备配件:传感器",
					"productNameEn": "2.4G Radio System Accessories:Sensors",
					"productLink": null,
					"productLength": 1.0,
					"productWidth": 1.0,
					"productHeight": 1.0,
					"productWeight": 0.08,
					"productQuantity": 2,
					"unitPrice": 0.0,
					"currencyCode": "USD",
					"hsCode": "8529909090",
					"declareBrand": "FRSKY牌",
					"declareModel": "FR8501(HV5501)",
					"declareMaterial": null,
					"declarePurpose": "用于航模遥控附件传感器监测模型状态",
					"declareProperty": null,
					"declareUnit": "007",
					"declarePrice": 55.37,
					"declareCurrency": "USD",
					"originCountry": null,
					"originPlace": "32029"
				}
			]
		}
	]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://webapi.fulfillment.keythus.com/api/v1/shipment/create' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
	"referenceNumber": "11206808302",
	"businessCode": "FBDS",
	"warehouseCode": "USNJ",
	"channelCode": "SELF-4PX",
	"confirmFlag": true,
	"platformCode": "Shopify",
	"shopCode": null,
	"cargoType": "PACKAGE",
	"incotermType": null,
	"signatureType": "",
	"insuranceType": "",
	"insuranceAmount": 0.0,
	"declareType": "",
	"batteryFlag": "false",
	"batteryType": "",
	"remark": "",
	"sender": {
		"name": "TEST",
		"tag": null,
		"company": null,
		"email": "lingwu.zeng@foxmail.com",
		"phone": "18318057375",
		"country": "CN",
		"province": "guangdong",
		"city": "shenzhen",
		"county": "baoan",
		"address1": "fuhai streest junfeng build B101",
		"address2": null,
		"address3": null,
		"zipCode": "518003",
		"identificationNumber": null,
		"registrationNumber": null,
		"registrationType": null,
		"registrationCountry": null
	},
	"receiver": {
		"name": "Liam Tubach",
		"tag": null,
		"company": "",
		"email": "",
		"phone": "111-1111-111",
		"country": "US",
		"province": "OH",
		"city": "Loudonville",
		"county": "",
		"address1": "325 e Haskell st",
		"address2": "",
		"address3": "",
		"zipCode": "44842",
		"identificationNumber": null,
		"registrationNumber": "",
		"registrationType": "",
		"registrationCountry": ""
	},
	"packages": [
		{
			"packageIndex": 1,
			"packageWeight": 0.2,
			"packageLength": 10.0,
			"packageWidth": 8.0,
			"packageHeight": 5.0,
			"originalNumber": "",
			"trackNumber": "",
			"remark": null,
			"products": [
				{
					"productIndex": 1,
					"productSku": "03050606",
					"productFnsku": null,
					"productName": "2.4G无线电遥控设备配件:传感器",
					"productNameEn": "2.4G Radio System Accessories:Sensors",
					"productLink": null,
					"productLength": 1.0,
					"productWidth": 1.0,
					"productHeight": 1.0,
					"productWeight": 0.08,
					"productQuantity": 2,
					"unitPrice": 0.0,
					"currencyCode": "USD",
					"hsCode": "8529909090",
					"declareBrand": "FRSKY牌",
					"declareModel": "FR8501(HV5501)",
					"declareMaterial": null,
					"declarePurpose": "用于航模遥控附件传感器监测模型状态",
					"declareProperty": null,
					"declareUnit": "007",
					"declarePrice": 55.37,
					"declareCurrency": "USD",
					"originCountry": null,
					"originPlace": "32029"
				}
			]
		}
	]
}'

返回响应

🟢200成功
application/json
Body
success
boolean 
成功
必需
code
integer 
编码
必需
msg
string 
消息
必需
language
string 
语言
必需
data
string 
数据
必需
内部单号
示例
{
    "success": true,
    "code": 0,
    "msg": "成功",
    "language": "ZH",
    "data": "SC20091300001"
}
修改于 2024-12-30 13:18:39
上一页
出库委托查询
下一页
运单委托取消
Built with