开始前必读

在使用百分仓储开放接口前，必须先绑定邮箱，然后退出登录使用邮箱登录进入开发者模式。

在开发者模式下进入管理后台首页可以看到“+创建应用”按钮。填写应用名称和回调地址即可创建成功。

点击应用名可获得client id和client secret。

每个账号最多可以创建3个应用。

请自行理解OAuth2基本原理。

错误码

2000  SUCCESS     

4000  ERROR    

4001  未选择任何产品   

4002  数量不足   

4003  已经存在   

4005  已经存在SKU   

4006  标签为空   

4007  无此产品      

4009  数量错误   

4010  缺货出库    

4012  账户金额不足   

4013  未选中任何配送方式    

4016  非数字   

4017  未填必填项   

4018  无此权限操作

4019  重复操作   

4020  不是正数   

4021  找不到   

4022  SKU过长   

4023  SKU非法   

4024  丢失   

4025  已经支付   

4026  存在订单已经取消   

4027  没有新条目   

4028  不存在   

4029  不足   

4030  超重  

4031  地址错误   

4032  未完成   

4033  不允许   

4034  必须是正数   

4035  SKU必须填写   

4036  长宽高填写有误    

4038  还没准备好   

4039  已经处理过   

4043  联系管理员   

4044  过时了   

4045  电话号码不合法

获取授权码

百分仓储采用使用OAuth2授权码模式，这意味着客户端需要使用授权码来获取令牌。 构造如下规则的访问链接，将用户导向到百分仓储授权页面。其中redirect_uri必须是在百分仓储注册的相同的回调地址，当用户授权访问之后，将跳转到回调地址并传递授权码：code。需要注意的是用户必须同样以EMAIL登录才能成功跳转到回调地址。

接口URL

https://www.procentwarehouse.com/oauth/authorize?client_id=1&redirect_uri=https://your.app/callback&response_type=code&scope=basic

请求方式

GET

请求Query参数

参数 示例值 必填 参数描述
client_id 1 必填 -
redirect_uri https://your.app/callback 必填 -
response_type code 必填 -
scope basic 必填 -

获取访问令牌

OAuth2中一旦得到授权码就可以通过它来获取访问令牌(access_token)，然后通过访问令牌来获取/更新百分仓储的资源。

接口URL

https://www.procentwarehouse.com/oauth/token

请求方式

POST

请求 Content-Type

application/x-www-form-urlencoded

请求自定义Header

参数 示例值 必填 参数描述
Content-Type application/x-www-form-urlencoded 必填 -

请求Body参数

参数 示例值 必填 参数描述
client_secret MOIyWzZAo3HCOnBoyRg8lwFpNimYQ02OcQDoQtIH 必填 client secret
client_id 1 必填 client id
grant_type authorization_code 必填 -
redirect_uri https://your.app/callback 必填 回调地址
code def501006b3b4b0e8e85c9464d0afe1dd4912cd5551a2932c5468c58839f3ea30826178103926fc1c1dfb37c724d151d2838a5040450aac779d90db4a7d15691f8617a26d7e37158c2204d08d9414bb9b4b84098d4268e5dd95d8bc0acec1e85fde022fbce6b03a5f3b8c46a0cffa2212965c780c891893f52439df4fcf7a4957c2a1b5171dd2a4ed0e1b17d2d1f16df51492157563279d3fc8cf97d24c1f94215e034e7629b027778a3a85fcc88ad129466bb43159dc554970a38d4b9aa51d5b46b4cfc199fa88efb70ff0bb2dcffe3ff0dad0222fe81fc272a4ff772c5500af70686cbb27e26963796f0d9bd212025cae63c26de695844998450540c37c7e386510ffb28a737689cd2ce4483c811da9f577b5dc00ff6e252a7ddef5cb90726de0eee38c7a5e39afea5c223b09fa306f1bba1056fa09456517f23b1f3e6557b5d9060b34ed6e0a7ae765d8befa6e289e018f1f742cb740b23512fab31c2702df6b4adf9 必填 授权码

成功响应示例

