inquiryStore需要签名验签

POST /amsin/api/v1/business/store/inquiryStore

集成商可调用此接口获取店铺信息以及店铺关联账号的信息。

报文结构

万里汇接口报文结构包括:请求头,请求体、响应体。

请求头

字段名

是否必传

范例

说明

Client-Id

Client-Id: *****

关于这些参数的解释说明,详见:请求头

Signature

Signature: algorithm=RSA256, keyVersion=2, signature=*****

Content-Type

Content-Type: application/json; charset=UTF-8

Request-Time

Request-Time: 2019-04-04T12:08:56+08:00

Access-Token

否(有条件要求)

Access-Token: ******

注意此字段

当用 OAUTH 授权时需要传递

Connected-CustomerId

否(有条件要求)

Connected-CustomerId: *****

注意此字段

该字段为万里汇唯一用户识别id。当平台客户操作商户账户时需要传递

入参

pageSize Integer  REQUIRED

每页包含的条目数。

pageNumber Integer  REQUIRED

当前页码。

格式:1、2、3......

出参

result Result  REQUIRED

代表接口调用的结果。

Show child parameters

customerId String  

由万里汇定义、用于唯一标识某万里汇账户。

此字段只有当 result.resultStatusS 时才会按需返回。

更多信息:

  • 最大长度:64 字符

storeInformation Array<StoreInfo>  

店铺信息。

此字段只有当 result.resultStatusS 时才会按需返回。

Show child parameters

totalCount Integer  REQUIRED

本次查询结果的总条目数。

此字段只有当 result.resultStatusS 时才会按需返回。

更多信息:

  • 最大长度:8 字符

totalPageNumber Integer  REQUIRED

查询结果的总页数。

此字段只有当 result.resultStatusS 时才会按需返回。

更多信息:

  • 最大长度:8 字符

currentPageNumber Integer  REQUIRED

当前页码。

此字段只有当 result.resultStatusS 时才会按需返回。

更多信息:

  • 最大长度:8 字符
API Explorer

请求

URL
请求体

响应

响应体

响应处理

集成商调用接口后,万里汇返回集成商API调用结果。result.resultStatus字段取值范围为:

result.resultStatus

描述

S

API请求成功。

F

API请求失败。

失败原因参见结果码(即result.resultCoderesult.resultMessage

U

API响应结果为UNKNOWN(未知)时,需重试API请求。

重试策略:

  • 重试次数上限:7次
  • 重试时间间隔:5分钟、10分钟、20分钟、40分钟、80分钟、160分钟、320分钟

如果问题依旧,请联系万里汇技术支持。

结果码

结果码结果码信息行动建议
SUCCESSSSuccess
PROCESS_FAILFA general business failure occurred. Do not retry.

需要人工介入,联系万里汇技术支持以解决此问题

PARAM_ILLEGALFIllegal parameters exist. For example, a non-numeric input, or an invalid date.

参考API文档页面,确认请求头和传参是否正确

KEY_NOT_FOUNDFThe key is not found.

联系万里汇技术支持以解决此问题。

ACCESS_DENIEDFAccess is denied.

联系万里汇技术支持以解决此问题。

INVALID_APIFThe called API is invalid or not active.

确认是否调用正确的API

INVALID_CLIENTFThe client is invalid.

Client ID不存在或无效

INVALID_SIGNATUREFThe signature is invalid.

确认请求正确加签

METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTP method.

确认HTTP请求方法为POST

UNKNOWN_EXCEPTIONUAPI failed due to unknown reason.

服务器错误,若稍后重试问题依旧,联系万里汇技术支持以解决问题

UN_SUPPORT_BUSINESSFUnsupported business.

使用正确的参数重试

USER_ACCOUNT_NOT_PRIMARYFThe use account is not primary.

请使用主账号来查询接口

AUTHORIZATION_NOT_EXISTFOAUTH does not exist.

当前token授权关系不存在,请联系万里汇技术支持检查token授权关系

INVALID_ACCESS_TOKENFInvalid access token

请使用正确的访问令牌(access token)

ACCESS_TOKEN_EXPIREDFThe access token has expired.

刷新token接口以重新获取访问令牌(access token),或联系万里汇技术支持以解决问题

@2024 WorldFirst