open.shopweb.passengerFlow.getShopFlowTags (Get all customer flow tags based on store id)Sandbox debugging
Get all customer flow tags based on store id
Interface description#
The environment | Interface method | Submission method | Do you need a signature | HTTP request routing |
---|---|---|---|---|
Formal environment | open.shopweb.passengerFlow.getShopFlowTags | POST | true | http://openapi.opretail.com/m.api |
Common request parameters#
Parameters | Types of | Is required | The maximum length | Description | Example values |
---|---|---|---|---|---|
_aid | String | True | 20 | Open platform system number, fixed to S107 | S107 |
_akey | String | True | 20 | Opretail open platform assigns developer keys to third parties | Obtained after certification of platform developer |
_mt | String | True | 100 | Interface name | open.shopweb.passengerFlow.getShopFlowTags |
_sm | String | True | 100 | Signature algorithm md5,sha1 | md5 |
_requestMode | String | True | 100 | Request method post,get | POST |
_version | String | True | 100 | Version number | v1 |
_timestamp | String | True | 100 | Timestamp | yyyyMMddHHmmss format |
_sig | String | True | 32 | Signature token | Generated according to the signature algorithm, see the signature algorithm rules for details |
_format | String | False | 10 | Format type | Currently only supports json by default |
Business request parameters#
Parameters | Types of | Is required | The maximum length | Description | Example values |
---|---|---|---|---|---|
deptId | int | √ | Store id |
Common response parameters#
Parameters | Types of | The maximum length | Description | Example values |
---|---|---|---|---|
stat | JSON | - | Gateway status (specific parameters are described below :) | View |
stat.cid | String | 100 | Http request identifier | |
stat.code | String | 100 | Gateway return code | |
stat.codename | String | 100 | Gateway return code name | |
stat.systime | String | Long | The current time of the interface call | |
result | String | 100 | Interface returns prompt information | |
data | JSON | - | Business information returned by the interface call (generally json format data, the specific data format will be defined in the business return parameters) | View |
Business return parameters#
Parameter | Types of | Whether to return | Returns the maximum length | Description | Example values |
---|---|---|---|---|---|
isPrimaryPort | int | × | Whether it is the store owner's entrance (used to count the entire store's passenger flow) (0: no, 1: yes) | ||
isDelete | int | × | Whether to delete (0: not deleted, 1: deleted) | ||
deptId | int | × | Store id | ||
name | string | × | Label name | ||
tagType | int | × | Label type (0: Normal 1: Area (Subordinate sub-tag 5: Fitting room) 2: Format 3: Brand 4: Entrance | ||
canDelete | int | × | Can it be deleted (0: Can't 1: Can) | ||
pid | int | × | Parent tag id | ||
id | int | × | Label id | ||
childs | JSON | × | Inferior label | View | |
int | × | Whether it is the store owner's entrance (used to count the entire store's passenger flow) (0: no, 1: yes) | |||
int | × | Whether to delete (0: not deleted, 1: deleted) | |||
int | × | Store id | |||
string | × | Label name | |||
int | × | Label type (0: Normal 1: Area (Subordinate sub-tag 5: Fitting room) 2: Format 3: Brand 4: Entrance | |||
int | × | Can it be deleted (0: Can't 1: Can) |
Public return code#
Return code name | Return code | Return code description | Solution |
---|---|---|---|
SUCCESS | 0 | Call success | |
KEY_NOTNULL | 1 | _akey can not be empty | Input the _akey parameter when the interface is called |
KEY_UNLAWFUL | 2 | _akey is illegal | key is illegal, input in the correct key |
KEY_HAS_EXPIRED | 3 | _akey has expired | Please renew the service or contact the platform administrator |
SIGN_METHOD_NOTNULL | 4 | _sm parameter cannot be empty | Input the _sm parameter when the interface is called |
SIGN_TYPE_NOTEXIST | 5 | _sm type does not exist | Currently only supports md5, sha1 |
SIGN_NOTNULL | 6 | _sig parameter cannot be empty | Input the _sig parameter when the interface is called |
SIGN_WRONG | 7 | Invalid signature, please check parameters and signature format | _sig value is generated according to the signature algorithm |
METHOD_NOTNULL | 8 | _mt parameter cannot be empty | Input the _mt parameter when the interface is called |
METHOD_NOTEXIST_CODE | 9 | The method name corresponding to _mt does not exist or is not registered in the service | Check if the method corresponding to _mt method name and _version version number is passed in error |
REQUESTMODE_NOTNULL | 10 | _requestMode parameter cannot be empty | Input the _requestMode parameter when the interface is called |
APPLICATIONID_NOTNULL | 11 | _aid parameter cannot be empty | Input the _aid parameter when the interface is called |
APPLICATIONID_NOTSAME | 12 | _aid does not match the current key | _aid and _akey must correspond one-to-one |
VERSION_NOTNULL | 13 | _version version number cannot be empty | Input the _version parameter when the interface is called |
TIMESTAMP_NOTNULL | 14 | _timestamp timestamp cannot be empty | Input the _timestamp parameter when the interface is called |
TIMESTAMP_FORMAT_ERROR | 15 | _timestamp timestamp formatting error | According to yyyyMMddHHmmss format |
TIMESTAMP_OVERTIME | 16 | _timestamp has expired | _timestamp is regenerated every time the interface is called |
FORMAT_TYPE_NOTEXIST | 17 | _format type does not exist | Currently only supports json (default), xml |
API_CALL_REPEAT | -100 | The interface is called repeatedly | Interface platform call exception |
API_SYSTEM_CALL_ERROR | -500 | API call failed, system exception occurred | Interface platform call exception |
UNKNOWN_ERROR | -999 | Open platform system exception | Reissue request |
Business return code#
Return code name | Return code | Return code description |
---|