{
    "token_type": "Bearer",
    "expires_in": 86399,
    "access_token": "eyJ0eXAiOiJKV1QiLEfhbGciOiJSUzI1NiIsImp0aSI6IjkxMDhhOTUyYTQ2OWI3ZTI1MjllYzliMjVlODViYzYxNDg0MTRlZGQ1NGVkMGQ5MmFkMmQ0ZmIzNmI1OGRlYTNkZTI2NjRkYTIxMDFiNjQyIn0.eyJhdWQiOiIxIiwianRpIjoiOTEwOGE5NTJhNDY5YjdlMjUyOWVjOWIyNWU4NWJjNjE0ODQxNGVkZDU0ZWQwZDkyYWQyZDRmYjM2YjU4ZGVhM2RlMjY2NGRhMjEwMWI2NDIiLCJpYXQiOjE1NzU1Mjc3NTQsIm5iZiI6MTU3NTUyNzc1NCwiZXhwIjoxNTc1NjE0MTUzLCJzdWIiOiI0MzQiLCJzY29wZXMiOlsiYmFzaWMiXX0.o28YBNUHbfAlSEXjVNcJUNX_krP7bsgLPK8SjC8zzmtpaZMy5RnQTA5I5tLFtShtvXzqfcn_VHjEM-KH4fozGAviiFKg52q41rNbNC_-aRiwQF1if-iEivrvPFIDrxy0pMIaLKmEKHlhIPEreiY_dIlTwMo2mefFz77AmAqDePajpF5qR2BcDBsJj8aRm1nU1sS__3XLmvDXNQe6XzodmilgktzZJ72AM38JVLDi-D_j6v_uwbZFpBO4ORUpGkiHr63Wyw0DonulDYZSqxE8bnG33vbYEhUdEbIEKeQwExiQBoK97QkCmFEdbZsieY7iNJpNmBvthGRAwB-UQoK-D0FvBNFNJi6aGR_NLN-ngmSxXfMgqTKqrBSE-MbUyABchLHHoghnyrEyB0JFi5C9F0yxERt4puyh7lTodksWTBjU82SvxiE2ju3z1ftxbFbx-y6v5K9zfLyzGJ7WNJCfy5rJ_P5ejdvoWzueQntaA-Q7YT0cSbHf_FeIgPzInkWP3F63EdfriZbuXlD4HdjWpzXyp6tD_4EzICTweV-nXtelEo8SR4vILHfzR1QFb3lSxaz7syue8JIMogZa5EMvtT0kFi8DOFb9pnitmr7Y_6E-COWFK6w-W7cnVm4TX1MuKjgZJ-hP2LiRH3rf9pTuKH7vZ4voNUK8YX-qaDbbLO8",
    "refresh_token": "def502003f5fd9e9ff15eb423d3668dff38279b5ba96863240be77c2a78719ad0bb1c04e3419f2093046ca9a412323a37baa185c87ab6769bd89735a69d4c613526792b5112b5861260780e76f658937fb40276d1a51c7dcf538df2987e1e6e64ad6832c7bd0111902fc8739eba5f287c855603cf06133540d521ebd894183611a63e2ce4e5b1787e454b3405207925c16cef064480bfaa277f62e8723c3357a3e6926b579bad7b76680ca629d5dc3a475d34472569d2e9e00c24b167f96d313074886966ba4c390858c2918fe082e3fe7bf74e2f170fac0c0dada29553e9d296e3cfadd75748aebeb4e134304bdcdea8aeb195194cd0707eba895beba82c86b60bc3c7d086c4e021a576afe06e55dc10509e0f9a48710c20d779493a283ea8adbc24f9b862bc2bcc37881af8e6b4d788ec746cfb07718ac00682d289b6e40ceae437a55b0a3c26842db17667f297a7f7da886819e862078cab7b484a37789674a037fb416cbba57c8d8"
}

查询服务状态

接口URL

https://www.procentwarehouse.com/api/ping

请求方式

GET

请求自定义Header

