summaryrefslogtreecommitdiff
path: root/data/en_us/cloudesl/2020-02-01
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/cloudesl/2020-02-01
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/cloudesl/2020-02-01')
-rw-r--r--data/en_us/cloudesl/2020-02-01/api-docs.php8174
1 files changed, 2428 insertions, 5746 deletions
diff --git a/data/en_us/cloudesl/2020-02-01/api-docs.php b/data/en_us/cloudesl/2020-02-01/api-docs.php
index c194742..9a23bdd 100644
--- a/data/en_us/cloudesl/2020-02-01/api-docs.php
+++ b/data/en_us/cloudesl/2020-02-01/api-docs.php
@@ -1,103 +1,50 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'cloudesl',
- 'version' => '2020-02-01',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'cloudesl', 'version' => '2020-02-01'],
'directories' => [
[
- 'id' => 149062,
- 'title' => null,
+ 'children' => ['BindEslDevice', 'UnbindEslDevice', 'UpdateEslDeviceLight', 'DescribeBinders', 'DescribeEslDevice', 'DescribeEslDevices'],
'type' => 'directory',
- 'children' => [
- 'BindEslDevice',
- 'UnbindEslDevice',
- 'UpdateEslDeviceLight',
- 'DescribeBinders',
- 'DescribeEslDevice',
- 'DescribeEslDevices',
- ],
+ 'title' => 'CloudESL devices',
],
[
- 'id' => 149069,
- 'title' => null,
+ 'children' => ['CreateStore', 'DeleteStore', 'UpdateStore', 'UpdateStoreConfig', 'DescribeStores', 'DescribeStoreConfig'],
'type' => 'directory',
- 'children' => [
- 'CreateStore',
- 'DeleteStore',
- 'UpdateStore',
- 'UpdateStoreConfig',
- 'DescribeStores',
- 'DescribeStoreConfig',
- ],
+ 'title' => 'Stores',
],
[
- 'id' => 149076,
- 'title' => null,
+ 'children' => ['DeleteItem', 'BatchInsertItems', 'DescribeItems'],
'type' => 'directory',
- 'children' => [
- 'DeleteItem',
- 'BatchInsertItems',
- 'DescribeItems',
- ],
+ 'title' => 'Items',
],
[
- 'id' => 149080,
- 'title' => null,
+ 'children' => ['AssignUser', 'UnassignUser', 'DescribeUserLog'],
'type' => 'directory',
- 'children' => [
- 'AddUser',
- 'DeleteUser',
- 'AssignUser',
- 'UnassignUser',
- 'DescribeUserLog',
- 'DescribeUsers',
- 'GetUser',
- ],
+ 'title' => 'Users',
],
[
- 'id' => 149088,
- 'title' => null,
+ 'children' => ['AddApDevice', 'DeleteApDevice', 'ActivateApDevice', 'DescribeApDevices'],
'type' => 'directory',
- 'children' => [
- 'AddApDevice',
- 'DeleteApDevice',
- 'ActivateApDevice',
- 'DescribeApDevices',
- ],
+ 'title' => 'Base station devices',
],
[
- 'id' => 362556,
- 'title' => null,
+ 'children' => ['ApplyCompanyTemplateVersionToStores', 'DescribeStoreByTemplateVersion', 'DescribeCompanyTemplateVersions', 'DescribeEslModelByTemplateVersion', 'DescribeTemplateByModel', 'DescribeAvailableEslModels', 'DeleteCompanyTemplate', 'AddCompanyTemplate', 'SyncAddMaterial', 'QueryTemplateListByGroupId'],
+ 'type' => 'directory',
+ 'title' => 'Other',
+ ],
+ [
+ 'children' => ['AddUser', 'DeleteUser', 'DescribeUsers', 'GetUser'],
+ 'title' => 'Others',
'type' => 'directory',
- 'children' => [
- 'ApplyCompanyTemplateVersionToStores',
- 'DescribeStoreByTemplateVersion',
- 'DescribeCompanyTemplateVersions',
- 'DescribeEslModelByTemplateVersion',
- 'DescribeTemplateByModel',
- 'DescribeAvailableEslModels',
- 'DeleteCompanyTemplate',
- 'AddCompanyTemplate',
- 'SyncAddMaterial',
- 'QueryTemplateListByGroupId',
- ],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'BindEslDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ActivateApDevice' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -108,122 +55,98 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ItemBarCode',
+ 'name' => 'ApMac',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '690560583****',
- ],
+ 'schema' => ['description' => 'The MAC address of the base station device.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11:22:33:44:55:66', 'title' => ''],
],
[
- 'name' => 'EslBarCode',
+ 'name' => 'StoreId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '18bc5a63****',
- ],
+ 'schema' => ['description' => 'The store ID or custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
- 'name' => 'StoreId',
+ 'name' => 'ExtraParams',
'in' => 'formData',
+ 'schema' => ['description' => 'A reserved parameter. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'The request status identifier.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'title' => 'ActivateApDevice',
+ 'summary' => 'Activates a base station device.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T06:18:47.000Z', 'description' => 'Error codes changed'],
+ ],
+ ],
+ 'AddApDevice' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Shelf',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20200201',
- ],
+ 'AK' => [],
],
[
- 'name' => 'Layer',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'BearerToken' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create'],
+ 'parameters' => [
[
- 'name' => 'Column',
+ 'name' => 'StoreId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The store ID or custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
- 'name' => 'ExtraParams',
+ 'name' => 'ApMac',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'The MAC address of the base station device. You can call DescribeApDevices to obtain this value.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11:22:33:44:55:66', 'title' => ''],
],
[
- 'name' => 'LayoutId',
+ 'name' => 'Remark',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7',
- ],
+ 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => '天猫店的基站设备', 'title' => ''],
],
[
- 'name' => 'ContainerId',
+ 'name' => 'ClientToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The client token.', 'type' => 'string', 'required' => false, 'example' => '1*', 'title' => ''],
],
[
- 'name' => 'ContainerName',
+ 'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'A reserved parameter. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
- 'name' => 'LayoutName',
+ 'name' => 'SerialNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The serial number (SN) of the device.', 'type' => 'string', 'required' => false, 'example' => '18****', 'title' => ''],
],
],
'responses' => [
@@ -231,75 +154,35 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 418 => [
- [
- 'errorCode' => 'LayoutOrContainerIsNotExistErrorPub',
- 'errorMessage' => 'Layout or Container is not exist.',
- ],
- [
- 'errorCode' => 'ContainerTemplateNoMatchPub',
- 'errorMessage' => 'The Template of the Container has not match at all.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","errorExample":""},{"type":"xml","example":"<code>200</code>\\n<data>\\n <RequestId>8F124625-DF0A-4B08-B205-2CF538FAF713</RequestId>\\n <Success>true</Success>\\n</data>\\n<requestId>8F124625-DF0A-4B08-B205-2CF538FAF713</requestId>\\n<successResponse>true</successResponse>","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'title' => 'Add a base station device',
+ 'summary' => 'Adds a base station device with the specified MAC address and automatically attempts to activate it.',
+ 'requestParamsDescription' => 'The Remark parameter is not supported.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'UnbindEslDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T06:18:47.000Z', 'description' => 'Error codes changed'],
],
+ ],
+ 'AddCompanyTemplate' => [
+ 'summary' => 'Add a template.'."\n",
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -310,90 +193,87 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'EslBarCode',
+ 'name' => 'Scene',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '18bc5a63****',
- ],
+ 'schema' => ['description' => 'Scenarios. Select an appropriate scenario.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'NORMAL', 'title' => ''],
],
[
- 'name' => 'ItemBarCode',
+ 'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '690560583****',
- ],
+ 'schema' => ['description' => 'System extension field. Ignore this field.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
- 'name' => 'Column',
+ 'name' => 'EslSize',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'ESL size', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '800X480', 'title' => ''],
],
[
- 'name' => 'StoreId',
+ 'name' => 'TemplateName',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
- ],
+ 'schema' => ['description' => 'Template Name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '促销', 'maxLength' => 128, 'minLength' => 0, 'title' => ''],
],
[
- 'name' => 'Shelf',
+ 'name' => 'Layout',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20200201',
- ],
+ 'schema' => ['description' => 'Layout information.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'Layer',
+ 'name' => 'TemplateVersion',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'Outlet template version.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.1.0', 'title' => ''],
],
[
- 'name' => 'ExtraParams',
+ 'name' => 'DeviceType',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'Device type', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3', 'title' => ''],
],
[
- 'name' => 'ContainerName',
+ 'name' => 'TemplateType',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Template type'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
+ ],
+ [
+ 'name' => 'IfPromotion',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Specifies whether it is a promotion. Valid values: - true: Yes. - false: No.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'IfSourceCode',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Indicates whether source tracing is enabled. Valid values: - true: Yes. - false: No.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'IfDefault',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Specifies whether the template is the default one. Valid values: - true: Yes. - false: No.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'IfMember',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Specifies whether it is for membership. Valid values: - true: Yes. - false: No.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'IfOutOfInventory',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Indicates whether the item is out of stock. Valid values: - true: Yes. - false: No.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'Vendor',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Device manufacturer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ali', 'title' => ''],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Template group ID', 'type' => 'string', 'required' => false, 'example' => '9', 'title' => ''],
+ ],
+ [
+ 'name' => 'TemplateSceneId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Custom Template ID'."\n", 'type' => 'string', 'required' => false, 'example' => '大甩卖', 'title' => ''],
],
],
'responses' => [
@@ -401,64 +281,36 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
+ 'RequestId' => ['description' => 'Request ID.'."\n", 'type' => 'string', 'example' => 'C033DCCE-FA85-5AD8-9A7C-C3F41220B898', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'Error message returned when the invocation fails.'."\n", 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request succeeded.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'Error code'."\n", 'type' => 'string', 'example' => 'InvalidResourceType.NotSupported', 'title' => ''],
+ 'Code' => ['description' => 'HTTP status code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Response message. If the request succeeds, the value is "success".'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'Error message'."\n", 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'Dynamic error code.'."\n", 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","errorExample":""},{"type":"xml","example":"<code>200</code>\\n<data>\\n <RequestId>8F124625-DF0A-4B08-B205-2CF538FAF713</RequestId>\\n <Success>true</Success>\\n</data>\\n<requestId>8F124625-DF0A-4B08-B205-2CF538FAF713</requestId>\\n<successResponse>true</successResponse>","errorExample":""}]',
- 'title' => 'UnbindEslDevice',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'UpdateEslDeviceLight' => [
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 418 => [
+ ['errorCode' => 'DuplicateTemplateSceneIdErrorPub', 'errorMessage' => 'The TemplateSceneId is duplicated.', 'description' => ''],
+ ['errorCode' => 'ContainerLayoutBindEslDevicePub', 'errorMessage' => 'The Layout of the Container has been bound to an ESL device.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C033DCCE-FA85-5AD8-9A7C-C3F41220B898\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"InvalidResourceType.NotSupported\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => 'Error codes changed, Request parameters changed'],
],
+ 'title' => '',
+ ],
+ 'AddUser' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -469,177 +321,108 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'LedColor',
+ 'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'GREEN',
- ],
+ 'schema' => ['description' => 'The UID of the RAM user.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '134****', 'title' => ''],
],
[
- 'name' => 'Frequency',
+ 'name' => 'ClientToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'NORMAL',
- ],
+ 'schema' => ['description' => 'The client token.', 'type' => 'string', 'required' => false, 'example' => '1*', 'title' => ''],
],
[
- 'name' => 'StoreId',
+ 'name' => 'ExtraParams',
'in' => 'formData',
+ 'schema' => ['description' => 'The system extension field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'title' => 'Create a user',
+ 'summary' => 'Creates a user.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T06:18:46.000Z', 'description' => 'Error codes changed'],
+ ],
+ ],
+ 'ApplyCompanyTemplateVersionToStores' => [
+ 'summary' => 'Apply the version to outlets.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ItemBarCode',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6905605836648',
- ],
+ 'AK' => [],
],
[
- 'name' => 'LightUpTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '30',
- ],
+ 'BearerToken' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete'],
+ 'parameters' => [
[
- 'name' => 'EslBarCode',
+ 'name' => 'TemplateVersion',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '18bc5a631ak9',
- ],
+ 'schema' => ['description' => 'Outlet template version number.', 'type' => 'string', 'required' => true, 'example' => '1.1.0', 'title' => ''],
],
[
- 'name' => 'ExtraParams',
+ 'name' => 'Stores',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'List of outlet IDs. Convert it to a JSON string.', 'type' => 'string', 'required' => false, 'example' => '[\\"s-y9eoecc7mu\\"]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'FailCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'SuccessCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
- 'LightFailEslInfos' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'EslBarCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '18bc5a63****',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified ESL device does not exist.',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '450E6CA4-5C5D-5DED-86C2-2B577C291764', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'Error message returned when the invocation fails.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Message' => ['description' => 'Response message. If the request succeeds, the value is "success".', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'Dynamic error message used to replace the %s placeholder in the ErrorMessage parameter of the response.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"FailCount\\": 0,\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"SuccessCount\\": 1,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"LightFailEslInfos\\": [\\n {\\n \\"EslBarCode\\": \\"18bc5a63****\\",\\n \\"ErrorMessage\\": \\"The specified ESL device does not exist.\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<code>200</code>\\n<data>\\n <RequestId>8F124625-DF0A-4B08-B205-2CF538FAF713</RequestId>\\n <Success>true</Success>\\n</data>\\n<requestId>8F124625-DF0A-4B08-B205-2CF538FAF713</requestId>\\n<successResponse>true</successResponse>","errorExample":""}]',
- 'title' => 'UpdateEslDeviceLight',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"450E6CA4-5C5D-5DED-86C2-2B577C291764\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'changeSet' => [],
+ 'title' => '',
],
- 'DescribeBinders' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AssignUser' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -648,84 +431,39 @@
'BearerToken' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ItemBarCode',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '690560583****',
- ],
- ],
- [
- 'name' => 'EslBarCode',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '18bc5a63****',
- ],
- ],
- [
- 'name' => 'StoreId',
+ 'name' => 'Stores',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
- ],
+ 'schema' => ['description' => 'The list of store IDs.', 'type' => 'string', 'required' => false, 'example' => '[s-dxsxxxxxx,s-dxsyyyyyyy]', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The UID of the Alibaba Cloud RAM user.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1344***', 'title' => ''],
],
[
- 'name' => 'ItemTitle',
+ 'name' => 'UserType',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The type of the user. Valid values:'."\n"
+ ."\n"
+ .'- `USER_TYPE_COMPANY_ROOT`: Super merchant administrator. This role can create, read, update, and delete accounts related to merchants and stores.'."\n"
+ ."\n"
+ .'- `USER_TYPE_COMPANY_ADMIN`: Merchant administrator. This role can create, read, update, and delete accounts related to stores under the merchant.'."\n"
+ ."\n"
+ .'- `USER_TYPE_STORE_ADMIN`: Store administrator. A store administrator can be associated with multiple stores, but each store can only be associated with one store administrator.'."\n"
+ ."\n"
+ .'- `USER_TYPE_STORE_OPERATOR`: Store operator. This role can only be associated with one store.'."\n"
+ ."\n"
+ .'- `USER_TYPE_GUEST`: Guest with no permissions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'USER_TYPE_COMPANY_OWNER', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'The extended information.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
@@ -733,204 +471,34 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '6E0FF7FA-3F89-598F-9BF2-57DF480FE111',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '24',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
- 'EslItemBindInfos' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'EslBarCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '18bc5a63****',
- ],
- 'TemplateSceneId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'ActionPrice' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '690',
- ],
- 'ItemTitle' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'PromotionStart' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-03-16T07:05:34Z',
- ],
- 'PriceUnit' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '187',
- ],
- 'OriginalPrice' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '500',
- ],
- 'ItemId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1234567',
- ],
- 'GmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1656469716000',
- ],
- 'EslPic' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'kUzlfuzgayDo5uTXW3D66Q',
- ],
- 'StoreId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 's-pdwrrnkufn',
- ],
- 'ItemShortTitle' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'BindId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'b4adf048-f36d-4da5-a8bb-ab4adbd5eb04',
- ],
- 'PromotionText' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'EslModel' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'AESL0213',
- ],
- 'BePromotion' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'SkuId' => [
- 'description' => 'SkuID。',
- 'type' => 'string',
- 'example' => '124',
- ],
- 'EslConnectAp' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '11:22:33:44:55:66',
- ],
- 'EslStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ESL_STATUS_ONLINE',
- ],
- 'TemplateId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'PromotionEnd' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-03-17T07:05:34Z',
- ],
- 'ItemBarCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '690560583****',
- ],
- 'ContainerName' => [
- 'title' => '绑定的模板区域名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters ', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001 ', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E0FF7FA-3F89-598F-9BF2-57DF480FE111\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"null\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 24,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"EslItemBindInfos\\": [\\n {\\n \\"EslBarCode\\": \\"18bc5a63****\\",\\n \\"TemplateSceneId\\": \\"123456\\",\\n \\"ActionPrice\\": \\"690\\",\\n \\"ItemTitle\\": \\"麦麸吐司\\",\\n \\"PromotionStart\\": \\"2020-03-16T07:05:34Z\\",\\n \\"PriceUnit\\": \\"187\\",\\n \\"OriginalPrice\\": \\"500\\",\\n \\"ItemId\\": \\"1234567\\",\\n \\"GmtModified\\": \\"1656469716000\\",\\n \\"EslPic\\": \\"kUzlfuzgayDo5uTXW3D66Q\\",\\n \\"StoreId\\": \\"s-pdwrrnkufn\\",\\n \\"ItemShortTitle\\": \\"牛奶\\",\\n \\"BindId\\": \\"b4adf048-f36d-4da5-a8bb-ab4adbd5eb04\\",\\n \\"PromotionText\\": \\"买一送一\\",\\n \\"EslModel\\": \\"AESL0213\\",\\n \\"BePromotion\\": true,\\n \\"SkuId\\": \\"124\\",\\n \\"EslConnectAp\\": \\"11:22:33:44:55:66\\",\\n \\"EslStatus\\": \\"ESL_STATUS_ONLINE\\",\\n \\"TemplateId\\": \\"123456\\",\\n \\"PromotionEnd\\": \\"2020-03-17T07:05:34Z\\",\\n \\"ItemBarCode\\": \\"690560583****\\",\\n \\"ContainerName\\": \\"2\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeBindersResponse>\\n <RequestId>6E0FF7FA-3F89-598F-9BF2-57DF480FE111</RequestId>\\n <ErrorMessage>The specified resource type is invalid.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>MandatoryParameters</ErrorCode>\\n <Code>-1001</Code>\\n <Message>null</Message>\\n <DynamicMessage>The specified store %s does not exist.</DynamicMessage>\\n <PageNumber>1</PageNumber>\\n <PageSize>20</PageSize>\\n <TotalCount>24</TotalCount>\\n <DynamicCode>PlatformResponseError.%s</DynamicCode>\\n <EslItemBindInfos>\\n <EslBarCode>18bc5a63****</EslBarCode>\\n <TemplateSceneId>123456</TemplateSceneId>\\n <ActionPrice>690</ActionPrice>\\n <ItemTitle>麦麸吐司</ItemTitle>\\n <PromotionStart>2020-03-16T07:05:34Z</PromotionStart>\\n <PriceUnit>187</PriceUnit>\\n <OriginalPrice>500</OriginalPrice>\\n <ItemId>1234567</ItemId>\\n <GmtModified>1656469716000</GmtModified>\\n <EslPic>kUzlfuzgayDo5uTXW3D66Q</EslPic>\\n <StoreId>s-pdwrrnkufn</StoreId>\\n <ItemShortTitle>牛奶</ItemShortTitle>\\n <BindId>b4adf048-f36d-4da5-a8bb-ab4adbd5eb04</BindId>\\n <PromotionText>买一送一</PromotionText>\\n <EslModel>AESL0213</EslModel>\\n <BePromotion>true</BePromotion>\\n <SkuId>124</SkuId>\\n <EslConnectAp>11:22:33:44:55:66</EslConnectAp>\\n <EslStatus>ESL_STATUS_ONLINE</EslStatus>\\n <TemplateId>123456</TemplateId>\\n <PromotionEnd>2020-03-17T07:05:34Z</PromotionEnd>\\n <ItemBarCode>690560583****</ItemBarCode>\\n <ContainerName>2</ContainerName>\\n </EslItemBindInfos>\\n</DescribeBindersResponse>","errorExample":""}]',
- ],
- 'DescribeEslDevice' => [
- 'summary' => '增量查询价签绑定状态',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters \\",\\n \\"Code\\": \\"-1001 \\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'title' => 'AssignUser',
+ 'summary' => 'Assigns user permissions.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T06:18:46.000Z', 'description' => 'Error codes changed'],
],
+ ],
+ 'BatchInsertItems' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -939,120 +507,177 @@
'BearerToken' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'StoreId',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The store ID or merchant-defined custom store ID. A maximum of 100 records can be inserted at a time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
- 'name' => 'FromDate',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'ToDate',
+ 'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The system extension field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'SyncByItemId',
'in' => 'formData',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'schema' => ['description' => 'Specifies whether to update item information for other items with the same ItemId in the store. Default value: false. If this parameter is set to true, the item information is updated for all items with the same ItemId in the store. If the item list contains multiple items with the same ItemId, the last item in the list is used for the update.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'ItemInfo',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => 'The list of item information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ActionPrice' => ['description' => 'The actual selling price, in cents.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '500', 'title' => ''],
+ 'ItemTitle' => ['description' => 'The full name of the item. Maximum length: 100 characters.', 'type' => 'string', 'required' => true, 'example' => '光明儿童星', 'title' => ''],
+ 'BrandName' => ['description' => 'The brand name. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '光明乳业', 'title' => ''],
+ 'SourceCode' => ['description' => 'The traceability code. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '1234567', 'title' => ''],
+ 'PriceUnit' => ['description' => 'The pricing unit. Maximum length: 64 characters.', 'type' => 'string', 'required' => true, 'example' => '箱', 'title' => ''],
+ 'ForestFirstId' => ['description' => 'The first-level item category ID. Maximum length: 32 characters.', 'type' => 'string', 'required' => false, 'example' => '食品', 'title' => ''],
+ 'CustomizeFeatureF' => ['description' => 'The custom attribute F. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性F', 'title' => ''],
+ 'CustomizeFeatureA' => ['description' => 'The custom attribute A. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性A', 'title' => ''],
+ 'CustomizeFeatureK' => ['description' => 'The custom attribute K. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性K', 'title' => ''],
+ 'TemplateSceneId' => ['description' => 'The custom template ID. If valid characters are specified, the system matches the custom template for item display. Default value: empty string "".', 'type' => 'string', 'required' => false, 'example' => '23452', 'title' => ''],
+ 'CustomizeFeatureD' => ['description' => 'The custom attribute D. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性D', 'title' => ''],
+ 'MemberPrice' => ['description' => 'The member price, in cents.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '800', 'title' => ''],
+ 'ModelNumber' => ['description' => 'The model number. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '330', 'title' => ''],
+ 'PromotionStart' => ['description' => 'The promotion start time in UTC format: "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'".', 'type' => 'string', 'required' => false, 'example' => '2020-02-10T00:00:00Z', 'title' => ''],
+ 'CategoryName' => ['description' => 'The category name. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '饮料', 'title' => ''],
+ 'CustomizeFeatureE' => ['description' => 'The custom attribute E. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性E', 'title' => ''],
+ 'SuggestPrice' => ['description' => 'The suggested retail price, in cents.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '600', 'title' => ''],
+ 'SaleSpec' => ['description' => 'The specification. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '330毫升', 'title' => ''],
+ 'PromotionText' => ['description' => 'The promotion text. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '买一送一', 'title' => ''],
+ 'PromotionReason' => ['description' => 'The promotion reason. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '儿童节活动', 'title' => ''],
+ 'Rank' => ['description' => 'The rank. Maximum length: 32 characters.', 'type' => 'string', 'required' => false, 'example' => '1级', 'title' => ''],
+ 'CustomizeFeatureG' => ['description' => 'The custom attribute G. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性G', 'title' => ''],
+ 'SalesPrice' => ['description' => 'The sales price, in cents.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''],
+ 'CustomizeFeatureH' => ['description' => 'The custom attribute H. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性H', 'title' => ''],
+ 'OriginalPrice' => ['description' => 'The original price, in cents.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''],
+ 'CustomizeFeatureI' => ['description' => 'The custom attribute I. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性I', 'title' => ''],
+ 'ProductionPlace' => ['description' => 'The place of origin. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '中国', 'title' => ''],
+ 'CustomizeFeatureB' => ['description' => 'The custom attribute B. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性B', 'title' => ''],
+ 'ItemShortTitle' => ['description' => 'The short name of the item. If not specified, the value is truncated from the full item name. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '牛奶', 'title' => ''],
+ 'CustomizeFeatureN' => ['description' => 'The custom attribute N. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性N', 'title' => ''],
+ 'BeMember' => ['description' => 'Specifies whether to match the member template for display. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ 'TaxFee' => ['description' => 'The tax information. Maximum length: 32 characters.', 'type' => 'string', 'required' => false, 'example' => '增值税', 'title' => ''],
+ 'InventoryStatus' => ['description' => 'Specifies whether to match the out-of-stock template for display. Valid values:'."\n"
+ ."\n"
+ .'- `OUT_OF_STOCK`: out of stock.'."\n"
+ ."\n"
+ .'- `NORMAL`: Normal.'."\n"
+ ."\n"
+ .'Default value: NORMAL. If this parameter is set to OUT_OF_STOCK, the out-of-stock template is used for display.', 'type' => 'string', 'required' => false, 'example' => 'OUT_OF_STOCK', 'title' => ''],
+ 'ItemPicUrl' => ['description' => 'The URL of the item image. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => 'http://m.taobao.com/xxx.html', 'title' => ''],
+ 'SupplierName' => ['description' => 'The distributor name. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '天猫超市', 'title' => ''],
+ 'CustomizeFeatureL' => ['description' => 'The custom attribute L. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性L', 'title' => ''],
+ 'EnergyEfficiency' => ['description' => 'The energy efficiency rating. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '2焦/毫升', 'title' => ''],
+ 'CustomizeFeatureC' => ['description' => 'The custom attribute C. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性C', 'title' => ''],
+ 'ItemId' => ['description' => 'The custom item barcode. Only Arabic numerals that form an integer are allowed.', 'type' => 'string', 'required' => true, 'example' => '1234567', 'title' => ''],
+ 'Manufacturer' => ['description' => 'The manufacturer name. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '中国制造', 'title' => ''],
+ 'Material' => ['description' => 'The material. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '新鲜牛奶', 'title' => ''],
+ 'CustomizeFeatureJ' => ['description' => 'The custom attribute J. Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性J', 'title' => ''],
+ 'CustomizeFeatureO' => ['description' => 'The custom attribute O. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性O', 'title' => ''],
+ 'CustomizeFeatureP' => ['description' => 'The custom attribute P. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性P', 'title' => ''],
+ 'CustomizeFeatureQ' => ['description' => 'The custom attribute Q. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性Q', 'title' => ''],
+ 'CustomizeFeatureR' => ['description' => 'The custom attribute R. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性R', 'title' => ''],
+ 'CustomizeFeatureS' => ['description' => 'The custom attribute S. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性S', 'title' => ''],
+ 'CustomizeFeatureT' => ['description' => 'The custom attribute T. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性T', 'title' => ''],
+ 'CustomizeFeatureU' => ['description' => 'The custom attribute U. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性U', 'title' => ''],
+ 'CustomizeFeatureV' => ['description' => 'The custom attribute V. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性V', 'title' => ''],
+ 'CustomizeFeatureW' => ['description' => 'The custom attribute W. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性W', 'title' => ''],
+ 'CustomizeFeatureX' => ['description' => 'The custom attribute X. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => '345678', 'title' => ''],
+ 'CustomizeFeatureY' => ['description' => 'The custom attribute Y. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => 'YYY', 'title' => ''],
+ 'CustomizeFeatureZ' => ['description' => 'The custom attribute Z. Maximum length: 512 characters.', 'type' => 'string', 'required' => false, 'example' => 'ZZZZ', 'title' => ''],
+ 'SkuId' => ['description' => 'The item ID (SKU). Maximum length: 64 characters.', 'type' => 'string', 'required' => false, 'example' => '1234567', 'title' => ''],
+ 'CustomizeFeatureM' => ['description' => 'The custom attribute M. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => '自定义属性M', 'title' => ''],
+ 'BePromotion' => ['description' => 'Specifies whether to match the promotion template for display. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ 'BeSourceCode' => ['description' => 'Specifies whether to match the traceability template for display. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ 'ForestSecondId' => ['description' => 'The second-level item category ID. Maximum length: 32 characters.', 'type' => 'string', 'required' => false, 'example' => '饮料', 'title' => ''],
+ 'ItemQrCode' => ['description' => 'The QR code URL of the item. Maximum length: 1024 characters.', 'type' => 'string', 'required' => false, 'example' => 'http://m.taobao.com/xxx.html', 'title' => ''],
+ 'ItemInfoIndex' => ['description' => 'The item information index. You do not need to specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ 'PromotionEnd' => ['description' => 'The promotion end time in UTC format: "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'".', 'type' => 'string', 'required' => false, 'example' => '2020-02-01T00:00:00Z', 'title' => ''],
+ 'ItemBarCode' => ['description' => 'The item barcode. The value is case-insensitive. Maximum length: 64 characters.', 'type' => 'string', 'required' => true, 'example' => '690560583****', 'title' => ''],
+ 'BeClearance' => ['description' => 'Specifies whether to match the clearance template for display. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ 'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'maxItems' => 500,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'PageSize' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'PageNumber' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
- 'EslDetails' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'BatchResults' => [
+ 'description' => 'The batch results.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'EslBarCode' => [
- 'type' => 'string',
- ],
- 'LastUpdateTime' => [
- 'type' => 'string',
- ],
- 'ItemBarCode' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'ItemId' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'ItemShortTitle' => [
- 'type' => 'string',
- ],
- 'Status' => [
- 'type' => 'string',
- ],
- 'StoreId' => [
- 'type' => 'string',
- ],
+ 'Index' => ['description' => 'The index of the request sequence.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the current item was inserted successfully.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => null,
- ],
- 'DescribeEslDevices' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"BatchResults\\": [\\n {\\n \\"Index\\": 1,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'BatchInsertItems',
+ 'summary' => 'Creates or updates item information in batches. A maximum of 100 items can be processed per request, and each request cannot contain duplicate item barcodes.',
+ 'requestParamsDescription' => 'The following item information fields are used for template matching and display, listed in descending order of priority:'."\n"
+ ."\n"
+ .'- TemplateSceneId: attempts to match a custom template.'."\n"
+ .'- InventoryStatus: attempts to match the out-of-stock template.'."\n"
+ .'- BeMember: attempts to match the member template.'."\n"
+ .'- BeSourceCode && BePromotion: attempts to match the marketing template.'."\n"
+ .'- BeSourceCode: attempts to match the traceability template.'."\n"
+ .'- BePromotion: attempts to match the promotion template.'."\n"
+ .'- BeClearance: attempts to match the clearance template.',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-18T13:13:48.000Z', 'description' => 'Request parameters changed'],
],
+ ],
+ 'BindEslDevice' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1061,297 +686,107 @@
'BearerToken' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'PageNumber',
+ 'name' => 'ItemBarCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
- ],
+ 'schema' => ['description' => 'The item bar code.', 'type' => 'string', 'required' => false, 'example' => '690560583****', 'title' => ''],
],
[
- 'name' => 'Type',
+ 'name' => 'EslBarCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'ESL_TYPE_E_INK',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ESL bar code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '18bc5a63****', 'title' => ''],
],
[
- 'name' => 'TypeEncode',
+ 'name' => 'StoreId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'LOW_TEMPLATE',
- 'required' => false,
- 'title' => '类型编码'."\n"
- .'取值范围如下：'."\n"
- .'NORMAL 常规'."\n"
- .'LOW_TEMPLATE 低温价签'."\n"
- .'THREE_COLOR 三色价签'."\n"
- .'ESL_TYPE_DM_LCD 段码屏幕'."\n"
- .'ESL_TYPE_FULL_COLOR 彩色屏幕'."\n"
- .'ESL_TYPE_MUTIMEDIA 多媒体',
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The store ID or the custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'Shelf',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
- ],
+ 'schema' => ['description' => 'The shelf number in the display system.', 'type' => 'string', 'required' => false, 'example' => '20200201', 'title' => ''],
],
[
- 'name' => 'ToBatteryLevel',
+ 'name' => 'Layer',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '80',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
- ],
+ 'schema' => ['description' => 'The layer number in the display system.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'StoreId',
+ 'name' => 'Column',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The logical column in the display system.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'EslStatus',
+ 'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'ESL_STATUS_ONLINE',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The extended parameters.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
- 'name' => 'EslBarCode',
+ 'name' => 'LayoutId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '18bc5a63****',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The layout ID. Only a single ID is supported.', 'type' => 'string', 'required' => false, 'example' => '7', 'title' => ''],
],
[
- 'name' => 'FromBatteryLevel',
+ 'name' => 'ContainerId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
- ],
+ 'schema' => ['description' => 'The container ID.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''],
],
[
- 'name' => 'ExtraParams',
+ 'name' => 'ContainerName',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '{}',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The container name.', 'type' => 'string', 'required' => false, 'example' => '区域4号', 'title' => ''],
+ ],
+ [
+ 'name' => 'LayoutName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The layout name.', 'type' => 'string', 'required' => false, 'example' => '布局2号', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'The specified resource type is invalid.',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'example' => 'MandatoryParameters ',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '-1001',
- 'type' => 'string',
- ],
- 'Message' => [
- 'description' => '',
- 'example' => 'success',
- 'type' => 'string',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'example' => 'The specified store %s does not exist.',
- 'type' => 'string',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'PageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'example' => 'PlatformResponseError.%s',
- 'type' => 'string',
- ],
- 'EslDevices' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'Type' => [
- 'description' => '',
- 'example' => 'ESL_TYPE_E_INK',
- 'type' => 'string',
- ],
- 'StoreId' => [
- 'description' => '',
- 'example' => 's-dxsxx****',
- 'type' => 'string',
- ],
- 'EslBarCode' => [
- 'description' => '',
- 'example' => '18bc5a63****',
- 'type' => 'string',
- ],
- 'Model' => [
- 'description' => '',
- 'example' => 'AESL0213',
- 'type' => 'string',
- ],
- 'LastCommunicateTime' => [
- 'description' => '',
- 'example' => '2020-03-16T07:04:16Z',
- 'type' => 'string',
- ],
- 'ScreenHeight' => [
- 'description' => '',
- 'example' => '200',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'ScreenWidth' => [
- 'description' => '',
- 'example' => '200',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'EslSignal' => [
- 'description' => '',
- 'example' => '54',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'BatteryLevel' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'EslStatus' => [
- 'description' => '',
- 'example' => 'ESL_STATUS_ONLINE',
- 'type' => 'string',
- ],
- 'Mac' => [
- 'description' => '',
- 'example' => '18:bc:5a:63:**:**',
- 'type' => 'string',
- ],
- 'TypeEncode' => [
- 'description' => '',
- 'example' => 'THREE_COLOR',
- 'title' => '类型编码'."\n"
- .'取值范围如下：'."\n"
- .'NORMAL 常规'."\n"
- .'LOW_TEMPLATE 低温价签'."\n"
- .'THREE_COLOR 三色价签'."\n"
- .'ESL_TYPE_DM_LCD 段码屏幕'."\n"
- .'ESL_TYPE_FULL_COLOR 彩色屏幕'."\n"
- .'ESL_TYPE_MUTIMEDIA 多媒体'."\n",
- 'type' => 'string',
- ],
- 'LayoutId' => [
- 'description' => '',
- 'example' => '7',
- 'type' => 'string',
- ],
- 'LayoutName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- ],
- 'type' => 'object',
- ],
- 'type' => 'array',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters \\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"EslDevices\\": [\\n {\\n \\"Type\\": \\"ESL_TYPE_E_INK\\",\\n \\"StoreId\\": \\"s-dxsxx****\\",\\n \\"EslBarCode\\": \\"18bc5a63****\\",\\n \\"Model\\": \\"AESL0213\\",\\n \\"LastCommunicateTime\\": \\"2020-03-16T07:04:16Z\\",\\n \\"ScreenHeight\\": 200,\\n \\"ScreenWidth\\": 200,\\n \\"EslSignal\\": 54,\\n \\"BatteryLevel\\": 100,\\n \\"EslStatus\\": \\"ESL_STATUS_ONLINE\\",\\n \\"Mac\\": \\"18:bc:5a:63:**:**\\",\\n \\"TypeEncode\\": \\"THREE_COLOR\\",\\n \\"LayoutId\\": \\"7\\",\\n \\"LayoutName\\": \\"新增布局\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<code>200</code>\\n<data>\\n <TotalCount>4</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>80B45212-5669-4B27-9B8E-80BDCB18E99C</RequestId>\\n <PageNumber>1</PageNumber>\\n <EslDevices>\\n <EslBarCode>18bc5a63****</EslBarCode>\\n <Type>ESL_TYPE_E_INK</Type>\\n <BatteryLevel>100</BatteryLevel>\\n <StoreId>s-ph5agd****</StoreId>\\n <ScreenWidth>320</ScreenWidth>\\n <EslStatus>ESL_STATUS_ONLINE</EslStatus>\\n <ScreenHeight>240</ScreenHeight>\\n <LastCommunicateTime>2020-03-16T07:04:16Z</LastCommunicateTime>\\n <Mac>18:bc:5a:63:**:**</Mac>\\n <EslSignal>47</EslSignal>\\n </EslDevices>\\n <EslDevices>\\n <EslBarCode>18bc5a7a****</EslBarCode>\\n <Type>ESL_TYPE_E_INK</Type>\\n <BatteryLevel>100</BatteryLevel>\\n <StoreId>s-ph5agd****</StoreId>\\n <ScreenWidth>400</ScreenWidth>\\n <EslStatus>ESL_STATUS_OFFLINE</EslStatus>\\n <ScreenHeight>300</ScreenHeight>\\n <LastCommunicateTime>2020-03-14T17:19:57Z</LastCommunicateTime>\\n <Mac>18:bc:5a:7a:**:**</Mac>\\n <EslSignal>47</EslSignal>\\n </EslDevices>\\n <Success>true</Success>\\n</data>\\n<requestId>80B45212-5669-4B27-9B8E-80BDCB18E99C</requestId>\\n<successResponse>true</successResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
+ 'errorCodes' => [
+ 418 => [
+ ['errorCode' => 'LayoutOrContainerIsNotExistErrorPub', 'errorMessage' => 'Layout or Container is not exist.', 'description' => ''],
+ ['errorCode' => 'ContainerTemplateNoMatchPub', 'errorMessage' => 'The Template of the Container has not match at all.', 'description' => 'The Template of the Container has not match at all.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'title' => 'Bind a cloudESL device',
+ 'summary' => 'Binds a CloudESL device.',
+ 'description' => 'This operation supports two modes: display mode and standard mode. In display mode, binding is performed by using a display shelf position and an ESL bar code. In standard mode, binding is performed by using an item bar code and an ESL bar code.',
+ 'requestParamsDescription' => ' In standard binding mode, StoreId, EslBarCode, and ItemBarCode are required.'."\n"
+ .'In display binding mode, StoreId, EslBarCode, Shelf, Layer, and Column are required. If ItemBarCode is specified, it must be consistent with the information stored in the display shelf position.',
'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => 'Error codes changed, Request parameters changed'],
+ ],
],
'CreateStore' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1362,187 +797,96 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'ParentId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 's-dxsxx****',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The ID of the parent store.', 'type' => 'string', 'required' => false, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'UserStoreCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '20200201',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The custom store ID defined by the merchant.', 'type' => 'string', 'required' => false, 'example' => '20200201', 'title' => ''],
],
[
'name' => 'StoreName',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The store name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '天猫旗舰店', 'title' => ''],
],
[
'name' => 'Phone',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '0571-5666888',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The phone number of the store.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0571-5666888', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '1212',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The client token.', 'type' => 'string', 'required' => false, 'example' => '1212', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '{}',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'A system reserved field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
'name' => 'TimeZone',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'GMT+08:00',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The time zone.', 'type' => 'string', 'required' => false, 'example' => 'GMT+08:00', 'title' => ''],
],
[
'name' => 'BarCodeEncode',
'in' => 'formData',
'schema' => [
- 'description' => '',
+ 'description' => 'The barcode encoding method. Valid values:'."\n"
+ .'- 0: Code128.'."\n"
+ .'- 1: EAN13.'."\n"
+ ."\n"
+ .'Default value: 0.',
'enumValueTitles' => [],
- 'example' => '0',
+ 'type' => 'integer',
'format' => 'int32',
'maximum' => '1',
'minimum' => '0',
- 'required' => false,
- 'type' => 'integer',
+ 'example' => '0',
'default' => '0',
- ],
- ],
- [
- 'name' => 'AutoUnbindOfflineEsl',
- 'in' => 'formData',
- 'schema' => [
'required' => false,
- 'title' => '是否启用自动解绑离线价签',
- 'type' => 'boolean',
- 'default' => 'false',
- ],
- ],
- [
- 'name' => 'AutoUnbindDays',
- 'in' => 'formData',
- 'schema' => [
- 'format' => 'int32',
- 'minimum' => '7',
- 'required' => false,
- 'title' => '自动解绑离线价签条件-价签离线天数',
- 'type' => 'integer',
- 'default' => '36500',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'StoreId' => [
- 'description' => '',
- 'example' => 's-dxsxx****',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'The specified resource type is invalid.',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'example' => 'MandatoryParameters',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '-1001',
- 'type' => 'string',
- ],
- 'Message' => [
- 'description' => '',
- 'example' => 'success',
- 'type' => 'string',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'example' => 'The specified store %s does not exist.',
- 'type' => 'string',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'example' => 'PlatformResponseError.%s',
- 'type' => 'string',
- ],
+ 'StoreId' => ['description' => 'The store ID.', 'type' => 'string', 'example' => 's-dxsxx****', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"StoreId\\": \\"s-dxsxx****\\",\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","errorExample":""},{"type":"xml","example":"<code>200</code>\\n<data>\\n <RequestId>8F124625-DF0A-4B08-B205-2CF538FAF713</RequestId>\\n <Success>true</Success>\\n</data>\\n<requestId>8F124625-DF0A-4B08-B205-2CF538FAF713</requestId>\\n<successResponse>true</successResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StoreId\\": \\"s-dxsxx****\\",\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'title' => 'Create store',
+ 'summary' => 'Adds a store.',
+ 'requestParamsDescription' => ' The ParentId parameter is not supported.',
'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
],
- 'DeleteStore' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteApDevice' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1553,30 +897,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
+ 'name' => 'ApMac',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The MAC address of the base station device.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11:22:33:44:55:66', 'title' => ''],
+ ],
+ [
'name' => 'StoreId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
- ],
+ 'schema' => ['description' => 'The store ID or custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
@@ -1584,64 +920,34 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","errorExample":""},{"type":"xml","example":"<code>200</code>\\n<data>\\n <RequestId>8F124625-DF0A-4B08-B205-2CF538FAF713</RequestId>\\n <Success>true</Success>\\n</data>\\n<requestId>8F124625-DF0A-4B08-B205-2CF538FAF713</requestId>\\n<successResponse>true</successResponse>","errorExample":""}]',
- 'title' => 'DeleteStore',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a base station device',
+ 'summary' => 'Deletes a base station device with the specified MAC address.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'UpdateStore' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T06:18:44.000Z', 'description' => 'Error codes changed'],
],
+ ],
+ 'DeleteCompanyTemplate' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1652,182 +958,47 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'StoreId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
- 'required' => true,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'UserStoreCode',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '123456',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'StoreName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'Phone',
+ 'name' => 'TemplateId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '0571-5666888',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'Template ID ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '742842379343605760', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '{}',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'TemplateVersion',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '1.1.0',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'Timezone',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'GMT+08:00',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'BarCodeEncode',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '0',
- 'format' => 'int32',
- 'maximum' => '1',
- 'minimum' => '0',
- 'required' => false,
- 'type' => 'integer',
- 'default' => '0',
- ],
- ],
- [
- 'name' => 'AutoUnbindOfflineEsl',
- 'in' => 'formData',
- 'schema' => [
- 'required' => false,
- 'title' => '是否启用自动解绑离线价签',
- 'type' => 'boolean',
- 'default' => 'false',
- ],
- ],
- [
- 'name' => 'AutoUnbindDays',
- 'in' => 'formData',
- 'schema' => [
- 'format' => 'int32',
- 'maximum' => '36500',
- 'minimum' => '7',
- 'required' => false,
- 'title' => '自动解绑离线价签条件-价签离线天数',
- 'type' => 'integer',
- 'default' => '36500',
- ],
+ 'schema' => ['description' => 'System extension field. Ignore it. ', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'The specified resource type is invalid.',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'example' => 'MandatoryParameters',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '-1001',
- 'type' => 'string',
- ],
- 'Message' => [
- 'description' => '',
- 'example' => 'success',
- 'type' => 'string',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'example' => 'The specified store %s does not exist.',
- 'type' => 'string',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'example' => 'PlatformResponseError.%s',
- 'type' => 'string',
- ],
+ 'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => 'A7571D49-9B36-5782-AD3D-32C8436D45B7', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'Error message. ', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the POP request succeeded. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'Error code. The value is described as follows: If the request succeeds, the ErrorCode field is not returned. If the request fails, the ErrorCode field is returned. For more information, see the error code list in this topic. ', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'HTTP status code. ', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'Error code. ', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'Dynamic error message used to replace the %s placeholder in the error message returned by the ErrMessage parameter. ', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'Dynamic error code. ', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateStoreResponse>\\n <RequestId>E69C8998-1787-4999-8C75-D663FF1173CF</RequestId>\\n <ErrorMessage>The specified resource type is invalid.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>MandatoryParameters</ErrorCode>\\n <Code>-1001</Code>\\n <Message>success</Message>\\n <DynamicMessage>The specified store %s does not exist.</DynamicMessage>\\n <DynamicCode>PlatformResponseError.%s</DynamicCode>\\n</UpdateStoreResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7571D49-9B36-5782-AD3D-32C8436D45B7\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'changeSet' => [],
+ 'title' => '',
+ 'summary' => '',
],
- 'UpdateStoreConfig' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteItem' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1838,69 +1009,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'NotificationSilentTimes',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[{"from":960,"to":1320},{"from":1170,"to":1230}]',
- ],
- ],
- [
- 'name' => 'EnableNotification',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
'name' => 'StoreId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-sds1233****',
- ],
- ],
- [
- 'name' => 'NotificationWebHook',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://oapi.dingtalk.com/robot/send?.',
- ],
+ 'schema' => ['description' => 'The store ID or merchant-defined custom store ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
- 'name' => 'ExtraParams',
+ 'name' => 'ItemBarCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'The bar code of the item.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '693737264225', 'title' => ''],
],
[
- 'name' => 'SubscribeContents',
+ 'name' => 'UnbindEslDevice',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Specifies whether to unbind the CloudESL device that is bound to the item. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
@@ -1908,61 +1032,31 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '97B41B7F-A6EC-524C-9B8F-1BDD7E733F5E',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"97B41B7F-A6EC-524C-9B8F-1BDD7E733F5E\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
- ],
- 'DescribeStores' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a store item',
+ 'summary' => 'Deletes a store item.',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T06:18:43.000Z', 'description' => 'Error codes changed'],
],
+ ],
+ 'DeleteStore' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1971,263 +1065,55 @@
'BearerToken' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'UserStoreCode',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '123456',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
- ],
- ],
- [
- 'name' => 'StoreName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'ToDate',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '2020-03-08T02:58:16Z',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
'name' => 'StoreId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 's-dxsxx****',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'FromDate',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '2020-03-06T02:58:16Z',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The store ID or the custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '{}',
- 'required' => false,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'TemplateVersion',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '1.1.0',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'A reserved field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'The specified resource type is invalid.',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'example' => 'MandatoryParameters',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '-1001',
- 'type' => 'string',
- ],
- 'Message' => [
- 'description' => '',
- 'example' => 'success',
- 'type' => 'string',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'example' => 'The specified store %s does not exist.',
- 'type' => 'string',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'PageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'example' => 'PlatformResponseError.%s',
- 'type' => 'string',
- ],
- 'Stores' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'StoreId' => [
- 'description' => '',
- 'example' => 's-dxsxx**** ',
- 'type' => 'string',
- ],
- 'ParentId' => [
- 'description' => '',
- 'example' => 's-aasx****',
- 'type' => 'string',
- ],
- 'TimeZone' => [
- 'type' => 'string',
- ],
- 'GmtCreate' => [
- 'description' => '',
- 'example' => '2020-03-06T02:58:16Z',
- 'type' => 'string',
- ],
- 'StoreName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'GmtModified' => [
- 'description' => '',
- 'example' => '2020-03-06T02:58:16Z',
- 'type' => 'string',
- ],
- 'TemplateVersion' => [
- 'description' => '',
- 'example' => '1.1.0',
- 'type' => 'string',
- ],
- 'Level' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'Phone' => [
- 'description' => '',
- 'example' => '0571-5666888',
- 'type' => 'string',
- ],
- 'UserStoreCode' => [
- 'description' => '',
- 'example' => '20200201',
- 'type' => 'string',
- ],
- 'BarCodeEncode' => [
- 'description' => '',
- 'example' => '0',
- 'format' => 'int32',
- 'maximum' => '1',
- 'minimum' => '0',
- 'type' => 'integer',
- 'default' => '0',
- ],
- 'AutoUnbindOfflineEsl' => [
- 'title' => '是否启用自动解绑离线价签',
- 'type' => 'boolean',
- 'default' => 'false',
- ],
- 'AutoUnbindDays' => [
- 'title' => '自动解绑离线价签条件-价签离线天数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'default' => '36500',
- ],
- ],
- 'type' => 'object',
- ],
- 'type' => 'array',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"Stores\\": [\\n {\\n \\"StoreId\\": \\"s-dxsxx**** \\",\\n \\"ParentId\\": \\"s-aasx****\\",\\n \\"TimeZone\\": \\"GMT+08:00\\",\\n \\"GmtCreate\\": \\"2020-03-06T02:58:16Z\\",\\n \\"StoreName\\": \\"天猫旗舰店\\",\\n \\"GmtModified\\": \\"2020-03-06T02:58:16Z\\",\\n \\"TemplateVersion\\": \\"1.1.0\\",\\n \\"Level\\": \\"1级\\",\\n \\"Phone\\": \\"0571-5666888\\",\\n \\"UserStoreCode\\": \\"20200201\\",\\n \\"BarCodeEncode\\": 0,\\n \\"AutoUnbindOfflineEsl\\": true,\\n \\"AutoUnbindDays\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeStoresResponse>\\n <RequestId>E69C8998-1787-4999-8C75-D663FF1173CF</RequestId>\\n <ErrorMessage>The specified resource type is invalid.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>MandatoryParameters</ErrorCode>\\n <Code>-1001</Code>\\n <Message>success</Message>\\n <DynamicMessage>The specified store %s does not exist.</DynamicMessage>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <DynamicCode>PlatformResponseError.%s</DynamicCode>\\n <Stores>\\n <StoreId>s-dxsxx****</StoreId>\\n <ParentId>s-aasx****</ParentId>\\n <TimeZone>GMT+08:00</TimeZone>\\n <GmtCreate>2020-03-06T02:58:16Z</GmtCreate>\\n <StoreName>天猫旗舰店</StoreName>\\n <GmtModified>2020-03-06T02:58:16Z</GmtModified>\\n <TemplateVersion>1.1.0</TemplateVersion>\\n <Level>1级</Level>\\n <Phone>0571-5666888</Phone>\\n <UserStoreCode>20200201</UserStoreCode>\\n <BarCodeEncode>0</BarCodeEncode>\\n <AutoUnbindOfflineEsl>true</AutoUnbindOfflineEsl>\\n <AutoUnbindDays>1</AutoUnbindDays>\\n </Stores>\\n</DescribeStoresResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'title' => 'DeleteStore',
+ 'summary' => 'Deletes a store.',
+ 'description' => 'Before you begin: The store must not contain any items or electronic shelf labels (ESLs).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'DescribeStoreConfig' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'extraInfo' => ' Before deleting a store, ensure that the store does not contain any items, ESL devices, or base station devices.',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T06:18:43.000Z', 'description' => 'Error codes changed'],
],
+ ],
+ 'DeleteUser' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2236,32 +1122,19 @@
'BearerToken' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'StoreId',
+ 'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
- ],
+ 'schema' => ['description' => 'The UID of the RAM user.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1344***', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'The system extension field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
@@ -2269,114 +1142,34 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
- 'StoreConfigInfo' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'StoreId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 's-dxsxx****',
- ],
- 'EnableNotification' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'NotificationWebHook' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://oapi.dingtalk.com/robot/send?.',
- ],
- 'NotificationSilentTimes' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '[{"from":960,"to":1320},{"from":1170,"to":1230}]',
- ],
- 'SubscribeContents' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Category' => [
- 'type' => 'string',
- ],
- 'Enable' => [
- 'type' => 'boolean',
- ],
- 'Threshold' => [
- 'type' => 'string',
- ],
- 'AtAll' => [
- 'type' => 'boolean',
- ],
- 'AtMobileList' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"StoreConfigInfo\\": {\\n \\"StoreId\\": \\"s-dxsxx****\\",\\n \\"EnableNotification\\": true,\\n \\"NotificationWebHook\\": \\"https://oapi.dingtalk.com/robot/send?.\\",\\n \\"NotificationSilentTimes\\": \\"[{\\\\\\"from\\\\\\":960,\\\\\\"to\\\\\\":1320},{\\\\\\"from\\\\\\":1170,\\\\\\"to\\\\\\":1230}]\\",\\n \\"SubscribeContents\\": [\\n {\\n \\"Category\\": \\"\\",\\n \\"Enable\\": true,\\n \\"Threshold\\": \\"\\",\\n \\"AtAll\\": true,\\n \\"AtMobileList\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<code>200</code>\\n<data>\\n <RequestId>CE715689-3EBA-422C-B3E7-76D98B7D0AE8</RequestId>\\n <StoreConfigInfo>\\n <StoreId>s-cc3nq****</StoreId>\\n <EnableNotification>true</EnableNotification>\\n </StoreConfigInfo>\\n <Success>true</Success>\\n</data>\\n<requestId>CE715689-3EBA-422C-B3E7-76D98B7D0AE8</requestId>\\n<successResponse>true</successResponse>","errorExample":""}]',
- 'title' => 'DescribeStoreConfig',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'title' => 'Delete a user',
+ 'summary' => 'Deletes a user.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeleteItem' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T06:18:42.000Z', 'description' => 'Error codes changed'],
],
+ ],
+ 'DescribeApDevices' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2385,43 +1178,51 @@
'BearerToken' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'StoreId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
- ],
+ 'schema' => ['description' => 'The store ID or the custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
- 'name' => 'ItemBarCode',
+ 'name' => 'ApMac',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '6937372642255',
- ],
+ 'schema' => ['description' => 'The MAC address of the AP device.', 'type' => 'string', 'required' => false, 'example' => '112233445566', 'title' => ''],
],
[
- 'name' => 'UnbindEslDevice',
+ 'name' => 'Status',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The online or offline status of the device. Valid values:'."\n"
+ .'- true: online.'."\n"
+ .'- false: offline.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Model',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The device model.', 'type' => 'string', 'required' => false, 'example' => 'aliyun', 'title' => ''],
+ ],
+ [
+ 'name' => 'BeActivate',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The activation status of the device.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'ExtraParams',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'A reserved parameter. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
@@ -2429,65 +1230,57 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'ApDevices' => [
+ 'description' => 'The list of AP devices.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The online status of the device, such as offline.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'StoreId' => ['description' => 'The store ID.', 'type' => 'string', 'example' => 's-cxsds****', 'title' => ''],
+ 'Model' => ['description' => 'The device model.', 'type' => 'string', 'example' => 'aliyun', 'title' => ''],
+ 'Remark' => ['description' => 'The remarks.', 'type' => 'string', 'example' => '测试数据', 'title' => ''],
+ 'BeActivate' => ['description' => 'Indicates whether the device is activated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Mac' => ['description' => 'The MAC address of the device.', 'type' => 'string', 'example' => '112233445566', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteItemResponse>\\n <RequestId>E69C8998-1787-4999-8C75-D663FF1173CF</RequestId>\\n <ErrorMessage>The specified resource type is invalid.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>MandatoryParameters</ErrorCode>\\n <Code>-1001</Code>\\n <Message>success</Message>\\n <DynamicMessage>The specified store %s does not exist.</DynamicMessage>\\n <DynamicCode>PlatformResponseError.%s</DynamicCode>\\n</DeleteItemResponse>","errorExample":""}]',
- 'title' => 'DeleteItem',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"ApDevices\\": [\\n {\\n \\"Status\\": false,\\n \\"StoreId\\": \\"s-cxsds****\\",\\n \\"Model\\": \\"aliyun\\",\\n \\"Remark\\": \\"测试数据\\",\\n \\"BeActivate\\": true,\\n \\"Mac\\": \\"112233445566\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query AP devices',
+ 'summary' => 'Queries information about access point (AP) devices.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'BatchInsertItems' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T06:18:42.000Z', 'description' => 'Error codes changed'],
],
+ ],
+ 'DescribeAvailableEslModels' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2496,544 +1289,83 @@
'BearerToken' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
- 'name' => 'StoreId',
+ 'name' => 'ModelId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['title' => '', 'description' => 'Device model ID ', 'type' => 'string', 'required' => false, 'example' => '6cd23870539e43759e65eef5b6808a49'],
],
[
- 'name' => 'ExtraParams',
+ 'name' => 'Name',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '{}',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['title' => '', 'description' => 'Model name ', 'type' => 'string', 'required' => false, 'example' => 'aa_ssaaa'],
],
[
- 'name' => 'SyncByItemId',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'true',
- 'required' => false,
- 'type' => 'boolean',
- ],
+ 'schema' => ['title' => '', 'description' => 'Page number ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
- 'name' => 'ItemInfo',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '',
- 'items' => [
- 'properties' => [
- 'ActionPrice' => [
- 'description' => '',
- 'example' => '500',
- 'format' => 'int32',
- 'required' => true,
- 'type' => 'integer',
- ],
- 'ItemTitle' => [
- 'description' => '',
- 'example' => '',
- 'required' => true,
- 'type' => 'string',
- ],
- 'BrandName' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'SourceCode' => [
- 'description' => '',
- 'example' => '1234567',
- 'required' => false,
- 'type' => 'string',
- ],
- 'PriceUnit' => [
- 'description' => '',
- 'example' => '',
- 'required' => true,
- 'type' => 'string',
- ],
- 'ForestFirstId' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureF' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureA' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureK' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'TemplateSceneId' => [
- 'description' => '',
- 'example' => '23452',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureD' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'MemberPrice' => [
- 'description' => '',
- 'example' => '800',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'ModelNumber' => [
- 'description' => '',
- 'example' => '330',
- 'required' => false,
- 'type' => 'string',
- ],
- 'PromotionStart' => [
- 'description' => '',
- 'example' => '2020-02-10T00:00:00Z',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CategoryName' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureE' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'SuggestPrice' => [
- 'description' => '',
- 'example' => '600',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'SaleSpec' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'PromotionText' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'PromotionReason' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'Rank' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureG' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'SalesPrice' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'CustomizeFeatureH' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'OriginalPrice' => [
- 'description' => '',
- 'example' => '1000',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'CustomizeFeatureI' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'ProductionPlace' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureB' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'ItemShortTitle' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureN' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'BeMember' => [
- 'description' => '',
- 'example' => 'true',
- 'required' => false,
- 'type' => 'boolean',
- ],
- 'TaxFee' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'InventoryStatus' => [
- 'description' => '',
- 'example' => 'OUT_OF_STOCK',
- 'required' => false,
- 'type' => 'string',
- ],
- 'ItemPicUrl' => [
- 'description' => '',
- 'example' => 'http://m.taobao.com/xxx.html',
- 'required' => false,
- 'type' => 'string',
- ],
- 'SupplierName' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureL' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'EnergyEfficiency' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureC' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'ItemId' => [
- 'description' => '',
- 'example' => '1234567',
- 'required' => true,
- 'type' => 'string',
- ],
- 'Manufacturer' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'Material' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureJ' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureO' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureP' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureQ' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureR' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureS' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureT' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureU' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureV' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureW' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureX' => [
- 'description' => '',
- 'example' => '345678',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureY' => [
- 'description' => '',
- 'example' => 'YYY',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureZ' => [
- 'description' => '',
- 'example' => 'ZZZZ',
- 'required' => false,
- 'type' => 'string',
- ],
- 'SkuId' => [
- 'description' => '',
- 'example' => '1234567',
- 'required' => false,
- 'type' => 'string',
- ],
- 'CustomizeFeatureM' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'BePromotion' => [
- 'description' => '',
- 'example' => 'true',
- 'required' => false,
- 'type' => 'boolean',
- ],
- 'BeSourceCode' => [
- 'description' => '',
- 'example' => 'true',
- 'required' => false,
- 'type' => 'boolean',
- ],
- 'ForestSecondId' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
- 'ItemQrCode' => [
- 'description' => '',
- 'example' => 'http://m.taobao.com/xxx.html',
- 'required' => false,
- 'type' => 'string',
- ],
- 'ItemInfoIndex' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
- ],
- 'PromotionEnd' => [
- 'description' => '',
- 'example' => '2020-02-01T00:00:00Z',
- 'required' => false,
- 'type' => 'string',
- ],
- 'ItemBarCode' => [
- 'description' => '',
- 'example' => '690560583****',
- 'required' => true,
- 'type' => 'string',
- ],
- 'BeClearance' => [
- 'description' => '',
- 'example' => 'false',
- 'required' => false,
- 'type' => 'boolean',
- ],
- ],
- 'required' => false,
- 'type' => 'object',
- ],
- 'maxItems' => 500,
- 'required' => true,
- 'type' => 'array',
- ],
+ 'schema' => ['title' => '', 'description' => 'Page size ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'DescribeAvailableEslModelsResponse',
+ 'description' => 'DescribeAvailableEslModelsResponse',
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'The specified resource type is invalid.',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'example' => 'MandatoryParameters',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '-1001',
- 'type' => 'string',
- ],
- 'Message' => [
- 'description' => '',
- 'example' => 'success',
- 'type' => 'string',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'example' => 'The specified store %s does not exist.',
- 'type' => 'string',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'example' => 'PlatformResponseError.%s',
- 'type' => 'string',
- ],
- 'BatchResults' => [
- 'description' => '',
+ 'TotalCount' => ['description' => 'Total count. ', 'type' => 'integer', 'format' => 'int32', 'example' => '436', 'title' => ''],
+ 'PageSize' => ['description' => 'Pagination parameter: number of entries per page. Default value is 10. ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'Pagination parameter: current page number. Default value is 1. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'EslModels' => [
+ 'description' => 'List of ESL information. ',
+ 'type' => 'array',
'items' => [
+ 'description' => 'List of ESL information. ',
+ 'type' => 'object',
'properties' => [
- 'Index' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'Message' => [
- 'description' => '',
- 'example' => 'success',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'example' => 'MandatoryParameters',
- 'type' => 'string',
- ],
+ 'ModelId' => ['title' => '', 'description' => 'Model ID ', 'type' => 'string', 'example' => '201167'],
+ 'Name' => ['title' => '', 'description' => 'Name ', 'type' => 'string', 'example' => '中文名测试'],
+ 'DeviceType' => ['title' => '', 'description' => 'Device type ', 'type' => 'string', 'example' => '3'],
+ 'Vendor' => ['title' => '', 'description' => 'Vendor ', 'type' => 'string', 'example' => 'ali'],
+ 'ScreenWidth' => ['title' => '', 'description' => 'Screen width ', 'type' => 'integer', 'format' => 'int32', 'example' => ''],
+ 'ScreenHeight' => ['title' => '', 'description' => 'Screen height ', 'type' => 'integer', 'format' => 'int32', 'example' => ''],
+ 'EslSize' => ['title' => '', 'description' => 'Screen size ', 'type' => 'string', 'example' => '800X480'],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'array',
- ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'Success' => ['description' => 'Request status identifier. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Message' => ['description' => 'Response message. If the request succeeded, the value is "success". ', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorCode' => ['description' => 'Error code ', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'Error message. ', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Code' => ['description' => 'Status code. A return value of 200 indicates success. ', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'DynamicCode' => ['description' => 'Dynamic error code. ', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'Dynamic error message, used to replace the "%s" placeholder in the error message returned in the ErrMessage parameter. ', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
],
- 'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"BatchResults\\": [\\n {\\n \\"Index\\": 1,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<BatchInsertItemsResponse>\\n <RequestId>E69C8998-1787-4999-8C75-D663FF1173CF</RequestId>\\n <ErrorMessage>The specified resource type is invalid.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>MandatoryParameters</ErrorCode>\\n <Code>-1001</Code>\\n <Message>success</Message>\\n <DynamicMessage>The specified store %s does not exist.</DynamicMessage>\\n <DynamicCode>PlatformResponseError.%s</DynamicCode>\\n <BatchResults>\\n <Index>1</Index>\\n <Message>success</Message>\\n <Success>true</Success>\\n <ErrorCode>MandatoryParameters</ErrorCode>\\n </BatchResults>\\n</BatchInsertItemsResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
- 'responseParamsDescription' => ' ',
- 'title' => 'BatchInsertItems',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 436,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"EslModels\\": [\\n {\\n \\"ModelId\\": \\"201167\\",\\n \\"Name\\": \\"中文名测试\\",\\n \\"DeviceType\\": \\"3\\",\\n \\"Vendor\\": \\"ali\\",\\n \\"ScreenWidth\\": 0,\\n \\"ScreenHeight\\": 0,\\n \\"EslSize\\": \\"800X480\\"\\n }\\n ],\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Code\\": \\"-1001\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\"\\n}","type":"json"}]',
+ 'changeSet' => [],
+ 'title' => '',
+ 'summary' => '',
],
- 'DescribeItems' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeBinders' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3044,532 +1376,121 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'required' => false,
- 'type' => 'integer',
- ],
- ],
- [
- 'name' => 'ItemTitle',
+ 'name' => 'ItemBarCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The bar code of the item.', 'type' => 'string', 'required' => false, 'example' => '690560583****', 'title' => ''],
],
[
- 'name' => 'SkuId',
+ 'name' => 'EslBarCode',
'in' => 'formData',
- 'schema' => [
- 'description' => 'SkuID。',
- 'example' => '1234565',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The bar code of the ESL. If you query by store ID and ESL bar code, you do not need to specify the shelf number or layer number.', 'type' => 'string', 'required' => false, 'example' => '18bc5a63****', 'title' => ''],
],
[
'name' => 'StoreId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The store ID or custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
- 'name' => 'ItemBarCode',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '6941297417178',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'ItemId',
+ 'name' => 'ItemTitle',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '6959294202901',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The name of the item.', 'type' => 'string', 'required' => false, 'example' => '纯牛奶', 'title' => ''],
],
[
- 'name' => 'BePromotion',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => 'true',
- 'required' => false,
- 'type' => 'boolean',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'example' => '{}',
- 'required' => false,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'A reserved field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'TemplateSceneId' => [
- 'description' => '',
- 'example' => '1223',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'The specified resource type is invalid.',
- 'type' => 'string',
- ],
- 'Success' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'Message' => [
- 'description' => '',
- 'example' => 'success',
- 'type' => 'string',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'example' => 'The specified store %s does not exist.',
- 'type' => 'string',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'example' => '100',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'example' => 'PlatformResponseError.%s',
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'example' => 'MandatoryParameters',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '-1001',
- 'type' => 'string',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'PageSize' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'Items' => [
- 'description' => '',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6E0FF7FA-3F89-598F-9BF2-57DF480FE111', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code. If the request is successful, the ErrorCode field is not returned. If the request fails, the ErrorCode field is returned. For more information, see the error codes section of this topic.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The backend error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'null', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic error message, which is used to replace the %s placeholder in the ErrMessage parameter.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '24', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'EslItemBindInfos' => [
+ 'description' => 'The list of binding information.',
+ 'type' => 'array',
'items' => [
+ 'type' => 'object',
'properties' => [
- 'ActionPrice' => [
- 'description' => '',
- 'example' => '500',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'ItemTitle' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'BrandName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'SourceCode' => [
- 'description' => '',
- 'example' => '123456',
- 'type' => 'string',
- ],
- 'PriceUnit' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'ForestFirstId' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureF' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureA' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureK' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'TemplateSceneId' => [
- 'description' => '',
- 'example' => '11223',
- 'type' => 'string',
- ],
- 'CustomizeFeatureD' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'MemberPrice' => [
- 'description' => '',
- 'example' => '4000',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'PromotionStart' => [
- 'description' => '',
- 'example' => '2022-04-25T16:00:00Z',
- 'type' => 'string',
- ],
- 'ModelNumber' => [
- 'description' => '',
- 'example' => 'CH8850AS',
- 'type' => 'string',
- ],
- 'CategoryName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureE' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'SuggestPrice' => [
- 'description' => '',
- 'example' => '500',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'SaleSpec' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'PromotionText' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'Rank' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'PromotionReason' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureG' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'SalesPrice' => [
- 'description' => '',
- 'example' => '500',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'CustomizeFeatureH' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'OriginalPrice' => [
- 'description' => '',
- 'example' => '500',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'GmtModified' => [
- 'description' => '',
- 'example' => '2020-03-09T00:00:00Z',
- 'type' => 'string',
- ],
- 'CustomizeFeatureI' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'ProductionPlace' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureB' => [
- 'description' => '',
- 'example' => '1:1:16',
- 'type' => 'string',
- ],
- 'ItemShortTitle' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureN' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'BeMember' => [
- 'description' => '',
- 'example' => 'false',
- 'type' => 'boolean',
- ],
- 'TaxFee' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'InventoryStatus' => [
- 'description' => '',
- 'example' => 'OUT_OF_STOCK',
- 'type' => 'string',
- ],
- 'SupplierName' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'ItemPicUrl' => [
- 'description' => '',
- 'example' => 'http://m.taobao.com/xxx.html',
- 'type' => 'string',
- ],
- 'EnergyEfficiency' => [
- 'description' => '',
- 'example' => '1kw/h',
- 'type' => 'string',
- ],
- 'CustomizeFeatureL' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureC' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'ItemId' => [
- 'description' => '',
- 'example' => '123456',
- 'type' => 'string',
- ],
- 'Manufacturer' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'Material' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureO' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureP' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureQ' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureR' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureS' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureT' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureU' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureV' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureW' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureX' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureY' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureZ' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'CustomizeFeatureJ' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'GmtCreate' => [
- 'description' => '',
- 'example' => '2020-03-09T00:00:00Z',
- 'type' => 'string',
- ],
- 'CustomizeFeatureM' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'BePromotion' => [
- 'description' => '',
- 'example' => 'false',
- 'type' => 'boolean',
- ],
- 'SkuId' => [
- 'description' => 'SKuID。',
- 'example' => '123456',
- 'type' => 'string',
- ],
- 'BeSourceCode' => [
- 'description' => '',
- 'example' => 'false',
- 'type' => 'boolean',
- ],
- 'ForestSecondId' => [
- 'description' => '',
- 'example' => '',
- 'type' => 'string',
- ],
- 'ItemQrCode' => [
- 'description' => '',
- 'example' => 'http://m.taobao.com/xxx.html',
- 'type' => 'string',
- ],
- 'ItemInfoIndex' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'PromotionEnd' => [
- 'description' => '',
- 'example' => '2020-02-11T00:00:00Z',
- 'type' => 'string',
- ],
- 'ItemBarCode' => [
- 'description' => '',
- 'example' => '01838',
- 'type' => 'string',
- ],
- 'BeClearance' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
+ 'EslBarCode' => ['description' => 'The bar code of the ESL. If you query by store ID and ESL bar code, you do not need to specify the shelf number or layer number.', 'type' => 'string', 'example' => '18bc5a63****', 'title' => ''],
+ 'TemplateSceneId' => ['description' => 'The custom template ID.', 'type' => 'string', 'example' => '123456', 'title' => ''],
+ 'ActionPrice' => ['description' => 'The actual selling price, in cents.', 'type' => 'string', 'example' => '690', 'title' => ''],
+ 'ItemTitle' => ['description' => 'The name of the item.', 'type' => 'string', 'example' => '麦麸吐司', 'title' => ''],
+ 'PromotionStart' => ['description' => 'The promotion start time in UTC format: "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'".', 'type' => 'string', 'example' => '2020-03-16T07:05:34Z', 'title' => ''],
+ 'PriceUnit' => ['description' => 'The pricing unit. Maximum length: 64 characters.', 'type' => 'string', 'example' => '187', 'title' => ''],
+ 'OriginalPrice' => ['description' => 'The original price, in cents.', 'type' => 'string', 'example' => '500', 'title' => ''],
+ 'ItemId' => ['description' => 'The custom item bar code.', 'type' => 'string', 'example' => '1234567', 'title' => ''],
+ 'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '1656469716000', 'title' => ''],
+ 'EslPic' => ['description' => 'The image displayed on the ESL. Use a Base64 decoding tool to decode the value into an image.', 'type' => 'string', 'example' => 'kUzlfuzgayDo5uTXW3D66Q', 'title' => ''],
+ 'StoreId' => ['description' => 'The store ID.', 'type' => 'string', 'example' => 's-pdwrrnkufn', 'title' => ''],
+ 'ItemShortTitle' => ['description' => 'The short name of the item. If not specified, the value is truncated from the full item name. Maximum length: 64 characters.', 'type' => 'string', 'example' => '牛奶', 'title' => ''],
+ 'BindId' => ['description' => 'The binding ID.', 'type' => 'string', 'example' => 'b4adf048-f36d-4da5-a8bb-ab4adbd5eb04', 'title' => ''],
+ 'PromotionText' => ['description' => 'The promotion text. Maximum length: 64 characters.', 'type' => 'string', 'example' => '买一送一', 'title' => ''],
+ 'EslModel' => ['description' => 'The ESL model.', 'type' => 'string', 'example' => 'AESL0213', 'title' => ''],
+ 'BePromotion' => ['description' => 'Indicates whether the promotion template is matched for display. Default value: false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'SkuId' => ['description' => 'The item ID (SKU).', 'type' => 'string', 'example' => '124', 'title' => ''],
+ 'EslConnectAp' => ['description' => 'The MAC address of the access point to which the ESL is connected.', 'type' => 'string', 'example' => '11:22:33:44:55:66', 'title' => ''],
+ 'EslStatus' => ['description' => 'The ESL status. Valid values:'."\n"
+ ."\n"
+ .'- `ESL_STATUS_ONLINE`: online and bound'."\n"
+ ."\n"
+ .'- `ESL_STATUS_OFFLINE`: offline and bound'."\n"
+ ."\n"
+ .'- `ESL_STATUS_UNBIND`: unbound.', 'type' => 'string', 'example' => 'ESL_STATUS_ONLINE', 'title' => ''],
+ 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '123456', 'title' => ''],
+ 'PromotionEnd' => ['description' => 'The promotion end time in UTC format: "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'".', 'type' => 'string', 'example' => '2020-03-17T07:05:34Z', 'title' => ''],
+ 'ItemBarCode' => ['description' => 'The item bar code.', 'type' => 'string', 'example' => '690560583****', 'title' => ''],
+ 'ContainerName' => ['title' => '', 'description' => 'The name of the bound template area.', 'type' => 'string', 'example' => '2'],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'type' => 'array',
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TemplateSceneId\\": \\"1223\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Items\\": [\\n {\\n \\"ActionPrice\\": 500,\\n \\"ItemTitle\\": \\"纯牛奶\\",\\n \\"BrandName\\": \\"阿里巴巴\\",\\n \\"SourceCode\\": \\"123456\\",\\n \\"PriceUnit\\": \\"瓶\\",\\n \\"ForestFirstId\\": \\"酒类\\",\\n \\"CustomizeFeatureF\\": \\"自定义属性F\\",\\n \\"CustomizeFeatureA\\": \\"自定义属性A\\",\\n \\"CustomizeFeatureK\\": \\"自定义属性K\\",\\n \\"TemplateSceneId\\": \\"11223\\",\\n \\"CustomizeFeatureD\\": \\"自定义属性D\\",\\n \\"MemberPrice\\": 4000,\\n \\"PromotionStart\\": \\"2022-04-25T16:00:00Z\\",\\n \\"ModelNumber\\": \\"CH8850AS\\",\\n \\"CategoryName\\": \\"手机\\",\\n \\"CustomizeFeatureE\\": \\"自定义属性E\\",\\n \\"SuggestPrice\\": 500,\\n \\"SaleSpec\\": \\"1台/盒\\",\\n \\"PromotionText\\": \\"买一送一\\",\\n \\"Rank\\": \\"一级\\",\\n \\"PromotionReason\\": \\"情人节活动\\",\\n \\"CustomizeFeatureG\\": \\"自定义属性G\\",\\n \\"SalesPrice\\": 500,\\n \\"CustomizeFeatureH\\": \\"自定义属性H\\",\\n \\"OriginalPrice\\": 500,\\n \\"GmtModified\\": \\"2020-03-09T00:00:00Z\\",\\n \\"CustomizeFeatureI\\": \\"自定义属性I\\",\\n \\"ProductionPlace\\": \\"中国\\",\\n \\"CustomizeFeatureB\\": \\"1:1:16\\",\\n \\"ItemShortTitle\\": \\"牛奶\\",\\n \\"CustomizeFeatureN\\": \\"自定义属性N\\",\\n \\"BeMember\\": false,\\n \\"TaxFee\\": \\"增值税\\",\\n \\"InventoryStatus\\": \\"OUT_OF_STOCK\\",\\n \\"SupplierName\\": \\"天猫超市\\",\\n \\"ItemPicUrl\\": \\"http://m.taobao.com/xxx.html\\",\\n \\"EnergyEfficiency\\": \\"1kw/h\\",\\n \\"CustomizeFeatureL\\": \\"自定义属性L\\",\\n \\"CustomizeFeatureC\\": \\"自定义属性C\\",\\n \\"ItemId\\": \\"123456\\",\\n \\"Manufacturer\\": \\"广东省深圳\\",\\n \\"Material\\": \\"金属\\",\\n \\"CustomizeFeatureO\\": \\"自定义属性O\\",\\n \\"CustomizeFeatureP\\": \\"自定义属性P\\",\\n \\"CustomizeFeatureQ\\": \\"自定义属性Q\\",\\n \\"CustomizeFeatureR\\": \\"自定义属性R\\",\\n \\"CustomizeFeatureS\\": \\"自定义属性S\\",\\n \\"CustomizeFeatureT\\": \\"自定义属性T\\",\\n \\"CustomizeFeatureU\\": \\"自定义属性U\\",\\n \\"CustomizeFeatureV\\": \\"自定义属性V\\",\\n \\"CustomizeFeatureW\\": \\"自定义属性W\\",\\n \\"CustomizeFeatureX\\": \\"自定义属性X\\",\\n \\"CustomizeFeatureY\\": \\"自定义属性Y\\",\\n \\"CustomizeFeatureZ\\": \\"自定义属性Z\\",\\n \\"CustomizeFeatureJ\\": \\"酸酸甜甜，肉厚饱满\\",\\n \\"GmtCreate\\": \\"2020-03-09T00:00:00Z\\",\\n \\"CustomizeFeatureM\\": \\"自定义属性M\\",\\n \\"BePromotion\\": false,\\n \\"SkuId\\": \\"123456\\",\\n \\"BeSourceCode\\": false,\\n \\"ForestSecondId\\": \\"白酒\\",\\n \\"ItemQrCode\\": \\"http://m.taobao.com/xxx.html\\",\\n \\"ItemInfoIndex\\": 1,\\n \\"PromotionEnd\\": \\"2020-02-11T00:00:00Z\\",\\n \\"ItemBarCode\\": \\"01838\\",\\n \\"BeClearance\\": true\\n }\\n ]\\n}","type":"json"}]',
- ],
- 'AddUser' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6E0FF7FA-3F89-598F-9BF2-57DF480FE111\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"null\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 24,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"EslItemBindInfos\\": [\\n {\\n \\"EslBarCode\\": \\"18bc5a63****\\",\\n \\"TemplateSceneId\\": \\"123456\\",\\n \\"ActionPrice\\": \\"690\\",\\n \\"ItemTitle\\": \\"麦麸吐司\\",\\n \\"PromotionStart\\": \\"2020-03-16T07:05:34Z\\",\\n \\"PriceUnit\\": \\"187\\",\\n \\"OriginalPrice\\": \\"500\\",\\n \\"ItemId\\": \\"1234567\\",\\n \\"GmtModified\\": \\"1656469716000\\",\\n \\"EslPic\\": \\"kUzlfuzgayDo5uTXW3D66Q\\",\\n \\"StoreId\\": \\"s-pdwrrnkufn\\",\\n \\"ItemShortTitle\\": \\"牛奶\\",\\n \\"BindId\\": \\"b4adf048-f36d-4da5-a8bb-ab4adbd5eb04\\",\\n \\"PromotionText\\": \\"买一送一\\",\\n \\"EslModel\\": \\"AESL0213\\",\\n \\"BePromotion\\": true,\\n \\"SkuId\\": \\"124\\",\\n \\"EslConnectAp\\": \\"11:22:33:44:55:66\\",\\n \\"EslStatus\\": \\"ESL_STATUS_ONLINE\\",\\n \\"TemplateId\\": \\"123456\\",\\n \\"PromotionEnd\\": \\"2020-03-17T07:05:34Z\\",\\n \\"ItemBarCode\\": \\"690560583****\\",\\n \\"ContainerName\\": \\"2\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query binding information',
+ 'summary' => 'Queries the binding information between items and electronic shelf labels (ESLs).',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => 'Response parameters changed, Error codes changed'],
],
+ ],
+ 'DescribeCompanyTemplateVersions' => [
+ 'summary' => 'Version List ',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3578,107 +1499,96 @@
'BearerToken' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'UserId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'docRequired' => true,
- 'example' => '134****',
- 'required' => true,
- 'type' => 'string',
- ],
- ],
- [
- 'name' => 'ClientToken',
+ 'name' => 'PageNumber',
'in' => 'formData',
'schema' => [
- 'description' => '',
- 'example' => '1*',
+ 'description' => 'Pagination parameter: current page number. Default value is 1.',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'type' => 'string',
+ 'enumValueTitles' => [1 => '1'],
+ 'example' => '1',
+ 'title' => '',
],
],
[
- 'name' => 'ExtraParams',
+ 'name' => 'PageSize',
'in' => 'formData',
'schema' => [
- 'description' => '',
- 'example' => '{}',
+ 'description' => 'Pagination parameter: number of entries per page. Default value is 10.',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'type' => 'string',
+ 'enumValueTitles' => [10 => '10'],
+ 'example' => '10',
+ 'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'example' => 'The specified resource type is invalid.',
- 'type' => 'string',
+ 'TotalCount' => [
+ 'title' => '',
+ 'description' => 'Total count. ',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'enumValueTitles' => [18 => '18'],
+ 'example' => '16',
],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '6248311A-3296-5084-B057-D0EC3DCE5C47'],
+ 'ErrorMessage' => ['description' => 'Error message. ', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
'Success' => [
- 'description' => '',
- 'example' => 'true',
+ 'description' => 'Indicates whether the POP request succeeded.',
'type' => 'boolean',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'example' => 'MandatoryParameters',
- 'type' => 'string',
- ],
- 'Code' => [
- 'description' => '',
- 'example' => '-1001',
- 'type' => 'string',
- ],
- 'Message' => [
- 'description' => '',
- 'example' => 'success',
- 'type' => 'string',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'example' => 'The specified store %s does not exist.',
- 'type' => 'string',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'example' => 'PlatformResponseError.%s',
- 'type' => 'string',
+ 'enumValueTitles' => ['True' => 'True'],
+ 'example' => 'true',
+ 'title' => '',
+ ],
+ 'ErrorCode' => ['description' => 'Error code. The following rules apply: If the request succeeded, the ErrorCode field is not returned. If the request failed, the ErrorCode field is returned. For details, see the error code list in this topic. ', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'HTTP status code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'Response message. If the request succeeded, the value is "success". ', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'Dynamic error message used to replace the %s placeholder in the error message returned in the ErrMessage parameter. ', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'Dynamic error code associated with this request. ', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'PageSize' => ['description' => 'Pagination parameter: number of entries per page. Default value is 10. ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'Pagination parameter: current page number. Default value is 1. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Versions' => [
+ 'description' => 'List of versions. ',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'List of versions. ',
+ 'type' => 'object',
+ 'properties' => [
+ 'Version' => ['description' => 'Version number. ', 'type' => 'string', 'example' => '1.1.0', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","errorExample":""},{"type":"xml","example":"<AddUserResponse>\\n <RequestId>E69C8998-1787-4999-8C75-D663FF1173CF</RequestId>\\n <ErrorMessage>The specified resource type is invalid.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>MandatoryParameters</ErrorCode>\\n <Code>-1001</Code>\\n <Message>success</Message>\\n <DynamicMessage>The specified store %s does not exist.</DynamicMessage>\\n <DynamicCode>PlatformResponseError.%s</DynamicCode>\\n</AddUserResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 16,\\n \\"RequestId\\": \\"6248311A-3296-5084-B057-D0EC3DCE5C47\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Versions\\": [\\n {\\n \\"Version\\": \\"1.1.0\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'changeSet' => [],
+ 'title' => '',
],
- 'DeleteUser' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeEslDevice' => [
+ 'summary' => 'Incrementally queries the data binding status of price tags.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3687,98 +1597,81 @@
'BearerToken' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'UserId',
+ 'name' => 'StoreId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1344***',
- ],
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
- 'name' => 'ExtraParams',
+ 'name' => 'FromDate',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'ToDate',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
+ 'TotalCount' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'PageSize' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'PageNumber' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'EslDetails' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EslBarCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'LastUpdateTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ItemBarCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'ItemId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'ItemShortTitle' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'StoreId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","errorExample":""},{"type":"xml","example":"<code>200</code>\\n<data>\\n <RequestId>8F124625-DF0A-4B08-B205-2CF538FAF713</RequestId>\\n <Success>true</Success>\\n</data>\\n<requestId>8F124625-DF0A-4B08-B205-2CF538FAF713</requestId>\\n<successResponse>true</successResponse>","errorExample":""}]',
- 'title' => 'DeleteUser',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 0,\\n \\"PageSize\\": 0,\\n \\"RequestId\\": \\"\\",\\n \\"PageNumber\\": 0,\\n \\"Success\\": false,\\n \\"EslDetails\\": [\\n {\\n \\"EslBarCode\\": \\"\\",\\n \\"LastUpdateTime\\": \\"\\",\\n \\"ItemBarCode\\": 0,\\n \\"ItemId\\": 0,\\n \\"ItemShortTitle\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"StoreId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '',
],
- 'AssignUser' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeEslDevices' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3787,53 +1680,83 @@
'BearerToken' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Stores',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[s-dxsxxxxxx,s-dxsyyyyyyy]',
- ],
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'UserId',
+ 'name' => 'Type',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1344***',
- ],
+ 'schema' => ['description' => 'The type of the electronic shelf label (ESL). Valid values:'."\n"
+ ."\n"
+ .'- `ESL_TYPE_E_INK`: e-ink screen'."\n"
+ ."\n"
+ .'- `ESL_TYPE_DM_LCD`: segment code screen'."\n"
+ ."\n"
+ .'- `ESL_TYPE_FULL_COLOR`: color screen.', 'type' => 'string', 'required' => false, 'example' => 'ESL_TYPE_E_INK', 'title' => ''],
],
[
- 'name' => 'UserType',
+ 'name' => 'TypeEncode',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'USER_TYPE_COMPANY_OWNER',
- ],
+ 'schema' => ['title' => '', 'description' => 'The type of the ESL. Valid values:'."\n"
+ ."\n"
+ .'- `NORMAL`: standard'."\n"
+ ."\n"
+ .'- `LOW_TEMPLATE`: low-temperature'."\n"
+ ."\n"
+ .'- `THREE_COLOR`: three-color'."\n"
+ ."\n"
+ .'- `ESL_TYPE_DM_LCD`: segment code'."\n"
+ ."\n"
+ .'- `ESL_TYPE_FULL_COLOR`: color'."\n"
+ ."\n"
+ .'- `ESL_TYPE_MUTI_MEDIA`: multimedia.', 'type' => 'string', 'required' => false, 'example' => 'LOW_TEMPLATE'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'ToBatteryLevel',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The upper bound of the battery level range. The battery level is greater than or equal to the specified value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', 'title' => ''],
+ ],
+ [
+ 'name' => 'StoreId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The store ID or custom store ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
+ ],
+ [
+ 'name' => 'EslStatus',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The status of the ESL. Valid values:'."\n"
+ ."\n"
+ .'- `ESL_STATUS_ONLINE`: online and bound'."\n"
+ ."\n"
+ .'- `ESL_STATUS_OFFLINE`: offline and bound'."\n"
+ ."\n"
+ .'- `ESL_STATUS_UNBIND`: unbound.', 'type' => 'string', 'required' => false, 'example' => 'ESL_STATUS_ONLINE', 'title' => ''],
+ ],
+ [
+ 'name' => 'EslBarCode',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The barcode of the ESL.', 'type' => 'string', 'required' => false, 'example' => '18bc5a63****', 'title' => ''],
+ ],
+ [
+ 'name' => 'FromBatteryLevel',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The lower bound of the battery level range. The battery level is less than or equal to the specified value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'The extended parameters.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
@@ -3841,65 +1764,85 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters ',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001 ',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters ', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'EslDevices' => [
+ 'description' => 'The list of ESL device information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The type of the ESL. Valid values:'."\n"
+ ."\n"
+ .'- `ESL_TYPE_E_INK`: e-ink screen'."\n"
+ ."\n"
+ .'- `ESL_TYPE_DM_LCD`: segment code screen'."\n"
+ ."\n"
+ .'- `ESL_TYPE_FULL_COLOR`: color screen.', 'type' => 'string', 'example' => 'ESL_TYPE_E_INK', 'title' => ''],
+ 'StoreId' => ['description' => 'The store ID.', 'type' => 'string', 'example' => 's-dxsxx****', 'title' => ''],
+ 'EslBarCode' => ['description' => 'The barcode of the ESL.', 'type' => 'string', 'example' => '18bc5a63****', 'title' => ''],
+ 'Model' => ['description' => 'The model of the ESL.', 'type' => 'string', 'example' => 'AESL0213', 'title' => ''],
+ 'LastCommunicateTime' => ['description' => 'The last communication time.', 'type' => 'string', 'example' => '2020-03-16T07:04:16Z', 'title' => ''],
+ 'ScreenHeight' => ['description' => 'The screen height, in px.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'ScreenWidth' => ['description' => 'The screen width, in px.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
+ 'EslSignal' => ['description' => 'The signal strength of the ESL.', 'type' => 'integer', 'format' => 'int32', 'example' => '54', 'title' => ''],
+ 'BatteryLevel' => ['description' => 'The battery level.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'EslStatus' => ['description' => 'The status of the ESL. Valid values:'."\n"
+ ."\n"
+ .'- `ESL_STATUS_ONLINE`: online and bound'."\n"
+ ."\n"
+ .'- `ESL_STATUS_OFFLINE`: offline and bound'."\n"
+ ."\n"
+ .'- `ESL_STATUS_UNBIND`: unbound.', 'type' => 'string', 'example' => 'ESL_STATUS_ONLINE', 'title' => ''],
+ 'Mac' => ['description' => 'The MAC address of the ESL.', 'type' => 'string', 'example' => '18:bc:5a:63:**:**', 'title' => ''],
+ 'TypeEncode' => ['title' => '', 'description' => 'The type encoding. Valid values:'."\n"
+ .'NORMAL: standard'."\n"
+ .'LOW_TEMPLATE: low-temperature ESL'."\n"
+ .'THREE_COLOR: three-color ESL'."\n"
+ .'ESL_TYPE_DM_LCD: segment code screen'."\n"
+ .'ESL_TYPE_FULL_COLOR: color screen'."\n"
+ .'ESL_TYPE_MUTIMEDIA: multimedia.', 'type' => 'string', 'example' => 'THREE_COLOR'],
+ 'LayoutId' => ['description' => 'The layout ID. Only a single ID is supported.', 'type' => 'string', 'example' => '7', 'title' => ''],
+ 'LayoutName' => ['description' => 'The layout name.', 'type' => 'string', 'example' => '新增布局', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters \\",\\n \\"Code\\": \\"-1001 \\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","errorExample":""},{"type":"xml","example":"<code>200</code>\\n<data>\\n <RequestId>8F124625-DF0A-4B08-B205-2CF538FAF713</RequestId>\\n <Success>true</Success>\\n</data>\\n<requestId>8F124625-DF0A-4B08-B205-2CF538FAF713</requestId>\\n<successResponse>true</successResponse>","errorExample":""}]',
- 'title' => 'AssignUser',
- 'requestParamsDescription' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters \\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"EslDevices\\": [\\n {\\n \\"Type\\": \\"ESL_TYPE_E_INK\\",\\n \\"StoreId\\": \\"s-dxsxx****\\",\\n \\"EslBarCode\\": \\"18bc5a63****\\",\\n \\"Model\\": \\"AESL0213\\",\\n \\"LastCommunicateTime\\": \\"2020-03-16T07:04:16Z\\",\\n \\"ScreenHeight\\": 200,\\n \\"ScreenWidth\\": 200,\\n \\"EslSignal\\": 54,\\n \\"BatteryLevel\\": 100,\\n \\"EslStatus\\": \\"ESL_STATUS_ONLINE\\",\\n \\"Mac\\": \\"18:bc:5a:63:**:**\\",\\n \\"TypeEncode\\": \\"THREE_COLOR\\",\\n \\"LayoutId\\": \\"7\\",\\n \\"LayoutName\\": \\"新增布局\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query cloudESL devices',
+ 'summary' => 'Queries CloudESL device information.',
+ 'requestParamsDescription' => 'Querying by battery level range is not currently supported.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'UnassignUser' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-03-30T08:13:18.000Z', 'description' => 'Request parameters changed, Response parameters changed, Error codes changed'],
],
+ ],
+ 'DescribeEslModelByTemplateVersion' => [
+ 'summary' => 'Query device types by version ',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3908,99 +1851,86 @@
'BearerToken' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'UserId',
+ 'name' => 'TemplateVersion',
'in' => 'formData',
'schema' => [
- 'description' => '',
+ 'description' => 'The outlet template version number. ',
'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1344***',
+ 'required' => false,
+ 'enumValueTitles' => ['1.1.0' => '1.1.0'],
+ 'example' => '1.1.0',
+ 'title' => '',
],
],
[
- 'name' => 'ExtraParams',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'Pagination parameter: the current page number. Default value: 1. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Pagination parameter: the number of entries to display per page. Default value: 10. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
+ 'TotalCount' => ['title' => '', 'description' => 'TotalCount is the total amount of data under the conditions of this request. This parameter is optional and does not need to be returned by default. ', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
+ 'RequestId' => ['description' => 'The request ID. ', 'type' => 'string', 'example' => '38F85526-14B8-54A8-A0BB-3B200BBC3682', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message. ', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'The request status identifier. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code. The value is interpreted as follows: If the request succeeded, the ErrorCode field is not returned. If the request failed, the ErrorCode field is returned. For more information, see the error code list in this topic. ', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The HTTP status code. ', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The error message. ', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'Dynamic error message used to replace the %s placeholder in the ErrMessage error message. ', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'Dynamic error code. ', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'PageNumber' => ['description' => 'Pagination parameter: the current page number. Default value: 1. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'Pagination parameter: the number of entries to display per page. Default value: 10. ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'EslModels' => [
+ 'description' => 'List of template version information. ',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'List of template version information. ',
+ 'type' => 'object',
+ 'properties' => [
+ 'ModelId' => ['description' => 'Model ID ', 'type' => 'string', 'example' => '9946366490094af4ab16bfe023ad5f22', 'title' => ''],
+ 'Name' => ['description' => 'The model name. ', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'Image' => ['description' => 'Product image. ', 'type' => 'string', 'example' => '/9xwqexcdaxasada....', 'title' => ''],
+ 'DeviceType' => ['description' => 'Device type ', 'type' => 'string', 'example' => '3', 'title' => ''],
+ 'Vendor' => ['description' => 'Vendor name ', 'type' => 'string', 'example' => 'ali', 'title' => ''],
+ 'ScreenWidth' => ['description' => 'Screen width. ', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''],
+ 'ScreenHeight' => ['description' => 'Screen height. ', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''],
+ 'EslSize' => ['description' => 'ESL model. ', 'type' => 'string', 'example' => '800X480', 'title' => ''],
+ 'EslPhysicalSize' => ['description' => 'Memory size. Unit: GiB ', 'type' => 'string', 'title' => '', 'example' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","errorExample":""},{"type":"xml","example":"<code>200</code>\\n<data>\\n <RequestId>8F124625-DF0A-4B08-B205-2CF538FAF713</RequestId>\\n <Success>true</Success>\\n</data>\\n<requestId>8F124625-DF0A-4B08-B205-2CF538FAF713</requestId>\\n<successResponse>true</successResponse>","errorExample":""}]',
- 'title' => 'UnassignUser',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"38F85526-14B8-54A8-A0BB-3B200BBC3682\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"EslModels\\": [\\n {\\n \\"ModelId\\": \\"9946366490094af4ab16bfe023ad5f22\\",\\n \\"Name\\": \\"test\\",\\n \\"Image\\": \\"/9xwqexcdaxasada....\\",\\n \\"DeviceType\\": \\"3\\",\\n \\"Vendor\\": \\"ali\\",\\n \\"ScreenWidth\\": 0,\\n \\"ScreenHeight\\": 0,\\n \\"EslSize\\": \\"800X480\\",\\n \\"EslPhysicalSize\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'changeSet' => [],
+ 'title' => '',
],
- 'DescribeUserLog' => [
- 'summary' => '增加国际化key',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeItems' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4011,142 +1941,52 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ItemShortTitle',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'Pagination parameter: the number of entries to display per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'OperationType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OPERATION_TYPE_BIND',
- ],
- ],
- [
- 'name' => 'EslBarCode',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '18bc5a63****',
- ],
+ 'schema' => ['description' => 'Pagination parameter: the current page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'FromDate',
+ 'name' => 'ItemTitle',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-03-18T02:26:28Z',
- ],
+ 'schema' => ['description' => 'The item title.', 'type' => 'string', 'required' => false, 'example' => '纯牛奶', 'title' => ''],
],
[
- 'name' => 'ItemBarCode',
+ 'name' => 'SkuId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '690560583****',
- ],
+ 'schema' => ['description' => 'The SKU ID.', 'type' => 'string', 'required' => false, 'example' => '1234565', 'title' => ''],
],
[
'name' => 'StoreId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
- ],
+ 'schema' => ['description' => 'The store ID or merchant-defined custom store ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
- 'name' => 'ToDate',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2020-03-17T02:26:28Z',
- ],
- ],
- [
- 'name' => 'LogId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123456',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'OperationStatus',
+ 'name' => 'ItemBarCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OPERATION_STATUS_NEW',
- ],
+ 'schema' => ['description' => 'The item barcode.', 'type' => 'string', 'required' => false, 'example' => '6941297417178', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ItemId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The item ID.', 'type' => 'string', 'required' => false, 'example' => '6959294202901', 'title' => ''],
],
[
- 'name' => 'UserId',
+ 'name' => 'BePromotion',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '134****',
- ],
+ 'schema' => ['description' => 'Specifies whether to display with the promotion template. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'A system reserved field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
@@ -4154,191 +1994,120 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
- 'UserLogs' => [
- 'description' => '',
+ 'TemplateSceneId' => ['description' => 'The custom template ID.', 'type' => 'string', 'example' => '1223', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Message' => ['description' => 'The error prompt message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic error message used to replace **%s** in the **ErrMessage** return parameter.'."\n", 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'PageNumber' => ['description' => 'Pagination parameter: the current page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'Pagination parameter: the number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Items' => [
+ 'description' => 'The list of item information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'EslBarCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '18bc5a63****',
- ],
- 'OperationSendTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-03-17T02:25:17Z',
- ],
- 'ActionPrice' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '500',
- ],
- 'UserId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '134****',
- ],
- 'PriceUnit' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'ResultCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2002',
- ],
- 'ItemId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'GmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-03-17T02:26:17Z',
- ],
- 'OperationType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OPERATION_TYPE_BIND',
- ],
- 'OperationResponseTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-03-17T02:26:17Z',
- ],
- 'OperationStatus' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OPERATION_STATUS_NEW',
- ],
- 'StoreId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 's-dxsxxx****',
- ],
- 'ItemShortTitle' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'LogId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'BePromotion' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'GmtCreate' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-03-17T02:26:17Z',
- ],
- 'EslSignal' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
- 'SpendTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'ItemBarCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '690560583****',
- ],
- 'I18nResultKey' => [
- 'type' => 'string',
- ],
+ 'ActionPrice' => ['description' => 'The actual selling price. Unit: cents.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''],
+ 'ItemTitle' => ['description' => 'The item title.', 'type' => 'string', 'example' => '纯牛奶', 'title' => ''],
+ 'BrandName' => ['description' => 'The brand name. Maximum length: 64 characters.', 'type' => 'string', 'example' => '阿里巴巴', 'title' => ''],
+ 'SourceCode' => ['description' => 'The traceability code. Maximum length: 128 characters.', 'type' => 'string', 'example' => '123456', 'title' => ''],
+ 'PriceUnit' => ['description' => 'The pricing unit. Maximum length: 64 characters.', 'type' => 'string', 'example' => '瓶', 'title' => ''],
+ 'ForestFirstId' => ['description' => 'The first-level item category ID.', 'type' => 'string', 'example' => '酒类', 'title' => ''],
+ 'CustomizeFeatureF' => ['description' => 'Custom attribute F.', 'type' => 'string', 'example' => '自定义属性F', 'title' => ''],
+ 'CustomizeFeatureA' => ['description' => 'Custom attribute A.', 'type' => 'string', 'example' => '自定义属性A', 'title' => ''],
+ 'CustomizeFeatureK' => ['description' => 'Custom attribute K.', 'type' => 'string', 'example' => '自定义属性K', 'title' => ''],
+ 'TemplateSceneId' => ['description' => 'The custom template ID.', 'type' => 'string', 'example' => '11223', 'title' => ''],
+ 'CustomizeFeatureD' => ['description' => 'Custom attribute D.', 'type' => 'string', 'example' => '自定义属性D', 'title' => ''],
+ 'MemberPrice' => ['description' => 'The member price. Unit: cents.', 'type' => 'integer', 'format' => 'int32', 'example' => '4000', 'title' => ''],
+ 'PromotionStart' => ['description' => 'The promotion start time in UTC format "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'".', 'type' => 'string', 'example' => '2022-04-25T16:00:00Z', 'title' => ''],
+ 'ModelNumber' => ['description' => 'The model number. Maximum length: 64 characters.', 'type' => 'string', 'example' => 'CH8850AS', 'title' => ''],
+ 'CategoryName' => ['description' => 'The category name. Maximum length: 64 characters.', 'type' => 'string', 'example' => '手机', 'title' => ''],
+ 'CustomizeFeatureE' => ['description' => 'Custom attribute E.', 'type' => 'string', 'example' => '自定义属性E', 'title' => ''],
+ 'SuggestPrice' => ['description' => 'The suggested retail price. Unit: cents.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''],
+ 'SaleSpec' => ['description' => 'The specification. Maximum length: 64 characters.', 'type' => 'string', 'example' => '1台/盒', 'title' => ''],
+ 'PromotionText' => ['description' => 'The promotion text. Maximum length: 64 characters.', 'type' => 'string', 'example' => '买一送一', 'title' => ''],
+ 'Rank' => ['description' => 'The rank. Maximum length: 32 characters.', 'type' => 'string', 'example' => '一级', 'title' => ''],
+ 'PromotionReason' => ['description' => 'The promotion reason. Maximum length: 64 characters.', 'type' => 'string', 'example' => '情人节活动', 'title' => ''],
+ 'CustomizeFeatureG' => ['description' => 'Custom attribute G.', 'type' => 'string', 'example' => '自定义属性G', 'title' => ''],
+ 'SalesPrice' => ['description' => 'The sales price. Unit: cents.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''],
+ 'CustomizeFeatureH' => ['description' => 'Custom attribute H.', 'type' => 'string', 'example' => '自定义属性H', 'title' => ''],
+ 'OriginalPrice' => ['description' => 'The original price. Unit: cents.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''],
+ 'GmtModified' => ['description' => 'The time when the item was last modified.', 'type' => 'string', 'example' => '2020-03-09T00:00:00Z', 'title' => ''],
+ 'CustomizeFeatureI' => ['description' => 'Custom attribute I.', 'type' => 'string', 'example' => '自定义属性I', 'title' => ''],
+ 'ProductionPlace' => ['description' => 'The place of production. Maximum length: 64 characters.', 'type' => 'string', 'example' => '中国', 'title' => ''],
+ 'CustomizeFeatureB' => ['description' => 'Custom attribute B.', 'type' => 'string', 'example' => '1:1:16', 'title' => ''],
+ 'ItemShortTitle' => ['description' => 'The item short title. If not specified, it is extracted from the full item title. Maximum length: 64 characters.', 'type' => 'string', 'example' => '牛奶', 'title' => ''],
+ 'CustomizeFeatureN' => ['description' => 'Custom attribute N.', 'type' => 'string', 'example' => '自定义属性N', 'title' => ''],
+ 'BeMember' => ['description' => 'Specifies whether to display with the member template. Default value: false.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'TaxFee' => ['description' => 'The tax information. Maximum length: 32 characters.', 'type' => 'string', 'example' => '增值税', 'title' => ''],
+ 'InventoryStatus' => ['description' => 'The inventory status. Valid values:'."\n"
+ ."\n"
+ .'- `OUT_OF_STOCK`: out of stock.'."\n"
+ ."\n"
+ .'- `NORMAL`: normal.', 'type' => 'string', 'example' => 'OUT_OF_STOCK', 'title' => ''],
+ 'SupplierName' => ['description' => 'The supplier name.', 'type' => 'string', 'example' => '天猫超市', 'title' => ''],
+ 'ItemPicUrl' => ['description' => 'The item image URL.', 'type' => 'string', 'example' => 'http://m.taobao.com/xxx.html', 'title' => ''],
+ 'EnergyEfficiency' => ['description' => 'The energy efficiency. Maximum length: 64 characters.', 'type' => 'string', 'example' => '1kw/h', 'title' => ''],
+ 'CustomizeFeatureL' => ['description' => 'Custom attribute L.', 'type' => 'string', 'example' => '自定义属性L', 'title' => ''],
+ 'CustomizeFeatureC' => ['description' => 'Custom attribute C.', 'type' => 'string', 'example' => '自定义属性C', 'title' => ''],
+ 'ItemId' => ['description' => 'The custom item barcode. Only Arabic numerals that form an integer are allowed.', 'type' => 'string', 'example' => '123456', 'title' => ''],
+ 'Manufacturer' => ['description' => 'The manufacturer. Maximum length: 128 characters.', 'type' => 'string', 'example' => '广东省深圳', 'title' => ''],
+ 'Material' => ['description' => 'The material. Maximum length: 64 characters.', 'type' => 'string', 'example' => '金属', 'title' => ''],
+ 'CustomizeFeatureO' => ['description' => 'Custom attribute O.', 'type' => 'string', 'example' => '自定义属性O', 'title' => ''],
+ 'CustomizeFeatureP' => ['description' => 'Custom attribute P.', 'type' => 'string', 'example' => '自定义属性P', 'title' => ''],
+ 'CustomizeFeatureQ' => ['description' => 'Custom attribute Q.', 'type' => 'string', 'example' => '自定义属性Q', 'title' => ''],
+ 'CustomizeFeatureR' => ['description' => 'Custom attribute R.', 'type' => 'string', 'example' => '自定义属性R', 'title' => ''],
+ 'CustomizeFeatureS' => ['description' => 'Custom attribute S.', 'type' => 'string', 'example' => '自定义属性S', 'title' => ''],
+ 'CustomizeFeatureT' => ['description' => 'Custom attribute T.', 'type' => 'string', 'example' => '自定义属性T', 'title' => ''],
+ 'CustomizeFeatureU' => ['description' => 'Custom attribute U.', 'type' => 'string', 'example' => '自定义属性U', 'title' => ''],
+ 'CustomizeFeatureV' => ['description' => 'Custom attribute V.', 'type' => 'string', 'example' => '自定义属性V', 'title' => ''],
+ 'CustomizeFeatureW' => ['description' => 'Custom attribute W.', 'type' => 'string', 'example' => '自定义属性W', 'title' => ''],
+ 'CustomizeFeatureX' => ['description' => 'Custom attribute X.', 'type' => 'string', 'example' => '自定义属性X', 'title' => ''],
+ 'CustomizeFeatureY' => ['description' => 'Custom attribute Y.', 'type' => 'string', 'example' => '自定义属性Y', 'title' => ''],
+ 'CustomizeFeatureZ' => ['description' => 'Custom attribute Z.', 'type' => 'string', 'example' => '自定义属性Z', 'title' => ''],
+ 'CustomizeFeatureJ' => ['description' => 'Custom attribute J.', 'type' => 'string', 'example' => '酸酸甜甜，肉厚饱满', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The creation time. Format: timestamp. Unit: milliseconds.', 'type' => 'string', 'example' => '2020-03-09T00:00:00Z', 'title' => ''],
+ 'CustomizeFeatureM' => ['description' => 'Custom attribute M.', 'type' => 'string', 'example' => '自定义属性M', 'title' => ''],
+ 'BePromotion' => ['description' => 'Specifies whether to display with the promotion template. Default value: false.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'SkuId' => ['description' => 'The SKU ID.', 'type' => 'string', 'example' => '123456', 'title' => ''],
+ 'BeSourceCode' => ['description' => 'Specifies whether to display with the traceability template. Default value: false.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'ForestSecondId' => ['description' => 'The second-level item category ID.', 'type' => 'string', 'example' => '白酒', 'title' => ''],
+ 'ItemQrCode' => ['description' => 'The item QR code URL. Maximum length: 1024 characters.', 'type' => 'string', 'example' => 'http://m.taobao.com/xxx.html', 'title' => ''],
+ 'ItemInfoIndex' => ['description' => 'The item information index. This field does not need to be specified.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PromotionEnd' => ['description' => 'The promotion end time in UTC format "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'".', 'type' => 'string', 'example' => '2020-02-11T00:00:00Z', 'title' => ''],
+ 'ItemBarCode' => ['description' => 'The item barcode.', 'type' => 'string', 'example' => '01838', 'title' => ''],
+ 'BeClearance' => ['description' => 'Indicates whether custom attributes have been added.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"UserLogs\\": [\\n {\\n \\"EslBarCode\\": \\"18bc5a63****\\",\\n \\"OperationSendTime\\": \\"2020-03-17T02:25:17Z\\",\\n \\"ActionPrice\\": \\"500\\",\\n \\"UserId\\": \\"134****\\",\\n \\"PriceUnit\\": \\"台\\",\\n \\"ResultCode\\": \\"2002\\",\\n \\"ItemId\\": \\"123456\\",\\n \\"GmtModified\\": \\"2020-03-17T02:26:17Z\\",\\n \\"OperationType\\": \\"OPERATION_TYPE_BIND\\",\\n \\"OperationResponseTime\\": \\"2020-03-17T02:26:17Z\\",\\n \\"OperationStatus\\": \\"OPERATION_STATUS_NEW\\",\\n \\"StoreId\\": \\"s-dxsxxx****\\",\\n \\"ItemShortTitle\\": \\"牛奶\\",\\n \\"LogId\\": \\"123456\\",\\n \\"BePromotion\\": false,\\n \\"GmtCreate\\": \\"2020-03-17T02:26:17Z\\",\\n \\"EslSignal\\": 50,\\n \\"SpendTime\\": \\"10\\",\\n \\"ItemBarCode\\": \\"690560583****\\",\\n \\"I18nResultKey\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<code>200</code>\\n<data>\\n <TotalCount>68</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>78DDE5D5-7E14-4BED-92AF-C465C74BCDBF</RequestId>\\n <PageNumber>1</PageNumber>\\n <Success>true</Success>\\n <UserLogs>\\n <GmtModified>2020-03-16T06:38:56Z</GmtModified>\\n <ActionPrice>999</ActionPrice>\\n <OperationSendTime>2020-03-16T06:38:57Z</OperationSendTime>\\n <ItemBarCode>123456</ItemBarCode>\\n <SpendTime>0</SpendTime>\\n <ItemId>123456</ItemId>\\n <GmtCreate>2020-03-16T06:38:56Z</GmtCreate>\\n <EslBarCode>18bc5a63****</EslBarCode>\\n <PriceUnit>个</PriceUnit>\\n <ItemShortTitle>促销商品</ItemShortTitle>\\n <StoreId>s-ph5agd****</StoreId>\\n <OperationStatus>OPERATION_STATUS_SEND_FAILED</OperationStatus>\\n <OperationType>OPERATION_TYPE_BIND</OperationType>\\n <LogId>123456</LogId>\\n <ResultCode>Error00000011|Assemble sending package fail!</ResultCode>\\n <BePromotion>true</BePromotion>\\n </UserLogs>\\n <UserLogs>\\n <GmtModified>2020-03-16T06:36:46Z</GmtModified>\\n <ActionPrice>1688</ActionPrice>\\n <OperationSendTime>2020-03-16T06:36:47Z</OperationSendTime>\\n <ItemBarCode>123456</ItemBarCode>\\n <SpendTime>0</SpendTime>\\n <ItemId>123456</ItemId>\\n <GmtCreate>2020-03-16T06:36:46Z</GmtCreate>\\n <EslBarCode>18bc5a63****</EslBarCode>\\n <PriceUnit>盒</PriceUnit>\\n <ItemShortTitle>常规商品</ItemShortTitle>\\n <StoreId>s-ph5agd****</StoreId>\\n <OperationStatus>OPERATION_STATUS_SEND_FAILED</OperationStatus>\\n <OperationType>OPERATION_TYPE_BIND</OperationType>\\n <LogId>123456</LogId>\\n <ResultCode>Error00000011|Assemble sending package fail!</ResultCode>\\n <BePromotion>false</BePromotion>\\n </UserLogs>\\n</data>\\n<requestId>78DDE5D5-7E14-4BED-92AF-C465C74BCDBF</requestId>\\n<successResponse>true</successResponse>","errorExample":""}]',
- 'title' => 'DescribeUserLog',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeUsers' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TemplateSceneId\\": \\"1223\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Items\\": [\\n {\\n \\"ActionPrice\\": 500,\\n \\"ItemTitle\\": \\"纯牛奶\\",\\n \\"BrandName\\": \\"阿里巴巴\\",\\n \\"SourceCode\\": \\"123456\\",\\n \\"PriceUnit\\": \\"瓶\\",\\n \\"ForestFirstId\\": \\"酒类\\",\\n \\"CustomizeFeatureF\\": \\"自定义属性F\\",\\n \\"CustomizeFeatureA\\": \\"自定义属性A\\",\\n \\"CustomizeFeatureK\\": \\"自定义属性K\\",\\n \\"TemplateSceneId\\": \\"11223\\",\\n \\"CustomizeFeatureD\\": \\"自定义属性D\\",\\n \\"MemberPrice\\": 4000,\\n \\"PromotionStart\\": \\"2022-04-25T16:00:00Z\\",\\n \\"ModelNumber\\": \\"CH8850AS\\",\\n \\"CategoryName\\": \\"手机\\",\\n \\"CustomizeFeatureE\\": \\"自定义属性E\\",\\n \\"SuggestPrice\\": 500,\\n \\"SaleSpec\\": \\"1台/盒\\",\\n \\"PromotionText\\": \\"买一送一\\",\\n \\"Rank\\": \\"一级\\",\\n \\"PromotionReason\\": \\"情人节活动\\",\\n \\"CustomizeFeatureG\\": \\"自定义属性G\\",\\n \\"SalesPrice\\": 500,\\n \\"CustomizeFeatureH\\": \\"自定义属性H\\",\\n \\"OriginalPrice\\": 500,\\n \\"GmtModified\\": \\"2020-03-09T00:00:00Z\\",\\n \\"CustomizeFeatureI\\": \\"自定义属性I\\",\\n \\"ProductionPlace\\": \\"中国\\",\\n \\"CustomizeFeatureB\\": \\"1:1:16\\",\\n \\"ItemShortTitle\\": \\"牛奶\\",\\n \\"CustomizeFeatureN\\": \\"自定义属性N\\",\\n \\"BeMember\\": false,\\n \\"TaxFee\\": \\"增值税\\",\\n \\"InventoryStatus\\": \\"OUT_OF_STOCK\\",\\n \\"SupplierName\\": \\"天猫超市\\",\\n \\"ItemPicUrl\\": \\"http://m.taobao.com/xxx.html\\",\\n \\"EnergyEfficiency\\": \\"1kw/h\\",\\n \\"CustomizeFeatureL\\": \\"自定义属性L\\",\\n \\"CustomizeFeatureC\\": \\"自定义属性C\\",\\n \\"ItemId\\": \\"123456\\",\\n \\"Manufacturer\\": \\"广东省深圳\\",\\n \\"Material\\": \\"金属\\",\\n \\"CustomizeFeatureO\\": \\"自定义属性O\\",\\n \\"CustomizeFeatureP\\": \\"自定义属性P\\",\\n \\"CustomizeFeatureQ\\": \\"自定义属性Q\\",\\n \\"CustomizeFeatureR\\": \\"自定义属性R\\",\\n \\"CustomizeFeatureS\\": \\"自定义属性S\\",\\n \\"CustomizeFeatureT\\": \\"自定义属性T\\",\\n \\"CustomizeFeatureU\\": \\"自定义属性U\\",\\n \\"CustomizeFeatureV\\": \\"自定义属性V\\",\\n \\"CustomizeFeatureW\\": \\"自定义属性W\\",\\n \\"CustomizeFeatureX\\": \\"自定义属性X\\",\\n \\"CustomizeFeatureY\\": \\"自定义属性Y\\",\\n \\"CustomizeFeatureZ\\": \\"自定义属性Z\\",\\n \\"CustomizeFeatureJ\\": \\"酸酸甜甜，肉厚饱满\\",\\n \\"GmtCreate\\": \\"2020-03-09T00:00:00Z\\",\\n \\"CustomizeFeatureM\\": \\"自定义属性M\\",\\n \\"BePromotion\\": false,\\n \\"SkuId\\": \\"123456\\",\\n \\"BeSourceCode\\": false,\\n \\"ForestSecondId\\": \\"白酒\\",\\n \\"ItemQrCode\\": \\"http://m.taobao.com/xxx.html\\",\\n \\"ItemInfoIndex\\": 1,\\n \\"PromotionEnd\\": \\"2020-02-11T00:00:00Z\\",\\n \\"ItemBarCode\\": \\"01838\\",\\n \\"BeClearance\\": true\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'QueryItems',
+ 'summary' => 'Queries item information.',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-18T13:13:48.000Z', 'description' => 'Response parameters changed'],
],
+ ],
+ 'DescribeStoreByTemplateVersion' => [
+ 'summary' => 'Query outlets to which the template is applied ',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4349,213 +2118,64 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'UserType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'USER_TYPE_COMPANY_OWNER',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'UserId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1344***',
- ],
- ],
- [
- 'name' => 'UserName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'ExtraParams',
+ 'name' => 'TemplateVersion',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'Outlet Template Version number. ', 'type' => 'string', 'required' => false, 'example' => '1.1.0', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
- 'Users' => [
- 'description' => '',
+ 'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'Fault message. ', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the Request succeeded. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'Error code. ', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'HTTP status code. ', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'Response message. If the request succeeded, the value is "success". ', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'Dynamic error message used to replace the %s placeholder in the **ErrMessage** error message in the response parameters. ', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'Dynamic error code associated with this request. ', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'Stores' => [
+ 'description' => 'List of outlet information. ',
'type' => 'array',
'items' => [
+ 'description' => 'List of outlet information. ',
'type' => 'object',
'properties' => [
- 'UserType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'USER_TYPE_COMPANY_OWNER',
- ],
- 'UserId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1344***',
- ],
- 'Stores' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '[s-dxsxxxxxx,s-dxsyyyyyyy]',
- ],
- 'UserName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Bid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '26842',
- ],
- 'OwnerId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1212124434535',
- ],
- 'DingTalkInfos' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'DingTalkCompanyId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '13124',
- ],
- 'DingTalkUserId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3455566',
- ],
- ],
- ],
- ],
+ 'StoreName' => ['description' => 'Outlet Name. ', 'type' => 'string', 'example' => '天猫旗舰店', 'title' => ''],
+ 'StoreId' => ['description' => 'Outlet ID. ', 'type' => 'string', 'example' => 's-nxwd8sutd6', 'title' => ''],
+ 'ParentId' => ['description' => 'Parent outlet ID. ', 'type' => 'string', 'example' => 'rm-2zeb2rt850x880j1n', 'title' => ''],
+ 'UserStoreCode' => ['description' => 'User outlet code ', 'type' => 'string', 'example' => 's-2zeb2r1t12sq', 'title' => ''],
+ 'GmtModified' => ['description' => 'Updated At', 'type' => 'string', 'example' => '2020-03-06T02:58:16Z', 'title' => ''],
+ 'Phone' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Level' => ['description' => 'Level. ', 'type' => 'string', 'example' => '1级', 'title' => ''],
+ 'TemplateVersion' => ['description' => 'Outlet Template Version number. ', 'type' => 'string', 'example' => '1.1.0', 'title' => ''],
+ 'TimeZone' => ['description' => 'Time Zone. ', 'type' => 'string', 'example' => 'GMT+08:00', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"Users\\": [\\n {\\n \\"UserType\\": \\"USER_TYPE_COMPANY_OWNER\\",\\n \\"UserId\\": \\"1344***\\",\\n \\"Stores\\": \\"[s-dxsxxxxxx,s-dxsyyyyyyy]\\",\\n \\"UserName\\": \\"张三\\",\\n \\"Bid\\": \\"26842\\",\\n \\"OwnerId\\": \\"1212124434535\\",\\n \\"DingTalkInfos\\": [\\n {\\n \\"DingTalkCompanyId\\": \\"13124\\",\\n \\"DingTalkUserId\\": \\"3455566\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>100</TotalCount>\\n<PageSize>10</PageSize>\\n<RequestId>E69C8998-1787-4999-8C75-D663FF1173CF</RequestId>\\n<Message>success</Message>\\n<PageNumber>1</PageNumber>\\n<DynamicCode>PlatformResponseError.%s</DynamicCode>\\n<DynamicMessage>The specified store %s does not exist.</DynamicMessage>\\n<ErrorCode>MandatoryParameters</ErrorCode>\\n<Users>\\n <UserName>张三</UserName>\\n <OwnerId>1212124434535</OwnerId>\\n <UserId>1344***</UserId>\\n <Stores>[s-dxsxxxxxx,s-dxsyyyyyyy]</Stores>\\n <Bid>26842</Bid>\\n <UserType>USER_TYPE_COMPANY_OWNER</UserType>\\n <DingTalkInfos>\\n <DingTalkCompanyId>13124</DingTalkCompanyId>\\n <DingTalkUserId>3455566</DingTalkUserId>\\n </DingTalkInfos>\\n</Users>\\n<ErrorMessage>The specified resource type is invalid.</ErrorMessage>\\n<Code>-1001</Code>\\n<Success>true</Success>","errorExample":""}]',
- 'title' => 'DescribeUsers',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"Stores\\": [\\n {\\n \\"StoreName\\": \\"天猫旗舰店\\",\\n \\"StoreId\\": \\"s-nxwd8sutd6\\",\\n \\"ParentId\\": \\"rm-2zeb2rt850x880j1n\\",\\n \\"UserStoreCode\\": \\"s-2zeb2r1t12sq\\",\\n \\"GmtModified\\": \\"2020-03-06T02:58:16Z\\",\\n \\"Phone\\": \\"\\",\\n \\"Level\\": \\"1级\\",\\n \\"TemplateVersion\\": \\"1.1.0\\",\\n \\"TimeZone\\": \\"GMT+08:00\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'changeSet' => [],
+ 'title' => '',
],
- 'GetUser' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeStoreConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4564,31 +2184,19 @@
'BearerToken' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'UserId',
+ 'name' => 'StoreId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1344***',
- ],
+ 'schema' => ['description' => 'The store ID or the custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'A reserved field of the system. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
@@ -4596,120 +2204,63 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
- 'User' => [
- 'description' => '',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'StoreConfigInfo' => [
+ 'description' => 'The store configuration information.',
'type' => 'object',
'properties' => [
- 'UserType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'USER_TYPE_COMPANY_OWNER',
- ],
- 'UserId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1344***',
- ],
- 'Stores' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '[s-dxsxxxxxx,s-dxsyyyyyyy]',
- ],
- 'UserName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Bid' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '26842',
- ],
- 'OwnerId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '12143124132',
- ],
- 'DingTalkInfos' => [
- 'description' => '',
+ 'StoreId' => ['description' => 'The store ID.', 'type' => 'string', 'example' => 's-dxsxx****', 'title' => ''],
+ 'EnableNotification' => ['description' => 'Indicates whether DingTalk exception notification is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'NotificationWebHook' => ['description' => 'The webhook URL for DingTalk messages.', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?.', 'title' => ''],
+ 'NotificationSilentTimes' => ['description' => 'The cool-down periods configured by the user during which no notification messages are sent. The value is a JSON array. The unit is minutes. Each JSON object represents a cool-down period. The values are specified in minutes within a day in UTC time. The from field specifies the start minute of the cool-down period, and the to field specifies the end minute.', 'type' => 'string', 'example' => '[{"from":960,"to":1320},{"from":1170,"to":1230}]', 'title' => ''],
+ 'SubscribeContents' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'DingTalkCompanyId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '131242',
- ],
- 'DingTalkUserId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '34352525',
- ],
+ 'Category' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Enable' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'Threshold' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'AtAll' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'AtMobileList' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"User\\": {\\n \\"UserType\\": \\"USER_TYPE_COMPANY_OWNER\\",\\n \\"UserId\\": \\"1344***\\",\\n \\"Stores\\": \\"[s-dxsxxxxxx,s-dxsyyyyyyy]\\",\\n \\"UserName\\": \\"张三\\",\\n \\"Bid\\": \\"26842\\",\\n \\"OwnerId\\": \\"12143124132\\",\\n \\"DingTalkInfos\\": [\\n {\\n \\"DingTalkCompanyId\\": \\"131242\\",\\n \\"DingTalkUserId\\": \\"34352525\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => 'GetUser',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"StoreConfigInfo\\": {\\n \\"StoreId\\": \\"s-dxsxx****\\",\\n \\"EnableNotification\\": true,\\n \\"NotificationWebHook\\": \\"https://oapi.dingtalk.com/robot/send?.\\",\\n \\"NotificationSilentTimes\\": \\"[{\\\\\\"from\\\\\\":960,\\\\\\"to\\\\\\":1320},{\\\\\\"from\\\\\\":1170,\\\\\\"to\\\\\\":1230}]\\",\\n \\"SubscribeContents\\": [\\n {\\n \\"Category\\": \\"\\",\\n \\"Enable\\": false,\\n \\"Threshold\\": \\"\\",\\n \\"AtAll\\": false,\\n \\"AtMobileList\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'DescribeStoreConfig',
+ 'summary' => 'Queries the configuration information of a store.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
],
- 'AddApDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeStores' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4718,73 +2269,54 @@
'BearerToken' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'StoreId',
+ 'name' => 'UserStoreCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
- ],
+ 'schema' => ['description' => 'The custom store ID defined by the merchant.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''],
],
[
- 'name' => 'ApMac',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '11:22:33:44:55:66',
- ],
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'Remark',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'StoreName',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1*',
- ],
+ 'schema' => ['description' => 'The store name.', 'type' => 'string', 'required' => false, 'example' => '天猫超市', 'title' => ''],
+ ],
+ [
+ 'name' => 'ToDate',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The end time of the store creation time range.', 'type' => 'string', 'required' => false, 'example' => '2020-03-08T02:58:16Z', 'title' => ''],
+ ],
+ [
+ 'name' => 'StoreId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The store ID.', 'type' => 'string', 'required' => false, 'example' => 's-dxsxx****', 'title' => ''],
+ ],
+ [
+ 'name' => 'FromDate',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The start time of the store creation time range.', 'type' => 'string', 'required' => false, 'example' => '2020-03-06T02:58:16Z', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'A reserved field of the system. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
- 'name' => 'SerialNumber',
+ 'name' => 'TemplateVersion',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '18****',
- ],
+ 'schema' => ['description' => 'The version number of the template configured for the store.', 'type' => 'string', 'required' => false, 'example' => '1.1.0', 'title' => ''],
],
],
'responses' => [
@@ -4792,64 +2324,65 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The backend error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'Stores' => [
+ 'description' => 'The list of store information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'StoreId' => ['description' => 'The store ID.', 'type' => 'string', 'example' => 's-dxsxx**** ', 'title' => ''],
+ 'ParentId' => ['description' => 'The parent store ID.', 'type' => 'string', 'example' => 's-aasx****', 'title' => ''],
+ 'TimeZone' => ['description' => 'The time zone configured for the store.', 'type' => 'string', 'example' => 'GMT+08:00', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-03-06T02:58:16Z', 'title' => ''],
+ 'StoreName' => ['description' => 'The store name.', 'type' => 'string', 'example' => '天猫旗舰店', 'title' => ''],
+ 'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2020-03-06T02:58:16Z', 'title' => ''],
+ 'TemplateVersion' => ['description' => 'The version number of the store template.', 'type' => 'string', 'example' => '1.1.0', 'title' => ''],
+ 'Level' => ['description' => 'The level.', 'type' => 'string', 'example' => '1级', 'title' => ''],
+ 'Phone' => ['description' => 'The supervision phone number of the local administration for industry and commerce where the store is located.', 'type' => 'string', 'example' => '0571-5666888', 'title' => ''],
+ 'UserStoreCode' => ['description' => 'The custom store ID defined by the merchant.', 'type' => 'string', 'example' => '20200201', 'title' => ''],
+ 'BarCodeEncode' => ['description' => 'The barcode encoding method. Valid values:'."\n"
+ .'- 0: Code128.'."\n"
+ .'- 1: EAN13.'."\n"
+ ."\n"
+ .'Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1', 'minimum' => '0', 'example' => '0', 'default' => '0', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","errorExample":""},{"type":"xml","example":"<code>200</code>\\n<data>\\n <RequestId>8F124625-DF0A-4B08-B205-2CF538FAF713</RequestId>\\n <Success>true</Success>\\n</data>\\n<requestId>8F124625-DF0A-4B08-B205-2CF538FAF713</requestId>\\n<successResponse>true</successResponse>","errorExample":""}]',
- 'title' => 'AddApDevice',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"Stores\\": [\\n {\\n \\"StoreId\\": \\"s-dxsxx**** \\",\\n \\"ParentId\\": \\"s-aasx****\\",\\n \\"TimeZone\\": \\"GMT+08:00\\",\\n \\"GmtCreate\\": \\"2020-03-06T02:58:16Z\\",\\n \\"StoreName\\": \\"天猫旗舰店\\",\\n \\"GmtModified\\": \\"2020-03-06T02:58:16Z\\",\\n \\"TemplateVersion\\": \\"1.1.0\\",\\n \\"Level\\": \\"1级\\",\\n \\"Phone\\": \\"0571-5666888\\",\\n \\"UserStoreCode\\": \\"20200201\\",\\n \\"BarCodeEncode\\": 0\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query stores',
+ 'summary' => 'Queries the basic information about stores.',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
],
- 'DeleteApDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeTemplateByModel' => [
+ 'summary' => 'Template query.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4858,41 +2391,34 @@
'BearerToken' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ApMac',
+ 'name' => 'EslSize',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '11:22:33:44:55:66',
- ],
+ 'schema' => ['description' => 'ESL size', 'type' => 'string', 'required' => false, 'example' => '200X200', 'title' => ''],
],
[
- 'name' => 'StoreId',
+ 'name' => 'DeviceType',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
- ],
+ 'schema' => ['description' => 'Device type ', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''],
],
[
- 'name' => 'ExtraParams',
+ 'name' => 'TemplateVersion',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Outlet template version number;', 'type' => 'string', 'required' => false, 'example' => '1.1.0', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Pagination Parameters: current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'Pagination Parameters: number of entries displayed per page. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
@@ -4900,65 +2426,61 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B9E230F7-8BC6-5E4B-B540-14142DD94E3B', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'Error message returned when the invocation failed. ', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the current Product was inserted successfully. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'Error code. The value is described as follows: If the request succeeded, the ErrorCode field is not returned. If the request failed, the ErrorCode field is returned. For more information, see the error code list in this topic. ', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'Backend error code. ', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => 'null', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'Dynamic message. ', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'Dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'TotalCount' => ['description' => 'Total number of templates.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'PageSize' => ['description' => 'Pagination parameter: number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'Pagination parameter: current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Items' => [
+ 'description' => 'List of product information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'BasePicture' => ['description' => 'Image.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'TemplateId' => ['description' => 'Template ID ', 'type' => 'string', 'example' => '772629024140898304', 'title' => ''],
+ 'TemplateName' => ['description' => 'Template Name.', 'type' => 'string', 'example' => '常规', 'title' => ''],
+ 'EslSize' => ['description' => 'ESL size.', 'type' => 'string', 'example' => '250X122', 'title' => ''],
+ 'EslType' => ['description' => 'Price tag type. The return values correspond as follows: - [unk]esl_type_e_ink[unk]: electron ink screen - [unk]px_type_dm_lcd[unk]: segment screen - [unk]x-ddl_type_full_color[unk]: color screen. ', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'Width' => ['description' => 'Width. Unit: px. ', 'type' => 'integer', 'format' => 'int64', 'example' => '400', 'title' => ''],
+ 'Height' => ['description' => 'Video height.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
+ 'TemplateVersion' => ['description' => 'Outlet template version number.', 'type' => 'string', 'example' => '15.15.15', 'title' => ''],
+ 'Layout' => ['description' => 'Layout information.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'Scene' => ['description' => 'Scenario. Select an appropriate scenario. ', 'type' => 'string', 'example' => 'MEMBER', 'title' => ''],
+ 'Brand' => ['description' => 'Brand.', 'type' => 'string', 'example' => 'ZTE', 'title' => ''],
+ 'TemplateSceneId' => ['description' => 'Displays the matching Custom Template ID. ', 'type' => 'string', 'example' => '大甩卖', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","errorExample":""},{"type":"xml","example":"<code>200</code>\\n<data>\\n <RequestId>8F124625-DF0A-4B08-B205-2CF538FAF713</RequestId>\\n <Success>true</Success>\\n</data>\\n<requestId>8F124625-DF0A-4B08-B205-2CF538FAF713</requestId>\\n<successResponse>true</successResponse>","errorExample":""}]',
- 'title' => 'DeleteApDevice',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ActivateApDevice' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B9E230F7-8BC6-5E4B-B540-14142DD94E3B\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"null\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"BasePicture\\": \\"\\",\\n \\"TemplateId\\": \\"772629024140898304\\",\\n \\"TemplateName\\": \\"常规\\",\\n \\"EslSize\\": \\"250X122\\",\\n \\"EslType\\": \\"\\",\\n \\"Width\\": 400,\\n \\"Height\\": 200,\\n \\"TemplateVersion\\": \\"15.15.15\\",\\n \\"Layout\\": \\"1\\",\\n \\"Scene\\": \\"MEMBER\\",\\n \\"Brand\\": \\"ZTE\\",\\n \\"TemplateSceneId\\": \\"大甩卖\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T06:18:37.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => 'Response parameters changed'],
],
+ 'title' => '',
+ ],
+ 'DescribeUserLog' => [
+ 'summary' => 'Queries the operation log records of a user.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4967,201 +2489,106 @@
'BearerToken' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'ApMac',
+ 'name' => 'ItemShortTitle',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '11:22:33:44:55:66',
- ],
+ 'schema' => ['description' => 'The short title of the item.', 'type' => 'string', 'required' => false, 'example' => '牛奶', 'title' => ''],
],
[
- 'name' => 'StoreId',
+ 'name' => 'OperationType',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
- ],
+ 'schema' => ['description' => 'The log type. Valid values:'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_BIND`: ESL binding.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_UNBIND`: ESL unbinding.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_FORCE_UPDATE`: ESL refresh - manual refresh.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_ITEM_CHANGE_UPDATE`: ESL refresh - item update.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_ALL_UPDATE`: ESL refresh - store-level refresh.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_SEND_FAILED_RETRY`: Operation retry - send failed.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_DISPLAY_FAILED_RETRY`: Operation retry - display failed.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_LIGHT_UP_ESL_LED`: ESL LED light-up.', 'type' => 'string', 'required' => false, 'example' => 'OPERATION_TYPE_BIND', 'title' => ''],
],
[
- 'name' => 'ExtraParams',
+ 'name' => 'EslBarCode',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The barcode of the ESL.', 'type' => 'string', 'required' => false, 'example' => '18bc5a63****', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","errorExample":""},{"type":"xml","example":"<ActivateApDeviceResponse>\\n <RequestId>E69C8998-1787-4999-8C75-D663FF1173CF</RequestId>\\n <ErrorMessage>The specified resource type is invalid.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>MandatoryParameters</ErrorCode>\\n <Code>-1001</Code>\\n <Message>success</Message>\\n <DynamicMessage>The specified store %s does not exist.</DynamicMessage>\\n <DynamicCode>PlatformResponseError.%s</DynamicCode>\\n</ActivateApDeviceResponse>","errorExample":""}]',
- 'title' => 'ActivateApDevice',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeApDevices' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'FromDate',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The start time for querying operation logs. The time follows the ISO 8601 standard in UTC+0. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2020-03-18T02:26:28Z', 'title' => ''],
],
[
- 'BearerToken' => [],
+ 'name' => 'ItemBarCode',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The barcode of the item.', 'type' => 'string', 'required' => false, 'example' => '690560583****', 'title' => ''],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
'name' => 'StoreId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 's-dxsxx****',
- ],
+ 'schema' => ['description' => 'The store ID or custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
- 'name' => 'ApMac',
+ 'name' => 'ToDate',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '112233445566',
- ],
+ 'schema' => ['description' => 'The end time for querying operation logs. The time follows the ISO 8601 standard in UTC+0. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2020-03-17T02:26:28Z', 'title' => ''],
],
[
- 'name' => 'Status',
+ 'name' => 'LogId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The log ID.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'OperationStatus',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The log status. Valid values:'."\n"
+ ."\n"
+ .'- `OPERATION_STATUS_NEW`: new.'."\n"
+ ."\n"
+ .'- `OPERATION_STATUS_SENT`: sent.'."\n"
+ ."\n"
+ .'- `OPERATION_STATUS_DISPLAY`: displayed.'."\n"
+ ."\n"
+ .'- `OPERATION_STATUS_DELETE`: deleted.'."\n"
+ ."\n"
+ .'- `OPERATION_STATUS_BREAK`: interrupted.'."\n"
+ ."\n"
+ .'- `OPERATION_STATUS_DEVICE_RETRY_DISPLAY`: retrying.'."\n"
+ ."\n"
+ .'- `OPERATION_STATUS_SEND_FAILED`: send failed.'."\n"
+ ."\n"
+ .'- `OPERATION_STATUS_DISPLAY_FAILED`: display failed.', 'type' => 'string', 'required' => false, 'example' => 'OPERATION_STATUS_NEW', 'title' => ''],
],
[
- 'name' => 'Model',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aliyun',
- ],
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'BeActivate',
+ 'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '134****', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'A reserved field of the system. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
@@ -5169,123 +2596,110 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
- 'ApDevices' => [
- 'description' => '',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The backend error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'UserLogs' => [
+ 'description' => 'The list of log entries.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'StoreId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 's-cxsds****',
- ],
- 'Model' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'aliyun',
- ],
- 'Remark' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'BeActivate' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Mac' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '112233445566',
- ],
+ 'EslBarCode' => ['description' => 'The barcode of the ESL.', 'type' => 'string', 'example' => '18bc5a63****', 'title' => ''],
+ 'OperationSendTime' => ['description' => 'The time when the operation was sent.', 'type' => 'string', 'example' => '2020-03-17T02:25:17Z', 'title' => ''],
+ 'ActionPrice' => ['description' => 'The actual selling price, in cents.', 'type' => 'string', 'example' => '500', 'title' => ''],
+ 'UserId' => ['description' => 'The UID of the RAM user.', 'type' => 'string', 'example' => '134****', 'title' => ''],
+ 'PriceUnit' => ['description' => 'The pricing unit.', 'type' => 'string', 'example' => '台', 'title' => ''],
+ 'ResultCode' => ['description' => 'The execution result code.', 'type' => 'string', 'example' => '2002', 'title' => ''],
+ 'ItemId' => ['description' => 'The custom item barcode.', 'type' => 'string', 'example' => '123456', 'title' => ''],
+ 'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2020-03-17T02:26:17Z', 'title' => ''],
+ 'OperationType' => ['description' => 'The log type. Valid values:'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_BIND`: ESL binding.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_UNBIND`: ESL unbinding.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_FORCE_UPDATE`: ESL refresh - manual refresh.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_ITEM_CHANGE_UPDATE`: ESL refresh - item update.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_ALL_UPDATE`: ESL refresh - store-level refresh.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_SEND_FAILED_RETRY`: Operation retry - send failed.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_DISPLAY_FAILED_RETRY`: Operation retry - display failed.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_TIMEOUT_RETRY`: Operation retry - operation timeout.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_ESL_NOT_FOUND_RETRY`: Operation retry - unknown device.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_TEMPLATE_NOT_FOUND_RETRY`: Operation retry - unknown template.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_DRAW_PICTURE_FAILED_RETRY`: Operation retry - abnormal template.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_BATCH_TIMES_DIRECTIONAL_REFRESH`: ESL refresh - item import.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_ON_LINE_RETRY`: ESL refresh - online retry.'."\n"
+ ."\n"
+ .'- `OPERATION_TYPE_LIGHT_UP_ESL_LED`: LED light-up.', 'type' => 'string', 'example' => 'OPERATION_TYPE_BIND', 'title' => ''],
+ 'OperationResponseTime' => ['description' => 'The operation response time.', 'type' => 'string', 'example' => '2020-03-17T02:26:17Z', 'title' => ''],
+ 'OperationStatus' => ['description' => 'The log status. Valid values:'."\n"
+ ."\n"
+ .'- `OPERATION_STATUS_NEW`: new operation.'."\n"
+ ."\n"
+ .'- `OPERATION_STATUS_SENT`: send operation.'."\n"
+ ."\n"
+ .'- `OPERATION_STATUS_DISPLAY`: completed operation.'."\n"
+ ."\n"
+ .'- `OPERATION_STATUS_DELETE`: delete operation.'."\n"
+ ."\n"
+ .'- `OPERATION_STATUS_DEVICE_RETRY_DISPLAY`: retry operation.'."\n"
+ ."\n"
+ .'- `OPERATION_STATUS_SEND_FAILED`: send failed.'."\n"
+ ."\n"
+ .'- `OPERATION_STATUS_DISPLAY_FAILED`: refresh failed.', 'type' => 'string', 'example' => 'OPERATION_STATUS_NEW', 'title' => ''],
+ 'StoreId' => ['description' => 'The store ID.', 'type' => 'string', 'example' => 's-dxsxxx****', 'title' => ''],
+ 'ItemShortTitle' => ['description' => 'The short title of the item.', 'type' => 'string', 'example' => '牛奶', 'title' => ''],
+ 'LogId' => ['description' => 'The log ID.', 'type' => 'string', 'example' => '123456', 'title' => ''],
+ 'BePromotion' => ['description' => 'Indicates whether the item is on promotion.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-03-17T02:26:17Z', 'title' => ''],
+ 'EslSignal' => ['description' => 'The signal strength of the ESL.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
+ 'SpendTime' => ['description' => 'The time consumed, in milliseconds.', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'ItemBarCode' => ['description' => 'The barcode of the item.', 'type' => 'string', 'example' => '690560583****', 'title' => ''],
+ 'I18nResultKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"ApDevices\\": [\\n {\\n \\"Status\\": false,\\n \\"StoreId\\": \\"s-cxsds****\\",\\n \\"Model\\": \\"aliyun\\",\\n \\"Remark\\": \\"测试数据\\",\\n \\"BeActivate\\": true,\\n \\"Mac\\": \\"112233445566\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<code>200</code>\\n<data>\\n <TotalCount>2</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>E210B842-6AD3-4420-833A-4ED8756DBFD0</RequestId>\\n <PageNumber>1</PageNumber>\\n <ApDevices>\\n <Status>true</Status>\\n <BeActivate>true</BeActivate>\\n <StoreId>s-xsaa****</StoreId>\\n <Mac>112233445566</Mac>\\n </ApDevices>\\n <ApDevices>\\n <Status>true</Status>\\n <BeActivate>true</BeActivate>\\n <StoreId>s-xsaa****</StoreId>\\n <Mac>141FBA86****</Mac>\\n </ApDevices>\\n <Success>true</Success>\\n</data>\\n<requestId>E210B842-6AD3-4420-833A-4ED8756DBFD0</requestId>\\n<successResponse>true</successResponse>","errorExample":""}]',
- 'title' => 'DescribeApDevices',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"UserLogs\\": [\\n {\\n \\"EslBarCode\\": \\"18bc5a63****\\",\\n \\"OperationSendTime\\": \\"2020-03-17T02:25:17Z\\",\\n \\"ActionPrice\\": \\"500\\",\\n \\"UserId\\": \\"134****\\",\\n \\"PriceUnit\\": \\"台\\",\\n \\"ResultCode\\": \\"2002\\",\\n \\"ItemId\\": \\"123456\\",\\n \\"GmtModified\\": \\"2020-03-17T02:26:17Z\\",\\n \\"OperationType\\": \\"OPERATION_TYPE_BIND\\",\\n \\"OperationResponseTime\\": \\"2020-03-17T02:26:17Z\\",\\n \\"OperationStatus\\": \\"OPERATION_STATUS_NEW\\",\\n \\"StoreId\\": \\"s-dxsxxx****\\",\\n \\"ItemShortTitle\\": \\"牛奶\\",\\n \\"LogId\\": \\"123456\\",\\n \\"BePromotion\\": false,\\n \\"GmtCreate\\": \\"2020-03-17T02:26:17Z\\",\\n \\"EslSignal\\": 50,\\n \\"SpendTime\\": \\"10\\",\\n \\"ItemBarCode\\": \\"690560583****\\",\\n \\"I18nResultKey\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query operation logs',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
],
- 'ApplyCompanyTemplateVersionToStores' => [
- 'summary' => '版本应用到门店',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DescribeUsers' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5294,237 +2708,137 @@
'BearerToken' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'TemplateVersion',
+ 'name' => 'UserType',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1.1.0',
- ],
+ 'schema' => ['description' => 'The user type. Valid values:'."\n"
+ ."\n"
+ .'- `USER_TYPE_COMPANY_OWNER`: company owner account'."\n"
+ ."\n"
+ .'- `USER_TYPE_COMPANY_ROOT`: senior company administrator'."\n"
+ ."\n"
+ .'- `USER_TYPE_COMPANY_ADMIN`: company administrator'."\n"
+ ."\n"
+ .'- `USER_TYPE_STORE_ADMIN`: store administrator'."\n"
+ ."\n"
+ .'- `USER_TYPE_STORE_OPERATOR`: store operator'."\n"
+ ."\n"
+ .'- `USER_TYPE_GUEST`: guest without any permissions.', 'type' => 'string', 'required' => false, 'example' => 'USER_TYPE_COMPANY_OWNER', 'title' => ''],
],
[
- 'name' => 'Stores',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[\\"s-y9eoecc7mu\\"]',
- ],
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '450E6CA4-5C5D-5DED-86C2-2B577C291764',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
- ],
- ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The UID of the RAM user.', 'type' => 'string', 'required' => false, 'example' => '1344***', 'title' => ''],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"450E6CA4-5C5D-5DED-86C2-2B577C291764\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
- ],
- 'DescribeStoreByTemplateVersion' => [
- 'summary' => '查询模板应用到的门店',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'UserName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The username.', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''],
],
[
- 'BearerToken' => [],
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
[
- 'name' => 'TemplateVersion',
+ 'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.1.0',
- ],
+ 'schema' => ['description' => 'A reserved field of the system. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
- 'Stores' => [
- 'description' => '',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'Users' => [
+ 'description' => 'The list of user information.',
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'StoreName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'StoreId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 's-nxwd8sutd6',
- ],
- 'ParentId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'rm-2zeb2rt850x880j1n',
- ],
- 'UserStoreCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 's-2zeb2r1t12sq',
- ],
- 'GmtModified' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-03-06T02:58:16Z',
- ],
- 'Phone' => [
- 'type' => 'string',
- ],
- 'Level' => [
- 'description' => '',
- 'type' => 'string',
+ 'UserType' => ['description' => 'The user type. Valid values:'."\n"
+ ."\n"
+ .'- `USER_TYPE_COMPANY_OWNER`: company owner account'."\n"
+ ."\n"
+ .'- `USER_TYPE_COMPANY_ROOT`: senior company administrator'."\n"
+ ."\n"
+ .'- `USER_TYPE_COMPANY_ADMIN`: company administrator'."\n"
+ ."\n"
+ .'- `USER_TYPE_STORE_ADMIN`: store administrator'."\n"
+ ."\n"
+ .'- `USER_TYPE_STORE_OPERATOR`: store operator'."\n"
+ ."\n"
+ .'- `USER_TYPE_GUEST`: guest without any permissions.', 'type' => 'string', 'example' => 'USER_TYPE_COMPANY_OWNER', 'title' => ''],
+ 'UserId' => ['description' => 'The UID of the RAM user.', 'type' => 'string', 'example' => '1344***', 'title' => ''],
+ 'Stores' => ['description' => 'The list of store IDs.', 'type' => 'string', 'example' => '[s-dxsxxxxxx,s-dxsyyyyyyy]', 'title' => ''],
+ 'UserName' => ['description' => 'The username.', 'type' => 'string', 'example' => '张三', 'title' => ''],
+ 'Bid' => ['description' => 'The account type. 26842: Alibaba Cloud.', 'type' => 'string', 'example' => '26842', 'title' => ''],
+ 'OwnerId' => ['description' => 'The Alibaba Cloud account.', 'type' => 'string', 'example' => '1212124434535', 'title' => ''],
+ 'DingTalkInfos' => [
+ 'description' => 'The DingTalk account information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DingTalkCompanyId' => ['description' => 'The DingTalk company ID.', 'type' => 'string', 'example' => '13124', 'title' => ''],
+ 'DingTalkUserId' => ['description' => 'The DingTalk user ID.', 'type' => 'string', 'example' => '3455566', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
'example' => '',
],
- 'TemplateVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.1.0',
- ],
- 'TimeZone' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'GMT+08:00',
- ],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"Stores\\": [\\n {\\n \\"StoreName\\": \\"天猫旗舰店\\",\\n \\"StoreId\\": \\"s-nxwd8sutd6\\",\\n \\"ParentId\\": \\"rm-2zeb2rt850x880j1n\\",\\n \\"UserStoreCode\\": \\"s-2zeb2r1t12sq\\",\\n \\"GmtModified\\": \\"2020-03-06T02:58:16Z\\",\\n \\"Phone\\": \\"\\",\\n \\"Level\\": \\"1级\\",\\n \\"TemplateVersion\\": \\"1.1.0\\",\\n \\"TimeZone\\": \\"GMT+08:00\\"\\n }\\n ]\\n}","type":"json"}]',
- ],
- 'DescribeCompanyTemplateVersions' => [
- 'summary' => '版本列表',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"Users\\": [\\n {\\n \\"UserType\\": \\"USER_TYPE_COMPANY_OWNER\\",\\n \\"UserId\\": \\"1344***\\",\\n \\"Stores\\": \\"[s-dxsxxxxxx,s-dxsyyyyyyy]\\",\\n \\"UserName\\": \\"张三\\",\\n \\"Bid\\": \\"26842\\",\\n \\"OwnerId\\": \\"1212124434535\\",\\n \\"DingTalkInfos\\": [\\n {\\n \\"DingTalkCompanyId\\": \\"13124\\",\\n \\"DingTalkUserId\\": \\"3455566\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query users',
+ 'summary' => 'Queries user information.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T06:18:37.000Z', 'description' => 'Error codes changed'],
],
+ ],
+ 'GetUser' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5533,145 +2847,91 @@
'BearerToken' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'PageNumber',
+ 'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- 1 => '1',
- ],
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The UID of the Alibaba Cloud RAM user.', 'type' => 'string', 'required' => false, 'example' => '1344***', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- 10 => '10',
- ],
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'A system reserved field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [
- 18 => '18',
- ],
- 'example' => '16',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => '6248311A-3296-5084-B057-D0EC3DCE5C47',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'enumValueTitles' => [
- 'True' => 'True',
- ],
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Versions' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Version' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic error message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'User' => [
+ 'description' => 'The user information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'UserType' => ['description' => 'The user type. Valid values:'."\n"
+ ."\n"
+ .'USER_TYPE_COMPANY_OWNER: the primary account of the merchant.'."\n"
+ .'USER_TYPE_COMPANY_ROOT: a senior merchant administrator.'."\n"
+ .'USER_TYPE_COMPANY_ADMIN: a merchant administrator.'."\n"
+ .'USER_TYPE_STORE_ADMIN: a store administrator.'."\n"
+ .'USER_TYPE_STORE_OPERATOR: a store operator.'."\n"
+ .'USER_TYPE_GUEST: a guest without any permissions.', 'type' => 'string', 'example' => 'USER_TYPE_COMPANY_OWNER', 'title' => ''],
+ 'UserId' => ['description' => 'The UID of the Alibaba Cloud RAM user.', 'type' => 'string', 'example' => '1344***', 'title' => ''],
+ 'Stores' => ['description' => 'The list of store IDs.', 'type' => 'string', 'example' => '[s-dxsxxxxxx,s-dxsyyyyyyy]', 'title' => ''],
+ 'UserName' => ['description' => 'The username.', 'type' => 'string', 'example' => '张三', 'title' => ''],
+ 'Bid' => ['description' => 'The account type.'."\n"
+ ."\n"
+ .'26842: Alibaba Cloud.', 'type' => 'string', 'example' => '26842', 'title' => ''],
+ 'OwnerId' => ['description' => 'The UID of the Alibaba Cloud primary account.', 'type' => 'string', 'example' => '12143124132', 'title' => ''],
+ 'DingTalkInfos' => [
+ 'description' => 'The DingTalk account information.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DingTalkCompanyId' => ['description' => 'The DingTalk merchant ID.', 'type' => 'string', 'example' => '131242', 'title' => ''],
+ 'DingTalkUserId' => ['description' => 'The DingTalk user ID.', 'type' => 'string', 'example' => '34352525', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '1.1.0',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 16,\\n \\"RequestId\\": \\"6248311A-3296-5084-B057-D0EC3DCE5C47\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Versions\\": [\\n {\\n \\"Version\\": \\"1.1.0\\"\\n }\\n ]\\n}","type":"json"}]',
- ],
- 'DescribeEslModelByTemplateVersion' => [
- 'summary' => '按版本查询设备类型',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"User\\": {\\n \\"UserType\\": \\"USER_TYPE_COMPANY_OWNER\\",\\n \\"UserId\\": \\"1344***\\",\\n \\"Stores\\": \\"[s-dxsxxxxxx,s-dxsyyyyyyy]\\",\\n \\"UserName\\": \\"张三\\",\\n \\"Bid\\": \\"26842\\",\\n \\"OwnerId\\": \\"12143124132\\",\\n \\"DingTalkInfos\\": [\\n {\\n \\"DingTalkCompanyId\\": \\"131242\\",\\n \\"DingTalkUserId\\": \\"34352525\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Query a Single User',
+ 'summary' => 'Queries the information about a single user.',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T06:18:36.000Z', 'description' => 'Error codes changed'],
],
+ ],
+ 'QueryTemplateListByGroupId' => [
+ 'summary' => 'Query templates by group ID ',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5682,182 +2942,86 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'TemplateVersion',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- '1.1.0' => '1.1.0',
- ],
- 'example' => '1.1.0',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'GroupId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '7',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '38F85526-14B8-54A8-A0BB-3B200BBC3682',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'EslModels' => [
- 'description' => '',
+ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'ErrorCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DynamicMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'DynamicCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'TotalCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'PageNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
+ 'TemplateList' => [
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'ModelId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9946366490094af4ab16bfe023ad5f22',
- ],
- 'Name' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Image' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '/9xwqexcdaxasada....',
- ],
- 'DeviceType' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3',
- ],
- 'Vendor' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ali',
- ],
- 'ScreenWidth' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ScreenHeight' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'EslSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '800X480',
- ],
- 'EslPhysicalSize' => [
- 'description' => '',
- 'type' => 'string',
- ],
+ 'BasePicture' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'TemplateId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'TemplateName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'EslSize' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'EslType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Width' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'Height' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'TemplateVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Layout' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Scene' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Brand' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'GroupId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'TemplateSceneId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Relation' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 7,\\n \\"RequestId\\": \\"38F85526-14B8-54A8-A0BB-3B200BBC3682\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"EslModels\\": [\\n {\\n \\"ModelId\\": \\"9946366490094af4ab16bfe023ad5f22\\",\\n \\"Name\\": \\"test\\",\\n \\"Image\\": \\"/9xwqexcdaxasada....\\",\\n \\"DeviceType\\": \\"3\\",\\n \\"Vendor\\": \\"ali\\",\\n \\"ScreenWidth\\": 0,\\n \\"ScreenHeight\\": 0,\\n \\"EslSize\\": \\"800X480\\",\\n \\"EslPhysicalSize\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
- ],
- 'DescribeTemplateByModel' => [
- 'summary' => '模板查询',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T06:18:35.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2022-07-18T13:15:18.000Z', 'description' => 'OpenAPI offline'],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"Success\\": false,\\n \\"ErrorCode\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"DynamicMessage\\": \\"\\",\\n \\"DynamicCode\\": \\"\\",\\n \\"TotalCount\\": 0,\\n \\"PageSize\\": 0,\\n \\"PageNumber\\": 0,\\n \\"TemplateList\\": [\\n {\\n \\"BasePicture\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"TemplateName\\": \\"\\",\\n \\"EslSize\\": \\"\\",\\n \\"EslType\\": \\"\\",\\n \\"Width\\": 0,\\n \\"Height\\": 0,\\n \\"TemplateVersion\\": \\"\\",\\n \\"Layout\\": \\"\\",\\n \\"Scene\\": \\"\\",\\n \\"Brand\\": \\"\\",\\n \\"GroupId\\": \\"\\",\\n \\"TemplateSceneId\\": \\"\\",\\n \\"Relation\\": false\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '',
+ ],
+ 'SyncAddMaterial' => [
+ 'summary' => 'Asynchronously add media material ',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5866,212 +3030,61 @@
'BearerToken' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'EslSize',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '200X200',
- ],
- ],
- [
- 'name' => 'DeviceType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2',
- ],
- ],
- [
- 'name' => 'TemplateVersion',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.1.0',
- ],
- ],
- [
- 'name' => 'PageNumber',
+ 'name' => 'Name',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'Material Name', 'type' => 'string', 'required' => true, 'example' => 'xx图片', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'Content',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'Material Link', 'type' => 'string', 'required' => true, 'example' => 'https://iotx-alg-picture-auto.oss-cn-shanghai.aliyuncs.com/0622/zxytest/12.jpg', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'SyncAddEslMaterialResponse',
+ 'description' => 'SyncAddEslMaterialResponse',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'B9E230F7-8BC6-5E4B-B540-14142DD94E3B',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Items' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'BasePicture' => [
- 'description' => '',
- 'type' => 'string',
- ],
- 'TemplateId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '772629024140898304',
- ],
- 'TemplateName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'EslSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '250X122',
- ],
- 'EslType' => [
- 'description' => '',
- 'type' => 'string',
- ],
- 'Width' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '400',
- ],
- 'Height' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'TemplateVersion' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '15.15.15',
- ],
- 'Layout' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Scene' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MEMBER',
- ],
- 'Brand' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ZTE',
- ],
- 'TemplateSceneId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- ],
- ],
- ],
+ 'Result' => [
+ 'description' => 'Return Result ',
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => ['title' => '', 'description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '', 'description' => 'Basic information ', 'type' => 'string', 'example' => 'success'],
+ 'DynamicMessage' => ['title' => '', 'description' => 'POP dynamic supplementary information ', 'type' => 'string', 'example' => 'The specified store %s does not exist.'],
+ 'DynamicCode' => ['title' => '', 'description' => 'POP dynamic supplementary information ', 'type' => 'string', 'example' => ''],
+ 'ErrorCode' => ['title' => '', 'description' => 'Error Type. See the ErrorCodes enumeration.', 'type' => 'string', 'example' => 'MandatoryParameters'],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RequestId' => ['description' => 'Request ID '."\n", 'type' => 'string', 'example' => '450E6CA4-5C5D-5DED-86C2-2B577C291764'."\n", 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the operation succeeded. '."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Message' => ['description' => 'The error message returned when the invocation fails. '."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'ErrorCode' => ['description' => 'Error code ', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message returned when the invocation fails. '."\n", 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Code' => ['description' => 'HTTP status code. ', 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'DynamicCode' => ['description' => 'Dynamic code ', 'type' => 'string', 'example' => 'PlatformResponseError.%s'."\n", 'title' => ''],
+ 'DynamicMessage' => ['description' => 'Dynamic error message used to replace the %s placeholder in the ErrMessage parameter returned in the response. '."\n", 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B9E230F7-8BC6-5E4B-B540-14142DD94E3B\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"null\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Items\\": [\\n {\\n \\"BasePicture\\": \\"\\",\\n \\"TemplateId\\": \\"772629024140898304\\",\\n \\"TemplateName\\": \\"常规\\",\\n \\"EslSize\\": \\"250X122\\",\\n \\"EslType\\": \\"\\",\\n \\"Width\\": 400,\\n \\"Height\\": 200,\\n \\"TemplateVersion\\": \\"15.15.15\\",\\n \\"Layout\\": \\"1\\",\\n \\"Scene\\": \\"MEMBER\\",\\n \\"Brand\\": \\"ZTE\\",\\n \\"TemplateSceneId\\": \\"大甩卖\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"\\",\\n \\"ErrorCode\\": \\"MandatoryParameters\\"\\n },\\n \\"RequestId\\": \\"450E6CA4-5C5D-5DED-86C2-2B577C291764\\\\n\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Code\\": \\"200\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\\\n\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\"\\n}","type":"json"}]',
+ 'changeSet' => [],
+ 'title' => '',
],
- 'DescribeAvailableEslModels' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UnassignUser' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6080,197 +3093,54 @@
'BearerToken' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'ModelId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '设备模型id',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6cd23870539e43759e65eef5b6808a49',
- ],
- ],
- [
- 'name' => 'Name',
+ 'name' => 'UserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '模型名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aa_ssaaa',
- ],
+ 'schema' => ['description' => 'The UID of the RAM user.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1344***', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'title' => '分页号',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '分页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'A reserved parameter. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'DescribeAvailableEslModelsResponse',
- 'description' => 'DescribeAvailableEslModelsResponse',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '436',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'EslModels' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'ModelId' => [
- 'title' => '模型id',
- 'description' => '',
- 'type' => 'string',
- 'example' => '201167',
- ],
- 'Name' => [
- 'title' => '名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'DeviceType' => [
- 'title' => '设备颜色类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => '3',
- ],
- 'Vendor' => [
- 'title' => '厂商',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ali',
- ],
- 'ScreenWidth' => [
- 'title' => '屏幕宽度',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ScreenHeight' => [
- 'title' => '屏幕高度',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'EslSize' => [
- 'title' => '屏幕尺寸',
- 'description' => '',
- 'type' => 'string',
- 'example' => '800X480',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 436,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"EslModels\\": [\\n {\\n \\"ModelId\\": \\"201167\\",\\n \\"Name\\": \\"中文名测试\\",\\n \\"DeviceType\\": \\"3\\",\\n \\"Vendor\\": \\"ali\\",\\n \\"ScreenWidth\\": 0,\\n \\"ScreenHeight\\": 0,\\n \\"EslSize\\": \\"800X480\\"\\n }\\n ],\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Code\\": \\"-1001\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\"\\n}","type":"json"}]',
- ],
- 'DeleteCompanyTemplate' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'title' => 'UnassignUser',
+ 'summary' => 'Revokes permissions from a user.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T06:18:34.000Z', 'description' => 'Error codes changed'],
],
+ ],
+ 'UnbindEslDevice' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6281,30 +3151,47 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'TemplateId',
+ 'name' => 'EslBarCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '742842379343605760',
- ],
+ 'schema' => ['description' => 'The ESL bar code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '18bc5a63****', 'title' => ''],
+ ],
+ [
+ 'name' => 'ItemBarCode',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The item bar code.', 'type' => 'string', 'required' => false, 'example' => '690560583****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Column',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The logical column in the display system.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'StoreId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The store ID or custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
+ ],
+ [
+ 'name' => 'Shelf',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The shelf number in the display system.', 'type' => 'string', 'required' => false, 'example' => '20200201', 'title' => ''],
+ ],
+ [
+ 'name' => 'Layer',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The layer number in the display system.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'The extended parameters.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
+ ],
+ [
+ 'name' => 'ContainerName',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
@@ -6312,62 +3199,35 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'A7571D49-9B36-5782-AD3D-32C8436D45B7',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '-1001',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7571D49-9B36-5782-AD3D-32C8436D45B7\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
- ],
- 'AddCompanyTemplate' => [
- 'summary' => '模板新增',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'title' => 'Unbind an ESL device',
+ 'summary' => 'Unbinds an electronic shelf label (ESL) device.',
+ 'description' => 'This operation supports two modes: display mode and standard mode. In display mode, the ESL is unbound by using the display shelf position and ESL bar code. In standard mode, the ESL is unbound by using the item bar code and ESL bar code.',
+ 'requestParamsDescription' => 'In standard mode, StoreId and EslBarCode are required. In display mode, StoreId, EslBarCode, Shelf, Layer, and Column are required. The EslBarCode specified in the request must exist at the current shelf position. If ItemBarCode is specified, it must match the information stored for the display shelf position.',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => 'Request parameters changed, Error codes changed'],
],
+ ],
+ 'UpdateEslDeviceLight' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6378,179 +3238,170 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'Scene',
+ 'name' => 'LedColor',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'NORMAL',
- ],
+ 'schema' => ['description' => 'The LED color. Valid values:'."\n"
+ ."\n"
+ .'- `GREEN`: green'."\n"
+ ."\n"
+ .'- `RED`: red'."\n"
+ ."\n"
+ .'- `BLUE`: blue'."\n"
+ ."\n"
+ .'- `OFF`: off.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GREEN', 'title' => ''],
],
[
- 'name' => 'ExtraParams',
+ 'name' => 'Frequency',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'The LED blinking frequency. Valid values:'."\n"
+ ."\n"
+ .'- `ALWAYS`: always on'."\n"
+ ."\n"
+ .'- `HEIGHT`: high frequency'."\n"
+ ."\n"
+ .'- `MIDDLE`: medium frequency'."\n"
+ ."\n"
+ .'- `NORMAL`: normal frequency.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NORMAL', 'title' => ''],
],
[
- 'name' => 'EslSize',
+ 'name' => 'StoreId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '800X480',
- ],
+ 'schema' => ['description' => 'The store ID or merchant-defined custom store ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
- 'name' => 'TemplateName',
+ 'name' => 'ItemBarCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '',
- 'maxLength' => 128,
- 'minLength' => 0,
- ],
+ 'schema' => ['description' => 'The item bar code.', 'type' => 'string', 'required' => false, 'example' => '6905605836648', 'title' => ''],
],
[
- 'name' => 'Layout',
+ 'name' => 'LightUpTime',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '2',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The duration for which the LED stays on. Unit: seconds. The value must be greater than 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '30', 'title' => ''],
],
[
- 'name' => 'TemplateVersion',
+ 'name' => 'EslBarCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1.1.0',
- ],
+ 'schema' => ['description' => 'The ESL bar code.', 'type' => 'string', 'required' => false, 'example' => '18bc5a631ak9', 'title' => ''],
],
[
- 'name' => 'DeviceType',
+ 'name' => 'ExtraParams',
'in' => 'formData',
+ 'schema' => ['description' => 'The extended parameters.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'FailCount' => ['description' => 'The number of failures.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'SuccessCount' => ['description' => 'The number of successes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
+ 'LightFailEslInfos' => [
+ 'description' => 'The list of ESLs that failed to light up.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EslBarCode' => ['description' => 'The ESL bar code.', 'type' => 'string', 'example' => '18bc5a63****', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified ESL device does not exist.', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '3',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"FailCount\\": 0,\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"SuccessCount\\": 1,\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\",\\n \\"LightFailEslInfos\\": [\\n {\\n \\"EslBarCode\\": \\"18bc5a63****\\",\\n \\"ErrorMessage\\": \\"The specified ESL device does not exist.\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Control the LED light of an ESL',
+ 'summary' => 'Controls the LED light of an electronic shelf label (ESL) to change its frequency and color.',
+ 'requestParamsDescription' => ' Specify either ItemBarCode or EslBarCode. If both are specified, EslBarCode takes priority.'."\n"
+ .'If only EslBarCode is specified, a single ESL is lit up.'."\n"
+ .'If only ItemBarCode is specified, all ESLs bound to the item bar code are lit up.',
+ 'responseParamsDescription' => ' When EslBarCode is used to light up an ESL, the response indicates success or failure.'."\n"
+ .'When ItemBarCode is used to light up ESLs, the response returns the number of successes and failures, along with information about the ESLs that failed.',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-04-26T06:18:34.000Z', 'description' => 'Error codes changed'],
+ ],
+ ],
+ 'UpdateStore' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'TemplateType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'normal',
- ],
+ 'AK' => [],
],
[
- 'name' => 'IfPromotion',
+ 'BearerToken' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'StoreId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The store ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****', 'title' => ''],
],
[
- 'name' => 'IfSourceCode',
+ 'name' => 'UserStoreCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The custom store ID defined by the merchant.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''],
],
[
- 'name' => 'IfDefault',
+ 'name' => 'StoreName',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The store name.', 'type' => 'string', 'required' => false, 'example' => '天猫超市', 'title' => ''],
],
[
- 'name' => 'IfMember',
+ 'name' => 'Phone',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The supervision phone number of the local administration for industry and commerce where the store is located.', 'type' => 'string', 'required' => false, 'example' => '0571-5666888', 'title' => ''],
],
[
- 'name' => 'IfOutOfInventory',
+ 'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- ],
+ 'schema' => ['description' => 'A system reserved field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
- 'name' => 'Vendor',
+ 'name' => 'TemplateVersion',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ali',
- ],
+ 'schema' => ['description' => 'The store template version.', 'type' => 'string', 'required' => false, 'example' => '1.1.0', 'title' => ''],
],
[
- 'name' => 'GroupId',
+ 'name' => 'Timezone',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '9',
- ],
+ 'schema' => ['description' => 'The time zone.', 'type' => 'string', 'required' => false, 'example' => 'GMT+08:00', 'title' => ''],
],
[
- 'name' => 'TemplateSceneId',
+ 'name' => 'BarCodeEncode',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The barcode encoding method. Valid values:'."\n"
+ ."\n"
+ .'- 0: Code128.'."\n"
+ .'- 1: EAN13.'."\n"
+ ."\n"
+ .'Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1', 'minimum' => '0', 'example' => '0', 'default' => '0', 'required' => false, 'title' => ''],
],
],
'responses' => [
@@ -6558,74 +3409,32 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C033DCCE-FA85-5AD8-9A7C-C3F41220B898',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'InvalidResourceType.NotSupported',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'The request status identifier.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The backend error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 418 => [
- [
- 'errorCode' => 'DuplicateTemplateSceneIdErrorPub',
- 'errorMessage' => 'The TemplateSceneId is duplicated.',
- ],
- [
- 'errorCode' => 'ContainerLayoutBindEslDevicePub',
- 'errorMessage' => 'The Layout of the Container has been bound to an ESL device.',
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C033DCCE-FA85-5AD8-9A7C-C3F41220B898\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"InvalidResourceType.NotSupported\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E69C8998-1787-4999-8C75-D663FF1173CF\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'title' => 'Modify store information',
+ 'summary' => 'Modifies the basic information of a store.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
],
- 'SyncAddMaterial' => [
- 'summary' => '异步添加媒体素材',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateStoreConfig' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6636,166 +3445,37 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'Name',
+ 'name' => 'NotificationSilentTimes',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'The silent periods configured by the user during which notification messages are not sent. The value is a JSON list in minutes. Each JSON object represents a silent period time range, where the values are the minute offsets within a day in UTC time. The "from" field specifies the start minute of the silent period, and the "to" field specifies the end minute.', 'type' => 'string', 'required' => false, 'example' => '[{"from":960,"to":1320},{"from":1170,"to":1230}]', 'title' => ''],
],
[
- 'name' => 'Content',
+ 'name' => 'EnableNotification',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'https://iotx-alg-picture-auto.oss-cn-shanghai.aliyuncs.com/0622/zxytest/12.jpg',
- ],
+ 'schema' => ['description' => 'Specifies whether to enable DingTalk exception message notifications. Set to true to enable or false to disable.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'SyncAddEslMaterialResponse',
- 'description' => 'SyncAddEslMaterialResponse',
- 'type' => 'object',
- 'properties' => [
- 'Result' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Success' => [
- 'title' => '是否成功',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '基本信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DynamicMessage' => [
- 'title' => 'POP动态补充信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- 'DynamicCode' => [
- 'title' => 'POP动态补充信息',
- 'description' => '',
- 'type' => 'string',
- ],
- 'ErrorCode' => [
- 'title' => '错误类型 参考 ErrorCodes枚举',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '450E6CA4-5C5D-5DED-86C2-2B577C291764'."\n",
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MandatoryParameters',
- ],
- 'ErrorMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified resource type is invalid.',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'DynamicCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PlatformResponseError.%s'."\n",
- ],
- 'DynamicMessage' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The specified store %s does not exist.',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"\\",\\n \\"ErrorCode\\": \\"MandatoryParameters\\"\\n },\\n \\"RequestId\\": \\"450E6CA4-5C5D-5DED-86C2-2B577C291764\\\\n\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Code\\": \\"200\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\\\n\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\"\\n}","type":"json"}]',
- ],
- 'QueryTemplateListByGroupId' => [
- 'summary' => '根据分组id查询模板',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'StoreId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The store ID or a custom store ID defined by the merchant.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-sds1233****', 'title' => ''],
],
[
- 'BearerToken' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'PageNumber',
+ 'name' => 'NotificationWebHook',
'in' => 'formData',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'schema' => ['description' => 'The webhook URL for DingTalk messages.', 'type' => 'string', 'required' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?.', 'title' => ''],
],
[
- 'name' => 'GroupId',
+ 'name' => 'ExtraParams',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['description' => 'The system extension field. Ignore this parameter.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'SubscribeContents',
'in' => 'formData',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'schema' => ['description' => 'The subscription content.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
@@ -6803,316 +3483,318 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
- 'ErrorCode' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'DynamicMessage' => [
- 'type' => 'string',
- ],
- 'DynamicCode' => [
- 'type' => 'string',
- ],
- 'TotalCount' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'PageSize' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'PageNumber' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'TemplateList' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'BasePicture' => [
- 'type' => 'string',
- ],
- 'TemplateId' => [
- 'type' => 'string',
- ],
- 'TemplateName' => [
- 'type' => 'string',
- ],
- 'EslSize' => [
- 'type' => 'string',
- ],
- 'EslType' => [
- 'type' => 'string',
- ],
- 'Width' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'Height' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'TemplateVersion' => [
- 'type' => 'string',
- ],
- 'Layout' => [
- 'type' => 'string',
- ],
- 'Scene' => [
- 'type' => 'string',
- ],
- 'Brand' => [
- 'type' => 'string',
- ],
- 'GroupId' => [
- 'type' => 'string',
- ],
- 'TemplateSceneId' => [
- 'type' => 'string',
- ],
- 'Relation' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '97B41B7F-A6EC-524C-9B8F-1BDD7E733F5E', 'title' => ''],
+ 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified resource type is invalid.', 'title' => ''],
+ 'Success' => ['description' => 'The request status indicator.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'MandatoryParameters', 'title' => ''],
+ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => '-1001', 'title' => ''],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DynamicMessage' => ['description' => 'The dynamic message.', 'type' => 'string', 'example' => 'The specified store %s does not exist.', 'title' => ''],
+ 'DynamicCode' => ['description' => 'The dynamic error code.', 'type' => 'string', 'example' => 'PlatformResponseError.%s', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"97B41B7F-A6EC-524C-9B8F-1BDD7E733F5E\\",\\n \\"ErrorMessage\\": \\"The specified resource type is invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"MandatoryParameters\\",\\n \\"Code\\": \\"-1001\\",\\n \\"Message\\": \\"success\\",\\n \\"DynamicMessage\\": \\"The specified store %s does not exist.\\",\\n \\"DynamicCode\\": \\"PlatformResponseError.%s\\"\\n}","type":"json"}]',
+ 'title' => 'Modify Store Configuration',
+ 'summary' => 'Modifies the configuration information of a store.',
+ 'changeSet' => [],
],
],
'endpoints' => [
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => 'cloudesl-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => 'cloudesl-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cloudesl.cn-hangzhou.aliyuncs.com', 'endpoint' => 'cloudesl.cn-hangzhou.aliyuncs.com', 'vpc' => 'cloudesl-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'ActionPermissionError', 'message' => 'You are not authorized to perform the action %s.', 'http_code' => 401, 'description' => 'You are not authorized to perform the action %s.'],
+ ['code' => 'ActionPermissionErrorPub', 'message' => 'You are not authorized to perform the action %s.', 'http_code' => 411, 'description' => 'You are not authorized to perform the action %s.'],
+ ['code' => 'AlarmError', 'message' => 'An error occurred while processing the specified alert.', 'http_code' => 510, 'description' => 'An error occurred while processing the specified alert.'],
+ ['code' => 'ApDeviceActivateErrorPub', 'message' => 'Failed to activate the AP device.', 'http_code' => 418, 'description' => 'Failed to activate the AP device.'],
+ ['code' => 'ApDeviceActivateErrorPub', 'message' => 'Failed to active the AP device.', 'http_code' => 418, 'description' => 'Failed to activate the AP device.'],
+ ['code' => 'ApDeviceAlreadyExistPub', 'message' => 'The specified AP device already exists.', 'http_code' => 418, 'description' => 'The specified AP device already exists.'],
+ ['code' => 'ApDeviceInStorePub', 'message' => 'The store contains an AP device.', 'http_code' => 418, 'description' => 'The store contains an AP device.'],
+ ['code' => 'ApDeviceOtherStorePub', 'message' => 'The specified AP device is being used by another store.', 'http_code' => 418, 'description' => 'The specified AP device is being used by another store.'],
+ ['code' => 'ApDeviceRegisterErrorPub', 'message' => 'Failed to register the AP device.', 'http_code' => 418, 'description' => 'Failed to register the AP device.'],
+ ['code' => 'ApNumberLimitPub', 'message' => 'The number of AP devices under the store exceeds the limit.', 'http_code' => 418, 'description' => 'The number of AP devices under the store exceeds the limit.'],
+ ['code' => 'BetaTestLabelError', 'message' => 'You are not authorized to use the public beta version.', 'http_code' => 405, 'description' => 'You are not authorized to use the public beta version.'],
+ ['code' => 'BetaTestLabelErrorPub', 'message' => 'You are not authorized to use the public preview version.', 'http_code' => 418, 'description' => 'You are not authorized to use the public beta version.'],
+ ['code' => 'BeyondBatchLimit', 'message' => 'The maximum number of items that you can insert is exceeded.', 'http_code' => 405, 'description' => 'The maximum number of items that you can insert is exceeded.'],
+ ['code' => 'BeyondBatchLimitPub', 'message' => 'The maximum number of items that you can insert is exceeded.', 'http_code' => 418, 'description' => 'The maximum number of items that you can insert is exceeded.'],
+ ['code' => 'CompanyAlreadyExist', 'message' => 'The specified company already exists.', 'http_code' => 405, 'description' => 'The specified company already exists.'],
+ ['code' => 'CompanyAlreadyExistPub', 'message' => 'The specified company already exists.', 'http_code' => 418, 'description' => 'The specified company already exists.'],
+ ['code' => 'CompanyDataNotMigratePub', 'message' => 'The specified company data is not migrated.', 'http_code' => 418, 'description' => 'The specified company data is not migrated.'],
+ ['code' => 'CompanyError', 'message' => 'An error occurred while processing your request related to companies.', 'http_code' => 506, 'description' => 'An error occurred while processing your request related to companies.'],
+ ['code' => 'CompanyOwnerError', 'message' => 'Failed to configure the specified company.', 'http_code' => 405, 'description' => 'Failed to configure the specified company.'],
+ ['code' => 'CompanyOwnerErrorPub', 'message' => 'Failed to configure the specified company.', 'http_code' => 418, 'description' => 'Failed to configure the specified company.'],
+ ['code' => 'CompanyTemplatePermissionErrorPub', 'message' => 'You are not authorized to operate on the specified company template %s.', 'http_code' => 411, 'description' => 'You do not have permissions to perform operations on the enterprise template.'],
+ ['code' => 'ContainerLayoutBindEslDevicePub', 'message' => 'The Layout of the Container has been bound to an ESL device.', 'http_code' => 418, 'description' => ''],
+ ['code' => 'ContainerTemplateNoMatchPub', 'message' => 'The Template of the Container has not match at all.', 'http_code' => 418, 'description' => 'The Template of the Container has not match at all.'],
+ ['code' => 'CreateCompanyError', 'message' => 'Failed to create a company.', 'http_code' => 405, 'description' => 'Failed to create a company.'],
+ ['code' => 'CreateCompanyErrorPub', 'message' => 'Failed to create a company.', 'http_code' => 418, 'description' => 'Failed to create a company.'],
+ ['code' => 'DeviceError', 'message' => 'An error occurred while processing your request related to devices.', 'http_code' => 508, 'description' => 'An error occurred while processing your request related to devices.'],
+ ['code' => 'DingTalkAlreadyExistPub', 'message' => 'The specified DingTalk information already exists.', 'http_code' => 418, 'description' => 'The specified DingTalk information already exists.'],
+ ['code' => 'DuplicateContainerNameErrorPub', 'message' => 'The ContainerName is duplicated.', 'http_code' => 418, 'description' => ''],
+ ['code' => 'DuplicateTemplateGroupNameErrorPub', 'message' => 'The TemplateGroupName is duplicated.', 'http_code' => 418, 'description' => ''],
+ ['code' => 'DuplicateTemplateSceneIdErrorPub', 'message' => 'The TemplateSceneId is duplicated.', 'http_code' => 418, 'description' => ''],
+ ['code' => 'ErrorParameter', 'message' => 'The parameter %s is invalid.', 'http_code' => 403, 'description' => 'The parameter %s is invalid.'],
+ ['code' => 'ErrorParameterPub', 'message' => 'The parameter %s is invalid.', 'http_code' => 413, 'description' => 'The parameter %s is invalid.'],
+ ['code' => 'EslDeviceInPlanogramPositionPub', 'message' => 'The ESL device is used in planogram position.', 'http_code' => 418, 'description' => 'The ESL device is used in planogram position.'],
+ ['code' => 'EslDeviceInStore', 'message' => 'The store contains an ESL device.', 'http_code' => 405, 'description' => 'The store contains an ESL device.'],
+ ['code' => 'EslDeviceInStorePub', 'message' => 'The store contains an ESL device.', 'http_code' => 418, 'description' => 'The store contains an ESL device.'],
+ ['code' => 'EslDeviceNotMatchEslPositionPub', 'message' => 'The specified ESL device does not match the ESL position.', 'http_code' => 418, 'description' => 'The specified ESL device does not match the ESL position.'],
+ ['code' => 'EslDeviceOtherStore', 'message' => 'The specified ESL device is being used by another store', 'http_code' => 405, 'description' => 'The specified ESL device is being used by another store.'],
+ ['code' => 'EslDeviceOtherStorePub', 'message' => 'The specified ESL device is being used by another store', 'http_code' => 418, 'description' => 'The specified ESL device is being used by another store.'],
+ ['code' => 'FailInsertItemPub', 'message' => 'Failed to insert the same item.', 'http_code' => 412, 'description' => 'Failed to insert the same item.'],
+ ['code' => 'InternalError', 'message' => 'An error occurred while processing API operations of Cloud ESL.', 'http_code' => 500, 'description' => 'An error occurred while processing API operations of Cloud ESL.'],
+ ['code' => 'InvalidActionPermissionPub', 'message' => 'The specified action permission is invalid.', 'http_code' => 412, 'description' => 'The specified action permission is invalid.'],
+ ['code' => 'InvalidCompanyTemplatePub', 'message' => 'The company template is invalid.', 'http_code' => 412, 'description' => 'The enterprise template is invalid.'],
+ ['code' => 'InvalidCompanyTemplateScenePub', 'message' => 'The specified company template scenario is invalid.', 'http_code' => 412, 'description' => 'The use scenario of the enterprise template is invalid.'],
+ ['code' => 'InvalidDeviceMac', 'message' => 'The specified device MAC address is invalid.', 'http_code' => 400, 'description' => 'The specified device MAC address is invalid.'],
+ ['code' => 'InvalidDeviceMacPub', 'message' => 'The specified device MAC address is invalid.', 'http_code' => 412, 'description' => 'The specified device MAC address is invalid.'],
+ ['code' => 'InvalidEslBarCode', 'message' => 'The specified ESL bar code is invalid.', 'http_code' => 400, 'description' => 'The specified ESL bar code is invalid.'],
+ ['code' => 'InvalidEslBarCodePub', 'message' => 'The specified ESL bar code is invalid.', 'http_code' => 412, 'description' => 'The specified ESL bar code is invalid.'],
+ ['code' => 'InvalidFileSize', 'message' => 'The specified size of the material is invalid.', 'http_code' => 412, 'description' => 'The specified size of the material is invalid.'],
+ ['code' => 'InvalidHttpSignaturePub', 'message' => 'The HTTP signature is invalid.', 'http_code' => 412, 'description' => 'The HTTP signature is invalid.'],
+ ['code' => 'InvalidItemBarCode', 'message' => 'The specified item bar code is invalid.', 'http_code' => 400, 'description' => 'The specified item bar code is invalid.'],
+ ['code' => 'InvalidItemBarCodePub', 'message' => 'The specified item bar code is invalid.', 'http_code' => 412, 'description' => 'The specified item bar code is invalid.'],
+ ['code' => 'InvalidMaterialId', 'message' => 'The material id is invalid.', 'http_code' => 418, 'description' => ''],
+ ['code' => 'InvalidPageNumber', 'message' => 'The specified starting page number is invalid.', 'http_code' => 400, 'description' => 'The specified starting page number is invalid.'],
+ ['code' => 'InvalidPageNumberPub', 'message' => 'The specified starting page number is invalid.', 'http_code' => 412, 'description' => 'The specified starting page number is invalid.'],
+ ['code' => 'InvalidPageSize', 'message' => 'The specified number of entries to return on each page is invalid.', 'http_code' => 400, 'description' => 'The specified number of entries to return on each page is invalid.'],
+ ['code' => 'InvalidPageSizePub', 'message' => 'The specified number of entries to return on each page is invalid.', 'http_code' => 412, 'description' => 'The specified number of entries to return on each page is invalid.'],
+ ['code' => 'InvalidParameter.DataViolated', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'],
+ ['code' => 'InvalidParameter.ValidationFailure', 'message' => 'An error occurred while validating parameters.', 'http_code' => 400, 'description' => 'An error occurred while validating parameters.'],
+ ['code' => 'InvalidPlatformType', 'message' => 'The specified system type is invalid.', 'http_code' => 400, 'description' => 'The specified system type is invalid.'],
+ ['code' => 'InvalidPlatformTypePub', 'message' => 'The specified system type is invalid.', 'http_code' => 412, 'description' => 'The specified system type is invalid.'],
+ ['code' => 'InvalidResourceType', 'message' => 'The specified resource type is invalid.', 'http_code' => 400, 'description' => 'The specified resource type is invalid.'],
+ ['code' => 'InvalidResourceTypePub', 'message' => 'The specified resource type is invalid.', 'http_code' => 412, 'description' => 'The specified resource type is invalid.'],
+ ['code' => 'InvalidShelfTypePub', 'message' => 'The specified shelf type is invalid.', 'http_code' => 412, 'description' => 'The specified shelf type is invalid.'],
+ ['code' => 'InvalidUserType', 'message' => 'The specified user type is invalid.', 'http_code' => 400, 'description' => 'The specified user type is invalid.'],
+ ['code' => 'InvalidUserTypePub', 'message' => 'The specified user type is invalid.', 'http_code' => 412, 'description' => 'The specified user type is invalid.'],
+ ['code' => 'ItemAlreadyExistPub', 'message' => 'The item already exists.', 'http_code' => 412, 'description' => 'The item already exists.'],
+ ['code' => 'ItemBindEslDevice', 'message' => 'The item has been bound to an ESL device.', 'http_code' => 405, 'description' => 'The item has been bound to an ESL device.'],
+ ['code' => 'ItemBindEslDevicePub', 'message' => 'The item has been bound to an ESL device.', 'http_code' => 418, 'description' => 'The item has been bound to an ESL device.'],
+ ['code' => 'ItemError', 'message' => 'An error occurred while processing your request related to items.', 'http_code' => 509, 'description' => 'An error occurred while processing your request related to items.'],
+ ['code' => 'ItemInStore', 'message' => 'The store contains an item.', 'http_code' => 405, 'description' => 'The store contains an item.'],
+ ['code' => 'ItemInStorePub', 'message' => 'The store contains an item.', 'http_code' => 418, 'description' => 'The store contains an item.'],
+ ['code' => 'ItemNotMatch', 'message' => 'The specified item does not match the item that has been bound to the specified ESL device.', 'http_code' => 405, 'description' => 'The specified item does not match the item that has been bound to the specified ESL device.'],
+ ['code' => 'ItemNotMatchPlanogramPositionPub', 'message' => 'The specified item does not match the planogram position.', 'http_code' => 418, 'description' => 'The specified item does not match the planogram position.'],
+ ['code' => 'ItemNotMatchPub', 'message' => 'The specified item does not match the item that has been bound to the specified ESL device.', 'http_code' => 418, 'description' => 'The specified item does not match the item that has been bound to the specified ESL device.'],
+ ['code' => 'ItemNumberLimitPub', 'message' => 'The number of products under the store exceeds the limit.', 'http_code' => 418, 'description' => 'The number of products under the store exceeds the limit.'],
+ ['code' => 'ItemNumLimit', 'message' => 'The maximum number of items is %s.', 'http_code' => 410, 'description' => 'The maximum number of items is %s.'],
+ ['code' => 'LayerBindOtherRailPub', 'message' => 'The layer has been bound to another rail.', 'http_code' => 418, 'description' => 'The layer has been bound to another rail.'],
+ ['code' => 'LayoutBindEslDevicePub', 'message' => 'The Layout has been bound to an ESL device.', 'http_code' => 418, 'description' => ''],
+ ['code' => 'LayoutNameContainerNameErrorPub', 'message' => 'The LayoutName is duplicated.', 'http_code' => 418, 'description' => ''],
+ ['code' => 'LayoutOrContainerIsNotExistErrorPub', 'message' => 'Layout or Container is not exist.', 'http_code' => 418, 'description' => ''],
+ ['code' => 'LockError', 'message' => 'An error occurred while processing your request.', 'http_code' => 405, 'description' => 'A server error occurred while processing your request.'],
+ ['code' => 'LockErrorPub', 'message' => 'An error occurred while processing your request.', 'http_code' => 418, 'description' => 'An internal system error occurred.'],
+ ['code' => 'MandatoryParameter', 'message' => 'Missing parameter %s.', 'http_code' => 403, 'description' => 'Missing parameter %s.'],
+ ['code' => 'MandatoryParameterPub', 'message' => 'Missing parameter %s.', 'http_code' => 413, 'description' => 'Missing parameter %s.'],
+ ['code' => 'MaterialContainIllegalContent', 'message' => 'The material contains illegal content.', 'http_code' => 416, 'description' => 'The material contains illegal content.'],
+ ['code' => 'MaterialHasBindToItem', 'message' => 'The material has been bound to the items.', 'http_code' => 418, 'description' => 'The material has been bound to the items.'],
+ ['code' => 'MaterialInfoParserError', 'message' => 'Type of material is invalid.', 'http_code' => 418, 'description' => 'The type of material is invalid.'],
+ ['code' => 'MissingParameter', 'message' => 'You must specify the parameters.', 'http_code' => 400, 'description' => 'You must specify the parameters.'],
+ ['code' => 'MoreThanOneStore', 'message' => 'The specified store operator can only manage one store.', 'http_code' => 405, 'description' => 'The specified store operator can only manage one store.'],
+ ['code' => 'MoreThanOneStorePub', 'message' => 'The specified store operator can only manage one store.', 'http_code' => 418, 'description' => 'The specified store operator can only manage one store.'],
+ ['code' => 'NotAcquireLockPub', 'message' => 'The lock is not acquired.', 'http_code' => 417, 'description' => 'An error occurred while obtaining'],
+ ['code' => 'NotAllowDifferentDeviceTypePub', 'message' => 'The specified Not allow Different device type to copy template.', 'http_code' => 418, 'description' => 'You are not allowed to copy a template across device types.'],
+ ['code' => 'NotBindEslDevice', 'message' => 'The specified ESL device has not been bound.', 'http_code' => 405, 'description' => 'The specified ESL device has not been bound.'],
+ ['code' => 'NotBindEslDevicePub', 'message' => 'The specified ESL device has not been bound.', 'http_code' => 418, 'description' => 'The specified ESL device has not been bound.'],
+ ['code' => 'NotFindAlarm', 'message' => 'The specified alert does not exist.', 'http_code' => 404, 'description' => 'The specified alert item does not exist.'],
+ ['code' => 'NotFindAlarmPub', 'message' => 'The specified alert does not exist.', 'http_code' => 417, 'description' => 'The specified alert item does not exist.'],
+ ['code' => 'NotFindApDevicePub', 'message' => 'The specified AP device does not exist.', 'http_code' => 417, 'description' => 'The specified AP device does not exist.'],
+ ['code' => 'NotFindCompany', 'message' => 'The specified company does not exist.', 'http_code' => 404, 'description' => 'The specified company does not exist.'],
+ ['code' => 'NotFindCompanyAccount', 'message' => 'The Alibaba Cloud account of the specified company does not exist.', 'http_code' => 404, 'description' => 'The Alibaba Cloud account of the specified company does not exist.'],
+ ['code' => 'NotFindCompanyAccountPub', 'message' => 'The Alibaba Cloud account of the specified company does not exist.', 'http_code' => 417, 'description' => 'The Alibaba Cloud account of the specified company does not exist.'],
+ ['code' => 'NotFindCompanyConfigPub', 'message' => 'The specified company configuration does not exist.', 'http_code' => 417, 'description' => 'The merchant configuration information does not exist.'],
+ ['code' => 'NotFindCompanyConfigStatusPub', 'message' => 'The specified company configuration status does not exist.', 'http_code' => 417, 'description' => 'The specified company configuration status does not exist.'],
+ ['code' => 'NotFindCompanyIdByConfigPub', 'message' => 'The company ID cannot be found based on the company configuration information.', 'http_code' => 417, 'description' => 'The company ID cannot be found based on the company configuration information.'],
+ ['code' => 'NotFindCompanyPub', 'message' => 'The specified company does not exist.', 'http_code' => 417, 'description' => 'The specified company does not exist.'],
+ ['code' => 'NotFindCompanySessionTokenPub', 'message' => 'The specified session token does not exist.', 'http_code' => 417, 'description' => 'No access token is configured for the merchant.'],
+ ['code' => 'NotFindCompanyTemplatePub', 'message' => 'The specified company template does not exist.', 'http_code' => 417, 'description' => 'The enterprise template does not exist.'],
+ ['code' => 'NotFindEslDevice', 'message' => 'The specified ESL device does not exist.', 'http_code' => 404, 'description' => 'The specified ESL device does not exist.'],
+ ['code' => 'NotFindEslDevicePub', 'message' => 'The specified ESL device does not exist.', 'http_code' => 417, 'description' => 'The specified ESL device does not exist.'],
+ ['code' => 'NotFindEslPositionPub', 'message' => 'The specified ESL position does not exist.', 'http_code' => 417, 'description' => 'The specified ESL position does not exist.'],
+ ['code' => 'NotFindItem', 'message' => 'The specified item does not exist.', 'http_code' => 404, 'description' => 'The specified item does not exist.'],
+ ['code' => 'NotFindItemPub', 'message' => 'The specified item does not exist.', 'http_code' => 417, 'description' => 'The specified item does not exist.'],
+ ['code' => 'NotFindOperatorAccount', 'message' => 'The specified RAM user of the operator does not exist.', 'http_code' => 404, 'description' => 'The specified RAM user of the operator does not exist.'],
+ ['code' => 'NotFindOperatorAccountPub', 'message' => 'The specified RAM user of the operator does not exist.', 'http_code' => 417, 'description' => 'The specified RAM user of the operator does not exist.'],
+ ['code' => 'NotFindOperatorUser', 'message' => 'The specified ESL user of the operator does not exist.', 'http_code' => 404, 'description' => 'The specified ESL user of the operator does not exist.'],
+ ['code' => 'NotFindOperatorUserPub', 'message' => 'The specified ESL user of the operator does not exist.', 'http_code' => 417, 'description' => 'The specified ESL user of the operator does not exist.'],
+ ['code' => 'NotFindPlanogramPositionPub', 'message' => 'The specified planogram position does not exist.', 'http_code' => 417, 'description' => 'The specified planogram position does not exist.'],
+ ['code' => 'NotFindPlanogramShelfPub', 'message' => 'The specified planogram shelf does not exist.', 'http_code' => 417, 'description' => 'The specified planogram shelf does not exist.'],
+ ['code' => 'NotFindRailMappingPub', 'message' => 'The specified rail mapping does not exist.', 'http_code' => 417, 'description' => 'The specified rail mapping does not exist.'],
+ ['code' => 'NotFindRamUser', 'message' => 'The specified RAM user does not exist.', 'http_code' => 404, 'description' => 'The specified RAM user does not exist.'],
+ ['code' => 'NotFindRamUserPub', 'message' => 'The specified RAM user does not exist.', 'http_code' => 417, 'description' => 'The specified RAM user does not exist.'],
+ ['code' => 'NotFindResource', 'message' => 'The specified resource %s does not exist.', 'http_code' => 404, 'description' => 'The specified resource %s does not exist.'],
+ ['code' => 'NotFindResourcePub', 'message' => 'The specified resource %s does not exist.', 'http_code' => 417, 'description' => 'The specified resource %s does not exist.'],
+ ['code' => 'NotFindRoleByRoleCodePub', 'message' => 'The specified role code does not exist.', 'http_code' => 417, 'description' => 'The specified role code does not exist.'],
+ ['code' => 'NotFindStore', 'message' => 'The specified store %s does not exist.', 'http_code' => 404, 'description' => 'The specified store %s does not exist.'],
+ ['code' => 'NotFindStorePub', 'message' => 'The specified store %s does not exist.', 'http_code' => 417, 'description' => 'The specified store %s does not exist.'],
+ ['code' => 'NotFindTaoCustomItem', 'message' => 'Failed to get the information about the Taobao item using user-defined information.', 'http_code' => 404, 'description' => 'Failed to get the information about the Taobao item using user-defined information.'],
+ ['code' => 'NotFindTaoItem', 'message' => 'Failed to get the item information from Taobao.', 'http_code' => 404, 'description' => 'Failed to get the item information from Taobao.'],
+ ['code' => 'NotFindTaoItemByOuterId', 'message' => 'Failed to get the Taobao item using outer ID.', 'http_code' => 404, 'description' => 'Failed to get the Taobao item using outer ID.'],
+ ['code' => 'NotFindTaoItemPrice', 'message' => 'Failed to get the price of the Taobao item.', 'http_code' => 404, 'description' => 'Failed to get the price of the Taobao item.'],
+ ['code' => 'NotFindTaoItemPromotion', 'message' => 'Failed to get the Taobao item promotion information.', 'http_code' => 404, 'description' => 'Failed to get the Taobao item promotion information.'],
+ ['code' => 'NotFindTaoItemSku', 'message' => 'Failed to get the Taobao SKU ID.', 'http_code' => 404, 'description' => 'Failed to get the Taobao SKU ID.'],
+ ['code' => 'NotFindTaoItemSkuPrice', 'message' => 'Failed to get the price of the Taobao item SKU.', 'http_code' => 404, 'description' => 'Failed to get the price of the Taobao item SKU.'],
+ ['code' => 'NotFindTaoPromotion', 'message' => 'Failed to get the Taobao promotion.', 'http_code' => 404, 'description' => 'Failed to get the Taobao promotion.'],
+ ['code' => 'NotFindTaoSkuPromotion', 'message' => 'Failed to get the Taobao item SKU promotion information.', 'http_code' => 404, 'description' => 'Failed to get the Taobao item SKU promotion information.'],
+ ['code' => 'NotFindTaoToken', 'message' => 'Failed to get the access token.', 'http_code' => 404, 'description' => 'Failed to get the access token from Taobao.'],
+ ['code' => 'NotFindUser', 'message' => 'The specified ESL user does not exist.', 'http_code' => 404, 'description' => 'The specified ESL user does not exist.'],
+ ['code' => 'NotFindUserAccount', 'message' => 'The specified RAM user does not exist.', 'http_code' => 404, 'description' => 'The specified RAM user does not exist.'],
+ ['code' => 'NotFindUserAccountPub', 'message' => 'The specified RAM user does not exist.', 'http_code' => 417, 'description' => 'The specified RAM user does not exist.'],
+ ['code' => 'NotFindUserPub', 'message' => 'The specified ESL user does not exist.', 'http_code' => 417, 'description' => 'The specified ESL user does not exist.'],
+ ['code' => 'NotFoundTheMaterial', 'message' => 'Failed to found the material in the brand.', 'http_code' => 418, 'description' => 'Failed to found the material in the brand.'],
+ ['code' => 'OAuthException', 'message' => 'An error occurred while processing your request.', 'http_code' => 405, 'description' => 'A server error occurred while processing your request.'],
+ ['code' => 'OAuthExceptionPub', 'message' => 'An error occurred while processing your request.', 'http_code' => 418, 'description' => 'An internal system error occurred.'],
+ ['code' => 'OperationFail.CompanyNotFound', 'message' => 'The specified company does not exist.', 'http_code' => 400, 'description' => 'The specified company does not exist.'],
+ ['code' => 'OperationFail.DuplicatedBind', 'message' => 'The specified ESL device has already been bound.', 'http_code' => 403, 'description' => 'The specified ESL device has already been bound.'],
+ ['code' => 'OperationFail.EslDeviceNotBound', 'message' => 'The specified ESL device has not been bound.', 'http_code' => 403, 'description' => 'The specified ESL device has not been bound.'],
+ ['code' => 'OperationFail.EslDeviceNotFound', 'message' => 'The specified ESL device does not exist.', 'http_code' => 403, 'description' => 'The specified ESL device does not exist.'],
+ ['code' => 'OperationFail.ItemNotFound', 'message' => 'The specified item does not exist.', 'http_code' => 403, 'description' => 'The specified item does not exist.'],
+ ['code' => 'OperationFail.StoreNotFound', 'message' => 'The specified store does not exist.', 'http_code' => 403, 'description' => 'The specified store does not exist.'],
+ ['code' => 'PermissionError', 'message' => 'You are not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => 'You are not authorized to operate on the specified resource.'],
+ ['code' => 'PlanogramPositionAlreadyExistPub', 'message' => 'The specified planogram position already exists.', 'http_code' => 418, 'description' => 'The lock is not acquired.'],
+ ['code' => 'PlanogramShelfAlreadyExistPub', 'message' => 'The specified planogram shelf already exists.', 'http_code' => 418, 'description' => 'The specified planogram shelf already exists.'],
+ ['code' => 'PlatformError', 'message' => 'An error occurred while processing your API request on the platform.', 'http_code' => 500, 'description' => 'An error occurred while processing your API request on the platform.'],
+ ['code' => 'PlatformFailActivateAp', 'message' => 'Failed to activate the specified access point.', 'http_code' => 406, 'description' => 'Failed to activate the specified access point.'],
+ ['code' => 'PlatformFailBatchInsertItem', 'message' => 'Failed to insert multiple items.', 'http_code' => 406, 'description' => 'Failed to insert multiple items.'],
+ ['code' => 'PlatformFailBindAp', 'message' => 'Failed to bind the specified access point.', 'http_code' => 406, 'description' => 'Failed to bind the specified access point.'],
+ ['code' => 'PlatformFailBindEslDevice', 'message' => 'Failed to bind the specified ESL device.', 'http_code' => 406, 'description' => 'Failed to bind the specified ESL device.'],
+ ['code' => 'PlatformFailCreateCompany', 'message' => 'Failed to create a company.', 'http_code' => 406, 'description' => 'Failed to create a company.'],
+ ['code' => 'PlatformFailCreateStore', 'message' => 'Failed to create a store.', 'http_code' => 406, 'description' => 'Failed to create a store.'],
+ ['code' => 'PlatformFailDeleteEslDevice', 'message' => 'Failed to delete the specified ESL device.', 'http_code' => 406, 'description' => 'Failed to delete the specified ESL device.'],
+ ['code' => 'PlatformFailGetEslDevice', 'message' => 'Failed to query the specified ESL device.', 'http_code' => 406, 'description' => 'Failed to query the specified ESL device.'],
+ ['code' => 'PlatformFailInsertItem', 'message' => 'Failed to insert an item.', 'http_code' => 406, 'description' => 'Failed to insert an item.'],
+ ['code' => 'PlatformFailSearchAp', 'message' => 'Failed to query the specified access point.', 'http_code' => 406, 'description' => 'Failed to query the specified access point.'],
+ ['code' => 'PlatformFailUnbindAp', 'message' => 'Failed to unbind the specified access point.', 'http_code' => 406, 'description' => 'Failed to unbind the specified access point.'],
+ ['code' => 'PlatformFailUnbindEslDevice', 'message' => 'Failed to unbind the specified ESL device.', 'http_code' => 406, 'description' => 'Failed to unbind the specified ESL device.'],
+ ['code' => 'PlatformResponseError', 'message' => 'An error occurred while processing your request.', 'http_code' => 416, 'description' => 'An error occurred while processing your request.'],
+ ['code' => 'PlatformResponseErrorPub.%s', 'message' => 'An error %s occurred while processing your request.', 'http_code' => 416, 'description' => 'An error %s occurred while processing your request.'],
+ ['code' => 'PlatformResponseErrorPub.ActivateAp', 'message' => 'An error occurred while processing your request.', 'http_code' => 416, 'description' => 'An error occurred while processing the request.'],
+ ['code' => 'PlatformResponseErrorPub.BindEslDevice', 'message' => 'An error occurred while processing your request.', 'http_code' => 416, 'description' => 'An error occurred while processing the request.'],
+ ['code' => 'PlatformResponseNone', 'message' => 'Failed to respond to your request.', 'http_code' => 406, 'description' => 'Failed to respond to your request.'],
+ ['code' => 'PlatformResponseNonePub', 'message' => 'Failed to respond to your request.', 'http_code' => 416, 'description' => 'Failed to respond to your request.'],
+ ['code' => 'PlatformResponseParserError', 'message' => 'Failed to parse the response to your request.', 'http_code' => 406, 'description' => 'Failed to parse the response to your request.'],
+ ['code' => 'PlatformResponseParserErrorPub', 'message' => 'Failed to parse the response to your request.', 'http_code' => 416, 'description' => 'Failed to parse the response to your request.'],
+ ['code' => 'PublicMaterial', 'message' => 'The public material cannot be operated.', 'http_code' => 418, 'description' => 'The public material can\'t be operated.'],
+ ['code' => 'PublicMaterial', 'message' => 'The public material cannott be operated.', 'http_code' => 418, 'description' => 'The public material cannott be operated.'],
+ ['code' => 'RailNotBelongStorePub', 'message' => 'The specified rail is being used by another store.', 'http_code' => 418, 'description' => 'The specified rail is being used by another store.'],
+ ['code' => 'RamAuthFailed', 'message' => 'Failed to authenticate the specified RAM user.', 'http_code' => 405, 'description' => 'Failed to authenticate the specified RAM user.'],
+ ['code' => 'RamAuthFailedPub', 'message' => 'Failed to authenticate the specified RAM user.', 'http_code' => 418, 'description' => 'Failed to authenticate the specified RAM user.'],
+ ['code' => 'RamSettingError', 'message' => 'Failed to process your RAM settings.', 'http_code' => 405, 'description' => 'Failed to process your RAM settings.'],
+ ['code' => 'RamSettingErrorPub', 'message' => 'Failed to process your RAM settings.', 'http_code' => 418, 'description' => 'Failed to process your RAM settings.'],
+ ['code' => 'ResourcePermissionError', 'message' => 'You are not authorized to operate on the specified resource %s.', 'http_code' => 401, 'description' => 'You are not authorized to operate on the specified resource %s.'],
+ ['code' => 'ResourcePermissionErrorPub', 'message' => 'You are not authorized to manage the specified resource %s.', 'http_code' => 411, 'description' => 'You are not authorized to operate on the specified resource %s.'],
+ ['code' => 'ReviewImageError', 'message' => 'Failed to review image.', 'http_code' => 418, 'description' => 'Failed to preview the image.'],
+ ['code' => 'SendPictureToEslErrorPub', 'message' => 'Failed to send picture to ESL device.', 'http_code' => 418, 'description' => 'Failed to send picture to ESL device.'],
+ ['code' => 'ServerLocationNotConfirmedErrorPub', 'message' => 'The server location is not confirmed.', 'http_code' => 418, 'description' => 'The server location is not confirmed.'],
+ ['code' => 'SettingError', 'message' => 'The specified configurations are invalid.', 'http_code' => 502, 'description' => 'The specified configurations are invalid.'],
+ ['code' => 'ShelfNumberLimitPub', 'message' => 'The number of shelves under the store exceeds the limit.', 'http_code' => 418, 'description' => 'The number of shelves under the store exceeds the limit.'],
+ ['code' => 'StoreBelongOther', 'message' => 'The specified store %s has been assigned to another store administrator.', 'http_code' => 409, 'description' => 'The specified store %s has been assigned to another store administrator.'],
+ ['code' => 'StoreBelongOtherPub', 'message' => 'The specified store %s has been assigned to another store administrator.', 'http_code' => 419, 'description' => 'The specified store %s has been assigned to another store administrator.'],
+ ['code' => 'StoreError', 'message' => 'An error occurred while processing your request related to stores.', 'http_code' => 507, 'description' => 'An error occurred while processing your request related to stores.'],
+ ['code' => 'StoreNumberLimitPub', 'message' => 'The number of stores exceeds the limit.', 'http_code' => 418, 'description' => 'The number of stores exceeds the limit.'],
+ ['code' => 'StoreNumLimit', 'message' => 'The maximum number of stores is %s.', 'http_code' => 410, 'description' => 'The maximum number of stores is %s.'],
+ ['code' => 'StoreOutsideCompany', 'message' => 'The specified store under the company does not exist.', 'http_code' => 405, 'description' => 'The specified store under the company does not exist.'],
+ ['code' => 'StoreOutsideCompanyPub', 'message' => 'The specified store for the company does not exist.', 'http_code' => 418, 'description' => 'The specified store under the company does not exist.'],
+ ['code' => 'SystemError', 'message' => 'A system error occurred while processing your request.', 'http_code' => 500, 'description' => 'A system error occurred while processing your request.'],
+ ['code' => 'TemplateGroupHasBindToContainer', 'message' => 'The TemplateGroup has been bound to the Container.', 'http_code' => 418, 'description' => ''],
+ ['code' => 'TestLabelError', 'message' => 'You are not authorized to use the public beta version.', 'http_code' => 503, 'description' => 'You are not authorized to use the public beta version.'],
+ ['code' => 'UnbindingStoreEslErrorPub', 'message' => 'In Unbinding, please wait', 'http_code' => 418, 'description' => 'The ESL device for your store is being unbound.'],
+ ['code' => 'UnexpectedError', 'message' => 'An error occurred while processing your request.', 'http_code' => 405, 'description' => 'An unknown error occurred.'],
+ ['code' => 'UnexpectedErrorPub', 'message' => 'An error occurred while processing your request.', 'http_code' => 418, 'description' => 'An unknown error occurred.'],
+ ['code' => 'UnknownError', 'message' => 'An error occurred while processing your request.', 'http_code' => 501, 'description' => 'An error occurred while processing your request.'],
+ ['code' => 'UserAlreadyExist', 'message' => 'The specified user already exists.', 'http_code' => 405, 'description' => 'The user already exists.'],
+ ['code' => 'UserAlreadyExistPub', 'message' => 'The specified user already exists.', 'http_code' => 418, 'description' => 'User already exists'],
+ ['code' => 'UserAssignGuest', 'message' => 'Users cannot be assigned as guests.', 'http_code' => 405, 'description' => 'Users cannot be assigned as guests.'],
+ ['code' => 'UserAssignGuestPub', 'message' => 'Users cannot be assigned as guests.', 'http_code' => 418, 'description' => 'Users cannot be assigned as guests.'],
+ ['code' => 'UserCompanyRootExist', 'message' => 'The specified company root administrator already exists.', 'http_code' => 405, 'description' => 'The specified company root administrator already exists.'],
+ ['code' => 'UserCompanyRootExistPub', 'message' => 'The specified company root administrator already exists.', 'http_code' => 418, 'description' => 'The specified company root administrator already exists.'],
+ ['code' => 'UserDeleteNotGuest', 'message' => 'Only guests can be deleted.', 'http_code' => 405, 'description' => 'Only guests can be deleted.'],
+ ['code' => 'UserDeleteNotGuestPub', 'message' => 'Only guests can be deleted.', 'http_code' => 418, 'description' => 'Only guests can be deleted.'],
+ ['code' => 'UserError', 'message' => 'An error occurred while processing your request.', 'http_code' => 504, 'description' => 'An error occurred while processing your request.'],
+ ['code' => 'UserInStore', 'message' => 'The store contains a user.', 'http_code' => 405, 'description' => 'The store contains a user.'],
+ ['code' => 'UserInStorePub', 'message' => 'The store contains a user.', 'http_code' => 418, 'description' => 'The store contains a user.'],
+ ['code' => 'UserOutsideCompany', 'message' => 'The operator and the specified user do not belong to the same company.', 'http_code' => 405, 'description' => 'The operator and the specified user do not belong to the same company.'],
+ ['code' => 'UserOutsideCompanyPub', 'message' => 'The operator and the specified user do not belong to the same company.', 'http_code' => 418, 'description' => 'The operator and the specified user do not belong to the same company.'],
+ ['code' => 'UserStoreCodeAlreadyExistPub', 'message' => 'The specified userStoreCode already exists.', 'http_code' => 418, 'description' => 'The specified userStoreCode already exists.'],
+ ['code' => 'UserTypePermissionError', 'message' => 'You are not authorized to operate on the specified user type %s.', 'http_code' => 401, 'description' => 'You are not authorized to operate on the specified user type %s.'],
+ ['code' => 'UserTypePermissionErrorPub', 'message' => 'You are not authorized to manage the specified user type %s.', 'http_code' => 411, 'description' => 'You are not authorized to operate on the specified user type %s.'],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-2-pop',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-south-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-2',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-finance-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-finance-pop',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-gov-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-nu16-b01',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-edge-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-fujian',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-haidian-cm12-c01',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-bj-b01',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-finance',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-prod-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-2',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-3',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-test-306',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong-finance-pop',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-north-2-gov-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao-nebula',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-et15-b01',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-et2-b01',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-inner',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-internal-test-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-inner',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-st4-d01',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-su18-b01',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-wuhan',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-yushanfang',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangbei-na61-b01',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou-na62-a01',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhengzhou-nebula-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1-oxs',
- 'endpoint' => 'cloudesl.aliyuncs.com',
- ],
- [
- 'regionId' => 'me-east-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'ActivateApDevice'],
+ ['description' => 'Error codes changed', 'api' => 'AddApDevice'],
+ ['description' => 'Error codes changed', 'api' => 'AddUser'],
+ ['description' => 'Error codes changed', 'api' => 'AssignUser'],
+ ['description' => 'Error codes changed', 'api' => 'DeleteApDevice'],
+ ],
+ 'createdAt' => '2024-04-26T06:18:58.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'rus-west-1-pop',
- 'endpoint' => 'cloudesl.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed, Request parameters changed', 'api' => 'AddCompanyTemplate'],
+ ['description' => 'Error codes changed, Request parameters changed', 'api' => 'BindEslDevice'],
+ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeBinders'],
+ ['description' => 'Response parameters changed', 'api' => 'DescribeEslDevices'],
+ ['description' => 'Response parameters changed', 'api' => 'DescribeTemplateByModel'],
+ ['description' => 'OpenAPI offline', 'api' => 'QueryTemplateListByGroupId'],
+ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'UnbindEslDevice'],
+ ],
+ 'createdAt' => '2022-07-18T13:15:44.000Z',
+ 'description' => '多媒体一屏多价功能支持',
],
[
- 'regionId' => 'us-east-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'BatchInsertItems'],
+ ['description' => 'Response parameters changed', 'api' => 'DescribeItems'],
+ ],
+ 'createdAt' => '2022-07-18T13:14:34.000Z',
+ 'description' => '出清模板支持',
],
[
- 'regionId' => 'us-west-1',
- 'endpoint' => 'cloudesl.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'AddMaterial'],
+ ],
+ 'createdAt' => '2022-05-30T08:48:26.000Z',
+ 'description' => '云价签1.2.0接口版本发布',
],
[
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'cloudesl.cn-hangzhou.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed, Error codes changed', 'api' => 'DescribeEslDevices'],
+ ],
+ 'createdAt' => '2022-03-30T09:08:37.000Z',
+ 'description' => '-增加电子价签模板可视化功能.',
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 21:27:30 +0000