REAPI/extend/sdk/taobao/top/request/LogisticsOnlineSendRequest.php
2024-09-29 15:43:18 +08:00

179 lines
4.7 KiB
PHP
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?php
/**
* TOP API: taobao.logistics.online.send request
*
* @author auto create
* @since 1.0, 2018.07.26
*/
class LogisticsOnlineSendRequest
{
/**
* 卖家联系人地址库ID可以通过taobao.logistics.address.search接口查询到地址库ID。 如果为空,取的卖家的默认退货地址
**/
private $cancelId;
/**
* 物流公司代码.如"POST"就代表中国邮政,"ZJS"就代表宅急送.调用 taobao.logistics.companies.get 获取。
**/
private $companyCode;
/**
* feature参数格式 范例: identCode=tid1:识别码1,识别码2|tid2:识别码3;machineCode=tid3:3C机器号A,3C机器号B identCode为识别码的KEY,machineCode为3C的KEY,多个key之间用”;”分隔 “tid1:识别码1,识别码2|tid2:识别码3”为identCode对应的value。 "|"不同商品间的分隔符。 例1商品和2商品之间就用"|"分开。 TID就是商品代表的子订单号对应taobao.trade.fullinfo.get 接口获得的oid字段。(通过OID可以唯一定位到当前商品上) ":"TID和具体传入参数间的分隔符。冒号前表示TID,之后代表该商品的参数属性。 "," 属性间分隔符。对应商品数量当存在一个商品的数量超过1个时用逗号分开。 具体:当订单中A商品的数量为2个其中手机串号分别为"12345","67890"。 参数格式identCode=TIDA:12345,67890。 TIDA对应了A宝贝冒号后用逗号分隔的"12345","67890".说明本订单A宝贝的数量为2值分别为"12345","67890"。 当存在"|"时,就说明订单中存在多个商品,商品间用"|"分隔了开来。|"之后的内容含义同上。retailStoreId=12345发货门店ID或仓信息。retailStoreType=STORE: 发货门店类别STORE表示门店WAREHOUSE表示电商仓。对于全渠道订单回传的商家retailStoreId和retailStoreType字段为必填字段。
**/
private $feature;
/**
* 表明是否是拆单默认值01表示拆单
**/
private $isSplit;
/**
* 运单号.具体一个物流公司的真实运单号码。淘宝官方物流会校验,请谨慎传入;
**/
private $outSid;
/**
* 商家的IP地址
**/
private $sellerIp;
/**
* 卖家联系人地址库ID可以通过taobao.logistics.address.search接口查询到地址库ID。如果为空取的卖家的默认取货地址
**/
private $senderId;
/**
* 需要拆单发货的子订单集合针对的是一笔交易下有多个子订单需要分开发货的场景1次可传人多个子订单号子订单间用逗号隔开为空表示不做拆单发货。
**/
private $subTid;
/**
* 淘宝交易ID
**/
private $tid;
private $apiParas = array();
public function setCancelId($cancelId)
{
$this->cancelId = $cancelId;
$this->apiParas["cancel_id"] = $cancelId;
}
public function getCancelId()
{
return $this->cancelId;
}
public function setCompanyCode($companyCode)
{
$this->companyCode = $companyCode;
$this->apiParas["company_code"] = $companyCode;
}
public function getCompanyCode()
{
return $this->companyCode;
}
public function setFeature($feature)
{
$this->feature = $feature;
$this->apiParas["feature"] = $feature;
}
public function getFeature()
{
return $this->feature;
}
public function setIsSplit($isSplit)
{
$this->isSplit = $isSplit;
$this->apiParas["is_split"] = $isSplit;
}
public function getIsSplit()
{
return $this->isSplit;
}
public function setOutSid($outSid)
{
$this->outSid = $outSid;
$this->apiParas["out_sid"] = $outSid;
}
public function getOutSid()
{
return $this->outSid;
}
public function setSellerIp($sellerIp)
{
$this->sellerIp = $sellerIp;
$this->apiParas["seller_ip"] = $sellerIp;
}
public function getSellerIp()
{
return $this->sellerIp;
}
public function setSenderId($senderId)
{
$this->senderId = $senderId;
$this->apiParas["sender_id"] = $senderId;
}
public function getSenderId()
{
return $this->senderId;
}
public function setSubTid($subTid)
{
$this->subTid = $subTid;
$this->apiParas["sub_tid"] = $subTid;
}
public function getSubTid()
{
return $this->subTid;
}
public function setTid($tid)
{
$this->tid = $tid;
$this->apiParas["tid"] = $tid;
}
public function getTid()
{
return $this->tid;
}
public function getApiMethodName()
{
return "taobao.logistics.online.send";
}
public function getApiParas()
{
return $this->apiParas;
}
public function check()
{
RequestCheckUtil::checkNotNull($this->companyCode,"companyCode");
RequestCheckUtil::checkMaxListSize($this->subTid,20,"subTid");
RequestCheckUtil::checkNotNull($this->tid,"tid");
}
public function putOtherTextParam($key, $value) {
$this->apiParas[$key] = $value;
$this->$key = $value;
}
}