参数 示例值 必填 参数描述
Accept application/json 必填 -
Authorization Bearer eyJ1eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjkxMDhhOTUyYTQ2OWI3ZTI1MjllYzliMjVlODViYzYxNDg0MTRlZGQ1NGVkMGQ5MmFkMmQ0ZmIzNmI1OGRlYTNkZTI2NjRkYTIxMDFiNjQyIn0.eyJhdWQiOiIxIiwianRpIjoiOTEwOGE5NTJhNDY5YjdlMjUyOWVjOWIyNWU4NWJjNjE0ODQxNGVkZDU0ZWQwZDkyYWQyZDRmYjM2YjU4ZGVhM2RlMjY2NGRhMjEwMWI2NDIiLCJpYXQiOjE1NzU1Mjc3NTQsIm5iZiI6MTU3NTUyNzc1NCwiZXhwIjoxNTc1NjE0MTUzLCJzdWIiOiI0MzQiLCJzY29wZXMiOlsiYmFzaWMiXX0.o28YBNUHbfAlSEXjVNcJUNX_krP7bsgLPK8SjC8zzmtpaZMy5RnQTA5I5tLFtShtvXzqfcn_VHjEM-KH4fozGAviiFKg52q41rNbNC_-aRiwQF1if-iEivrvPFIDrxy0pMIaLKmEKHlhIPEreiY_dIlTwMo2mefFz77AmAqDePajpF5qR2BcDBsJj8aRm1nU1sS__3XLmvDXNQe6XzodmilgktzZJ72AM38JVLDi-D_j6v_uwbZFpBO4ORUpGkiHr63Wyw0DonulDYZSqxE8bnG33vbYEhUdEbIEKeQwExiQBoK97QkCmFEdbZsieY7iNJpNmBvthGRAwB-UQoK-D0FvBNFNJi6aGR_NLN-ngmSxXfMgqTKqrBSE-MbUyABchLHHoghnyrEyB0JFi5C9F0yxERt4puyh7lTodksWTBjU82SvxiE2ju3z1ftxbFbx-y6v5K9zfLyzGJ7WNJCfy5rJ_P5ejdvoWzueQntaA-Q7YT0cSbHf_FeIgPzInkWP3F63EdfriZbuXlD4HdjWpzXyp6tD_4EzICTweV-nXtelEo8SR4vILHfzR1QFb3lSxaz7syue8JIMogZa5EMvtT0kFi8DOFb9pnitmr7Y_6E-COWFK6w-W7cnVm4TX1MuKjgZJ-hP2LiRH3rf9pTuKH7vZ4voNUK8YX-qaDbbLO8 必填 Bearer+空格+token
scope basic 必填 -
Content-Type application/x-www-form-urlencoded 必填 -

成功响应示例

pong

查询SKU库存

如不提供SKU那么将查询全部SKU的当前库存状态

接口URL

https://www.procentwarehouse.com/api/stock/{SKU}
https://www.procentwarehouse.com/api/stock

请求方式

GET

请求Query参数

参数 示例值 必填 参数描述
page 0 选填 查询全部SKU库存时的分页查询支持, 第几页
limit 20 选填 查询全部SKU库存时的分页查询支持, 每页显示, 最大值100

请求自定义Header

参数 示例值 必填 参数描述
Accept application/json 必填 -
Authorization Bearer eyJ1eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjkxMDhhOTUyYTQ2OWI3ZTI1MjllYzliMjVlODViYzYxNDg0MTRlZGQ1NGVkMGQ5MmFkMmQ0ZmIzNmI1OGRlYTNkZTI2NjRkYTIxMDFiNjQyIn0.eyJhdWQiOiIxIiwianRpIjoiOTEwOGE5NTJhNDY5YjdlMjUyOWVjOWIyNWU4NWJjNjE0ODQxNGVkZDU0ZWQwZDkyYWQyZDRmYjM2YjU4ZGVhM2RlMjY2NGRhMjEwMWI2NDIiLCJpYXQiOjE1NzU1Mjc3NTQsIm5iZiI6MTU3NTUyNzc1NCwiZXhwIjoxNTc1NjE0MTUzLCJzdWIiOiI0MzQiLCJzY29wZXMiOlsiYmFzaWMiXX0.o28YBNUHbfAlSEXjVNcJUNX_krP7bsgLPK8SjC8zzmtpaZMy5RnQTA5I5tLFtShtvXzqfcn_VHjEM-KH4fozGAviiFKg52q41rNbNC_-aRiwQF1if-iEivrvPFIDrxy0pMIaLKmEKHlhIPEreiY_dIlTwMo2mefFz77AmAqDePajpF5qR2BcDBsJj8aRm1nU1sS__3XLmvDXNQe6XzodmilgktzZJ72AM38JVLDi-D_j6v_uwbZFpBO4ORUpGkiHr63Wyw0DonulDYZSqxE8bnG33vbYEhUdEbIEKeQwExiQBoK97QkCmFEdbZsieY7iNJpNmBvthGRAwB-UQoK-D0FvBNFNJi6aGR_NLN-ngmSxXfMgqTKqrBSE-MbUyABchLHHoghnyrEyB0JFi5C9F0yxERt4puyh7lTodksWTBjU82SvxiE2ju3z1ftxbFbx-y6v5K9zfLyzGJ7WNJCfy5rJ_P5ejdvoWzueQntaA-Q7YT0cSbHf_FeIgPzInkWP3F63EdfriZbuXlD4HdjWpzXyp6tD_4EzICTweV-nXtelEo8SR4vILHfzR1QFb3lSxaz7syue8JIMogZa5EMvtT0kFi8DOFb9pnitmr7Y_6E-COWFK6w-W7cnVm4TX1MuKjgZJ-hP2LiRH3rf9pTuKH7vZ4voNUK8YX-qaDbbLO8 必填 Bearer+空格+token
scope basic 必填 -
Content-Type application/x-www-form-urlencoded 必填 -

