创建上门寄件订单。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dypls:CreatePickUpWaybill | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 | 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 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 |
|---|---|---|
| 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. |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史