APIUSB / OpenAPI / 下单接口

下单接口

接口描述: 适用于用户在线寄件、退货上门取件等场景;通过API提交寄件信息,由快递员揽件与收款,寄件方支付运费。

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
kuaidicom字符串必须-快递公司的编码,一律用小写字母,见快递公司编码
recManName字符串必须-收件人姓名
recManMobile字符串必须-收件人的手机号
recManPrintAddr字符串必须-收件人所在完整地址,如广东深圳市深圳市南山区科技南十二路 2 号金蝶软件园
sendManName字符串必须-寄件人姓名
sendManMobile字符串必须-寄件人的手机号
sendManPrintAddr字符串必须-寄件人所在的完整地址,如广东深圳市深圳市南山区科技南十二路 2 号金蝶软件园 B10
callBackUrl字符串必须-订单信息回调callBackUrl
cargo字符串可选-物品名称,例:文件
payment字符串可选-支付方式,SHIPPER: 寄付(默认)
weight字符串可选-物品总重量 KG,例:1.5,单位 kg
remark字符串可选-备注
dayType字符串可选-签名用随机字符串
pickupStartTime字符串可选-预约起始时间(HH:mm),例如:09:00
pickupEndTime字符串可选-预约截止时间(HH:mm),例如:10:00

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
kuaidicom 必须
recManName 必须
recManMobile 必须
recManPrintAddr 必须
sendManName 必须
sendManMobile 必须
sendManPrintAddr 必须
callBackUrl 必须
cargo 可选
payment 可选
weight 可选
remark 可选
dayType 可选
pickupStartTime 可选
pickupEndTime 可选

客户端请求示例

Request:
{Your endpoint domain}/?s=App.Logistics.PackageTrack&kuaidicom='yunda'
&recManName='张三'
&recManMobile=13323568782
&recManPrintAddr='广东省深圳市南山区科技园十二路金蝶软件园'
&sendManName='李四'
&sendManMobile=15938625456
&sendManPrintAddr='河南省郑州市金水区世玺中心'
&callBackUrl=callBackUrl
&cargo='文件'

Response:
{
"ret": 200,
"data": {
"code": 200,
"message": "success",
"data": {
"taskId": "BAB7EDF04019A6C7876096B88B611769",
"orderId": "100012021107633"
}
},
"msg": ""
}
curl https://api.apiusb.com/api/app?s=App.Logistics.CCreateOrder&kuaidicom='yunda'&recManName='张三'&recManMobile=13323568782&recManPrintAddr='广东省深圳市南山区科技园十二路金蝶软件园'&sendManName='李四'&sendManMobile=15938625456&sendManPrintAddr='河南省郑州市金水区世玺中心'&callBackUrl=callBackUrl&cargo='文件'
{
    "ret": 200,
    "data": {
        "code": 200,
        "message": "success",
        "data": {
            "taskId": "BAB7EDF04019A6C7876096B88B611769",
            "orderId": "100012021107633"
        }
    },
    "msg": ""
}
$.ajax({
    url: "https://api.apiusb.com/api/app",
    data: {
        s: "App.Logistics.CCreateOrder",
        kuaidicom: "yunda",
        recManName: "张三",
        recManMobile: "13323568782",
        recManPrintAddr: "广东省深圳市南山区科技园十二路金蝶软件园",
        sendManName: "李四",
        sendManMobile: "15938625456",
        sendManPrintAddr: "河南省郑州市金水区世玺中心",
        callBackUrl: "callBackUrl",
        cargo: "文件"
    },
    dataType: 'json',
    success: function (response, status, xhr) {
        console.log(response);
    }
});
<?php
require_once dirname(__FILE__) . '/PhalApiClient.php';

$client = PhalApiClient::create()
    ->withHost('https://api.apiusb.com/api/app');$rs = $client->reset()
->withService('App.Logistics.CCreateOrder')
->withParams("kuaidicom", "yunda")
->withParams("recManName", "张三")
->withParams("recManMobile", "13323568782")
->withParams("recManPrintAddr", "广东省深圳市南山区科技园十二路金蝶软件园")
->withParams("sendManName", "李四")
->withParams("sendManMobile", "15938625456")
->withParams("sendManPrintAddr", "河南省郑州市金水区世玺中心")
->withParams("callBackUrl", "callBackUrl")
->withParams("cargo", "文件")
->withTimeout(3000)
->request();



// ret状态码,200表示成功
var_dump($rs->getRet());
// 业务数据
var_dump($rs->getData());
// 提示信息
var_dump($rs->getMsg());
#-*- coding:utf-8 -*-
import PhalApiClient