成功响应示例

{
    "code": "2000",
    "message": "",
    "data": [
        {
            "inventory": 2, //仓库ID
            "available": 308, //可用
            "holding": 2, //待出库
            "total": 310 //总数
        },
        {
            "inventory": 4,
            "available": 0,
            "holding": 0,
            "total": 0
        }
    ]
}

查询出库单状态

接口URL

https://www.procentwarehouse.com/api/order/{出库单号/订单号}

请求方式

GET

请求Query参数

参数 示例值 必填 参数描述
byCustomNumber 0 选填 是否通过用户自定义编号(订单编号)查询, 默认否, 如果通过订单编号查询而非百分仓储出库单号, 此参数请填1. 自定义编号在创建订单时提供, 原则上不允许重复, 但一些用户可能需要创建具有相同自定义编号的多个订单, 因此在这种情况下请使用系统分配的唯一编号查询.

请求自定义Header

参数 示例值 必填 参数描述
Accept application/json 必填 -
Authorization Bearer eyJ1eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjkxMDhhOTUyYTQ2OWI3ZTI1MjllYzliMjVlODViYzYxNDg0MTRlZGQ1NGVkMGQ5MmFkMmQ0ZmIzNmI1OGRlYTNkZTI2NjRkYTIxMDFiNjQyIn0.eyJhdWQiOiIxIiwianRpIjoiOTEwOGE5NTJhNDY5YjdlMjUyOWVjOWIyNWU4NWJjNjE0ODQxNGVkZDU0ZWQwZDkyYWQyZDRmYjM2YjU4ZGVhM2RlMjY2NGRhMjEwMWI2NDIiLCJpYXQiOjE1NzU1Mjc3NTQsIm5iZiI6MTU3NTUyNzc1NCwiZXhwIjoxNTc1NjE0MTUzLCJzdWIiOiI0MzQiLCJzY29wZXMiOlsiYmFzaWMiXX0.o28YBNUHbfAlSEXjVNcJUNX_krP7bsgLPK8SjC8zzmtpaZMy5RnQTA5I5tLFtShtvXzqfcn_VHjEM-KH4fozGAviiFKg52q41rNbNC_-aRiwQF1if-iEivrvPFIDrxy0pMIaLKmEKHlhIPEreiY_dIlTwMo2mefFz77AmAqDePajpF5qR2BcDBsJj8aRm1nU1sS__3XLmvDXNQe6XzodmilgktzZJ72AM38JVLDi-D_j6v_uwbZFpBO4ORUpGkiHr63Wyw0DonulDYZSqxE8bnG33vbYEhUdEbIEKeQwExiQBoK97QkCmFEdbZsieY7iNJpNmBvthGRAwB-UQoK-D0FvBNFNJi6aGR_NLN-ngmSxXfMgqTKqrBSE-MbUyABchLHHoghnyrEyB0JFi5C9F0yxERt4puyh7lTodksWTBjU82SvxiE2ju3z1ftxbFbx-y6v5K9zfLyzGJ7WNJCfy5rJ_P5ejdvoWzueQntaA-Q7YT0cSbHf_FeIgPzInkWP3F63EdfriZbuXlD4HdjWpzXyp6tD_4EzICTweV-nXtelEo8SR4vILHfzR1QFb3lSxaz7syue8JIMogZa5EMvtT0kFi8DOFb9pnitmr7Y_6E-COWFK6w-W7cnVm4TX1MuKjgZJ-hP2LiRH3rf9pTuKH7vZ4voNUK8YX-qaDbbLO8 必填 Bearer+空格+token
scope basic 必填 -
Content-Type application/x-www-form-urlencoded 必填 -

成功响应示例

{
    "code": "2000",
    "message": "",
    "data": {
        "sn": "EX-A03-2-191205-0203",
	"status": "待出库",
	"deliveryName": "DHL",
	"deliveryCode": "00340434323390154956",
	"update": {
		"date": "2019-12-05 14:52:10.000000",
		"timezone_type": 3,
		"timezone": "PRC"
        }
    }
}

