寄件下单预查询。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dypls:CreatePickUpWaybillPreQuery | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Content-Type | string | 否 | HTTP 请求内容类型。 非必填,如果填,请填写 application/json;chatset=UTF-8 | application/json;chatset=UTF-8 |
SenderInfo | object | 是 | 寄件人信息。 | |
Name | string | 是 | 寄件人姓名。 | 王XX |
Mobile | string | 是 | 寄件人手机号。 | 1390000**** |
AddressInfo | object | 否 | 寄件人地址信息。 | |
ProvinceName | string | 否 | 寄件人所在省份。 | 浙江省 |
CityName | string | 否 | 寄件人所在市。 | 杭州市 |
AreaName | string | 否 | 寄件人所在区。 | 西湖区 |
TownName | string | 否 | 寄件人所在街道。 | XX街道 |
AddressDetail | string | 否 | 寄件人详细地址。 | XX小区XX号 |
ConsigneeInfo | object | 是 | 收件人信息。 | |
Name | string | 是 | 收件人姓名。 | 李XX |
Mobile | string | 是 | 收件人手机号。 | 1390000**** |
AddressInfo | object | 否 | 收件人地址信息。 | |
ProvinceName | string | 否 | 收件人所在省份。 | 陕西省 |
CityName | string | 否 | 收件人所在市。 | 西安市 |
AreaName | string | 否 | 收件人所在区。 | 长安区 |
TownName | string | 否 | 收件人所在街道。 | XX街道 |
AddressDetail | string | 否 | 收件人详细地址。 | XX小区XX号 |
CpCode | string | 否 | 快递公司编码。不指定快递公司时由系统进行分配。 | YTO |
PreWeight | string | 否 | 预估重量(单位:克)。 说明
若您需要查询预估价格,该参数必传。
| 2000 |
OuterOrderCode | string | 否 | 接入方系统的订单编号。 | 787DFHHDS989**** |
OrderChannels | string | 是 | 外部渠道来源标识,不可包含下划线。接入时与系统约定取值。 | Test |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 |
---|---|---|
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. |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-03-16 | OpenAPI 错误码发生变更 | 查看变更详情 |