result = PhalApiClient.PhalApiClient('https://api.apiusb.com/api/app', 'App.Logistics.CCreateOrderx', { 's': "App.Logistics.CCreateOrder",'kuaidicom': "yunda",'recManName': "张三", 'recManMobile': "13323568782", 'recManPrintAddr': "广东省深圳市南山区科技园十二路金蝶软件园",'sendManName': "李四",'sendManMobile': "15938625456", 'sendManPrintAddr': "河南省郑州市金水区世玺中心",'callBackUrl': "callBackUrl",'cargo': "文件"}, 3)



//FullscreenActivity.java
import net.phalapi.sdk.*;    /**
     * 网络操作相关的子线程
     */
    Runnable networkTask = new Runnable() {

        @Override
        public void run() {
            // TODO
            // 在这里进行 http request.网络请求相关操作

        	PhalApiClient client = PhalApiClient.create()
	       			    .withHost("https://api.apiusb.com/api/app");

	       	PhalApiClientResponse response = client
	       			    .withService("App.Logistics.CCreateOrder")
	       			    .withParams("kuaidicom", "yunda")
                        .withParams("recManName", "张三")
                        .withParams("recManMobile", "13323568782")
                        .withParams("recManPrintAddr", "广东省深圳市南山区科技园十二路金蝶软件园")
                        .withParams("sendManName", "李四")
                        .withParams("sendManMobile", "15938625456")
                        .withParams("sendManPrintAddr", "河南省郑州市金水区世玺中心")
                        .withParams("callBackUrl", "callBackUrl")
                        .withParams("cargo", "文件")
	       			    .withTimeout(3000)
	       			    .request();

	   		String content = "";
	   		content += "ret=" + response.getRet() + "\n";
	   		if (response.getRet() == 200) {
				try {
					JSONObject data = new JSONObject(response.getData());
					content += "data.title=" + data.getString("title") + "\n";
					content += "data.content=" + data.getString("content") + "\n";
					content += "data.version=" + data.getString("version") + "\n";
				} catch (JSONException ex) {

				}
	   		}
			content += "msg=" + response.getMsg() + "\n";

			Log.v("[PhalApiClientResponse]", content);


            Message msg = new Message();
            Bundle data = new Bundle();
            data.putString("value", content);
            msg.setData(data);
            handler.sendMessage(msg);
        }
    };
PhalApiClientResponse response = PhalApiClient.create()
  .withHost("https://api.apiusb.com/api/app")
  .withService("App.Logistics.CCreateOrder")
  .withparamsList("kuaidicom", "yunda")
  .withparamsList("recManName", "张三")
  .withparamsList("recManMobile", "13323568782")
  .withparamsList("recManPrintAddr", "广东省深圳市南山区科技园十二路金蝶软件园")
  .withparamsList("sendManName", "李四")
  .withparamsList("sendManMobile", "15938625456")
  .withparamsList("sendManPrintAddr", "河南省郑州市金水区世玺中心")
  .withparamsList("callBackUrl", "callBackUrl")
  .withparamsList("cargo", "文件")
  .withTimeout(3000)
  .request();

Log.v("response ret", response.ret + "");
Log.v("response data", response.data);
Log.v("response msg", response.msg);
#import "AFNPhalApiClient.h"// POST
NSDictionary *params = @{
                         @"s": @"App.Logistics.CCreateOrder",
                         @"kuaidicom": @"yunda",
                         @"recManName": @"张三",
                         @"recManMobile": @"13323568782",
                         @"recManPrintAddr": @"广东省深圳市南山区科技园十二路金蝶软件园",
                         @"sendManName": @"李四",
                         @"sendManMobile": @"15938625456",
                         @"sendManPrintAddr": @"河南省郑州市金水区世玺中心",
                         @"callBackUrl": @"callBackUrl",
                         @"cargo": @"文件"
                     };

// Call AFNPhalApiClient
[[[[[AFNPhalApiClient sharedClient] withHost:@"https://api.apiusb.com/api/app"] withService:@"App.Logistics.CCreateOrder"] withParams:params] requestWithFormDataBlock:^(id formData) {
	//
    [formData appendPartWithFileData:UIImageJPEGRepresentation([UIImage imageNamed:@"head.JPG"], 1) name:@"file" fileName:@"image.jpg" mimeType:@"image/jpeg"];
} completeBlock:^(id resultObject) {
    PALog(@"resultObject: %@", resultObject);
} failureBlock:^(NSError *error) {
    PALog(@"error: %@", error);
}];

// Print url
PALog(@"total url: %@", [[AFNPhalApiClient sharedClient] printTotalUrlStr]);

错误列表

错误状态码错误描述信息
400表示客户端参数错误
404表示接口服务不存在
500表示服务端内部错误

本文档生成时间:2024-05-06 07:06:26