前言

致各位小伙伴

    为方便广大电商伙伴、第三方开发商,将自有的包裹管理系统与顺友物流系统实现对接,特编写本文档,对 API 提供的功能进行说明,并提供示例源代码,请大家根据需要进行下载。

    问题反馈入口:https://www.sypost.com 底部投诉与建议

    正式启动开发之前,请联系我们并提供以下信息,我们为您提供专用的开发者Token。

公司名称
公司地址
公司网址
公司类型 电商卖家            第三方开发者
通过API操作账户数 一个顺友账户     多个顺友账户
API对接联系人
API对接联系人电话
API对接联系人QQ

访问TOKEN说明

    调用接口时头部信息需要提供2个token(apiLogUserToken 和 apiDevUserToken)

    apiLogUserToken为用户token,apiDevUserToken为开发者token。

    以bash命令为例,把密钥设置到头信息中。

					
  curl -X POST \
    --header 'apiLogUserToken:User Token' \
    --header 'apiDevUserToken:Developer Token' \
    --data '{}' \
  https://sandbox-api.sypost.cn/logistics/createAndConfirmPackages
					
				

SDK版本下载

版本号 描述 更新时间 操作
v1.0.0 Java 1.0.0版本 2025-10-24 下载
    如果您是电商卖家,您在注册时,我们已经为您默认分配了apiLogUserToken和apiDevUserToken,您可以登录我们的客户系统前往【系统设置】-【开发者】中查看。

    如果您是第三方开发者,请联系我们申请一个开发者token,当您申请到开发者token之后,结合客户(同时也是顺友客户)提供的用户token,即可通过API操作对应账户的包裹数据。

测试环境

    为方便广大电商伙伴、第三方开发商的包裹管理系统与顺友物流代理系统实现对接,顺友物流代理系统特别提供Sandbox测试环境,您需要直接使用表 1 1给出的信息登录Sandbox账号,查看该账号的User Token,使用该token以及Sandbox接口地址进行完整的系统功能测试,使用该token提交的数据,登录对应的测试账号(可自行注册)即可查看。

Sandbox客户系统 https://sandbox-client.sypost.cn
Sandbox登录账号 developer_guest
Sandbox登录密码 developer_guest01
Sandbox API地址 https://sandbox-api.sypost.cn/logistics
User Token Sandbox环境登录后在[设置]-[我的账户]-[开发者]界面查看。
Developer Token Sandbox环境登录后在[设置]-[我的账户]-[开发者]界面查看。

使用约定

    1.使用测试账号可以对Sandbox环境的全部功能进行测试,同一个账号同一接口每分钟内线程不能超过100个,请合理安排您的开发工作。

    2.使用测试账号提交需要追踪号之邮寄方式的包裹信息时,系统返回的追踪号,均为无效追踪号,请切勿在您的包裹面单上使用,以免给您的发货工作带来延误。

    3.每周日的凌晨0:00,我们将对测试账号中的数据进行清理,每次清理的数据为提交至系统中已超过30天的数据,假如某个周日的日期为“2020年11月29日”,那么我们将于当天的凌晨0:00整,一次性清理掉2020年10月31日 0:00之前创建的所有包裹。

    4.清理包裹信息时,测试账号中与被清理的包裹相关的账单信息、报关信息等,将一同被清理。

    5.测试环境的数据清理工作,恕不能提前给出通知,请您谅解,您首次使用顺友物流代理系统的测试账号登录或使用测试token进行API连接,我们将视为您已经接受我们在本文中描述的所有约定。

生产环境

前台地址 https://www.sypost.com
登录账号 您在顺友物流注册的账号。
登录密码 您在顺友物流注册账号时预留的密码。
API地址 https://api.sypost.com/logistics
User Token 请登录顺友物流管理系统,在[设置]-[我的账户]-[开发者]界面查看。
Developer Token 请登录顺友物流管理系统,在[设置]-[我的账户]-[开发者]界面查看。

使用约定

     1.使用本文中描述的API接口提交数据时,同一个账号同一接口每分钟内线程不能超过100个,请合理安排您的开发工作。

     2.生产环境的数据长年积累,将影响您的使用体验,我们每天凌晨1:00对数据进行归档,归档的包裹范围暂时为:创建时间已超过3年的包裹(退件等异常包裹除外),已归档的数据,您登录账号后将无法查看,如果您需要使用这些数据,请及时对您的私人数据进行备份。

     3.请认真审查贵公司开发的代码,一旦发现存在恶意攻击,影响其他公司正常数据的提交时,我司有权单方面停止贵公司API接入权限。

     4.您首次使用顺友物流代理系统的生产环境账号登录或使用生产环境API Token进行API连接时,我们将视为您已经接受我们在本文中描述的所有约定。

与我们联系

界面操作等业务相关问题 QQ群:469953878(建议加入,后续操作功能调整会优先发布通知此群)
API对接等技术相关问题 QQ群:469953878(建议加入,后续API功能调整会优先发布通知此群)

接口简介

接口名称 功能 备注
createAndConfirmPackages 创建并预报包裹 4.01
getPackagesDetails 获取包裹详情 4.02
getPackagesStatus 获取包裹状态 4.03
getPackagesTrackingNumber 获取包裹追踪号 4.04
getPackagesLabel 获取包裹面单 4.05
deletePackages 删除包裹 4.06
findShippingMethods 查询邮寄方式 4.07
operationPackages 修改重量和尺寸 4.08
interceptionPackages 拦截包裹 4.09
returnPackages 包裹退件 4.10
getPackagesShippmentProof 包裹发货证明 4.11
getPackagesDeliveryProof 包裹妥投证明 4.12
getFreightTrialCalculation 包裹运费试算 4.13
getUserFinancialFee 获取用户余额 4.14

调用方式

接口类型 HTTP (Post)
参数格式 JSON
编码格式 UTF-8
接口地址 {生产或测试环境的API地址}/{接口名称}
例如批量创建并预报包裹的接口调用地址为:
https://sandbox-api.sypost.cn/logistics/createAndConfirmPackages