查询可用仓库

接口URL

https://www.procentwarehouse.com/api/schema/inventory

请求方式

GET

请求自定义Header

参数 示例值 必填 参数描述
Accept application/json 必填 -
Authorization Bearer eyJ1eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjkxMDhhOTUyYTQ2OWI3ZTI1MjllYzliMjVlODViYzYxNDg0MTRlZGQ1NGVkMGQ5MmFkMmQ0ZmIzNmI1OGRlYTNkZTI2NjRkYTIxMDFiNjQyIn0.eyJhdWQiOiIxIiwianRpIjoiOTEwOGE5NTJhNDY5YjdlMjUyOWVjOWIyNWU4NWJjNjE0ODQxNGVkZDU0ZWQwZDkyYWQyZDRmYjM2YjU4ZGVhM2RlMjY2NGRhMjEwMWI2NDIiLCJpYXQiOjE1NzU1Mjc3NTQsIm5iZiI6MTU3NTUyNzc1NCwiZXhwIjoxNTc1NjE0MTUzLCJzdWIiOiI0MzQiLCJzY29wZXMiOlsiYmFzaWMiXX0.o28YBNUHbfAlSEXjVNcJUNX_krP7bsgLPK8SjC8zzmtpaZMy5RnQTA5I5tLFtShtvXzqfcn_VHjEM-KH4fozGAviiFKg52q41rNbNC_-aRiwQF1if-iEivrvPFIDrxy0pMIaLKmEKHlhIPEreiY_dIlTwMo2mefFz77AmAqDePajpF5qR2BcDBsJj8aRm1nU1sS__3XLmvDXNQe6XzodmilgktzZJ72AM38JVLDi-D_j6v_uwbZFpBO4ORUpGkiHr63Wyw0DonulDYZSqxE8bnG33vbYEhUdEbIEKeQwExiQBoK97QkCmFEdbZsieY7iNJpNmBvthGRAwB-UQoK-D0FvBNFNJi6aGR_NLN-ngmSxXfMgqTKqrBSE-MbUyABchLHHoghnyrEyB0JFi5C9F0yxERt4puyh7lTodksWTBjU82SvxiE2ju3z1ftxbFbx-y6v5K9zfLyzGJ7WNJCfy5rJ_P5ejdvoWzueQntaA-Q7YT0cSbHf_FeIgPzInkWP3F63EdfriZbuXlD4HdjWpzXyp6tD_4EzICTweV-nXtelEo8SR4vILHfzR1QFb3lSxaz7syue8JIMogZa5EMvtT0kFi8DOFb9pnitmr7Y_6E-COWFK6w-W7cnVm4TX1MuKjgZJ-hP2LiRH3rf9pTuKH7vZ4voNUK8YX-qaDbbLO8 必填 Bearer+空格+token
scope basic 必填 -
Content-Type application/x-www-form-urlencoded 必填 -

成功响应示例

