调用CreatePickUpWaybill创建上门寄件订单_号码隐私保护-阿里云帮助中心

创建上门寄件订单。

接口说明

QPS限制

本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Content-Type	string	否	HTTP请求内容类型。非必填，如果填，请填写application/json;chatset=UTF-8	application/json;chatset=UTF-8
OuterOrderCode	string	是	外部订单号。	143234234266****
OrderChannels	string	是	外部渠道来源。	YUN_DIAN_SHANG
CpCode	string	否	快递公司编码。	YTO
SendName	string	是	寄件人姓名。	王XX
SendMobile	string	否	寄件人手机号。说明SendMobile和SendPhone必须任选其一。	1596714****
SendPhone	string	否	寄件人电话。说明SendMobile和SendPhone必须任选其一。	05718845****
SendAddress	object	是	寄件人地址。
ProvinceName	string	是	省。	陕西省
CityName	string	是	市。	西安
AreaName	string	是	区。	未央区
TownName	string	否	街道。	XX街道
AddressDetail	string	是	详细地址。	XX小区XX号
ConsigneeName	string	是	收货人姓名。	张XX
ConsigneeMobile	string	否	收货人手机号。说明ConsigneeMobile和ConsigneePhone必须任选其一。	1580000****
ConsigneePhone	string	否	收货人电话。说明ConsigneeMobile和ConsigneePhone必须任选其一。	0570000****
ConsigneeAddress	object	是	收货人地址。
ProvinceName	string	是	省。	浙江
CityName	string	是	市。	杭州
AreaName	string	是	区。	西湖区
TownName	string	否	街道。	XX街道
AddressDetail	string	是	详细地址。	XX小区XX号
Remark	string	否	备注。打印在面单上的备注内容。	易碎物品
GoodsInfos	array	否	商品列表。
	object	否	商品列表。
Name	string	否	物品名称。	鞋子
Weight	string	否	重量。单位：克。	1000
Quantity	string	否	数量。	1
AppointGotStartTime	string	否	预约上门取件开始时间。 AppointGotStartTime的值，请从CreatePickUpWaybillPreQuery接口返回参数CpTimeSelectList中AppointTimes的StartTime获取。说明当bizType为1时必填。	2021-01-01 10:00:00
AppointGotEndTime	string	否	预约上门取件结束时间。 AppointGotEndTime的值，请从CreatePickUpWaybillPreQuery接口返回参数CpTimeSelectList中AppointTimes的EndTime获取。说明当bizType为1时必填。	2021-01-01 12:00:00
BizType	integer	否	寄件模式。取值： 0：实时订单（默认值）。 1：预约订单。	0

返回参数

名称	类型	描述	示例值
	object	返回数据。
RequestId	string	请求ID。	9FC30594-3841-43AD-9008-03393BCB5CD2
HttpStatusCode	integer	HTTP状态码。	200
Message	string	状态码描述。	OK
Data	object	返回数据。
Success	string	接口调用是否成功。	true
CpCode	string	快递公司编码。	YTO
MailNo	string	订单号。	77312345629****
ErrorCode	string	错误码。	无
ErrorMsg	string	错误信息。	无
GotCode	string	取件码。	3524

示例

正常返回示例

JSON格式

{
  "RequestId": "9FC30594-3841-43AD-9008-03393BCB5CD2",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Data": {
    "Success": "true",
    "CpCode": "YTO",
    "MailNo": "77312345629****",
    "ErrorCode": "无",
    "ErrorMsg": "无",
    "GotCode": "3524"
  }
}

错误码

Http code	错误码	错误信息
400	Insufficient.Balance	You have an insufficient balance.
400	Product.Unsubscript	You have not subscribed to the specified product.
400	Ram.PermissionDeny	You are not authorized to perform the operation.
400	System.LimitControl	The system is under flow control.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.
403	Permission.NotAuthorized	You are not authorized to perform the operation.
500	InternalError	A system error occurred.

访问错误中心查看更多错误码。