文档

CancelPickUpWaybill - 取消上门寄件订单

更新时间:

取消上门寄件订单。

接口说明

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

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

application/json;chatset=UTF-8
OuterOrderCodestring

外部订单号。

1145678823****
CancelDescstring

取消原因。

不想退货了

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

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

状态码。

  • 返回 OK 代表请求成功。
  • 其他错误码,请参见错误码列表
OK
Messagestring

状态码描述。

请求成功
Dataobject

返回数据。

Successboolean

是否取消成功。

true
ErrorCodestring

错误码。

Messagestring

取消结果。

取消成功
ErrorMsgstring

错误信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "9FC30594-3841-43AD-9008-03393BCB5CD2",
  "Code": "OK",
  "Message": "请求成功",
  "Data": {
    "Success": true,
    "ErrorCode": "无",
    "Message": "取消成功",
    "ErrorMsg": "无"
  }
}

错误码

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)