{
    "code": "2000",
    "message": "",
    "data": [
        {
            "id": 2, //仓库ID
            "name": "德国1仓-Tantow",
            "sn": "DE01", //仓库编号
            "delivery": [ //支持的配送方式
                {
                    "id": 1, //配送方式ID
                    "name": "DHL-DE-Tantow",
                    "desc": "总重量不得超过31.5KG；体积不能超过0.12立方米。",
                    "trackable": 1,
                    "form_type": [ //支持的收件信息表单类型
                        "normal",
                        "packstation"
                    ],
                    "destination": [ //可送达国家
                        "DE",
                        "AT",
                        "BE",
                        "CZ",
                        "DK",
                        "FR",
                        "LU",
                        "MC",
                        "NL",
                        "AD",
                        "HU",
                        "IT",
                        "SM",
                        "SK",
                        "SI",
                        "ES",
                        "SE",
                        "GB",
                        "VA",
                        "BG",
                        "HR",
                        "CY",
                        "EE",
                        "FI",
                        "GR",
                        "IE",
                        "LV",
                        "LT",
                        "MT",
                        "PT",
                        "RO"
                    ]
                },
                {
                    "id": 28,
                    "name": "DHL-PL-Tantow",
                    "desc": "总重量不得超过31.5KG；体积不能超过0.12立方米。",
                    "trackable": 1,
                    "form_type": [
                        "normal_with_email",
                        "packstation"
                    ],
                    "destination": [
                        "PL"
                    ]
                }
            ]
        },
        {
            "id": 4,
            "name": "波兰1仓-Szczecin",
            "sn": "PL01",
            "delivery": [
                {
                    "id": 19,
                    "name": "DHL-DE-什切青",
                    "desc": "总重量不得超过31.5KG；体积不能超过0.12立方米。",
                    "trackable": 1,
                    "form_type": [
                        "normal",
                        "packstation"
                    ],
                    "destination": [
                        "DE",
                        "AT",
                        "BE",
                        "CZ",
                        "DK",
                        "FR",
                        "LU",
                        "MC",
                        "NL",
                        "AD",
                        "HU",
                        "IT",
                        "SM",
                        "SK",
                        "SI",
                        "ES",
                        "SE",
                        "GB",
                        "VA",
                        "BG",
                        "HR",
                        "CY",
                        "EE",
                        "FI",
                        "GR",
                        "IE",
                        "LV",
                        "LT",
                        "MT",
                        "PT",
                        "RO"
                    ]
                },
                {
                    "id": 21,
                    "name": "InPost-PL-什切青",
                    "desc": "总重量不得超过31.5KG；体积不能超过0.12立方米。",
                    "trackable": 1,
                    "form_type": [
                        "normal_with_email",
                        "paczkomat"
                    ],
                    "destination": [
                        "PL"
                    ]
                },
                {
                    "id": 29,
                    "name": "DHL-PL-什切青",
                    "desc": "总重量不得超过31.5KG；体积不能超过0.12立方米。",
                    "trackable": 1,
                    "form_type": [
                        "normal_with_email",
                        "packstation"
                    ],
                    "destination": [
                        "PL"
                    ]
                },
                {
                    "id": 32,
                    "name": "GLS-PL-什切青",
                    "desc": "",
                    "trackable": 1,
                    "form_type": [
                        "normal2",
                        "packstation"
                    ],
                    "destination": [
                        "PL",
                        "AT",
                        "CZ",
                        "EE",
                        "DE",
                        "HU",
                        "LV",
                        "LT",
                        "LU",
                        "SK",
                        "BE",
                        "HR",
                        "DK",
                        "FR",
                        "IT",
                        "NL",
                        "RO",
                        "SI",
                        "GB",
                        "BA",
                        "BG",
                        "GR",
                        "IE",
                        "LI",
                        "MT",
                        "NO",
                        "PT",
                        "SM",
                        "ES",
                        "SE",
                        "CH"
                    ]
                }
            ]
        }
    ]
}

查询收件信息表单属性

接口URL

https://www.procentwarehouse.com/api/schema/form-type/{类型}

请求方式

GET

请求自定义Header

参数 示例值 必填 参数描述
Accept application/json 必填 -
Authorization Bearer eyJ1eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjkxMDhhOTUyYTQ2OWI3ZTI1MjllYzliMjVlODViYzYxNDg0MTRlZGQ1NGVkMGQ5MmFkMmQ0ZmIzNmI1OGRlYTNkZTI2NjRkYTIxMDFiNjQyIn0.eyJhdWQiOiIxIiwianRpIjoiOTEwOGE5NTJhNDY5YjdlMjUyOWVjOWIyNWU4NWJjNjE0ODQxNGVkZDU0ZWQwZDkyYWQyZDRmYjM2YjU4ZGVhM2RlMjY2NGRhMjEwMWI2NDIiLCJpYXQiOjE1NzU1Mjc3NTQsIm5iZiI6MTU3NTUyNzc1NCwiZXhwIjoxNTc1NjE0MTUzLCJzdWIiOiI0MzQiLCJzY29wZXMiOlsiYmFzaWMiXX0.o28YBNUHbfAlSEXjVNcJUNX_krP7bsgLPK8SjC8zzmtpaZMy5RnQTA5I5tLFtShtvXzqfcn_VHjEM-KH4fozGAviiFKg52q41rNbNC_-aRiwQF1if-iEivrvPFIDrxy0pMIaLKmEKHlhIPEreiY_dIlTwMo2mefFz77AmAqDePajpF5qR2BcDBsJj8aRm1nU1sS__3XLmvDXNQe6XzodmilgktzZJ72AM38JVLDi-D_j6v_uwbZFpBO4ORUpGkiHr63Wyw0DonulDYZSqxE8bnG33vbYEhUdEbIEKeQwExiQBoK97QkCmFEdbZsieY7iNJpNmBvthGRAwB-UQoK-D0FvBNFNJi6aGR_NLN-ngmSxXfMgqTKqrBSE-MbUyABchLHHoghnyrEyB0JFi5C9F0yxERt4puyh7lTodksWTBjU82SvxiE2ju3z1ftxbFbx-y6v5K9zfLyzGJ7WNJCfy5rJ_P5ejdvoWzueQntaA-Q7YT0cSbHf_FeIgPzInkWP3F63EdfriZbuXlD4HdjWpzXyp6tD_4EzICTweV-nXtelEo8SR4vILHfzR1QFb3lSxaz7syue8JIMogZa5EMvtT0kFi8DOFb9pnitmr7Y_6E-COWFK6w-W7cnVm4TX1MuKjgZJ-hP2LiRH3rf9pTuKH7vZ4voNUK8YX-qaDbbLO8 必填 Bearer+空格+token
scope basic 必填 -
Content-Type application/x-www-form-urlencoded 必填 -

