文档

CreatePickUpWaybill - 创建上门寄件订单

更新时间:

创建上门寄件订单。

接口说明

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dypls:CreatePickUpWaybillWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Content-Typestring

HTTP 请求内容类型。 非必填,如果填,请填写 application/json;chatset=UTF-8

application/json;chatset=UTF-8
OuterOrderCodestring

外部订单号。

143234234266****
OrderChannelsstring

外部渠道来源。

YUN_DIAN_SHANG
CpCodestring

快递公司编码。

YTO
SendNamestring

寄件人姓名。

王XX
SendMobilestring

寄件人手机号。

说明 SendMobile 和 SendPhone 必须任选其一。
1596714****
SendPhonestring

寄件人电话。

说明 SendMobile 和 SendPhone 必须任选其一。
05718845****
SendAddressobject

寄件人地址。

ProvinceNamestring

省。

陕西省
CityNamestring

市。

西安
AreaNamestring

区。

未央区
TownNamestring

街道。

XX街道
AddressDetailstring

详细地址。

XX小区XX号
ConsigneeNamestring

收货人姓名。

张XX
ConsigneeMobilestring

收货人手机号。

说明 ConsigneeMobile 和 ConsigneePhone 必须任选其一。
1580000****
ConsigneePhonestring

收货人电话。

说明 ConsigneeMobile 和 ConsigneePhone 必须任选其一。
0570000****
ConsigneeAddressobject

收货人地址。

ProvinceNamestring

省。

浙江
CityNamestring

市。

杭州
AreaNamestring

区。

西湖区
TownNamestring

街道。

XX街道
AddressDetailstring

详细地址。

XX小区XX号
Remarkstring

备注。打印在面单上的备注内容。

易碎物品
GoodsInfosobject []

商品列表。

Namestring

物品名称。

鞋子
Weightstring

重量。单位:克。

1000
Quantitystring

数量。

1
AppointGotStartTimestring

预约上门取件开始时间。 AppointGotStartTime 的值,请从 CreatePickUpWaybillPreQuery 接口返回参数 CpTimeSelectListAppointTimesStartTime 获取。

说明 bizType1 时必填。
2021-01-01 10:00:00
AppointGotEndTimestring

预约上门取件结束时间。 AppointGotEndTime 的值,请从 CreatePickUpWaybillPreQuery 接口返回参数 CpTimeSelectListAppointTimesEndTime 获取。

说明 bizType1 时必填。
2021-01-01 12:00:00
BizTypeinteger

寄件模式。取值:

  • 0:实时订单(默认值)。
  • 1:预约订单。
0

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

9FC30594-3841-43AD-9008-03393BCB5CD2
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

状态码描述。

OK
Dataobject

返回数据。

Successstring

接口调用是否成功。

true
CpCodestring

快递公司编码。

YTO
MailNostring

订单号。

77312345629****
ErrorCodestring

错误码。

ErrorMsgstring

错误信息。

GotCodestring

取件码。

3524

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
400Insufficient.BalanceYou have an insufficient balance.
400Product.UnsubscriptYou have not subscribed to the specified product.
400Ram.PermissionDenyYou are not authorized to perform the operation.
400System.LimitControlThe system is under flow control.
400Unknown.ResourceOwnerIdThe resource does not belong to the current user.
403Permission.NotAuthorizedYou are not authorized to perform the operation.
500InternalErrorA system error occurred.

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)