Query store informationSignature required

2024-04-28 06:07

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

Use this interface to obtain information of stores and the associated accounts.

Structure

A message consists of a header and body. For details, see the following sections.

Field	Required	Sample	Description
Client-Id	Yes	`Client-Id: *****`	For more information about these request header fields, see Request header.
Signature	Yes	`Signature: algorithm=RSA256, keyVersion=2, signature=*****`
Content-Type	Yes	`Content-Type: application/json; charset=UTF-8`
Request-Time	Yes	`Request-Time: 2019-04-04T12:08:56+08:00`
Access-Token	Conditional	`Access-Token: ******`	Attention to this field Required for OAUTH authorization.
Connected-CustomerId	Conditional	`Connected-CustomerId: *****`	Attention to this field Required when a partner manages a customer's account.

Request parameters

pageSize Integer REQUIRED

The number of items on each page.

pageNumber Integer REQUIRED

The page index that contains statement information.

Format: 1, 2, 3,...

Response parameters

result Result object REQUIRED

The result of the API call.

Show child parameters

customerId String

A unique id that is assigned by WorldFirst to identify an account on WorldFirst.

Note: This parameter is returned on demand only when result.resultStatus = S.

More information about this field

Maximum length: 64 characters

storeInformation Array<StoreInfo> object

The information of the store.

Note: This parameter is returned on demand only when result.resultStatus = S.

Show child parameters

totalCount Integer REQUIRED

The total number of items in the query.

Note: This parameter is returned on demand only when result.resultStatus = S.

More information about this field

Maximum length: 8 characters

totalPageNumber Integer REQUIRED

Number of the pages in total.

Note: This parameter is returned on demand only when result.resultStatus = S.

More information about this field

Maximum length: 8 characters

currentPageNumber Integer REQUIRED

The currency page index number.

Note: This parameter is returned on demand only when result.resultStatus = S.

More information about this field

Maximum length: 8 characters

API Explorer

Request

URL

Request Body

Response

Response Body

Result processing logic

After calling the API, a response is returned. The possible responses for result.resultStatus are:

Result status	Description
S	This indicates the API call succeeded.
F	This indicates the API call failed. For more information on why the call failed, see result.resultCode.
U	This indicates the API call result is unknown. A partner can make a query when the returned status is `UNKNOWN`. Use the following query strategy: A Partner can make 7 queries maximum. Intervals between queries: 5 min, 10 min, 20 min, 40 min, 80 min, 160 min, and 320 min. If none of the queries is successful, contact WorldFirst Technical Support

Result/Error codes

Code	Value	Message	Further action
SUCCESS	S	Success
PROCESS_FAIL	F	A general business failure occurred. Do not retry.	Human intervention is usually needed. It is recommended that you contact our Technical Support Team to resolve the issue.
PARAM_ILLEGAL	F	Illegal parameters exist. For example, a non-numeric input, or an invalid date.	Check and verify whether the request fields, including the header fields and body fields, are correct and valid. For details on the fields of each API, see the specific API Structure section.
KEY_NOT_FOUND	F	The key is not found.	Contact our Technical Support Team to resolve the issue.
ACCESS_DENIED	F	Access is denied.	Contact our Technical Support Team to resolve the issue.
INVALID_API	F	The called API is invalid or not active.	Check whether the correct API is being called.
INVALID_CLIENT	F	The client is invalid.	The client ID does not exist or is invalid.
INVALID_SIGNATURE	F	The signature is invalid.	Make sure the request is properly signed with a valid signature.
METHOD_NOT_SUPPORTED	F	The server does not implement the requested HTTP method.	Ensure the HTTP method is `POST`.
UNKNOWN_EXCEPTION	U	API failed due to unknown reason.	The service might be down, retry later. If the issue persists, contact our Technical Support Team.
UN_SUPPORT_BUSINESS	F	Unsupported business.	Invalid parameter. Retry with the correct parameters.
USER_ACCOUNT_NOT_PRIMARY	F	The use account is not primary.	Use the primary account to query the interface.
AUTHORIZATION_NOT_EXIST	F	OAUTH does not exist.	Make sure that the input is correct. If the issue persists, contact our Technical Support Team to verify the authorization status.
ACCESS_TOKEN_EXPIRED	F	The access token has expired.	Refresh token to get a new access token or contact out Technical Support Team to address it.