APIUSB / OpenAPI / 取消订单

取消订单

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

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
orderId字符串必须-平台订单 ID
taskId字符串必须-任务 ID
cancelMsg字符串必须-取消原因

返回字段

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

在线测试   

参数是否必须
service 必须
access_token 可选
orderId 必须
taskId 必须
cancelMsg 必须

客户端请求示例

Request:
{Your endpoint domain}/?s=App.Logistics.PackageTrack&orderId='100012021107633'&taskId='BAB7EDF04019A6C7876096B88B611769'&cancelMsg="不要了"


Response:
{
"ret": 200,
"data": {
"code": 200,
"message": "success",
"data": "取消成功"
},
"msg": "",
}



curl https://api.apiusb.com/api/app?s=App.Logistics.CCancelOrder&orderId='100012021107633'&taskId='BAB7EDF04019A6C7876096B88B611769'&cancelMsg='不要了'
{
    "ret": 200,
    "data": [
        {
            "lengthPre": 14,
            "comCode": "zhongtong",
            "noPre": "75351",
            "noCount": 548102
        }
    ],
    "msg": ""
}
$.ajax({
    url: "https://api.apiusb.com/api/app",
    data: {
        s: "App.Logistics.CCancelOrder",
        orderId: "100012021107633",
        taskId: "BAB7EDF04019A6C7876096B88B611769",
        cancelMsg: "不要了"
    },
    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.CCancelOrder')
->withParams("orderId", "100012021107633")
->withParams("taskId", "BAB7EDF04019A6C7876096B88B611769")
->withParams("cancelMsg", "不要了")
->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.CCancelOrderx', { 's': "App.Logistics.CCancelOrder",'orderId': "100012021107633",'taskId': "BAB7EDF04019A6C7876096B88B611769", 'cancelMsg': "不要了"}, 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.CCancelOrder")
	       			    .withParams("orderId", "100012021107633")
                        .withParams("taskId", "BAB7EDF04019A6C7876096B88B611769")
                        .withParams("cancelMsg", "不要了")
	       			    .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.CCancelOrder")
  .withparamsList("orderId", "100012021107633")
  .withparamsList("taskId", "BAB7EDF04019A6C7876096B88B611769")
  .withparamsList("cancelMsg", "不要了")
  .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.CCancelOrder",
                         @"orderId": @"100012021107633",
                         @"taskId": @"BAB7EDF04019A6C7876096B88B611769",
                         @"cancelMsg": @"不要了",

                     };

// Call AFNPhalApiClient
[[[[[AFNPhalApiClient sharedClient] withHost:@"https://api.apiusb.com/api/app"] withService:@"App.Logistics.CCancelOrder"] 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-03-28 21:15:08