蘑菇街开放平台

API 列表

xiaodian.trade.order.receiveDeclareNotify

免费
无需授权
结果不加密

跨境业务-交易订单接收报关结果通知接口，使用规则如下：
1、仅限跨境订单报关失败或无需报关直接退款业务使用
2、仅支持在报关成功前、发货流程前调用
3、调用此接口后系统会做自动退款【含关税】操作

公共参数

名称	类型	必选	描述
app_key	Long	是	接入时申请的app_key
method	String	是	接口名称
access_token	String	是	Oauth2.0授权获得的access_token
sign	String	是	对 API 调用参数（除sign外）进行 md5 加密获得。参数的顺序为字母表的顺序
timestamp	Long	是	时间戳，使用Unix时间戳格式
format	String	是	响应格式。默认为json格式，固定
sign_method	String	否	参数的加密方法选择，当前只支持Md5
version	String	否	API协议版本，固定值为：1.0

输入参数

名称	类型	必选	描述
userId	Number	是	店铺授权userId
reqDTO	Object	是	通知参数,具体见内部属性定义
shopOrderId	Number	是	蘑菇街店铺级订单id
code	String	是	海关报关通知code,最大支持30个字符,不支持4字节字符
msg	String	是	海关报关通知msg,最大支持150个字符,不支持4字节字符

返回参数

名称	类型	描述	默认值
data	Boolean	true: 通知成功; 其它值: 通知失败,需要业务方自己重试或者联系蘑菇街开发同学

请求参数示例

1).
{
    "shopOrderId":1232343232545456,
    "code":"test_order_refund",
    "msg":"测试订单不用报关直接退款"
}

返回示例

1).
{
    "result":{
        "data":true
    },
    "st":1548146043931,
    "status":{
        "msg":"请求成功",
        "code":"0000000"
    }
}

异常示例

1).
{
    "result":{
    },
    "st":1548146043931,
    "status":{
        "msg":"缺少必要的授权信息,请先对店铺进行授权操作!",
        "code":"1090001"
    }
}

2).
{
    "result":{
    },
    "st":1548146043931,
    "status":{
        "msg":"有必填参数为空,请检查参数信息!",
        "code":"1090002"
    }
}

3).
{
    "result":{
    },
    "st":1548146043931,
    "status":{
        "msg":"通知code最大支持30个字符,请检查参数信息!",
        "code":"1090003"
    }
}

4).
{
    "result":{
    },
    "st":1548146043931,
    "status":{
        "msg":"通知msg最大支持150个字符,请检查参数信息!",
        "code":"1090004"
    }
}

5).
{
    "result":{
    },
    "st":1548146043931,
    "status":{
        "msg":"无效的订单号,请检查参数信息!",
        "code":"1090005"
    }
}

6).
{
    "result":{
    },
    "st":1548146043931,
    "status":{
        "msg":"无效的订单状态,请联系蘑菇街开放平台技术支持(QQ群: 421068367)!",
        "code":"1090006"
    }
}

7).
{
    "result":{
    },
    "st":1548146043931,
    "status":{
        "msg":"无效的订单扩展信息,请联系蘑菇街开放平台技术支持(QQ群: 421068367)!",
        "code":"1090007"
    }
}

8).
{
    "result":{
    },
    "st":1548146043931,
    "status":{
        "msg":"无效的订单标信息,请联系蘑菇街开放平台技术支持(QQ群: 421068367)!",
        "code":"1090008"
    }
}

9).
{
    "result":{
    },
    "st":1548146043931,
    "status":{
        "msg":"无操作此订单的权限,请联系蘑菇街开放平台技术支持(QQ群: 421068367)!",
        "code":"1090009"
    }
}

10).
{
    "result":{
    },
    "st":1548146043931,
    "status":{
        "msg":"订单过期时间更新失败,请联系蘑菇街开放平台技术支持(QQ群: 421068367)!",
        "code":"1090010"
    }
}

11).
{
    "result":{
    },
    "st":1548146043931,
    "status":{
        "msg":"订单报关状态更新失败,请联系蘑菇街开放平台技术支持(QQ群: 421068367)!",
        "code":"1090011"
    }
}

12).
{
    "result":{
    },
    "st":1548146043931,
    "status":{
        "msg":"内部业务处理异常,详细见该字段返回的文案",
        "code":"1090012"
    }
}

13).
{
    "result":{
    },
    "st":1548146043931,
    "status":{
        "msg":"请求处理异常,请联系蘑菇街开放平台技术支持(QQ群: 421068367)!",
        "code":"1090013"
    }
}

API测试工具 SDK下载