summaryrefslogtreecommitdiff
path: root/data/en_us/retailadvqa
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/retailadvqa
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/retailadvqa')
-rw-r--r--data/en_us/retailadvqa/2019-10-27/api-docs.php618
-rw-r--r--data/en_us/retailadvqa/2023-04-17/api-docs.php2185
2 files changed, 837 insertions, 1966 deletions
diff --git a/data/en_us/retailadvqa/2019-10-27/api-docs.php b/data/en_us/retailadvqa/2019-10-27/api-docs.php
index 226b0da..c998f50 100644
--- a/data/en_us/retailadvqa/2019-10-27/api-docs.php
+++ b/data/en_us/retailadvqa/2019-10-27/api-docs.php
@@ -1,23 +1,12 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'retailadvqa',
- 'version' => '2019-10-27',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'retailadvqa', 'version' => '2019-10-27'],
'directories' => [
[
'id' => 0,
'title' => '其它',
'type' => 'directory',
- 'children' => [
- 'PushAudience',
- 'QueryAudienceStatus',
- 'QueryBrandList',
- 'PushAcknowledgeCrowd',
- 'PageIncrementMembers',
- 'PageMembers',
- ],
+ 'children' => ['PushAudience', 'QueryAudienceStatus', 'QueryBrandList', 'PushAcknowledgeCrowd', 'PageIncrementMembers', 'PageMembers'],
],
],
'components' => [
@@ -25,13 +14,8 @@
],
'apis' => [
'PushAudience' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -44,68 +28,37 @@
[
'name' => 'CrowdId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'CrowdName',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'CrowdCount',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '50000000000',
- 'minimum' => '0',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '50000000000', 'minimum' => '0'],
],
[
'name' => 'BrandId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'BrandName',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'SmartName',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'Uid',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
],
'responses' => [
@@ -113,45 +66,25 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Data' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
- 'TraceId' => [
- 'type' => 'string',
- ],
- 'ErrorDesc' => [
- 'type' => 'string',
- ],
+ 'Data' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'ErrorCode' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
+ 'TraceId' => ['type' => 'string'],
+ 'ErrorDesc' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'AuthorizeFail',
- 'errorMessage' => 'Failed to authorize the API operation.',
- ],
+ ['errorCode' => 'AuthorizeFail', 'errorMessage' => 'Failed to authorize the API operation.'],
],
],
],
'QueryAudienceStatus' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -164,32 +97,17 @@
[
'name' => 'UploadId',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '0',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '0'],
],
[
'name' => 'CrowdId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
'name' => 'Uid',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
],
'responses' => [
@@ -197,34 +115,17 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'TraceId' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
- 'ErrorCode' => [
- 'type' => 'string',
- ],
- 'ErrorDesc' => [
- 'type' => 'string',
- ],
+ 'RequestId' => ['type' => 'string'],
+ 'TraceId' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
+ 'ErrorCode' => ['type' => 'string'],
+ 'ErrorDesc' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
- 'UploadId' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'Status' => [
- 'type' => 'string',
- ],
- 'CrowdId' => [
- 'type' => 'string',
- ],
+ 'UploadId' => ['type' => 'integer', 'format' => 'int32'],
+ 'Status' => ['type' => 'string'],
+ 'CrowdId' => ['type' => 'string'],
],
],
],
@@ -233,22 +134,14 @@
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'AuthorizeFail',
- 'errorMessage' => 'Failed to authorize the API operation.',
- ],
+ ['errorCode' => 'AuthorizeFail', 'errorMessage' => 'Failed to authorize the API operation.'],
],
],
],
'QueryBrandList' => [
'summary' => '查询品牌列表',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -261,9 +154,7 @@
[
'name' => 'uid',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string'],
],
],
'responses' => [
@@ -272,36 +163,21 @@
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'type' => 'string'],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'BrandName' => [
- 'type' => 'string',
- ],
- 'SmartName' => [
- 'type' => 'string',
- ],
+ 'BrandName' => ['type' => 'string'],
+ 'SmartName' => ['type' => 'string'],
],
],
],
- 'ErrorCode' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
- 'ErrorDesc' => [
- 'type' => 'string',
- ],
- 'TraceId' => [
- 'type' => 'string',
- ],
+ 'ErrorCode' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
+ 'ErrorDesc' => ['type' => 'string'],
+ 'TraceId' => ['type' => 'string'],
],
],
],
@@ -309,13 +185,8 @@
],
'PushAcknowledgeCrowd' => [
'summary' => 'A人群回流接口',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -328,45 +199,32 @@
[
'name' => 'CrowdId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string'],
],
[
'name' => 'CrowdCount',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64'],
],
[
'name' => 'BrandId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string'],
],
[
'name' => 'BrandName',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string'],
],
[
'name' => 'SmartName',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string'],
],
[
'name' => 'Uid',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string'],
],
],
'responses' => [
@@ -375,25 +233,12 @@
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
- 'TraceId' => [
- 'type' => 'string',
- ],
- 'ErrorDesc' => [
- 'type' => 'string',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'type' => 'string'],
+ 'Data' => ['type' => 'string'],
+ 'ErrorCode' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
+ 'TraceId' => ['type' => 'string'],
+ 'ErrorDesc' => ['type' => 'string'],
],
],
],
@@ -401,13 +246,8 @@
],
'PageIncrementMembers' => [
'summary' => '按照时间段分页获取会员新增数据接口',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -424,36 +264,11 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'OpenMerchantId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '750cff00c3e0996d220ac2861dafdfadsf',
- ],
- 'StartModifiedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-04-17 00:00:00',
- ],
- 'EndModifiedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-04-18 00:00:00'."\n",
- ],
- 'PageNo' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- ],
+ 'OpenMerchantId' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '750cff00c3e0996d220ac2861dafdfadsf'],
+ 'StartModifiedTime' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-04-17 00:00:00'],
+ 'EndModifiedTime' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-04-18 00:00:00'."\n"],
+ 'PageNo' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '1'],
+ 'PageSize' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '10'],
],
'required' => false,
],
@@ -466,111 +281,31 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5000',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n",
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Lydaas.QuickMember.SystemError'."\n",
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'TotalCount' => ['title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '5000'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n"],
+ 'Success' => ['description' => '', 'type' => 'string', 'example' => 'true'],
+ 'ErrorCode' => ['description' => '', 'type' => 'string', 'example' => 'Lydaas.QuickMember.SystemError'."\n"],
+ 'ErrorMessage' => ['description' => '', 'type' => 'string', 'example' => ''],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'OpenMerchantId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '750cff00c3e0996d220ac2861dafdfadsf',
- ],
- 'OuterMemberId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MEMBER_fc498a12edd84dafd',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Empti_Tier',
- ],
- 'Mobile' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '13999999999',
- ],
- 'MixMobile' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'dfafaswsdfdfdsga',
- ],
- 'Birthday' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1992-04-17',
- ],
- 'Province' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'City' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Sex' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Email' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'dfasdfa@qq.com',
- ],
- 'LevelNum' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'LevelPoints' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '99',
- ],
- 'ConsumePoints' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '999',
- ],
- 'SiteUsers' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '[{\\"omid\\": null, \\"ouid\\": null, \\"openUserId\\": \\"ddajkajdlf-dfasdfq24r\\", \\"channelCode\\": \\"taobao\\"}]'."\n",
- ],
+ 'OpenMerchantId' => ['description' => '', 'type' => 'string', 'example' => '750cff00c3e0996d220ac2861dafdfadsf'],
+ 'OuterMemberId' => ['description' => '', 'type' => 'string', 'example' => 'MEMBER_fc498a12edd84dafd'],
+ 'Name' => ['description' => '', 'type' => 'string', 'example' => 'Empti_Tier'],
+ 'Mobile' => ['description' => '', 'type' => 'string', 'example' => '13999999999'],
+ 'MixMobile' => ['description' => '', 'type' => 'string', 'example' => 'dfafaswsdfdfdsga'],
+ 'Birthday' => ['description' => '', 'type' => 'string', 'example' => '1992-04-17'],
+ 'Province' => ['description' => '', 'type' => 'string', 'example' => ''],
+ 'City' => ['description' => '', 'type' => 'string', 'example' => ''],
+ 'Sex' => ['description' => '', 'type' => 'string', 'example' => ''],
+ 'Email' => ['description' => '', 'type' => 'string', 'example' => 'dfasdfa@qq.com'],
+ 'LevelNum' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'LevelPoints' => ['description' => '', 'type' => 'string', 'example' => '99'],
+ 'ConsumePoints' => ['description' => '', 'type' => 'string', 'example' => '999'],
+ 'SiteUsers' => ['description' => '', 'type' => 'string', 'example' => '[{\\"omid\\": null, \\"ouid\\": null, \\"openUserId\\": \\"ddajkajdlf-dfasdfq24r\\", \\"channelCode\\": \\"taobao\\"}]'."\n"],
],
],
],
@@ -580,26 +315,16 @@
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'AuthorizeFail',
- 'errorMessage' => 'Failed to authorize the API operation.',
- ],
+ ['errorCode' => 'AuthorizeFail', 'errorMessage' => 'Failed to authorize the API operation.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 5000,\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\\\n\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\\\n\\",\\n \\"Data\\": [\\n {\\n \\"OpenMerchantId\\": \\"750cff00c3e0996d220ac2861dafdfadsf\\",\\n \\"OuterMemberId\\": \\"MEMBER_fc498a12edd84dafd\\",\\n \\"Name\\": \\"Empti_Tier\\",\\n \\"Mobile\\": \\"13999999999\\",\\n \\"MixMobile\\": \\"dfafaswsdfdfdsga\\",\\n \\"Birthday\\": \\"1992-04-17\\",\\n \\"Province\\": \\"浙江\\",\\n \\"City\\": \\"杭州\\",\\n \\"Sex\\": \\"男\\",\\n \\"Email\\": \\"dfasdfa@qq.com\\",\\n \\"LevelNum\\": 2,\\n \\"LevelPoints\\": \\"99\\",\\n \\"ConsumePoints\\": \\"999\\",\\n \\"SiteUsers\\": \\"[{\\\\\\\\\\\\\\"omid\\\\\\\\\\\\\\": null, \\\\\\\\\\\\\\"ouid\\\\\\\\\\\\\\": null, \\\\\\\\\\\\\\"openUserId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"ddajkajdlf-dfasdfq24r\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"channelCode\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"taobao\\\\\\\\\\\\\\"}]\\\\n\\"\\n }\\n ]\\n}","type":"json"}]',
],
'PageMembers' => [
'summary' => '按照时间分页获取会员数据接口',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -616,32 +341,10 @@
'description' => '',
'type' => 'object',
'properties' => [
- 'OpenMerchantId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '750cff00c3e0996d220ac2861dafdfadsf',
- ],
- 'EndCreatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-04-17 00:00:00',
- ],
- 'PageNo' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'OpenMerchantId' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '750cff00c3e0996d220ac2861dafdfadsf'],
+ 'EndCreatedTime' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-04-17 00:00:00'],
+ 'PageNo' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'PageSize' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
'required' => false,
],
@@ -654,110 +357,31 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5000',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Lydaas.QuickMember.SystemError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'TotalCount' => ['title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '5000'],
+ 'RequestId' => ['description' => '', 'type' => 'string', 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'],
+ 'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrorCode' => ['description' => '', 'type' => 'string', 'example' => 'Lydaas.QuickMember.SystemError'],
+ 'ErrorMessage' => ['description' => '', 'type' => 'string', 'example' => ''],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'OpenMerchantId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '750cff00c3e0996d220ac2861dafdfadsf'."\n",
- ],
- 'OuterMemberId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MEMBER_fc498a12edd84dafd',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Mobile' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '13999999999',
- ],
- 'MixMobile' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'fc498a12edd84dafdvdadfa',
- ],
- 'Birthday' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1992-04-17',
- ],
- 'Province' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'City' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Sex' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Email' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '112232312@qq.com',
- ],
- 'LevelNum' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'LevelPoints' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '999',
- ],
- 'ConsumePoints' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9999',
- ],
- 'SiteUsers' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '[{\\"omid\\": null, \\"ouid\\": null, \\"openUserId\\": \\"ddajkajdlf-dfasdfq24r\\", \\"channelCode\\": \\"taobao\\"}]',
- ],
+ 'OpenMerchantId' => ['description' => '', 'type' => 'string', 'example' => '750cff00c3e0996d220ac2861dafdfadsf'."\n"],
+ 'OuterMemberId' => ['description' => '', 'type' => 'string', 'example' => 'MEMBER_fc498a12edd84dafd'],
+ 'Name' => ['description' => '', 'type' => 'string', 'example' => ''],
+ 'Mobile' => ['description' => '', 'type' => 'string', 'example' => '13999999999'],
+ 'MixMobile' => ['description' => '', 'type' => 'string', 'example' => 'fc498a12edd84dafdvdadfa'],
+ 'Birthday' => ['description' => '', 'type' => 'string', 'example' => '1992-04-17'],
+ 'Province' => ['description' => '', 'type' => 'string', 'example' => ''],
+ 'City' => ['description' => '', 'type' => 'string', 'example' => ''],
+ 'Sex' => ['description' => '', 'type' => 'string', 'example' => ''],
+ 'Email' => ['description' => '', 'type' => 'string', 'example' => '112232312@qq.com'],
+ 'LevelNum' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'LevelPoints' => ['description' => '', 'type' => 'string', 'example' => '999'],
+ 'ConsumePoints' => ['description' => '', 'type' => 'string', 'example' => '9999'],
+ 'SiteUsers' => ['description' => '', 'type' => 'string', 'example' => '[{\\"omid\\": null, \\"ouid\\": null, \\"openUserId\\": \\"ddajkajdlf-dfasdfq24r\\", \\"channelCode\\": \\"taobao\\"}]'],
],
],
],
@@ -767,30 +391,16 @@
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'AuthorizeFail',
- 'errorMessage' => 'Failed to authorize the API operation.',
- ],
+ ['errorCode' => 'AuthorizeFail', 'errorMessage' => 'Failed to authorize the API operation.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 5000,\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\",\\n \\"Data\\": [\\n {\\n \\"OpenMerchantId\\": \\"750cff00c3e0996d220ac2861dafdfadsf\\\\n\\",\\n \\"OuterMemberId\\": \\"MEMBER_fc498a12edd84dafd\\",\\n \\"Name\\": \\"张三\\",\\n \\"Mobile\\": \\"13999999999\\",\\n \\"MixMobile\\": \\"fc498a12edd84dafdvdadfa\\",\\n \\"Birthday\\": \\"1992-04-17\\",\\n \\"Province\\": \\"浙江\\",\\n \\"City\\": \\"杭州\\",\\n \\"Sex\\": \\"男\\",\\n \\"Email\\": \\"112232312@qq.com\\",\\n \\"LevelNum\\": 1,\\n \\"LevelPoints\\": \\"999\\",\\n \\"ConsumePoints\\": \\"9999\\",\\n \\"SiteUsers\\": \\"[{\\\\\\\\\\\\\\"omid\\\\\\\\\\\\\\": null, \\\\\\\\\\\\\\"ouid\\\\\\\\\\\\\\": null, \\\\\\\\\\\\\\"openUserId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"ddajkajdlf-dfasdfq24r\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"channelCode\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"taobao\\\\\\\\\\\\\\"}]\\"\\n }\\n ]\\n}","type":"json"}]',
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'quicka.cn-shenzhen.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'quicka.cn-zhangjiakou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'quicka.cn-shanghai.aliyuncs.com',
- ],
+ ['regionId' => 'cn-shenzhen', 'endpoint' => 'quicka.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'quicka.cn-zhangjiakou.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'endpoint' => 'quicka.cn-shanghai.aliyuncs.com'],
],
];
diff --git a/data/en_us/retailadvqa/2023-04-17/api-docs.php b/data/en_us/retailadvqa/2023-04-17/api-docs.php
index 1949e10..7377497 100644
--- a/data/en_us/retailadvqa/2023-04-17/api-docs.php
+++ b/data/en_us/retailadvqa/2023-04-17/api-docs.php
@@ -1,1802 +1,1063 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'retailadvqa',
- 'version' => '2023-04-17',
- ],
- 'directories' => [
- [
- 'id' => 182071,
- 'title' => null,
- 'type' => 'directory',
- 'children' => [
- 'EditMemberBasicInfo',
- 'CalculateMemberLevel',
- 'MemberAccountDetailPageQuery',
- 'SyncMemberBehaviorInfo',
- 'QueryMemberBasicInfo',
- 'MemberPointChange',
- 'SyncCardInfo',
- 'AddMemberBasicInfo',
- 'BatchSaveOrderPop',
- ],
- ],
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'retailadvqa', 'version' => '2023-04-17'],
+ 'directories' => ['AddMemberBasicInfo', 'BatchSaveOrderPop', 'CalculateMemberLevel', 'EditMemberBasicInfo', 'MemberAccountDetailPageQuery', 'MemberPointChange', 'QueryMemberBasicInfo', 'SyncCardInfo', 'SyncMemberBehaviorInfo'],
'components' => [
'schemas' => [],
],
'apis' => [
- 'EditMemberBasicInfo' => [
- 'summary' => '会员信息编辑API',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AddMemberBasicInfo' => [
+ 'summary' => 'Synchronizes basic member information through the Open Platform.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'create', 'chargeType' => 'paid'],
'parameters' => [
[
- 'name' => 'Body',
+ 'name' => 'body',
'in' => 'query',
+ 'allowEmptyValue' => false,
'style' => 'json',
'schema' => [
- 'title' => '',
- 'description' => '',
+ 'description' => 'Request parameters.',
'type' => 'object',
'properties' => [
- 'OpenMerchantId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1230094',
- ],
- 'PlatformType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TAOBAO',
- ],
- 'Mobile' => [
- 'description' => '',
- 'type' => 'string',
+ 'OpenMerchantId' => ['title' => '', 'description' => 'The encrypted brand ID of the merchant.', 'type' => 'string', 'required' => true, 'example' => '750cff00c3e0996d220ac2861dafdfadsf'],
+ 'PlatFormType' => ['description' => 'The platform type.', 'type' => 'string', 'required' => true, 'example' => 'FENGXUAN', 'title' => ''],
+ 'MemberName' => ['title' => '', 'description' => 'The member name.', 'type' => 'string', 'required' => false, 'example' => '核桃'],
+ 'MemberNickName' => ['description' => 'The member nickname.', 'type' => 'string', 'required' => false, 'example' => 'aaa', 'title' => ''],
+ 'Mobile' => ['title' => '', 'description' => 'The mobile number.', 'type' => 'string', 'required' => false, 'example' => '17716699087'],
+ 'MixMobile' => ['title' => '', 'description' => 'The encrypted mobile number.', 'type' => 'string', 'required' => false, 'example' => 'afdsjkfasdklcajfsldjf'],
+ 'Sex' => ['title' => '', 'description' => 'The gender.', 'type' => 'string', 'required' => false, 'example' => '男/女'],
+ 'Birthday' => ['title' => '', 'description' => 'The birthday.', 'type' => 'string', 'required' => false, 'example' => '2022-09-08'],
+ 'Country' => ['description' => 'The country.', 'type' => 'string', 'required' => false, 'example' => '中国', 'title' => ''],
+ 'Province' => ['title' => '', 'description' => 'The province.', 'type' => 'string', 'required' => false, 'example' => '浙江省'],
+ 'City' => ['title' => '', 'description' => 'The city.', 'type' => 'string', 'required' => false, 'example' => '杭州市'],
+ 'Area' => ['description' => 'The area.', 'type' => 'string', 'required' => false, 'example' => '西湖区', 'title' => ''],
+ 'Email' => ['description' => 'The email address.', 'type' => 'string', 'required' => false, 'example' => 'xxx@email.com', 'title' => ''],
+ 'Avatar' => ['description' => 'The profile picture.', 'type' => 'string', 'required' => false, 'example' => 'https://static-legacy.dingtalk.com/media/lALPD1IyQHXWp0LMusy6_186_186.png', 'title' => ''],
+ 'Channels' => [
+ 'description' => 'The channels.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The channel object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ChannelCode' => ['description' => 'The channel code.', 'type' => 'string', 'required' => true, 'example' => 'alipay', 'title' => ''],
+ 'AppId' => ['description' => 'The application ID or mini program ID.', 'type' => 'string', 'required' => false, 'example' => '4958916073165425157001', 'title' => ''],
+ 'ChannelOpenId' => ['description' => 'The channel OpenId.', 'type' => 'string', 'required' => false, 'example' => 'openId', 'title' => ''],
+ 'ChannelUnionId' => ['description' => 'The channel UnionId.', 'type' => 'string', 'required' => false, 'example' => 'UnionId', 'title' => ''],
+ 'Scene' => ['title' => '', 'description' => 'The scene.', 'type' => 'string', 'required' => false, 'example' => '如:xxx活动'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => true,
- 'example' => '***********',
- ],
- 'MemberNickName' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- 'MemberName' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'Birthday' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-06-20',
- ],
- 'Country' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'Province' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'City' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'Area' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'Sex' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
+ 'maxItems' => 100,
+ 'title' => '',
'example' => '',
],
- 'Email' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx.com',
- ],
- 'Avatar' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx.jpg',
- ],
+ 'GmtCreate' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'required' => false, 'example' => '2023-02-17 00:00:00'],
+ 'Extra' => ['title' => '', 'description' => 'The additional information.', 'type' => 'string', 'required' => false, 'example' => '""'],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n",
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Lydaas.QuickMember.SystemError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID. It is a unique identifier.', 'type' => 'string', 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n"],
+ 'Success' => ['description' => 'Indicates whether the query was successful. Valid values:'."\n"
+ .'true: Success. '."\n"
+ .'false: Failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'Lydaas.QuickMember.SystemError'."\n"],
+ 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '系统错误: openMerchantId 不能为空'."\n"],
+ 'OuterMemberId' => ['title' => '', 'description' => 'The member ID.', 'type' => 'string', 'example' => 'WMS_36606164948078_23218019'],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\\\n\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
- ],
- 'CalculateMemberLevel' => [
- 'summary' => '会员等级初始化',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\\\n\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\\\n\\",\\n \\"OuterMemberId\\": \\"WMS_36606164948078_23218019\\"\\n}","type":"json"}]',
+ 'title' => 'Synchronize basic member information',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-08T15:44:45.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-11-13T12:37:32.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-08-03T11:00:34.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-07-27T11:49:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2023-07-20T02:32:50.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2023-05-25T03:30:01.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-05-19T06:29:54.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMemberBasicInfo'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'BatchSaveOrderPop' => [
+ 'summary' => 'Saves orders in batches.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'Body',
+ 'name' => 'Orders',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'CurrentGrade' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- 'CurrentGradeName' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- ],
- 'MemberId' => [
- 'description' => '',
- 'type' => 'string',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '4000006009418358',
- ],
- 'OpenMerchantId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1230094',
- ],
- 'PlatformType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TAOBAO',
- ],
- 'Score' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
- 'SerialNo' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0235b7f20a11de9e2bf4c3494b6d998d',
+ 'description' => 'The list of orders.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The model.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ChannelCode' => ['description' => 'The channel code.', 'type' => 'string', 'required' => true, 'example' => 'doudian', 'title' => ''],
+ 'ChannelOpenId' => ['description' => 'The channel user OpenID.', 'type' => 'string', 'required' => true, 'example' => '1699b2b974d444e3aa489f96457ef204', 'title' => ''],
+ 'OpenOrderId' => ['description' => 'The order ID.', 'type' => 'string', 'required' => true, 'example' => 'testOpenOrderId', 'title' => ''],
+ 'buyerOpenUid' => ['description' => 'The buyer ID.', 'type' => 'string', 'required' => false, 'example' => 'testBuyId', 'title' => ''],
+ 'OpenMerchantId' => ['description' => 'The brand ID.', 'type' => 'string', 'required' => true, 'example' => 'testOpenMerchantId', 'title' => ''],
+ 'PlatformType' => ['description' => 'The platform type.', 'type' => 'string', 'required' => true, 'example' => 'DOUDIAN', 'title' => ''],
+ 'OrderPayment' => ['description' => 'The payment amount. Unit: cents.', 'type' => 'string', 'required' => true, 'example' => '10000', 'title' => ''],
+ 'TotalFee' => ['description' => 'The order amount. Unit: cents.', 'type' => 'string', 'required' => true, 'example' => '10000', 'title' => ''],
+ 'PostFee' => ['description' => 'The postage fee.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
+ 'OrderCreateTime' => ['description' => 'The time when the order was placed.', 'type' => 'string', 'required' => true, 'example' => '2023-12-20 12:12:12', 'title' => ''],
+ 'PayTime' => ['description' => 'The payment time.', 'type' => 'string', 'required' => false, 'example' => '2023-12-20 12:12:12'."\n", 'title' => ''],
+ 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'required' => false, 'example' => '2023-12-20 12:12:12'."\n", 'title' => ''],
+ 'ShopId' => ['description' => 'The shop ID.', 'type' => 'string', 'required' => true, 'example' => 'testShopId', 'title' => ''],
+ 'Status' => ['description' => 'The order status.', 'type' => 'string', 'required' => true, 'example' => 'TRADE_FINISHED', 'title' => ''],
+ 'Feature' => ['description' => 'The extended attributes.', 'type' => 'string', 'required' => false, 'example' => '{\\"扩展属性1\\":\\"featureData1\\",\\"扩展属性2\\":\\"featureData2\\"}', 'title' => ''],
+ 'SubOrderModelList' => [
+ 'description' => 'The sub-order information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The model.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OpenSubOrderId' => ['description' => 'The sub-order ID.', 'type' => 'string', 'required' => true, 'example' => 'testSubOrderId', 'title' => ''],
+ 'TotalFee' => ['description' => 'The order amount. Unit: cents.', 'type' => 'string', 'required' => true, 'example' => '10000', 'title' => ''],
+ 'OrderPayment' => ['description' => 'The payment amount. Unit: cents.', 'type' => 'string', 'required' => true, 'example' => '10000', 'title' => ''],
+ 'ProductAmount' => ['description' => 'The product quantity.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
+ 'ProductId' => ['description' => 'The product ID.', 'type' => 'string', 'required' => false, 'example' => 'testProductld', 'title' => ''],
+ 'OutProductId' => ['description' => 'The external product ID.', 'type' => 'string', 'required' => false, 'example' => 'testOutProductId', 'title' => ''],
+ 'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'required' => false, 'example' => 'testProductName', 'title' => ''],
+ 'Status' => ['description' => 'The sub-order status.', 'type' => 'string', 'required' => true, 'example' => 'TRADE_FINISHED', 'title' => ''],
+ 'RefundStatus' => ['description' => 'The refund status.', 'type' => 'string', 'required' => false, 'example' => 'testRefundStatus', 'title' => ''],
+ 'Feature' => ['description' => 'The extended attributes.', 'type' => 'string', 'required' => false, 'example' => '{\\"扩展属性1\\":\\"featureData1\\",\\"扩展属性2\\":\\"featureData2\\"}', 'title' => ''],
+ 'OrderTag' => ['description' => 'The order tag.', 'type' => 'string', 'required' => false, 'example' => '购物金', 'title' => ''],
+ 'ConsignTime' => ['description' => 'The time when the seller shipped the order.', 'type' => 'string', 'required' => false, 'example' => '2023-09-09 00:09:00', 'title' => ''],
+ 'ReceiverCity' => ['description' => 'The city.', 'type' => 'string', 'required' => false, 'example' => '杭州', 'title' => ''],
+ 'ReceiverState' => ['description' => 'The province.', 'type' => 'string', 'required' => false, 'example' => '浙江省', 'title' => ''],
+ 'DiscountFee' => ['description' => 'The discount amount for the sub-order.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
+ 'AdjustFee' => ['description' => 'The manually adjusted amount.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
+ 'ItemMealId' => ['description' => 'The bundle ID.', 'type' => 'string', 'required' => false, 'example' => 'dhahakdk', 'title' => ''],
+ 'ItemMealName' => ['description' => 'The bundle name.', 'type' => 'string', 'required' => false, 'example' => '订单套餐', 'title' => ''],
+ 'BuyerRate' => ['description' => 'Indicates whether the buyer has rated the order. Valid values: 1: rated. 0: not rated.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
+ 'SellerRate' => ['description' => 'Indicates whether the seller has rated the order. Valid values: 1: rated. 0: not rated.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
+ 'RefundId' => ['description' => 'The refund ID.', 'type' => 'string', 'required' => false, 'example' => '12183883883883', 'title' => ''],
+ 'Cid' => ['description' => 'The product category ID.', 'type' => 'string', 'required' => false, 'example' => '42876171', 'title' => ''],
+ 'BuyerArea' => ['description' => 'The region where the buyer placed the order.', 'type' => 'string', 'required' => false, 'example' => '杭州', 'title' => ''],
+ 'SellerFlag' => ['description' => 'The seller remark flag.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ 'TradeFrom' => ['description' => 'The Taobao transaction source.', 'type' => 'string', 'required' => false, 'example' => 'WAP,WAP', 'title' => ''],
+ 'Payment' => ['description' => 'The actual payment amount of the sub-order after refund.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ConsignTime' => ['description' => 'The time when the seller shipped the order.', 'type' => 'string', 'required' => false, 'example' => '2023-09-09 00:09:00'."\n", 'title' => ''],
+ 'ReceiverCity' => ['description' => 'The city.', 'type' => 'string', 'required' => false, 'example' => '杭州', 'title' => ''],
+ 'ReceiverState' => ['description' => 'The province.', 'type' => 'string', 'required' => false, 'example' => '浙江省', 'title' => ''],
+ 'Sid' => ['description' => 'The logistics tracking number.', 'type' => 'string', 'required' => false, 'example' => 'dbssad19', 'title' => ''],
+ 'BuyerRate' => ['title' => '', 'description' => 'Indicates whether the buyer has rated the order. Valid values: 1: rated. 0: not rated.', 'type' => 'string', 'required' => false, 'example' => '1'],
+ 'SellerRate' => ['title' => '', 'description' => 'Indicates whether the seller has rated the order. Valid values: 1: rated. 0: not rated.', 'type' => 'string', 'required' => false, 'example' => '1'],
+ 'DiscountFee' => ['description' => 'The system discount amount.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
+ 'AdjustFee' => ['description' => 'The amount manually adjusted by the seller.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
+ 'CommissionFee' => ['description' => 'The transaction commission.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''],
+ 'BuyerArea' => ['description' => 'The region where the buyer placed the order.', 'type' => 'string', 'required' => false, 'example' => '杭州', 'title' => ''],
+ 'PointFee' => ['description' => 'The points used by the buyer.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ 'RealPointFee' => ['description' => 'The actual points used.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ 'SellerFlag' => ['description' => 'The seller remark flag.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ 'tradeFrom' => ['description' => 'The Taobao transaction source.', 'type' => 'string', 'required' => false, 'example' => 'WAP,WAP', 'title' => ''],
],
+ 'required' => true,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n",
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Lydaas.QuickMember.SystemError'."\n",
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'Grade' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'OuterMemberId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6062f9067f170700a2e7ef5a',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'testRequestId'],
+ 'Success' => ['description' => 'The result. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200/400...', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'testErrorCode', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'testErrorMessage', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\\\n\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\\\n\\",\\n \\"Message\\": \\"success\\",\\n \\"Grade\\": \\"1\\",\\n \\"OuterMemberId\\": \\"6062f9067f170700a2e7ef5a\\"\\n}","type":"json"}]',
- ],
- 'MemberAccountDetailPageQuery' => [
- 'summary' => '开放平台会员积分明细查询',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": \\"200/400...\\",\\n \\"ErrorCode\\": \\"testErrorCode\\",\\n \\"ErrorMessage\\": \\"testErrorMessage\\"\\n}","type":"json"}]',
+ 'title' => 'Save orders in batches',
+ 'changeSet' => [
+ ['createdAt' => '2024-11-28T15:49:07.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2023-12-23T13:07:04.000Z', 'description' => 'Request parameters changed'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'CalculateMemberLevel' => [
+ 'summary' => 'Initializes the member level calculation.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'body',
+ 'name' => 'Body',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The HTTP request body in JSON format.',
'type' => 'object',
'properties' => [
- 'OpenMerchantId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '750cff00c3e0996d220ac2861dafdfadsf',
- ],
- 'PlatFormType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- ],
- 'OuterMemberId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'WMS_36606164948078_23218019',
- ],
- 'AccountType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'enumValueTitles' => [
- 20 => '',
- 30 => '',
- ],
- 'example' => '20'."\n",
- ],
- 'StartTime' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2011-09-01 00:00:00'."\n"
- ."\n",
- ],
- 'EndTime' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2011-09-02 00:00:00'."\n"
- ."\n",
- ],
- 'Page' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'CurrentGrade' => ['description' => 'The member level.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
+ 'CurrentGradeName' => ['description' => 'The level name.', 'type' => 'string', 'required' => true, 'example' => '黄金', 'title' => ''],
+ 'MemberId' => ['description' => 'The member ID.', 'type' => 'string', 'required' => true, 'example' => '4000006009418358', 'title' => ''],
+ 'OpenMerchantId' => ['description' => 'The merchant ID.', 'type' => 'string', 'required' => true, 'example' => '1230094', 'title' => ''],
+ 'PlatformType' => ['description' => 'The platform type.', 'type' => 'string', 'required' => true, 'example' => 'TAOBAO', 'title' => ''],
+ 'Score' => ['description' => 'The points.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
+ 'SerialNo' => ['description' => 'The operation serial number.', 'type' => 'string', 'required' => true, 'example' => '0235b7f20a11de9e2bf4c3494b6d998d', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5000',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n",
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Lydaas.QuickMember.SystemError',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'OpenMerchantId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '750cff00c3e0996d220ac2861dafdfadsf'."\n",
- ],
- 'OuterMemberId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MEMBER_fc498a12edd84dafd',
- ],
- 'AccountType' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'OperateType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'DetailValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '20',
- ],
- 'AccountBalance' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'ChannelCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ActivityType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- ],
- 'GmtCreate' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- ],
- 'GmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- ],
- 'Remark' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '...',
- ],
- 'Extra' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '...',
- ],
- ],
- 'required' => true,
- ],
- 'required' => false,
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n"],
+ 'Success' => ['description' => 'Indicates whether the query was successful. Valid values:'."\n"
+ .'- true: Success. '."\n"
+ .'- false: Failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Lydaas.QuickMember.SystemError'."\n", 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the request is abnormal.', 'type' => 'string', 'example' => '系统错误: openMerchantId 不能为空'."\n", 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'Grade' => ['description' => 'The member level.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'OuterMemberId' => ['description' => 'The external member ID.', 'type' => 'string', 'example' => '6062f9067f170700a2e7ef5a', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IdempotentParameterMismatch',
- 'errorMessage' => 'IdempotentParameterMismatch',
- ],
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\\\n\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\\\n\\",\\n \\"Message\\": \\"success\\",\\n \\"Grade\\": \\"1\\",\\n \\"OuterMemberId\\": \\"6062f9067f170700a2e7ef5a\\"\\n}","type":"json"}]',
+ 'title' => 'Initialize member level calculation',
+ 'changeSet' => [
+ ['createdAt' => '2024-05-17T05:55:53.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 5000,\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\",\\n \\"Data\\": [\\n {\\n \\"OpenMerchantId\\": \\"750cff00c3e0996d220ac2861dafdfadsf\\\\n\\",\\n \\"OuterMemberId\\": \\"MEMBER_fc498a12edd84dafd\\",\\n \\"AccountType\\": 20,\\n \\"OperateType\\": \\"1\\",\\n \\"DetailValue\\": \\"20\\",\\n \\"AccountBalance\\": \\"100\\",\\n \\"ChannelCode\\": \\"如：alipay\\",\\n \\"ActivityType\\": \\"示例值：\\\\n订单/活动/抽奖/…\\",\\n \\"GmtCreate\\": \\"示例值：\\\\n2011-09-01 00:00:00\\",\\n \\"GmtModified\\": \\"示例值：\\\\n2011-09-01 00:00:00\\",\\n \\"Remark\\": \\"...\\",\\n \\"Extra\\": \\"...\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'ramActions' => [],
],
- 'SyncMemberBehaviorInfo' => [
- 'summary' => '开放平台会员行为信息同步',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'EditMemberBasicInfo' => [
+ 'summary' => 'Edits membership information.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'body',
+ 'name' => 'Body',
'in' => 'query',
'style' => 'json',
'schema' => [
+ 'title' => '',
+ 'description' => 'The content of the HTTP request body in JSON format.',
'type' => 'object',
'properties' => [
- 'OpenMerchantId' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'PlatFormType' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'OuterMemberId' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'ActionType' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'ActionSubType' => [
- 'type' => 'string',
- ],
- 'ActionStartDate' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'ActionEndDate' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'ActionResult' => [
- 'type' => 'boolean',
- ],
- 'ActionDuration' => [
- 'type' => 'string',
- ],
- 'Extra' => [
- 'type' => 'string',
- ],
+ 'OpenMerchantId' => ['description' => 'The merchant ID.', 'type' => 'string', 'required' => true, 'example' => '1230094', 'title' => ''],
+ 'PlatformType' => ['description' => 'The platform type.', 'type' => 'string', 'required' => true, 'example' => 'TAOBAO', 'title' => ''],
+ 'Mobile' => ['description' => 'The mobile number.', 'type' => 'string', 'required' => true, 'example' => '***********', 'title' => ''],
+ 'MemberNickName' => ['description' => 'The nickname of the member.', 'type' => 'string', 'required' => false, 'example' => 'xxxx', 'title' => ''],
+ 'MemberName' => ['description' => 'The name of the member.', 'type' => 'string', 'required' => false, 'example' => '杨x', 'title' => ''],
+ 'Birthday' => ['description' => 'The birthday.', 'type' => 'string', 'required' => false, 'example' => '2024-06-20', 'title' => ''],
+ 'Country' => ['description' => 'The country.', 'type' => 'string', 'required' => false, 'example' => '中国', 'title' => ''],
+ 'Province' => ['description' => 'The province.', 'type' => 'string', 'required' => false, 'example' => '山东省', 'title' => ''],
+ 'City' => ['description' => 'The city.', 'type' => 'string', 'required' => false, 'example' => '青岛市', 'title' => ''],
+ 'Area' => ['description' => 'The area.', 'type' => 'string', 'required' => false, 'example' => '小岛区', 'title' => ''],
+ 'Sex' => ['description' => 'The gender. Valid values: male, female, and unknown.', 'type' => 'string', 'required' => false, 'example' => '男', 'title' => ''],
+ 'Email' => ['description' => 'The email address.', 'type' => 'string', 'required' => false, 'example' => 'xxx.com', 'title' => ''],
+ 'Avatar' => ['description' => 'The profile picture.', 'type' => 'string', 'required' => false, 'example' => 'xxx.jpg', 'title' => ''],
],
+ 'required' => false,
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n",
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Lydaas.QuickMember.SystemError'."\n",
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n"],
+ 'Success' => ['description' => 'Indicates whether the query was successful. Valid values:'."\n"
+ .'- true: Success. '."\n"
+ .'- false: Failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Lydaas.QuickMember.SystemError', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '系统错误: openMerchantId 不能为空'."\n", 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'IdempotentParameterMismatch',
- 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\\\n\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]',
+ 'title' => 'Edit membership information',
+ 'description' => 'Edits membership information.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\\\n\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\"\\n}","type":"json"}]',
+ 'ramActions' => [],
],
- 'QueryMemberBasicInfo' => [
- 'summary' => '查询会员基础信息',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'MemberAccountDetailPageQuery' => [
+ 'summary' => 'Queries points transaction details.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'body',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The request parameters.',
'type' => 'object',
'properties' => [
- 'OpenMerchantId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '750cff00c3e0996d220ac2861dafdfadsf',
- ],
- 'PlatFormType' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'Type' => [
- 'description' => '',
- 'type' => 'string',
+ 'OpenMerchantId' => ['description' => 'The encrypted merchant ID.', 'type' => 'string', 'required' => true, 'example' => '750cff00c3e0996d220ac2861dafdfadsf', 'title' => ''],
+ 'PlatFormType' => ['description' => 'The platform type.', 'type' => 'string', 'required' => true, 'example' => '如：FENGXUAN', 'title' => ''],
+ 'OuterMemberId' => ['description' => 'The merchant member ID.', 'type' => 'string', 'required' => true, 'example' => 'WMS_36606164948078_23218019', 'title' => ''],
+ 'AccountType' => [
+ 'description' => 'The account type. Valid values:'."\n"
+ ."\n"
+ .'- 20: points'."\n"
+ .'- 30: growth value.',
+ 'enumValueTitles' => [20 => 'Points.', 30 => 'Growth value.'],
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => true,
- 'enumValueTitles' => [
- 1 => '',
- '',
- '',
- ],
- 'example' => '1',
- 'title' => '1-渠道OpenId'."\0".'，2-手机号，3-外部会员id',
- 'docRequired' => false,
- ],
- 'OuterMemberId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'WMS_36606164948078_23218019',
- ],
- 'Mobile' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '18888889999',
- ],
- 'ChannelCode' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- 'title' => 'wechat'."\0".'-微信，alipay'."\0".'-支付宝',
- ],
- 'ChannelOpenId' => [
- 'type' => 'string',
- ],
+ 'example' => '20'."\n",
+ 'title' => '',
+ ],
+ 'StartTime' => ['description' => 'The query start time, for example, 2011-09-01 00:00:00.', 'type' => 'string', 'required' => false, 'example' => '2011-09-01 00:00:00'."\n"
+ ."\n", 'title' => ''],
+ 'EndTime' => ['description' => 'The query end time, for example, 2011-11-30 23:59:59.', 'type' => 'string', 'required' => false, 'example' => '2011-09-02 00:00:00'."\n"
+ ."\n", 'title' => ''],
+ 'Page' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n",
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Lydaas.QuickMember.SystemError'."\n",
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
+ 'TotalCount' => ['title' => '', 'description' => 'The total number of entries that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '5000'],
+ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n"],
+ 'Success' => ['description' => 'Indicates whether the query was successful. Valid values:'."\n"
+ ."\n"
+ .'- true: Successful.'."\n"
+ .'- false: Failed.', 'type' => 'string', 'required' => true, 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Lydaas.QuickMember.SystemError', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message. This parameter is returned when the request is abnormal.', 'type' => 'string', 'example' => '系统错误: openMerchantId 不能为空', 'title' => ''],
'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'OpenMerchantId' => [
- 'type' => 'string',
- ],
- 'OuterMemberId' => [
- 'type' => 'string',
- ],
- 'MemberName' => [
- 'type' => 'string',
- ],
- 'Mobile' => [
- 'type' => 'string',
- ],
- 'Sex' => [
- 'type' => 'string',
- ],
- 'Birthday' => [
- 'type' => 'string',
- ],
- 'Country' => [
- 'type' => 'string',
- ],
- 'Province' => [
- 'type' => 'string',
- ],
- 'City' => [
- 'type' => 'string',
- ],
- 'Email' => [
- 'type' => 'string',
- ],
- 'Avatar' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'LevelNum' => [
- 'type' => 'string',
- ],
- 'LevelName' => [
- 'type' => 'string',
- ],
- 'Points' => [
- 'type' => 'string',
- ],
- 'Score' => [
- 'type' => 'string',
- ],
- 'Extra' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'Area' => [
- 'type' => 'string',
- ],
- 'MemberNickName' => [
- 'type' => 'string',
- ],
- 'NearExpiredScore' => [
- 'type' => 'string',
+ 'description' => 'The details list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OpenMerchantId' => ['description' => 'The encrypted merchant ID.', 'type' => 'string', 'example' => '750cff00c3e0996d220ac2861dafdfadsf'."\n", 'title' => ''],
+ 'OuterMemberId' => ['description' => 'The merchant member ID.', 'type' => 'string', 'example' => 'MEMBER_fc498a12edd84dafd', 'title' => ''],
+ 'AccountType' => ['description' => 'The account type. Valid values:'."\n"
+ ."\n"
+ .'- 20: points'."\n"
+ .'- 30: growth value.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'OperateType' => ['description' => 'The operation type. Valid values:'."\n"
+ ."\n"
+ .'- 1: increase'."\n"
+ .'- 2: decrease.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'DetailValue' => ['description' => 'The change value of points or growth value.', 'type' => 'string', 'example' => '20', 'title' => ''],
+ 'AccountBalance' => ['description' => 'The points balance after the change.', 'type' => 'string', 'example' => '100', 'title' => ''],
+ 'ChannelCode' => ['description' => 'The channel code.', 'type' => 'string', 'example' => '如：alipay', 'title' => ''],
+ 'ActivityType' => ['description' => 'The activity type.', 'type' => 'string', 'required' => true, 'example' => '示例值：'."\n"
+ .'订单/活动/抽奖/…', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'required' => true, 'example' => '示例值：'."\n"
+ .'2011-09-01 00:00:00', 'title' => ''],
+ 'GmtModified' => ['description' => 'The modification date.', 'type' => 'string', 'required' => true, 'example' => '示例值：'."\n"
+ .'2011-09-01 00:00:00', 'title' => ''],
+ 'Remark' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => '...', 'title' => ''],
+ 'Extra' => ['description' => 'The additional information.', 'type' => 'string', 'required' => true, 'example' => '...', 'title' => ''],
],
+ 'required' => true,
+ 'title' => '',
+ 'example' => '',
],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IdempotentParameterMismatch',
- 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
- ],
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'IdempotentParameterMismatch', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 5000,\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\",\\n \\"Data\\": [\\n {\\n \\"OpenMerchantId\\": \\"750cff00c3e0996d220ac2861dafdfadsf\\\\n\\",\\n \\"OuterMemberId\\": \\"MEMBER_fc498a12edd84dafd\\",\\n \\"AccountType\\": 20,\\n \\"OperateType\\": \\"1\\",\\n \\"DetailValue\\": \\"20\\",\\n \\"AccountBalance\\": \\"100\\",\\n \\"ChannelCode\\": \\"如：alipay\\",\\n \\"ActivityType\\": \\"示例值：\\\\n订单/活动/抽奖/…\\",\\n \\"GmtCreate\\": \\"示例值：\\\\n2011-09-01 00:00:00\\",\\n \\"GmtModified\\": \\"示例值：\\\\n2011-09-01 00:00:00\\",\\n \\"Remark\\": \\"...\\",\\n \\"Extra\\": \\"...\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query points transaction details',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\\\n\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\",\\n \\"Data\\": {\\n \\"OpenMerchantId\\": \\"750cff00c3e0996d220ac2861dafdfadsf\\\\n\\",\\n \\"OuterMemberId\\": \\"MEMBER_fc498a12edd84dafd\\",\\n \\"MemberName\\": \\"匿名会员\\",\\n \\"Mobile\\": \\"13999999999\\",\\n \\"Sex\\": \\"男\\",\\n \\"Birthday\\": \\"1992-04-17\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江\\",\\n \\"City\\": \\"杭州\\",\\n \\"Email\\": \\"xxx@xxx.com\\",\\n \\"Avatar\\": \\"https://tfs.alipayobjects.com/images/partner/TB1aWA7Xv5GDuNjHvSCXXczuXXa\\",\\n \\"LevelNum\\": \\"1\\",\\n \\"LevelName\\": \\"VIP0\\",\\n \\"Points\\": \\"100\\",\\n \\"Score\\": \\"73\\",\\n \\"Extra\\": \\"...\\",\\n \\"Area\\": \\"余杭\\",\\n \\"MemberNickName\\": \\"aaa\\",\\n \\"NearExpiredScore\\": \\"0\\"\\n }\\n}","type":"json"}]',
+ 'ramActions' => [],
],
'MemberPointChange' => [
- 'summary' => '会员积分变更',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'summary' => 'Changes membership points.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'body',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'Request parameters.',
'type' => 'object',
'properties' => [
- 'OpenMerchantId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '750cff00c3e0996d220ac2861dafdfadsf',
- ],
- 'PlatFormType' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'OuterMemberId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'WMS_36606164948078_23218019',
- ],
- 'Quantity' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1',
- ],
+ 'OpenMerchantId' => ['description' => 'The encrypted brand ID of the merchant.', 'type' => 'string', 'required' => true, 'example' => '750cff00c3e0996d220ac2861dafdfadsf', 'title' => ''],
+ 'PlatFormType' => ['description' => 'The platform type.', 'type' => 'string', 'required' => true, 'example' => 'FENGXUAN', 'title' => ''],
+ 'OuterMemberId' => ['description' => 'The merchant member ID.', 'type' => 'string', 'required' => true, 'example' => 'WMS_36606164948078_23218019', 'title' => ''],
+ 'Quantity' => ['description' => 'The value of points or growth value to change.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
'AccountType' => [
+ 'description' => 'The account type. Valid values:'."\n"
+ .'- 20: points'."\n"
+ .'- 30: growth value.',
+ 'enumValueTitles' => [20 => 'Points.', 30 => 'Growth value.'],
'type' => 'string',
'required' => true,
+ 'example' => '20',
+ 'title' => '',
],
'OperateType' => [
- 'description' => '',
+ 'description' => 'The change type. Valid values:'."\n"
+ .'- 1: increase'."\n"
+ .'- 2: deduction.',
+ 'enumValueTitles' => [1 => 'increase.', 'deduction.'],
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 1 => '',
- '',
- ],
'example' => '1',
+ 'title' => '',
],
- 'SerialNo' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '4LJDNJH9JUX48L41',
- ],
- 'ChannelCode' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'Extra' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '""',
- ],
+ 'SerialNo' => ['description' => 'The operation serial number.', 'type' => 'string', 'required' => true, 'example' => '4LJDNJH9JUX48L41', 'title' => ''],
+ 'ChannelCode' => ['description' => 'The channel code.', 'type' => 'string', 'required' => false, 'example' => '如：alipay', 'title' => ''],
+ 'Extra' => ['description' => 'The additional information.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'B2CD5682-12C0-51A7-82FC-1D36091CADAD',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Lydaas.QuickMember.SystemError'."\n",
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'AccountBalance' => [
- 'type' => 'string',
- ],
- 'LevelName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '12',
- 'required' => true,
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B2CD5682-12C0-51A7-82FC-1D36091CADAD'],
+ 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n"
+ .'- true: Success. '."\n"
+ .'- false: Failure.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Lydaas.QuickMember.SystemError'."\n", 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message. This parameter is returned when the request is abnormal.', 'type' => 'string', 'example' => '系统错误: openMerchantId 不能为空'."\n", 'title' => ''],
+ 'AccountBalance' => ['description' => 'The account balance.', 'type' => 'string', 'example' => '100', 'title' => ''],
+ 'LevelName' => ['description' => 'The member level.', 'type' => 'string', 'required' => true, 'example' => '12', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IdempotentParameterMismatch',
- 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
- ],
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2CD5682-12C0-51A7-82FC-1D36091CADAD\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\\\n\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\\\n\\",\\n \\"AccountBalance\\": \\"100\\",\\n \\"LevelName\\": \\"12\\"\\n}","type":"json"}]',
- ],
- 'SyncCardInfo' => [
- 'summary' => '卡券信息同步',
- 'methods' => [
- 'post',
+ 'title' => 'Change membership points',
+ 'changeSet' => [
+ ['createdAt' => '2023-08-03T11:00:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2023-07-27T11:49:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'QueryMemberBasicInfo' => [
+ 'summary' => 'Queries the basic information of a member.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'body',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'Request parameters.',
'type' => 'object',
'properties' => [
- 'OpenMerchantId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '750cff00c3e0996d220ac2861dafdfadsf',
- ],
- 'TransferId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3eecd2b8a6f946ca',
- ],
- 'OrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '223332140970453',
- ],
- 'BuyerId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1236437142867408',
- ],
- 'Recipient' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1000030855004',
- ],
- 'Phone' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '18899998888',
- ],
- 'OpenId' => [
- 'description' => 'openId',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1179ead68b3833fea61a802ddb1dd3ac',
- ],
- 'Nickname' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'HeaderImg' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://xxx/1.jpg',
- ],
- ],
- 'required' => false,
- ],
- 'Gifters' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1000030820003',
- ],
- 'Phone' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '13277778888',
- ],
- 'OpenId' => [
- 'description' => 'openId',
- 'type' => 'string',
- 'required' => false,
- 'example' => '82ace612cd377134d597e32e91562caf',
- ],
- 'Nickname' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'HeaderImg' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://xxx/2.jpg',
- ],
- ],
- 'required' => false,
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'success' => 'success',
- 'failed' => 'failed',
- ],
- 'example' => 'success',
- ],
- 'Theme' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'TransferredAt' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-05-12 00:00:00',
- ],
- 'ReceivedAt' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-05-12 00:00:00',
- ],
- 'PresentDetail' => [
- 'description' => '',
- 'type' => 'array',
- 'properties' => [
- 'ItemId' => [
- 'name' => 'ItemId',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '608356956277',
- 'backendName' => 'itemId',
- ],
- 'Price' => [
- 'name' => 'Price',
- 'description' => '',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '89.5',
- 'backendName' => 'price',
- ],
- 'Name' => [
- 'name' => 'Name',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- 'backendName' => 'name',
- ],
- 'Count' => [
- 'name' => 'Count',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
- 'backendName' => 'count',
- 'parseType' => 'struct',
- ],
- 'SkuId' => [
- 'name' => 'SkuId',
- 'description' => 'SKU',
- 'type' => 'string',
- 'required' => false,
- 'example' => '4365eaf6f61840f7ac77054126a33366',
- 'backendName' => 'skuId',
- ],
- ],
- 'required' => false,
- 'title' => '商品详情',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ItemId' => [
- 'title' => '商品ID',
- 'type' => 'string',
- ],
- 'Price' => [
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'Name' => [
- 'title' => '商品名称',
- 'type' => 'string',
- ],
- 'Count' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'SkuId' => [
- 'title' => 'SKU',
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'OccurredAt' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-05-12 00:00:00',
- ],
- 'Extra' => [
- 'description' => '',
+ 'OpenMerchantId' => ['description' => 'The encrypted brand ID of the merchant.', 'type' => 'string', 'required' => true, 'example' => '750cff00c3e0996d220ac2861dafdfadsf', 'title' => ''],
+ 'PlatFormType' => ['description' => 'The platform type.', 'type' => 'string', 'required' => true, 'example' => 'FENGXUAN', 'title' => ''],
+ 'Type' => [
+ 'title' => '',
+ 'description' => 'The query type. You can query by member ID, mobile number, or channel open ID. Valid values:'."\n"
+ .'1: ChannelOpenId. Supported only when ChannelCode is set to alipay or wechat. ChannelOpenId is required.'."\n"
+ .'2: mobile. mobile is required.'."\n"
+ .'3: OuterMemberId. OuterMemberId is required.',
+ 'enumValueTitles' => [1 => 'ChannelOpenId', 'Mobile', 'OuterMemberId'],
'type' => 'string',
- 'required' => false,
- 'example' => '""',
+ 'required' => true,
+ 'docRequired' => false,
+ 'example' => '1',
],
+ 'OuterMemberId' => ['description' => 'The merchant member ID.', 'type' => 'string', 'required' => false, 'example' => 'WMS_36606164948078_23218019', 'title' => ''],
+ 'Mobile' => ['description' => 'The mobile number.', 'type' => 'string', 'required' => false, 'example' => '18888889999', 'title' => ''],
+ 'ChannelCode' => ['title' => '', 'description' => 'The channel code.', 'type' => 'string', 'required' => false, 'example' => '如：alipay'],
+ 'ChannelOpenId' => ['description' => 'The channel open ID.', 'type' => 'string', 'required' => false, 'example' => '750cff00c3e099', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'Response parameters.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n",
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Lydaas.QuickMember.SystemError'."\n",
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n"],
+ 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n"
+ .'- true: Success.'."\n"
+ .'- false: Failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Lydaas.QuickMember.SystemError'."\n", 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message. Returned when the request is abnormal.', 'type' => 'string', 'example' => '系统错误: openMerchantId 不能为空', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The data returned by the API, which contains the member information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OpenMerchantId' => ['description' => 'The encrypted merchant ID.', 'type' => 'string', 'example' => '750cff00c3e0996d220ac2861dafdfadsf'."\n", 'title' => ''],
+ 'OuterMemberId' => ['description' => 'The merchant member ID.', 'type' => 'string', 'example' => 'MEMBER_fc498a12edd84dafd', 'title' => ''],
+ 'MemberName' => ['description' => 'The member name.', 'type' => 'string', 'example' => '匿名会员', 'title' => ''],
+ 'Mobile' => ['description' => 'The mobile number.', 'type' => 'string', 'example' => '13999999999', 'title' => ''],
+ 'Sex' => ['description' => 'The gender (male or female).', 'type' => 'string', 'example' => '男', 'title' => ''],
+ 'Birthday' => ['description' => 'The birthday.', 'type' => 'string', 'example' => '1992-04-17', 'title' => ''],
+ 'Country' => ['description' => 'The country.', 'type' => 'string', 'example' => '中国', 'title' => ''],
+ 'Province' => ['description' => 'The province.', 'type' => 'string', 'example' => '浙江', 'title' => ''],
+ 'City' => ['description' => 'The city.', 'type' => 'string', 'example' => '杭州', 'title' => ''],
+ 'Email' => ['description' => 'The email address.', 'type' => 'string', 'example' => 'xxx@xxx.com', 'title' => ''],
+ 'Avatar' => ['description' => 'The profile picture.', 'type' => 'string', 'required' => true, 'example' => 'https://tfs.alipayobjects.com/images/partner/TB1aWA7Xv5GDuNjHvSCXXczuXXa', 'title' => ''],
+ 'LevelNum' => ['description' => 'The level number.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'LevelName' => ['description' => 'The member level.', 'type' => 'string', 'example' => 'VIP0', 'title' => ''],
+ 'Points' => ['description' => 'The member growth value.', 'type' => 'string', 'example' => '100', 'title' => ''],
+ 'Score' => ['description' => 'The membership points.', 'type' => 'string', 'example' => '73', 'title' => ''],
+ 'Extra' => ['description' => 'The additional information.', 'type' => 'string', 'required' => false, 'example' => '...', 'title' => ''],
+ 'Area' => ['description' => 'The area.', 'type' => 'string', 'example' => '余杭', 'title' => ''],
+ 'MemberNickName' => ['description' => 'The member nickname.', 'type' => 'string', 'example' => 'aaa', 'title' => ''],
+ 'NearExpiredScore' => ['description' => 'The points that are about to expire.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ ],
+ 'title' => '',
'example' => '',
],
- 'Message' => [
- 'type' => 'string',
- ],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IdempotentParameterMismatch',
- 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
- ],
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\\\n\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\\\n\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]',
- ],
- 'AddMemberBasicInfo' => [
- 'summary' => '开放平台同步会员基础信息',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\\\n\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\",\\n \\"Data\\": {\\n \\"OpenMerchantId\\": \\"750cff00c3e0996d220ac2861dafdfadsf\\\\n\\",\\n \\"OuterMemberId\\": \\"MEMBER_fc498a12edd84dafd\\",\\n \\"MemberName\\": \\"匿名会员\\",\\n \\"Mobile\\": \\"13999999999\\",\\n \\"Sex\\": \\"男\\",\\n \\"Birthday\\": \\"1992-04-17\\",\\n \\"Country\\": \\"中国\\",\\n \\"Province\\": \\"浙江\\",\\n \\"City\\": \\"杭州\\",\\n \\"Email\\": \\"xxx@xxx.com\\",\\n \\"Avatar\\": \\"https://tfs.alipayobjects.com/images/partner/TB1aWA7Xv5GDuNjHvSCXXczuXXa\\",\\n \\"LevelNum\\": \\"1\\",\\n \\"LevelName\\": \\"VIP0\\",\\n \\"Points\\": \\"100\\",\\n \\"Score\\": \\"73\\",\\n \\"Extra\\": \\"...\\",\\n \\"Area\\": \\"余杭\\",\\n \\"MemberNickName\\": \\"aaa\\",\\n \\"NearExpiredScore\\": \\"0\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Query member basic information',
+ 'changeSet' => [
+ ['createdAt' => '2024-01-10T01:32:48.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-08-03T11:00:34.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-07-27T11:49:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'SyncCardInfo' => [
+ 'summary' => 'Synchronizes voucher information.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'body',
'in' => 'query',
- 'allowEmptyValue' => false,
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The request parameters.',
'type' => 'object',
'properties' => [
- 'OpenMerchantId' => [
- 'title' => '开放商家加密ID',
- 'type' => 'string',
- 'required' => true,
- ],
- 'PlatFormType' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'MemberName' => [
- 'title' => '姓名',
- 'type' => 'string',
- ],
- 'MemberNickName' => [
- 'type' => 'string',
- ],
- 'Mobile' => [
- 'title' => '手机号',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '17716699087',
- ],
- 'MixMobile' => [
- 'title' => '加密手机号',
- 'type' => 'string',
- ],
- 'Sex' => [
- 'title' => '性别',
- 'type' => 'string',
- ],
- 'Birthday' => [
- 'title' => '生日',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2022-09-08',
- ],
- 'Country' => [
- 'type' => 'string',
- ],
- 'Province' => [
- 'title' => '省份',
- 'description' => '',
- 'type' => 'string',
+ 'OpenMerchantId' => ['description' => 'The encrypted Brand ID of the merchant.', 'type' => 'string', 'required' => false, 'example' => '750cff00c3e0996d220ac2861dafdfadsf', 'title' => ''],
+ 'TransferId' => ['description' => 'The gift transfer order number.', 'type' => 'string', 'required' => false, 'example' => '3eecd2b8a6f946ca', 'title' => ''],
+ 'OrderId' => ['description' => 'The purchase order number.', 'type' => 'string', 'required' => false, 'example' => '223332140970453', 'title' => ''],
+ 'BuyerId' => ['description' => 'The User ID of the buyer.', 'type' => 'string', 'required' => false, 'example' => '1236437142867408', 'title' => ''],
+ 'Recipient' => [
+ 'description' => 'The recipient of the gift.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'The ID of the recipient.', 'type' => 'string', 'required' => false, 'example' => '1000030855004', 'title' => ''],
+ 'Phone' => ['description' => 'The phone number of the recipient.', 'type' => 'string', 'required' => false, 'example' => '18899998888', 'title' => ''],
+ 'OpenId' => ['description' => 'openId', 'type' => 'string', 'required' => false, 'example' => '1179ead68b3833fea61a802ddb1dd3ac', 'title' => ''],
+ 'Nickname' => ['description' => 'The nickname of the recipient.', 'type' => 'string', 'required' => false, 'example' => '大大', 'title' => ''],
+ 'HeaderImg' => ['description' => 'The profile picture of the recipient.', 'type' => 'string', 'required' => false, 'example' => 'https://xxx/1.jpg', 'title' => ''],
+ ],
'required' => false,
+ 'title' => '',
'example' => '',
],
- 'City' => [
- 'title' => '城市',
- 'description' => '',
- 'type' => 'string',
+ 'Gifters' => [
+ 'description' => 'The gifter.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'The ID of the gifter.', 'type' => 'string', 'required' => false, 'example' => '1000030820003', 'title' => ''],
+ 'Phone' => ['description' => 'The phone number of the gifter.', 'type' => 'string', 'required' => false, 'example' => '13277778888', 'title' => ''],
+ 'OpenId' => ['description' => 'openId', 'type' => 'string', 'required' => false, 'example' => '82ace612cd377134d597e32e91562caf', 'title' => ''],
+ 'Nickname' => ['description' => 'The nickname of the gifter.', 'type' => 'string', 'required' => false, 'example' => '小小', 'title' => ''],
+ 'HeaderImg' => ['description' => 'The profile picture of the recipient.', 'type' => 'string', 'required' => false, 'example' => 'https://xxx/2.jpg', 'title' => ''],
+ ],
'required' => false,
+ 'title' => '',
'example' => '',
],
- 'Area' => [
- 'type' => 'string',
- ],
- 'Email' => [
- 'type' => 'string',
- ],
- 'Avatar' => [
+ 'Status' => [
+ 'description' => 'The status of the voucher. Valid values:'."\n"
+ .'- 1: Not redeemed.'."\n"
+ .'- 2: Redeemed.'."\n"
+ .'- 3: Returned.'."\n"
+ .'- 4: Expired.',
+ 'enumValueTitles' => [1 => 'Not redeemed.', 'Redeemed.', 'Returned.', 'Expired.'],
'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ 'title' => '',
],
- 'Channels' => [
- 'description' => '',
+ 'Theme' => ['description' => 'The name of the gift card.', 'type' => 'string', 'required' => false, 'example' => '礼品a', 'title' => ''],
+ 'TransferredAt' => ['description' => 'The time when the gift was transferred. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2023-05-12 00:00:00', 'title' => ''],
+ 'ReceivedAt' => ['description' => 'The time when the gift was received. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2023-05-12 00:00:00', 'title' => ''],
+ 'PresentDetail' => [
+ 'title' => '',
+ 'description' => 'The product details.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The product detail information.',
'type' => 'object',
'properties' => [
- 'ChannelCode' => [
- 'type' => 'string',
- 'required' => true,
- ],
- 'AppId' => [
- 'type' => 'string',
- ],
- 'ChannelOpenId' => [
- 'type' => 'string',
- ],
- 'ChannelUnionId' => [
- 'type' => 'string',
- ],
- 'Scene' => [
- 'title' => '场景',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'ItemId' => ['title' => '', 'description' => 'The Product ID.', 'type' => 'string', 'required' => false, 'example' => '608356956277'],
+ 'Price' => ['description' => 'The price of the product.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '89.5', 'title' => ''],
+ 'Name' => ['title' => '', 'description' => 'The Product Name.', 'type' => 'string', 'required' => false, 'example' => 'A商品'],
+ 'Count' => ['description' => 'The quantity of the product.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
+ 'SkuId' => ['title' => '', 'description' => 'SKU', 'type' => 'string', 'required' => false, 'example' => '4747141632519'],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
- 'required' => true,
- 'maxItems' => 100,
- ],
- 'GmtCreate' => [
- 'title' => '创建时间',
- 'type' => 'string',
- ],
- 'Extra' => [
- 'title' => '其他',
- 'description' => '',
- 'type' => 'string',
'required' => false,
- 'example' => '""',
+ 'example' => '',
],
+ 'OccurredAt' => ['description' => 'The system record time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2023-05-12 00:00:00', 'title' => ''],
+ 'Extra' => ['description' => 'The additional information.', 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，唯一标示',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n",
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Lydaas.QuickMember.SystemError'."\n",
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- 'OuterMemberId' => [
- 'title' => '会员id',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'WMS_36606164948078_23218019',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID. Each request has a unique ID for troubleshooting purposes.', 'type' => 'string', 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n"],
+ 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ .'- true: Successful. '."\n"
+ .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Lydaas.QuickMember.SystemError'."\n", 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message. This parameter is returned when the request is abnormal.', 'type' => 'string', 'example' => '系统错误: openMerchantId 不能为空'."\n", 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IdempotentParameterMismatch',
- 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
- ],
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n \\"Success\\": \\"true\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\\\n\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\\\n\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]',
+ 'title' => 'Synchronize voucher information',
+ 'changeSet' => [
+ ['createdAt' => '2023-05-31T02:07:38.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-05-30T03:37:40.000Z', 'description' => 'Request parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncCardInfo'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\\\n\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\\\n\\",\\n \\"OuterMemberId\\": \\"WMS_36606164948078_23218019\\"\\n}","type":"json"}]',
+ 'ramActions' => [],
],
- 'BatchSaveOrderPop' => [
- 'summary' => '批量保存订单信息',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'SyncMemberBehaviorInfo' => [
+ 'summary' => 'Saves membership behavior information.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
- 'name' => 'Orders',
+ 'name' => 'body',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ChannelCode' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'doudian',
- ],
- 'ChannelOpenId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1699b2b974d444e3aa489f96457ef204',
- ],
- 'OpenOrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testOpenOrderId',
- ],
- 'buyerOpenUid' => [
- 'type' => 'string',
- ],
- 'OpenMerchantId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testOpenMerchantId',
- ],
- 'PlatformType' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DOUDIAN',
- ],
- 'OrderPayment' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '10000',
- ],
- 'TotalFee' => [
- 'description' => '',
- 'type' => 'string',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '10000',
- ],
- 'PostFee' => [
- 'type' => 'string',
- ],
- 'OrderCreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2023-12-20 12:12:12',
- ],
- 'PayTime' => [
- 'type' => 'string',
- ],
- 'EndTime' => [
- 'type' => 'string',
- ],
- 'ShopId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testShopId',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TRADE_FINISHED',
- ],
- 'Feature' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'SubOrderModelList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'OpenSubOrderId' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testSubOrderId',
- ],
- 'TotalFee' => [
- 'description' => '',
- 'type' => 'string',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '10000',
- ],
- 'OrderPayment' => [
- 'description' => '',
- 'type' => 'string',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '10000',
- ],
- 'ProductAmount' => [
- 'description' => '',
- 'type' => 'string',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
- 'ProductId' => [
- 'type' => 'string',
- ],
- 'OutProductId' => [
- 'type' => 'string',
- ],
- 'ProductName' => [
- 'type' => 'string',
- ],
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TRADE_FINISHED',
- ],
- 'RefundStatus' => [
- 'type' => 'string',
- ],
- 'Feature' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'OrderTag' => [
- 'type' => 'string',
- ],
- 'ConsignTime' => [
- 'type' => 'string',
- ],
- 'ReceiverCity' => [
- 'type' => 'string',
- ],
- 'ReceiverState' => [
- 'type' => 'string',
- ],
- 'DiscountFee' => [
- 'type' => 'string',
- ],
- 'AdjustFee' => [
- 'type' => 'string',
- ],
- 'ItemMealId' => [
- 'type' => 'string',
- ],
- 'ItemMealName' => [
- 'type' => 'string',
- ],
- 'BuyerRate' => [
- 'type' => 'string',
- ],
- 'SellerRate' => [
- 'type' => 'string',
- ],
- 'RefundId' => [
- 'type' => 'string',
- ],
- 'Cid' => [
- 'type' => 'string',
- ],
- 'BuyerArea' => [
- 'type' => 'string',
- ],
- 'SellerFlag' => [
- 'type' => 'string',
- ],
- 'TradeFrom' => [
- 'type' => 'string',
- ],
- 'Payment' => [
- 'type' => 'string',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
- 'ConsignTime' => [
- 'type' => 'string',
- ],
- 'ReceiverCity' => [
- 'type' => 'string',
- ],
- 'ReceiverState' => [
- 'type' => 'string',
- ],
- 'Sid' => [
- 'type' => 'string',
- ],
- 'BuyerRate' => [
- 'title' => '买家是否评价,1-已评价,0-未评价',
- 'type' => 'string',
- ],
- 'SellerRate' => [
- 'title' => '卖家是否评价,1-已评价,0-未评价',
- 'type' => 'string',
- ],
- 'DiscountFee' => [
- 'type' => 'string',
- ],
- 'AdjustFee' => [
- 'type' => 'string',
- ],
- 'CommissionFee' => [
- 'type' => 'string',
- ],
- 'BuyerArea' => [
- 'type' => 'string',
- ],
- 'PointFee' => [
- 'type' => 'string',
- ],
- 'RealPointFee' => [
- 'type' => 'string',
- ],
- 'SellerFlag' => [
- 'type' => 'string',
- ],
- 'tradeFrom' => [
- 'type' => 'string',
- ],
- ],
- 'required' => true,
+ 'description' => 'Request parameters.',
+ 'type' => 'object',
+ 'properties' => [
+ 'OpenMerchantId' => ['description' => 'The encrypted merchant ID.', 'type' => 'string', 'required' => true, 'example' => '750cff00c3e0996d220ac2861dafdfadsf', 'title' => ''],
+ 'PlatFormType' => ['description' => 'The platform type.', 'type' => 'string', 'required' => true, 'example' => '如：FENGXUAN', 'title' => ''],
+ 'OuterMemberId' => ['description' => 'The merchant member ID.', 'type' => 'string', 'required' => true, 'example' => 'WMS_36606164948078_23218019', 'title' => ''],
+ 'ActionType' => [
+ 'description' => 'The behavior type. Valid values:'."\n"
+ .'- sign: check-in'."\n"
+ .'- medal: medal'."\n"
+ .'- questionnaire: questionnaire.',
+ 'enumValueTitles' => ['questionnaire' => 'questionnaire', 'sign' => 'sign', 'medal' => 'medal'],
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'sign',
+ 'title' => '',
+ ],
+ 'ActionSubType' => ['description' => 'The behavior subtype.', 'type' => 'string', 'required' => false, 'example' => '...', 'title' => ''],
+ 'ActionStartDate' => ['description' => 'The date when the behavior occurred.', 'type' => 'string', 'required' => false, 'example' => '2023-01-01 00:00:00', 'title' => ''],
+ 'ActionEndDate' => ['description' => 'The date when the behavior ended.', 'type' => 'string', 'required' => false, 'example' => '2023-01-01 00:00:00', 'title' => ''],
+ 'ActionResult' => ['description' => 'The behavior result. Valid values:'."\n"
+ .'- true: Success.'."\n"
+ .'- false: Failure.', 'type' => 'boolean', 'required' => false, 'example' => 'true'."\n", 'title' => ''],
+ 'ActionDuration' => ['description' => 'The duration, in seconds.', 'type' => 'string', 'required' => false, 'example' => '18', 'title' => ''],
+ 'Extra' => ['description' => 'The additional information.', 'type' => 'string', 'required' => false, 'example' => '...', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'testRequestId',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'HttpStatusCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200/400...',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'testErrorCode',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'testErrorMessage',
- ],
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1DEFC4F1-AF11-5A3C-93B9-2880768DA218'."\n"],
+ 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n"
+ .'- true: Success. '."\n"
+ .'- false: Failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Lydaas.QuickMember.SystemError'."\n", 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '系统错误: openMerchantId 不能为空', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'IdempotentParameterMismatch',
- 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
- ],
+ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DEFC4F1-AF11-5A3C-93B9-2880768DA218\\\\n\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Lydaas.QuickMember.SystemError\\\\n\\",\\n \\"ErrorMessage\\": \\"系统错误: openMerchantId 不能为空\\"\\n}","type":"json"}]',
+ 'title' => 'Save membership behavior information',
+ 'changeSet' => [
+ ['createdAt' => '2023-07-27T11:49:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": \\"200/400...\\",\\n \\"ErrorCode\\": \\"testErrorCode\\",\\n \\"ErrorMessage\\": \\"testErrorMessage\\"\\n}","type":"json"}]',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
],
],
'endpoints' => [
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'quicka.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'quicka.cn-zhangjiakou.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'quicka.cn-shenzhen.aliyuncs.com', 'endpoint' => 'quicka.cn-shenzhen.aliyuncs.com', 'vpc' => 'quicka-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'quicka.cn-shanghai.aliyuncs.com', 'endpoint' => 'quicka.cn-shanghai.aliyuncs.com', 'vpc' => 'quicka-vpc.cn-shanghai.aliyuncs.com'],
+ ],
+ 'errorCodes' => [],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'BatchSaveOrderPop'],
+ ],
+ 'createdAt' => '2024-11-28T15:49:13.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'AddMemberBasicInfo'],
+ ],
+ 'createdAt' => '2024-08-08T15:44:51.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CalculateMemberLevel'],
+ ],
+ 'createdAt' => '2024-05-17T05:55:56.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'QueryMemberBasicInfo'],
+ ],
+ 'createdAt' => '2024-01-10T01:32:53.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'BatchSaveOrderPop'],
+ ],
+ 'createdAt' => '2023-12-23T13:07:11.000Z',
+ 'description' => '',
+ ],
[
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'quicka.cn-shenzhen.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'AddMemberBasicInfo'],
+ ],
+ 'createdAt' => '2023-11-13T12:37:38.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'AddMemberBasicInfo'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'MemberPointChange'],
+ ['description' => 'Response parameters changed', 'api' => 'QueryMemberBasicInfo'],
+ ],
+ 'createdAt' => '2023-08-03T11:00:39.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'AddMemberBasicInfo'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'MemberPointChange'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'QueryMemberBasicInfo'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SyncMemberBehaviorInfo'],
+ ],
+ 'createdAt' => '2023-07-27T11:49:39.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'quicka.cn-zhangjiakou.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'AddMemberBasicInfo'],
+ ],
+ 'createdAt' => '2023-07-20T02:32:55.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'SyncCardInfo'],
+ ],
+ 'createdAt' => '2023-05-31T02:07:41.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'quicka.cn-shanghai.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'SyncCardInfo'],
+ ],
+ 'createdAt' => '2023-05-30T03:37:44.000Z',
+ 'description' => '',
],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'AddMemberBasicInfo'],
+ ],
+ 'createdAt' => '2023-05-25T03:33:07.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'AddMemberBasicInfo'],
+ ],
+ 'createdAt' => '2023-05-19T06:30:08.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'PageIncrementMembers'],
+ ['description' => 'Response parameters changed', 'api' => 'PageMembers'],
+ ],
+ 'createdAt' => '2023-04-24T12:23:54.000Z',
+ 'description' => '',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncCardInfo'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMemberBasicInfo'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'QuickAudience',
+ 'productName' => 'Quick Audience',
+ 'ramCodes' => ['quickaudience'],
+ 'ramLevel' => 'SERVICE',
+ 'ramConditions' => [],
+ 'ramActions' => [],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 19:00:59 +0000