文档

CreatePickUpWaybillPreQuery - 寄件下单预查询

更新时间:

寄件下单预查询。

接口说明

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

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

application/json;chatset=UTF-8
SenderInfoobject

寄件人信息。

Namestring

寄件人姓名。

王XX
Mobilestring

寄件人手机号。

1390000****
AddressInfoobject

寄件人地址信息。

ProvinceNamestring

寄件人所在省份。

浙江省
CityNamestring

寄件人所在市。

杭州市
AreaNamestring

寄件人所在区。

西湖区
TownNamestring

寄件人所在街道。

XX街道
AddressDetailstring

寄件人详细地址。

XX小区XX号
ConsigneeInfoobject

收件人信息。

Namestring

收件人姓名。

李XX
Mobilestring

收件人手机号。

1390000****
AddressInfoobject

收件人地址信息。

ProvinceNamestring

收件人所在省份。

陕西省
CityNamestring

收件人所在市。

西安市
AreaNamestring

收件人所在区。

长安区
TownNamestring

收件人所在街道。

XX街道
AddressDetailstring

收件人详细地址。

XX小区XX号
CpCodestring

快递公司编码。不指定快递公司时由系统进行分配。

YTO
PreWeightstring

预估重量(单位:克)。

说明 若您需要查询预估价格,该参数必传。
2000
OuterOrderCodestring

接入方系统的订单编号。

787DFHHDS989****
OrderChannelsstring

外部渠道来源标识,不可包含下划线。接入时与系统约定取值。

Test

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

HTTP 状态码。

200
Messagestring

状态码描述。

OK
Dataobject

结果集。

Successboolean

是否成功。

true
ErrorCodestring

错误码。

ErrorMsgstring

错误信息。

Codestring

响应码。

0
Messagestring

响应内容。

Success
CpTimeSelectListobject []

查询快递公司是否可下单的信息列表。

RealTimeobject

实时单可选信息。

Namestring

实时单服务类型名称。

2小时上门
Selectableboolean

超过实时单下单的时间,是否能再下实时单。

false
SelectDisableTipstring

不可选文案提示。

超过实时单下单时间范围
AppointTimesobject []

预约单可选时间信息,当前快递公司如果不能下预约单,则该字段值为空。

Datestring

YYYY-MM-DD 格式的日期字符串。

2022-04-28
DateSelectableboolean

该日期是否可选。

true
TimeListobject []

当天的下单时间段列表.

StartTimestring

时间段的开始时间。

10:00:00
EndTimestring

时间段的结束时间。

12:00:00
Selectableboolean

该预约时段是否可以选择。

true
SelectDisableTipstring

不可选文案提示。

约满
PrePricestring

预估价格,单位:元,保留到小数点后两位。当入参传入预估重量时该字段有值。

12.50

示例

正常返回示例

JSON格式

{
  "RequestId": "9FC30594-3841-43AD-9008-03393BCB5CD2",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Data": {
    "Success": true,
    "ErrorCode": "无",
    "ErrorMsg": "无",
    "Code": "0",
    "Message": "Success",
    "CpTimeSelectList": [
      {
        "RealTime": {
          "Name": "2小时上门",
          "Selectable": false,
          "SelectDisableTip": "超过实时单下单时间范围"
        },
        "AppointTimes": [
          {
            "Date": "2022-04-28",
            "DateSelectable": true,
            "TimeList": [
              {
                "StartTime": "10:00:00",
                "EndTime": "12:00:00",
                "Selectable": true,
                "SelectDisableTip": "约满"
              }
            ]
          }
        ],
        "PrePrice": "12.50"
      }
    ]
  }
}

错误码

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.

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

变更历史

变更时间变更内容概要操作
2023-03-16OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:500
  • 本页导读 (1)
文档反馈