成功响应示例

{
    "attribute": [
        "name",
        "company",
        "zip",
        "city",
        "address",
        "house",
        "phone"
    ],
    "require": [
        "name",
        "zip",
        "city",
        "address",
        "house"
    ]
}

创建出库单

接口URL

https://www.procentwarehouse.com/api/order

请求方式

POST

请求 Content-Type

Array

请求自定义Header

参数 示例值 必填 参数描述
Accept application/json 必填 -
Authorization Bearer eyJ1eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjkxMDhhOTUyYTQ2OWI3ZTI1MjllYzliMjVlODViYzYxNDg0MTRlZGQ1NGVkMGQ5MmFkMmQ0ZmIzNmI1OGRlYTNkZTI2NjRkYTIxMDFiNjQyIn0.eyJhdWQiOiIxIiwianRpIjoiOTEwOGE5NTJhNDY5YjdlMjUyOWVjOWIyNWU4NWJjNjE0ODQxNGVkZDU0ZWQwZDkyYWQyZDRmYjM2YjU4ZGVhM2RlMjY2NGRhMjEwMWI2NDIiLCJpYXQiOjE1NzU1Mjc3NTQsIm5iZiI6MTU3NTUyNzc1NCwiZXhwIjoxNTc1NjE0MTUzLCJzdWIiOiI0MzQiLCJzY29wZXMiOlsiYmFzaWMiXX0.o28YBNUHbfAlSEXjVNcJUNX_krP7bsgLPK8SjC8zzmtpaZMy5RnQTA5I5tLFtShtvXzqfcn_VHjEM-KH4fozGAviiFKg52q41rNbNC_-aRiwQF1if-iEivrvPFIDrxy0pMIaLKmEKHlhIPEreiY_dIlTwMo2mefFz77AmAqDePajpF5qR2BcDBsJj8aRm1nU1sS__3XLmvDXNQe6XzodmilgktzZJ72AM38JVLDi-D_j6v_uwbZFpBO4ORUpGkiHr63Wyw0DonulDYZSqxE8bnG33vbYEhUdEbIEKeQwExiQBoK97QkCmFEdbZsieY7iNJpNmBvthGRAwB-UQoK-D0FvBNFNJi6aGR_NLN-ngmSxXfMgqTKqrBSE-MbUyABchLHHoghnyrEyB0JFi5C9F0yxERt4puyh7lTodksWTBjU82SvxiE2ju3z1ftxbFbx-y6v5K9zfLyzGJ7WNJCfy5rJ_P5ejdvoWzueQntaA-Q7YT0cSbHf_FeIgPzInkWP3F63EdfriZbuXlD4HdjWpzXyp6tD_4EzICTweV-nXtelEo8SR4vILHfzR1QFb3lSxaz7syue8JIMogZa5EMvtT0kFi8DOFb9pnitmr7Y_6E-COWFK6w-W7cnVm4TX1MuKjgZJ-hP2LiRH3rf9pTuKH7vZ4voNUK8YX-qaDbbLO8 必填 Bearer+空格+token
Content-Type application/json 必填 -

请求Body参数

{
    "inventory": 2, //从ID为2的仓库发货
    "delivery": 1, //选取仓库支持的ID为1的配送方式
    "formType": "normal", //收件信息表单类型通过/api/schema/form-type/normal可查询出receiver的必备属性
    "receiver": {
        "name": "dd", //收件人姓名
        "phone": "dd", //电话
        "zip": "ddd", //邮编
        "address": "ddd", //街道/地址
        "country": "DE", //*国家 必须是代码形式 
        "city": "sdc", //城市
        "company": "sdc", //公司/别名
        "house": "12", //门牌号
        "email": "demo@live.com", //email
        "paczkomat": "", //paczkomat
        "packstationSn": "", //packstation编号
        "packstationUserSn": "" //packstation用户编号
    },
    "products": [
        {
            "sku": "A03-666",
            "num": 2
        },
        {
            "sku": "A03-888",
            "num": 10
        }
    ],
    "sn": "demo", //自定义编号/订单编号
    "message": "" //备注
}
inventory：从ID为2的仓库发货
delivery：选取仓库支持的ID为1的配送方式
formType：收件信息表单类型通过/api/schema/form-type/normal可查询出receiver的必备属性
name：收件人姓名
phone：电话
zip：邮编
address：街道/地址
country：国家（必须是代码形式）
city：城市
company：公司/别名
house：门牌号
paczkomat：paczkomat
packstationSn：packstation编号
packstationUserSn：packstation用户编号
sn：自定义编号/订单编号
message：备注

成功响应示例

{
    "code": 2000, // 2000成功 4000失败
    "sn": "EX-A03-2-191205-0003"
}

取消出库单

接口URL

https://www.procentwarehouse.com/api/order/{出库单号/订单号}

请求方式

DELETE

请求Query参数

参数 示例值 必填 参数描述
byCustomNumber 0 选填 是否通过用户自定义编号(订单编号)查询, 默认否, 如果通过订单编号查询而非百分仓储出库单号, 此参数请填1. 自定义编号在创建订单时提供, 原则上不允许重复, 但一些用户可能需要创建具有相同自定义编号的多个订单, 因此在这种情况下请使用系统分配的唯一编号查询.

请求自定义Header

参数 示例值 必填 参数描述
Accept application/json 必填 -
Authorization Bearer eyJ1eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjkxMDhhOTUyYTQ2OWI3ZTI1MjllYzliMjVlODViYzYxNDg0MTRlZGQ1NGVkMGQ5MmFkMmQ0ZmIzNmI1OGRlYTNkZTI2NjRkYTIxMDFiNjQyIn0.eyJhdWQiOiIxIiwianRpIjoiOTEwOGE5NTJhNDY5YjdlMjUyOWVjOWIyNWU4NWJjNjE0ODQxNGVkZDU0ZWQwZDkyYWQyZDRmYjM2YjU4ZGVhM2RlMjY2NGRhMjEwMWI2NDIiLCJpYXQiOjE1NzU1Mjc3NTQsIm5iZiI6MTU3NTUyNzc1NCwiZXhwIjoxNTc1NjE0MTUzLCJzdWIiOiI0MzQiLCJzY29wZXMiOlsiYmFzaWMiXX0.o28YBNUHbfAlSEXjVNcJUNX_krP7bsgLPK8SjC8zzmtpaZMy5RnQTA5I5tLFtShtvXzqfcn_VHjEM-KH4fozGAviiFKg52q41rNbNC_-aRiwQF1if-iEivrvPFIDrxy0pMIaLKmEKHlhIPEreiY_dIlTwMo2mefFz77AmAqDePajpF5qR2BcDBsJj8aRm1nU1sS__3XLmvDXNQe6XzodmilgktzZJ72AM38JVLDi-D_j6v_uwbZFpBO4ORUpGkiHr63Wyw0DonulDYZSqxE8bnG33vbYEhUdEbIEKeQwExiQBoK97QkCmFEdbZsieY7iNJpNmBvthGRAwB-UQoK-D0FvBNFNJi6aGR_NLN-ngmSxXfMgqTKqrBSE-MbUyABchLHHoghnyrEyB0JFi5C9F0yxERt4puyh7lTodksWTBjU82SvxiE2ju3z1ftxbFbx-y6v5K9zfLyzGJ7WNJCfy5rJ_P5ejdvoWzueQntaA-Q7YT0cSbHf_FeIgPzInkWP3F63EdfriZbuXlD4HdjWpzXyp6tD_4EzICTweV-nXtelEo8SR4vILHfzR1QFb3lSxaz7syue8JIMogZa5EMvtT0kFi8DOFb9pnitmr7Y_6E-COWFK6w-W7cnVm4TX1MuKjgZJ-hP2LiRH3rf9pTuKH7vZ4voNUK8YX-qaDbbLO8 必填 Bearer+空格+token
scope basic 必填 -
Content-Type application/x-www-form-urlencoded 必填 -

成功响应示例

                            
{
    "code":"2000", // 2000成功 4000失败
    "message":"已取消订单"
}