diff options
Diffstat (limited to 'data/zh_cn/cloudesl/2020-02-01/api-docs.php')
| -rw-r--r-- | data/zh_cn/cloudesl/2020-02-01/api-docs.php | 8256 |
1 files changed, 2269 insertions, 5987 deletions
diff --git a/data/zh_cn/cloudesl/2020-02-01/api-docs.php b/data/zh_cn/cloudesl/2020-02-01/api-docs.php index ef5edc3..518e775 100644 --- a/data/zh_cn/cloudesl/2020-02-01/api-docs.php +++ b/data/zh_cn/cloudesl/2020-02-01/api-docs.php @@ -1,103 +1,51 @@ <?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' => '价签设备', + 'children' => ['BindEslDevice', 'UnbindEslDevice', 'UpdateEslDeviceLight', 'DescribeBinders', 'DescribeEslDevice', 'DescribeEslDevices'], 'type' => 'directory', - 'children' => [ - 'BindEslDevice', - 'UnbindEslDevice', - 'UpdateEslDeviceLight', - 'DescribeBinders', - 'DescribeEslDevice', - 'DescribeEslDevices', - ], + 'title' => '价签设备', + 'id' => 335020, ], [ - 'id' => 149069, - 'title' => '门店', + 'children' => ['CreateStore', 'DeleteStore', 'UpdateStore', 'UpdateStoreConfig', 'DescribeStores', 'DescribeStoreConfig'], 'type' => 'directory', - 'children' => [ - 'CreateStore', - 'DeleteStore', - 'UpdateStore', - 'UpdateStoreConfig', - 'DescribeStores', - 'DescribeStoreConfig', - ], + 'title' => '门店', + 'id' => 335027, ], [ - 'id' => 149076, - 'title' => '商品', + 'children' => ['DeleteItem', 'BatchInsertItems', 'DescribeItems'], 'type' => 'directory', - 'children' => [ - 'DeleteItem', - 'BatchInsertItems', - 'DescribeItems', - ], + 'title' => '商品', + 'id' => 335034, ], [ - 'id' => 149080, - 'title' => '用户', + 'children' => ['AssignUser', 'UnassignUser', 'DescribeUserLog'], 'type' => 'directory', - 'children' => [ - 'AddUser', - 'DeleteUser', - 'AssignUser', - 'UnassignUser', - 'DescribeUserLog', - 'DescribeUsers', - 'GetUser', - ], + 'title' => '用户', + 'id' => 335038, ], [ - 'id' => 149088, - 'title' => '基站设备', + 'children' => ['AddApDevice', 'DeleteApDevice', 'ActivateApDevice', 'DescribeApDevices'], 'type' => 'directory', - 'children' => [ - 'AddApDevice', - 'DeleteApDevice', - 'ActivateApDevice', - 'DescribeApDevices', - ], + 'title' => '基站设备', + 'id' => 335046, ], [ - 'id' => 362556, - 'title' => '其他', + 'children' => ['ApplyCompanyTemplateVersionToStores', 'DescribeStoreByTemplateVersion', 'DescribeCompanyTemplateVersions', 'DescribeEslModelByTemplateVersion', 'DescribeTemplateByModel', 'DescribeAvailableEslModels', 'DeleteCompanyTemplate', 'AddCompanyTemplate', 'SyncAddMaterial', 'QueryTemplateListByGroupId', 'AddUser', 'DeleteUser', 'DescribeUsers', 'GetUser'], 'type' => 'directory', - 'children' => [ - 'ApplyCompanyTemplateVersionToStores', - 'DescribeStoreByTemplateVersion', - 'DescribeCompanyTemplateVersions', - 'DescribeEslModelByTemplateVersion', - 'DescribeTemplateByModel', - 'DescribeAvailableEslModels', - 'DeleteCompanyTemplate', - 'AddCompanyTemplate', - 'SyncAddMaterial', - 'QueryTemplateListByGroupId', - ], + 'title' => '其他', + 'id' => 335077, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'BindEslDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ActivateApDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -108,122 +56,96 @@ ], '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' => '基站设备的Mac地址。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11:22:33:44:55:66'], ], [ - 'name' => 'EslBarCode', + 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'description' => '价签条码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '18bc5a63****', - ], + 'schema' => ['description' => '门店ID或商家自定义门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], ], [ - 'name' => 'StoreId', + 'name' => 'ExtraParams', 'in' => 'formData', + 'schema' => ['description' => '系统保留字段，请忽略', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '门店ID或商家自定义门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', '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'], + ], + 'description' => '', ], ], + ], + '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', + 'summary' => '激活基站设备', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-26T06:18:47.000Z', 'description' => '错误码发生变更'], + ], + ], + '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' => '门店ID或商家自定义门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], ], [ - 'name' => 'ExtraParams', + 'name' => 'ApMac', 'in' => 'formData', - 'schema' => [ - 'description' => '扩展参数', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '基站设备的Mac地址，可调用DescribeApDevices获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11:22:33:44:55:66'], ], [ - 'name' => 'LayoutId', + 'name' => 'Remark', 'in' => 'formData', - 'schema' => [ - 'description' => '布局ID。仅支持传单个ID。', - 'type' => 'string', - 'required' => false, - 'example' => '7', - ], + 'schema' => ['description' => '备注。', 'type' => 'string', 'required' => false, 'example' => '天猫店的基站设备'], ], [ - 'name' => 'ContainerId', + 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '容器id', - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '客户端token', 'type' => 'string', 'required' => false, 'example' => '1*'], ], [ - 'name' => 'ContainerName', + 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'description' => '容器名称。', - 'type' => 'string', - 'required' => false, - 'example' => '区域4号', - ], + 'schema' => ['description' => '系统保留字段，请忽略；', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'LayoutName', + 'name' => 'SerialNumber', 'in' => 'formData', - 'schema' => [ - 'description' => '布局名称。', - 'type' => 'string', - 'required' => false, - 'example' => '布局2号', - ], + 'schema' => ['description' => '设备SN号', 'type' => 'string', 'required' => false, 'example' => '18****'], ], ], 'responses' => [ @@ -231,80 +153,33 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '请求ID。', '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'], ], - ], - ], - ], - 'errorCodes' => [ - 418 => [ - [ - 'errorCode' => 'LayoutOrContainerIsNotExistErrorPub', - 'errorMessage' => 'Layout or Container is not exist.', - ], - [ - 'errorCode' => 'ContainerTemplateNoMatchPub', - 'errorMessage' => 'The Template of the Container has not match at all.', + 'description' => '', ], ], ], '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' => '绑定价签设备', - 'summary' => '绑定价签设备。', - 'description' => '该接口分为陈列模式和普通模式两种。陈列模式是用陈列货位和价签条码进行绑定，普通模式是用商品条码和价签条码进行绑定。', - 'requestParamsDescription' => ' 普通绑定模式下，StoreId+EslBarCode+ItemBarCode必填；'."\n" - .'陈列绑定模式下，StoreId+EslBarCode+Shelf+Layer+Column必填，ItemBarCode如果填写要和陈列货位上的信息保存一致。', + 'title' => '增加基站设备', + 'summary' => '增加指定MAC地址的基站设备，会自动尝试进行激活。', + 'requestParamsDescription' => 'Remark字段，暂不支持。', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UnbindEslDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2024-04-26T06:18:47.000Z', 'description' => '错误码发生变更'], ], + ], + 'AddCompanyTemplate' => [ + 'summary' => '模板新增。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -315,90 +190,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' => '使用场景，选择合适的使用场景', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'NORMAL'], ], [ - 'name' => 'ItemBarCode', + 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'description' => '商品条码。', - 'type' => 'string', - 'required' => false, - 'example' => '690560583****', - ], + 'schema' => ['description' => '系统扩展字段，请忽略；', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'Column', + 'name' => 'EslSize', 'in' => 'formData', - 'schema' => [ - 'description' => '陈列系统的逻辑列。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '价签尺寸', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '800X480'], ], [ - 'name' => 'StoreId', + 'name' => 'TemplateName', 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID或商家自定义门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', - ], + 'schema' => ['description' => '模板名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '促销', 'maxLength' => 128, 'minLength' => 0], ], [ - 'name' => 'Shelf', + 'name' => 'Layout', 'in' => 'formData', - 'schema' => [ - 'description' => '陈列系统的货架号。', - 'type' => 'string', - 'required' => false, - 'example' => '20200201', - ], + 'schema' => ['description' => '布局信息。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2', 'minimum' => '1', 'example' => '1'], ], [ - 'name' => 'Layer', + 'name' => 'TemplateVersion', 'in' => 'formData', - 'schema' => [ - 'description' => '陈列系统的层号。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '门店模板版本；', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.1.0'], ], [ - 'name' => 'ExtraParams', + 'name' => 'DeviceType', 'in' => 'formData', - 'schema' => [ - 'description' => '扩展参数', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '设备类型', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3'], ], [ - 'name' => 'ContainerName', + 'name' => 'TemplateType', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '模板类型', 'type' => 'string', 'required' => false, 'example' => 'normal'], + ], + [ + 'name' => 'IfPromotion', + 'in' => 'formData', + 'schema' => ['description' => '是否促销，取值：-true：是。-false：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'IfSourceCode', + 'in' => 'formData', + 'schema' => ['description' => '是否溯源，取值：-true：是。-false：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'IfDefault', + 'in' => 'formData', + 'schema' => ['description' => '是否默认模板，取值：-true：是。-false：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'IfMember', + 'in' => 'formData', + 'schema' => ['description' => '是否会员，取值：-true：是。-false：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'IfOutOfInventory', + 'in' => 'formData', + 'schema' => ['description' => '是否缺货，取值：-true：是。-false：否。', 'type' => 'boolean', 'required' => false], + ], + [ + 'name' => 'Vendor', + 'in' => 'formData', + 'schema' => ['description' => '设备厂商。', 'type' => 'string', 'required' => false, 'example' => 'ali'], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => ['description' => '模板组id', 'type' => 'string', 'required' => false, 'example' => '9'], + ], + [ + 'name' => 'TemplateSceneId', + 'in' => 'formData', + 'schema' => ['description' => '自定义模板ID', 'type' => 'string', 'required' => false, 'example' => '大甩卖'], ], ], 'responses' => [ @@ -406,67 +278,33 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '请求ID。', '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' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '响应消息，若成功请求为success', 'type' => 'string', 'example' => 'success'], + 'DynamicMessage' => ['description' => '错误消息', 'type' => 'string', 'example' => 'The specified store %s does not exist.'], + 'DynamicCode' => ['description' => '动态错误码。', 'type' => 'string', 'example' => 'PlatformResponseError.%s'], ], + 'description' => '', ], ], ], - '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' => '解绑价签设备', - 'summary' => '解绑价签设备。', - 'description' => '该接口分为陈列模式和普通模式两种。陈列模式是用陈列货位和价签条码进行解绑，普通模式是用商品条码和价签条码进行解绑。', - 'requestParamsDescription' => '普通模式下，StoreId+EslBarCode必填； 陈列模式下，StoreId+EslBarCode+Shelf+Layer+Column必填，当前货位上要有入参的EslBarCode，ItemBarCode如果填写要和陈列货位上的信息保存一致。', - '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' => '错误码发生变更、请求参数发生变更'], ], + ], + 'AddUser' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -477,201 +315,104 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'LedColor', + 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'description' => '亮灯颜色，可选值：'."\n" - ."\n" - .'- `GREEN`：绿色'."\n" - ."\n" - .'- `RED`：红色'."\n" - ."\n" - .'- `BLUE`：蓝色'."\n" - ."\n" - .'- `OFF`：关闭。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GREEN', - ], + 'schema' => ['description' => '阿里云子账号UID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '134****'], ], [ - 'name' => 'Frequency', + 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '亮灯频率，可选值：'."\n" - ."\n" - .'- `ALWAYS`：持续亮灯'."\n" - ."\n" - .'- `HEIGHT`：高频率亮灯'."\n" - ."\n" - .'- `MIDDLE`：中频率亮灯'."\n" - ."\n" - .'- `NORMAL`：正常频率亮灯。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'NORMAL', - ], + 'schema' => ['description' => '客户端token', 'type' => 'string', 'required' => false, 'example' => '1*'], ], [ - 'name' => 'StoreId', + 'name' => 'ExtraParams', 'in' => 'formData', + 'schema' => ['description' => '系统扩展字段，请忽略；', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '门店ID或商家自定义门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', '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'], + ], + 'description' => '', ], ], + ], + '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":""}]', + 'title' => '新增用户', + 'summary' => '新增用户。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-26T06:18:46.000Z', 'description' => '错误码发生变更'], + ], + ], + 'ApplyCompanyTemplateVersionToStores' => [ + 'summary' => '版本应用到门店。', + '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' => '亮灯时长，单位：s，取值大于1。', - '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' => '门店模板版本号；', 'type' => 'string', 'required' => true, 'example' => '1.1.0'], ], [ - 'name' => 'ExtraParams', + 'name' => 'Stores', 'in' => 'formData', - 'schema' => [ - 'description' => '扩展参数', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '门店ID列表。请转为JSON字符串', 'type' => 'string', 'required' => false, 'example' => '[\\"s-y9eoecc7mu\\"]'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'POP请求ID。', - 'type' => 'string', - 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', - ], - 'ErrorMessage' => [ - 'description' => '错误消息。', - 'type' => 'string', - 'example' => 'The specified resource type is invalid.', - ], - 'Success' => [ - 'description' => 'POP请求成功与否标识。', - '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' => '请求ID。', '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' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '响应消息，若成功请求为success', 'type' => 'string', 'example' => 'success'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数ErrMessage错误信息中的%s。', '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 \\"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' => '操作价签的Led灯', - 'summary' => '操作价签的Led灯，进行频率和色彩的变换。', - 'requestParamsDescription' => ' ItemBarCode和EslBarCode二选一，两个都填时EslBarCode优先级比较高。'."\n" - .'只填EslBarCode时，点亮单个价签。'."\n" - .'只填ItemBarCode时，点亮该商品条码绑定的所有价签。', - 'responseParamsDescription' => ' 使用EslBarCode点亮时，返回成功或失败；'."\n" - .'使用ItemBarCode点亮时，返回成功数量和失败数量，以及失败的价签信息。', - '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' => [], ], - 'DescribeBinders' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AssignUser' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -680,84 +421,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' => '价签条码，使用门店ID+价签条码查询时，不用填写货架号和层号。', - 'type' => 'string', - 'required' => false, - 'example' => '18bc5a63****', - ], - ], - [ - 'name' => 'StoreId', + 'name' => 'Stores', 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID或商家自定义门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', - ], + 'schema' => ['description' => '门店ID列表。', 'type' => 'string', 'required' => false, 'example' => '[s-dxsxxxxxx,s-dxsyyyyyyy]'], ], [ - 'name' => 'PageNumber', + 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：当前页码，默认值1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '阿里云子账号UID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1344***'], ], [ - 'name' => 'ItemTitle', + 'name' => 'UserType', 'in' => 'formData', - 'schema' => [ - 'description' => '商品名称。', - 'type' => 'string', - 'required' => false, - 'example' => '纯牛奶', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：每页显示条数，默认值10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '用户类型，可选值：'."\n" + ."\n" + .'- `USER_TYPE_COMPANY_ROOT`：高级商家管理员，商家和门店相关账号的增删改查；'."\n" + ."\n" + .'- `USER_TYPE_COMPANY_ADMIN`：商家管理员，商家下的门店相关账号的增删改查；'."\n" + ."\n" + .'- `USER_TYPE_STORE_ADMIN`：门店管理员，一个门店管理员可关联多个门店，但一个门店仅能关联一个门店管理员；'."\n" + ."\n" + .'- `USER_TYPE_STORE_OPERATOR`：门店操作员，仅能关联一个门店；'."\n" + ."\n" + .'- `USER_TYPE_GUEST`：没有任何权限的访客。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'USER_TYPE_COMPANY_OWNER'], ], [ 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'description' => '系统保留字段，请忽略；', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '扩展参数', 'type' => 'string', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ @@ -765,212 +461,32 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '错误码。取值说明如下：请求成功：不返回ErrorCode字段。 请求失败：返回ErrorCode字段。具体信息，请参见本文的错误码目录。', - 'type' => 'string', - 'example' => 'MandatoryParameters', - ], - 'Code' => [ - 'description' => '后端错误码。', - 'type' => 'string', - 'example' => '-1001', - ], - 'Message' => [ - 'description' => '返回信息。', - 'type' => 'string', - 'example' => 'null', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的%s。', - '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' => '价签条码，使用门店ID+价签条码查询时，不用填写货架号和层号。', - 'type' => 'string', - 'example' => '18bc5a63****', - ], - 'TemplateSceneId' => [ - 'description' => '自定义模板ID', - 'type' => 'string', - 'example' => '123456', - ], - 'ActionPrice' => [ - 'description' => '实际销售价格（单位：分）。', - 'type' => 'string', - 'example' => '690', - ], - 'ItemTitle' => [ - 'description' => '商品名称。', - 'type' => 'string', - 'example' => '麦麸吐司', - ], - 'PromotionStart' => [ - 'description' => '促销开始时间 UTC格式 "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'"。', - 'type' => 'string', - 'example' => '2020-03-16T07:05:34Z', - ], - 'PriceUnit' => [ - 'description' => '计价单位，最长64个字符；', - 'type' => 'string', - 'example' => '187', - ], - 'OriginalPrice' => [ - 'description' => '原价（单位：分）。', - 'type' => 'string', - 'example' => '500', - ], - 'ItemId' => [ - 'description' => '自定义商品条码。', - 'type' => 'string', - 'example' => '1234567', - ], - 'GmtModified' => [ - 'description' => '修改时间。', - 'type' => 'string', - 'example' => '1656469716000', - ], - 'EslPic' => [ - 'description' => '价签显示图片，请使用Base64解码工具解码成图片。', - 'type' => 'string', - 'example' => 'kUzlfuzgayDo5uTXW3D66Q', - ], - 'StoreId' => [ - 'description' => '门店ID。', - 'type' => 'string', - 'example' => 's-pdwrrnkufn', - ], - 'ItemShortTitle' => [ - 'description' => '商品简称，不输入则从商品全称中截取，最长64字符；', - 'type' => 'string', - 'example' => '牛奶', - ], - 'BindId' => [ - 'description' => '绑定ID。', - 'type' => 'string', - 'example' => 'b4adf048-f36d-4da5-a8bb-ab4adbd5eb04', - ], - 'PromotionText' => [ - 'description' => '促销文案，最长64个字符；', - 'type' => 'string', - 'example' => '买一送一', - ], - 'EslModel' => [ - 'description' => '价签型号。', - 'type' => 'string', - 'example' => 'AESL0213', - ], - 'BePromotion' => [ - 'description' => '是否匹配促销模板显示，默认值为false；', - 'type' => 'boolean', - 'example' => 'true', - ], - 'SkuId' => [ - 'description' => '商品ID(SKU)。', - 'type' => 'string', - 'example' => '124', - ], - 'EslConnectAp' => [ - 'description' => '价签链接基站Mac。', - 'type' => 'string', - 'example' => '11:22:33:44:55:66', - ], - 'EslStatus' => [ - 'description' => '价签状态，返回值对应关系：'."\n" - ."\n" - .'- `ESL_STATUS_ONLINE`：在线，已绑定'."\n" - ."\n" - .'- `ESL_STATUS_OFFLINE`：离线，已绑定'."\n" - ."\n" - .'- `ESL_STATUS_UNBIND`：未绑定。', - 'type' => 'string', - 'example' => 'ESL_STATUS_ONLINE', - ], - 'TemplateId' => [ - 'description' => '模板ID', - 'type' => 'string', - 'example' => '123456', - ], - 'PromotionEnd' => [ - 'description' => '促销结束时间 UTC格式 "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'"。', - 'type' => 'string', - 'example' => '2020-03-17T07:05:34Z', - ], - 'ItemBarCode' => [ - 'description' => '商品条码。', - 'type' => 'string', - 'example' => '690560583****', - ], - 'ContainerName' => [ - 'title' => '绑定的模板区域名称', - 'description' => '绑定的模板区域名称', - 'type' => 'string', - 'example' => '2', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', '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'], ], + 'description' => '', ], ], ], - '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":""}]', - 'title' => '查询绑定信息', - 'summary' => '查询商品和价签的绑定信息。', - ], - 'DescribeEslDevice' => [ - 'summary' => '增量查询价签绑定状态', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + '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', + 'summary' => '分配用户权限。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-26T06:18:46.000Z', 'description' => '错误码发生变更'], ], + ], + 'BatchInsertItems' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -979,120 +495,167 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => '门店ID或商家自定义门店ID，一次最多插入100条数据。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], ], [ - 'name' => 'FromDate', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], - ], - [ - 'name' => 'ToDate', + 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => '系统扩展字段，请忽略；', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'PageNumber', + 'name' => 'SyncByItemId', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'schema' => ['description' => '默认值为false，如果配置为true则商品信息会更新门店下其它ItemId字段相同的商品信息；如果一次商品列表中包含多个ItemId相同的商品，则以排在最后那个内容做更新；', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'PageSize', + 'name' => 'ItemInfo', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', + 'description' => '商品信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ActionPrice' => ['description' => '实际销售价格(单位:分)。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '500'], + 'ItemTitle' => ['description' => '商品全称，最长100字符；', 'type' => 'string', 'required' => true, 'example' => '光明儿童星'], + 'BrandName' => ['description' => '品牌名称，最长64字符；', 'type' => 'string', 'required' => false, 'example' => '光明乳业'], + 'SourceCode' => ['description' => '溯源码，最长128个字符；', 'type' => 'string', 'required' => false, 'example' => '1234567'], + 'PriceUnit' => ['description' => '计价单位，最长64个字符；', 'type' => 'string', 'required' => true, 'example' => '箱'], + 'ForestFirstId' => ['description' => '一类商品类目ID，最长32个字符；', 'type' => 'string', 'required' => false, 'example' => '食品'], + 'CustomizeFeatureF' => ['description' => '自定义属性F，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '自定义属性F'], + 'CustomizeFeatureA' => ['description' => '自定义属性A，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '自定义属性A'], + 'CustomizeFeatureK' => ['description' => '自定义属性K，最长128个字符；', 'type' => 'string', 'required' => false, 'example' => '自定义属性K'], + 'TemplateSceneId' => ['description' => '客户自定义模板ID，如果有输入有效字符则匹配客户自定义模板进行商品展示，默认值为空字符“”；', 'type' => 'string', 'required' => false, 'example' => '23452'], + 'CustomizeFeatureD' => ['description' => '自定义属性D，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '自定义属性D'], + 'MemberPrice' => ['description' => '会员价(单位:分)。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '800'], + 'ModelNumber' => ['description' => '型号，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '330'], + 'PromotionStart' => ['description' => '促销开始时间 UTC格式 "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'"。', 'type' => 'string', 'required' => false, 'example' => '2020-02-10T00:00:00Z'], + 'CategoryName' => ['description' => '品类，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '饮料'], + 'CustomizeFeatureE' => ['description' => '自定义属性E，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '自定义属性E'], + 'SuggestPrice' => ['description' => '建议零售价(单位:分)。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '600'], + 'SaleSpec' => ['description' => '规格，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '330毫升'], + 'PromotionText' => ['description' => '促销文案，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '买一送一'], + 'PromotionReason' => ['description' => '促销原因，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '儿童节活动'], + 'Rank' => ['description' => '等级，最长32个字符；', 'type' => 'string', 'required' => false, 'example' => '1级'], + 'CustomizeFeatureG' => ['description' => '自定义属性G，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '自定义属性G'], + 'SalesPrice' => ['description' => '销售价格(单位:分)。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000'], + 'CustomizeFeatureH' => ['description' => '自定义属性H，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '自定义属性H'], + 'OriginalPrice' => ['description' => '原价(单位:分)。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000'], + 'CustomizeFeatureI' => ['description' => '自定义属性I，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '自定义属性I'], + 'ProductionPlace' => ['description' => '产地，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '中国'], + 'CustomizeFeatureB' => ['description' => '自定义属性B，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '自定义属性B'], + 'ItemShortTitle' => ['description' => '商品简称，不输入则从商品全称中截取，最长64字符；', 'type' => 'string', 'required' => false, 'example' => '牛奶'], + 'CustomizeFeatureN' => ['description' => '自定义属性N，最长128个字符；', 'type' => 'string', 'required' => false, 'example' => '自定义属性N'], + 'BeMember' => ['description' => '是否匹配会员模板显示，默认值为false；', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'TaxFee' => ['description' => '税费信息，最长32个字符；', 'type' => 'string', 'required' => false, 'example' => '增值税'], + 'InventoryStatus' => ['description' => '是否匹配缺货模板显示，可选值：'."\n" + ."\n" + .'- `OUT_OF_STOCK`：缺货'."\n" + ."\n" + .'- `NORMAL`：正常。'."\n" + ."\n" + .'默认值NORMAL，如果配置为OUT_OF_STOCK则会配置缺货模板进行显示', 'type' => 'string', 'required' => false, 'example' => 'OUT_OF_STOCK'], + 'ItemPicUrl' => ['description' => '商品图片URL，最长128个字符；', 'type' => 'string', 'required' => false, 'example' => 'http://m.taobao.com/xxx.html'], + 'SupplierName' => ['description' => '经销商，最长128个字符；', 'type' => 'string', 'required' => false, 'example' => '天猫超市'], + 'CustomizeFeatureL' => ['description' => '自定义属性L，最长128个字符；', 'type' => 'string', 'required' => false, 'example' => '自定义属性L'], + 'EnergyEfficiency' => ['description' => '能效，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '2焦/毫升'], + 'CustomizeFeatureC' => ['description' => '自定义属性C，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '自定义属性C'], + 'ItemId' => ['description' => '自定义商品条码，只允许输入构成整数的阿拉伯数字。', 'type' => 'string', 'required' => true, 'example' => '1234567'], + 'Manufacturer' => ['description' => '生产商，最长128个字符；', 'type' => 'string', 'required' => false, 'example' => '中国制造'], + 'Material' => ['description' => '材质，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '新鲜牛奶'], + 'CustomizeFeatureJ' => ['description' => '自定义属性J，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '自定义属性J'], + 'CustomizeFeatureO' => ['description' => '自定义属性O，最长128个字符；', 'type' => 'string', 'required' => false, 'example' => '自定义属性O'], + 'CustomizeFeatureP' => ['description' => '自定义属性P，最长512字符', 'type' => 'string', 'required' => false, 'example' => '自定义属性P'], + 'CustomizeFeatureQ' => ['description' => '自定义属性Q，最长512字符', 'type' => 'string', 'required' => false, 'example' => '自定义属性Q'], + 'CustomizeFeatureR' => ['description' => '自定义属性R，最长512字符', 'type' => 'string', 'required' => false, 'example' => '自定义属性R'], + 'CustomizeFeatureS' => ['description' => '自定义属性S，最长512字符', 'type' => 'string', 'required' => false, 'example' => '自定义属性S'], + 'CustomizeFeatureT' => ['description' => '自定义属性T，最长512字符', 'type' => 'string', 'required' => false, 'example' => '自定义属性T'], + 'CustomizeFeatureU' => ['description' => '自定义属性U，最长512字符', 'type' => 'string', 'required' => false, 'example' => '自定义属性U'], + 'CustomizeFeatureV' => ['description' => '自定义属性V，最长512字符', 'type' => 'string', 'required' => false, 'example' => '自定义属性V'], + 'CustomizeFeatureW' => ['description' => '自定义属性W，最长512字符', 'type' => 'string', 'required' => false, 'example' => '自定义属性W'], + 'CustomizeFeatureX' => ['description' => '自定义属性X，最长512字符', 'type' => 'string', 'required' => false, 'example' => '345678'], + 'CustomizeFeatureY' => ['description' => '自定义属性Y，最长512字符', 'type' => 'string', 'required' => false, 'example' => 'YYY'], + 'CustomizeFeatureZ' => ['description' => '自定义属性Z，最长512字符', 'type' => 'string', 'required' => false, 'example' => 'ZZZZ'], + 'SkuId' => ['description' => '商品ID(SKU)，最长64个字符；', 'type' => 'string', 'required' => false, 'example' => '1234567'], + 'CustomizeFeatureM' => ['description' => '自定义属性M，最长128个字符；', 'type' => 'string', 'required' => false, 'example' => '自定义属性M'], + 'BePromotion' => ['description' => '是否匹配促销模板显示，默认值为false；', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'BeSourceCode' => ['description' => '是否匹配溯源模板显示，默认值为false；', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'ForestSecondId' => ['description' => '二类商品类目ID，最长32个字符；', 'type' => 'string', 'required' => false, 'example' => '饮料'], + 'ItemQrCode' => ['description' => '商品二维码地址，最长1024个字符；', 'type' => 'string', 'required' => false, 'example' => 'http://m.taobao.com/xxx.html'], + 'ItemInfoIndex' => ['description' => '商品信息坐标，此字段不用填。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'PromotionEnd' => ['description' => '促销结束时间 UTC格式 "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'"。', 'type' => 'string', 'required' => false, 'example' => '2020-02-01T00:00:00Z'], + 'ItemBarCode' => ['description' => '商品条码，字符不区分大小写，最长64；', 'type' => 'string', 'required' => true, 'example' => '690560583****'], + 'BeClearance' => ['description' => '是否匹配出清，默认值为false；', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, + 'maxItems' => 500, ], ], ], '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' => '请求ID。', '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'], + 'BatchResults' => [ + 'description' => '批量返回结果。', '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' => '请求序列下标。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Message' => ['description' => '消息。', 'type' => 'string', 'example' => 'success'], + 'Success' => ['description' => '当前商品插入成功与否标识。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'MandatoryParameters'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '', - ], - 'DescribeEslDevices' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + '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":""}]', + 'title' => 'BatchInsertItems', + 'summary' => '批量新增或修改商品信息，一次最大商品数量为100条，每次不能包含相同的商品条码。', + 'requestParamsDescription' => '商品信息的下列字段会用于匹配模板显示，优先级从高到低'."\n" + ."\n" + .'- TemplateSceneId：尝试匹配客户自定义模板；'."\n" + .'- InventoryStatus：尝试匹配缺货模板；'."\n" + .'- BeMember：尝试匹配会员模板；'."\n" + .'- BeSourceCode && BePromotion：尝试匹配营销模板；'."\n" + .'- BeSourceCode：尝试匹配溯源模板；'."\n" + .'- BePromotion：尝试匹配促销模板；'."\n" + .'- BeClearance：尝试匹配出清模板；', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-07-18T13:13:48.000Z', 'description' => '请求参数发生变更'], ], + ], + 'BindEslDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1101,148 +664,64 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'ItemBarCode', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：当前页码，默认值1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '商品条码。', 'type' => 'string', 'required' => false, 'example' => '690560583****'], ], [ - 'name' => 'Type', + 'name' => 'EslBarCode', 'in' => 'formData', - 'schema' => [ - 'description' => '价签类型，可选值：'."\n" - ."\n" - .'- `ESL_TYPE_E_INK`：电子墨水屏幕'."\n" - ."\n" - .'- `ESL_TYPE_DM_LCD`：段码屏幕'."\n" - ."\n" - .'- `ESL_TYPE_FULL_COLOR`：彩色屏幕。', - 'type' => 'string', - 'required' => false, - 'example' => 'ESL_TYPE_E_INK', - ], + 'schema' => ['description' => '价签条码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '18bc5a63****'], ], [ - 'name' => 'TypeEncode', + 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'title' => '类型编码'."\n" - .'取值范围如下：'."\n" - .'NORMAL 常规'."\n" - .'LOW_TEMPLATE 低温价签'."\n" - .'THREE_COLOR 三色价签'."\n" - .'ESL_TYPE_DM_LCD 段码屏幕'."\n" - .'ESL_TYPE_FULL_COLOR 彩色屏幕'."\n" - .'ESL_TYPE_MUTIMEDIA 多媒体', - 'description' => '价签类型，可选值：'."\n" - ."\n" - .'- `NORMAL`：常规'."\n" - ."\n" - .'- `LOW_TEMPLATE`：低温'."\n" - ."\n" - .'- `THREE_COLOR`：三色'."\n" - ."\n" - .'- `ESL_TYPE_DM_LCD`：段码'."\n" - ."\n" - .'- `ESL_TYPE_FULL_COLOR`：彩色'."\n" - ."\n" - .'- `ESL_TYPE_MUTI_MEDIA`：多媒体。', - 'type' => 'string', - 'required' => false, - 'example' => 'LOW_TEMPLATE', - ], + 'schema' => ['description' => '门店ID或商家自定义门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], ], [ - 'name' => 'PageSize', + 'name' => 'Shelf', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：每页显示条数，默认值10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '陈列系统中的货架号。', 'type' => 'string', 'required' => false, 'example' => '20200201'], ], [ - 'name' => 'ToBatteryLevel', + 'name' => 'Layer', 'in' => 'formData', - 'schema' => [ - 'description' => '电量区间右偏移，电量大于等于输入值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], + 'schema' => ['description' => '陈列系统中的层号。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'StoreId', + 'name' => 'Column', 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID或商家自定义门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', - ], + 'schema' => ['description' => '陈列系统中的逻辑列。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'EslStatus', + 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'description' => '价签状态，可选值：'."\n" - ."\n" - .'- `ESL_STATUS_ONLINE`：在线，已绑定'."\n" - ."\n" - .'- `ESL_STATUS_OFFLINE`：离线，已绑定'."\n" - ."\n" - .'- `ESL_STATUS_UNBIND`：未绑定。', - 'type' => 'string', - 'required' => false, - 'example' => 'ESL_STATUS_ONLINE', - ], + 'schema' => ['description' => '扩展参数', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'EslBarCode', + 'name' => 'LayoutId', 'in' => 'formData', - 'schema' => [ - 'description' => '价签条码。', - 'type' => 'string', - 'required' => false, - 'example' => '18bc5a63****', - ], + 'schema' => ['description' => '布局ID。仅支持传单个ID。', 'type' => 'string', 'required' => false, 'example' => '7'], ], [ - 'name' => 'FromBatteryLevel', + 'name' => 'ContainerId', 'in' => 'formData', - 'schema' => [ - 'description' => '电量区间左偏移，电量小于等于输入值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '容器id', 'type' => 'string', 'required' => false, 'example' => '20'], ], [ - 'name' => 'ExtraParams', + 'name' => 'ContainerName', 'in' => 'formData', - 'schema' => [ - 'description' => '扩展参数', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '容器名称。', 'type' => 'string', 'required' => false, 'example' => '区域4号'], + ], + [ + 'name' => 'LayoutName', + 'in' => 'formData', + 'schema' => ['description' => '布局名称。', 'type' => 'string', 'required' => false, 'example' => '布局2号'], ], ], 'responses' => [ @@ -1250,194 +729,40 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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', - ], - 'EslDevices' => [ - 'description' => '价签信息列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '价签类型，返回值对应关系：'."\n" - ."\n" - .'- `ESL_TYPE_E_INK`：电子墨水屏幕'."\n" - ."\n" - .'- `ESL_TYPE_DM_LCD`：段码屏幕'."\n" - ."\n" - .'- `ESL_TYPE_FULL_COLOR`：彩色屏幕。', - 'type' => 'string', - 'example' => 'ESL_TYPE_E_INK', - ], - 'StoreId' => [ - 'description' => '门店ID。', - 'type' => 'string', - 'example' => 's-dxsxx****', - ], - 'EslBarCode' => [ - 'description' => '价签条码。', - 'type' => 'string', - 'example' => '18bc5a63****', - ], - 'Model' => [ - 'description' => '价签型号。', - 'type' => 'string', - 'example' => 'AESL0213', - ], - 'LastCommunicateTime' => [ - 'description' => '最后通讯时间。', - 'type' => 'string', - 'example' => '2020-03-16T07:04:16Z', - ], - 'ScreenHeight' => [ - 'description' => '屏幕高度，单位为px。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ScreenWidth' => [ - 'description' => '屏幕宽度，单位为px。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'EslSignal' => [ - 'description' => '价签信号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '54', - ], - 'BatteryLevel' => [ - 'description' => '电量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'EslStatus' => [ - 'description' => '价签状态，返回值对应关系：'."\n" - ."\n" - .'- `ESL_STATUS_ONLINE`：在线，已绑定'."\n" - ."\n" - .'- `ESL_STATUS_OFFLINE`：离线，已绑定'."\n" - ."\n" - .'- `ESL_STATUS_UNBIND`：未绑定。', - 'type' => 'string', - 'example' => 'ESL_STATUS_ONLINE', - ], - 'Mac' => [ - 'description' => '价签Mac地址。', - 'type' => 'string', - 'example' => '18:bc:5a:63:**:**', - ], - 'TypeEncode' => [ - '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", - 'description' => '类型编码'."\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', - 'example' => 'THREE_COLOR', - ], - 'LayoutId' => [ - 'description' => '布局ID。仅支持传单个ID。', - 'type' => 'string', - 'example' => '7', - ], - 'LayoutName' => [ - 'description' => '布局名称。', - 'type' => 'string', - 'example' => '新增布局', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', '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'], ], + 'description' => '', ], ], ], - '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":""}]', - 'title' => '查询价签设备', - 'summary' => '查询价签设备信息。', - 'requestParamsDescription' => ' 根据电量区间查询暂时不支持', + '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' => '模板和容器不匹配'], + ], + ], + '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' => '绑定价签设备', + 'summary' => '绑定价签设备。', + 'description' => '该接口分为陈列模式和普通模式两种。陈列模式是用陈列货位和价签条码进行绑定，普通模式是用商品条码和价签条码进行绑定。', + 'requestParamsDescription' => ' 普通绑定模式下，StoreId+EslBarCode+ItemBarCode必填；'."\n" + .'陈列绑定模式下，StoreId+EslBarCode+Shelf+Layer+Column必填，ItemBarCode如果填写要和陈列货位上的信息保存一致。', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => '错误码发生变更、请求参数发生变更'], + ], ], 'CreateStore' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1448,81 +773,42 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'ParentId', 'in' => 'formData', - 'schema' => [ - 'description' => '父门店ID', - 'type' => 'string', - 'required' => false, - 'example' => 's-dxsxx****', - ], + 'schema' => ['description' => '父门店ID', 'type' => 'string', 'required' => false, 'example' => 's-dxsxx****'], ], [ 'name' => 'UserStoreCode', 'in' => 'formData', - 'schema' => [ - 'description' => '商家自定义门店ID', - 'type' => 'string', - 'required' => false, - 'example' => '20200201', - ], + 'schema' => ['description' => '商家自定义门店ID', 'type' => 'string', 'required' => false, 'example' => '20200201'], ], [ 'name' => 'StoreName', 'in' => 'formData', - 'schema' => [ - 'description' => '门店名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '天猫旗舰店', - ], + 'schema' => ['description' => '门店名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '天猫旗舰店'], ], [ 'name' => 'Phone', 'in' => 'formData', - 'schema' => [ - 'description' => '门店联系电话', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0571-5666888', - ], + 'schema' => ['description' => '门店联系电话', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0571-5666888'], ], [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '客户端token', - 'type' => 'string', - 'required' => false, - 'example' => '1212', - ], + 'schema' => ['description' => '客户端token', 'type' => 'string', 'required' => false, 'example' => '1212'], ], [ 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'description' => '系统保留字段，请忽略', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '系统保留字段，请忽略', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ 'name' => 'TimeZone', 'in' => 'formData', - 'schema' => [ - 'description' => '时区', - 'type' => 'string', - 'required' => false, - 'example' => 'GMT+08:00', - ], + 'schema' => ['description' => '时区', 'type' => 'string', 'required' => false, 'example' => 'GMT+08:00'], ], [ 'name' => 'BarCodeEncode', @@ -1542,28 +828,12 @@ [ 'name' => 'AutoUnbindOfflineEsl', 'in' => 'formData', - 'schema' => [ - 'title' => '是否启用自动解绑离线价签', - 'description' => '是否启用自动解绑离线价签', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['title' => '是否启用自动解绑离线价签', 'description' => '是否启用自动解绑离线价签', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], [ 'name' => 'AutoUnbindDays', 'in' => 'formData', - 'schema' => [ - 'title' => '自动解绑离线价签条件-价签离线天数', - 'description' => '自动解绑离线价签条件-价签离线天数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '7', - 'example' => '30', - 'default' => '36500', - ], + 'schema' => ['title' => '自动解绑离线价签条件-价签离线天数', 'description' => '自动解绑离线价签条件-价签离线天数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '7', 'example' => '30', 'default' => '36500'], ], ], 'responses' => [ @@ -1571,52 +841,17 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'StoreId' => [ - 'description' => '门店ID。', - 'type' => 'string', - 'example' => 's-dxsxx****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - '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', - ], + 'StoreId' => ['description' => '门店ID。', 'type' => 'string', 'example' => 's-dxsxx****'], + 'RequestId' => ['description' => '请求ID。', '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'], ], + 'description' => '', ], ], ], @@ -1626,16 +861,13 @@ 'requestParamsDescription' => ' ParentId字段，暂时不支持。', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteStore' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2022-11-23T03:19:05.000Z', 'description' => '请求参数发生变更'], ], + ], + 'DeleteApDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1646,30 +878,22 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ + 'name' => 'ApMac', + 'in' => 'formData', + 'schema' => ['description' => '基站设备的Mac地址。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11:22:33:44:55:66'], + ], + [ 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID或商家自定义门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', - ], + 'schema' => ['description' => '门店ID或商家自定义门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], ], [ 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'description' => '系统保留字段，请忽略', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -1677,67 +901,32 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '请求ID。', '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'], ], + 'description' => '', ], ], ], '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', - 'summary' => '删除门店。', - 'description' => '删除门店的前提条件：该门店下没有商品和价签', + 'title' => '删除基站设备', + 'summary' => '删除指定MAC地址的基站设备。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => ' 删除门店前，需先保证门店下没有商品、价签设备和基站设备；', - ], - 'UpdateStore' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-26T06:18:44.000Z', 'description' => '错误码发生变更'], ], + ], + 'DeleteCompanyTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1748,121 +937,175 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'StoreId', + 'name' => 'TemplateId', 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', - ], + 'schema' => ['description' => '模板ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '742842379343605760'], ], [ - 'name' => 'UserStoreCode', + 'name' => 'ExtraParams', 'in' => 'formData', + 'schema' => ['description' => '系统扩展字段，请忽略；', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '商家自定义门店ID。', - 'type' => 'string', - 'required' => false, - 'example' => '123456', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7571D49-9B36-5782-AD3D-32C8436D45B7'], + 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified resource type is invalid.'], + 'Success' => ['description' => 'POP请求成功与否标识。', 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => '错误码。取值说明如下：请求成功：不返回ErrorCode字段。 请求失败：返回ErrorCode字段。具体信息，请参见本文的错误码列表。', 'type' => 'string', 'example' => 'MandatoryParameters'], + 'Code' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '-1001'], + 'Message' => ['description' => '错误代码。', 'type' => 'string', 'example' => 'success'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数ErrMessage错误信息中的%s。', 'type' => 'string', 'example' => 'The specified store %s does not exist.'], + 'DynamicCode' => ['description' => '动态错误码。', 'type' => 'string', 'example' => 'PlatformResponseError.%s'], + ], + 'description' => '', ], ], + ], + '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' => [], + ], + 'DeleteItem' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StoreName', - 'in' => 'formData', - 'schema' => [ - 'description' => '门店名称。', - 'type' => 'string', - 'required' => false, - 'example' => '天猫超市', - ], + 'AK' => [], ], [ - 'name' => 'Phone', + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'description' => '门店所在监督工商局的监督电话。', - 'type' => 'string', - 'required' => false, - 'example' => '0571-5666888', - ], + 'schema' => ['description' => '门店ID或商家自定义门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], ], [ - 'name' => 'ExtraParams', + 'name' => 'ItemBarCode', 'in' => 'formData', - 'schema' => [ - 'description' => '系统保留字段，请忽略；', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '商品条码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '693737264225'], ], [ - 'name' => 'TemplateVersion', + 'name' => 'UnbindEslDevice', 'in' => 'formData', + 'schema' => ['description' => '是否解绑该商品已绑定的价签设备，默认值false', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '门店模板版本；', - 'type' => 'string', - 'required' => false, - 'example' => '1.1.0', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', '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'], + ], + 'description' => '', ], ], + ], + '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' => '删除门店商品', + 'summary' => '删除门店商品。', + 'changeSet' => [ + ['createdAt' => '2024-04-26T06:18:43.000Z', 'description' => '错误码发生变更'], + ], + ], + 'DeleteStore' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Timezone', + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'description' => '时区。', - 'type' => 'string', - 'required' => false, - 'example' => 'GMT+08:00', - ], + 'schema' => ['description' => '门店ID或商家自定义门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], ], [ - 'name' => 'BarCodeEncode', + 'name' => 'ExtraParams', 'in' => 'formData', + 'schema' => ['description' => '系统保留字段，请忽略', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '条形码编码方式：0：Code128 ，1：EAN13（默认0）', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1', - 'minimum' => '0', - 'example' => '0', - 'default' => '0', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', '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'], + ], + 'description' => '', ], ], + ], + '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', + 'summary' => '删除门店。', + 'description' => '删除门店的前提条件：该门店下没有商品和价签', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' 删除门店前，需先保证门店下没有商品、价签设备和基站设备；', + 'changeSet' => [ + ['createdAt' => '2024-04-26T06:18:43.000Z', 'description' => '错误码发生变更'], + ], + ], + 'DeleteUser' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], [ - 'name' => 'AutoUnbindOfflineEsl', + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'title' => '是否启用自动解绑离线价签', - 'description' => '是否自动解绑离线价签', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => '阿里云子账号UID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1344***'], ], [ - 'name' => 'AutoUnbindDays', + 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'title' => '自动解绑离线价签条件-价签离线天数', - 'description' => '自动解绑时间，单位：日', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '36500', - 'minimum' => '7', - 'example' => '1', - 'default' => '36500', - ], + 'schema' => ['description' => '系统扩展字段，请忽略；', 'type' => 'string', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ @@ -1870,66 +1113,32 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '请求ID。', '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'], ], + 'description' => '', ], ], ], - '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":""}]', - 'title' => '修改门店信息', - 'summary' => '修改门店基础信息。', + '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' => '删除用户', + 'summary' => '删除用户。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateStoreConfig' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2024-04-26T06:18:42.000Z', 'description' => '错误码发生变更'], ], + ], + 'DescribeApDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1938,71 +1147,49 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'NotificationSilentTimes', + 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'description' => '用户配置的静默期，不发通知消息，JSON列表，单位为分钟，每个JSON字段表示一个静默期时间段，里面的值为UTC时间下一天里面的分钟数，from为静默期的起始分钟数，to为结束分钟数。', - 'type' => 'string', - 'required' => false, - 'example' => '[{"from":960,"to":1320},{"from":1170,"to":1230}]', - ], + 'schema' => ['description' => '门店ID或商家自定义门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], ], [ - 'name' => 'EnableNotification', + 'name' => 'ApMac', 'in' => 'formData', - 'schema' => [ - 'description' => '是否启用钉钉异常消息通知，true 启用，false不启用。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '基站设备的Mac地址。', 'type' => 'string', 'required' => false, 'example' => '112233445566'], ], [ - 'name' => 'StoreId', + 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID或商家自定义门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-sds1233****', - ], + 'schema' => ['description' => '设备在线或离线状态 ，true：在线、false：离线。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'NotificationWebHook', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '钉钉消息的webHook地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'https://oapi.dingtalk.com/robot/send?.', - ], + 'schema' => ['description' => '分页参数：每页显示条数，默认值10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'ExtraParams', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => '系统扩展字段，请忽略；', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '分页参数：当前页码，默认值1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'SubscribeContents', + 'name' => 'Model', 'in' => 'formData', - 'schema' => [ - 'description' => '订阅内容。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '设备型号。', 'type' => 'string', 'required' => false, 'example' => 'aliyun'], + ], + [ + 'name' => 'BeActivate', + 'in' => 'formData', + 'schema' => ['description' => '设备的激活状态。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'ExtraParams', + 'in' => 'formData', + 'schema' => ['description' => '系统保留字段，请忽略', 'type' => 'string', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ @@ -2010,63 +1197,51 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '本次请求的ID。', - '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' => '请求ID。', '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' => '基站设备列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '在线状态：离线。', 'type' => 'boolean', 'example' => 'false'], + 'StoreId' => ['description' => '门店ID。', 'type' => 'string', 'example' => 's-cxsds****'], + 'Model' => ['description' => '设备型号。', 'type' => 'string', 'example' => 'aliyun'], + 'Remark' => ['description' => '备注。', 'type' => 'string', 'example' => '测试数据'], + 'BeActivate' => ['description' => '是否激活。', 'type' => 'boolean', 'example' => 'true'], + 'Mac' => ['description' => '设备的mac地址。', 'type' => 'string', 'example' => '112233445566'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], - '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' => '修改门店配置', - 'summary' => '修改门店的配置信息。', - ], - 'DescribeStores' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + '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' => '查询基站设备', + 'summary' => '查询基站设备信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-26T06:18:42.000Z', 'description' => '错误码发生变更'], ], + ], + 'DescribeAvailableEslModels' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2077,101 +1252,120 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'UserStoreCode', + 'name' => 'ModelId', 'in' => 'formData', - 'schema' => [ - 'description' => '商家自定义门店ID。', - 'type' => 'string', - 'required' => false, - 'example' => '123456', - ], + 'schema' => ['title' => '设备模型id', 'description' => '设备模型id', 'type' => 'string', 'required' => false, 'example' => '6cd23870539e43759e65eef5b6808a49'], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['title' => '模型名称', 'description' => '模型名称', 'type' => 'string', 'required' => false, 'example' => 'aa_ssaaa'], ], [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：当前页码，默认值1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + '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'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分页参数：每页显示条数，默认值10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'title' => 'DescribeAvailableEslModelsResponse', + 'description' => 'DescribeAvailableEslModelsResponse', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '436'], + 'PageSize' => ['description' => '分页参数：每页显示条数，默认值10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '分页参数：当前页码，默认值1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'EslModels' => [ + 'description' => '价签信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '价签信息列表。', + 'type' => 'object', + 'properties' => [ + 'ModelId' => ['title' => '模型id', 'description' => '模型id', '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' => '请求ID。', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF'], + 'Success' => ['description' => '请求状态标识。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '响应消息，若成功请求为success', 'type' => 'string', 'example' => 'success'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'MandatoryParameters'], + 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified resource type is invalid.'], + 'Code' => ['description' => '状态码。返回200代表成功。', 'type' => 'string', 'example' => '-1001'], + 'DynamicCode' => ['description' => '动态错误码。', 'type' => 'string', 'example' => 'PlatformResponseError.%s'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数ErrMessage错误信息中的%s。', 'type' => 'string', 'example' => 'The specified store %s does not exist.'], + ], ], ], + ], + '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' => [], + ], + 'DescribeBinders' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], [ - 'name' => 'StoreName', + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ItemBarCode', 'in' => 'formData', - 'schema' => [ - 'description' => '门店名称。', - 'type' => 'string', - 'required' => false, - 'example' => '天猫超市', - ], + 'schema' => ['description' => '商品条码', 'type' => 'string', 'required' => false, 'example' => '690560583****'], ], [ - 'name' => 'ToDate', + 'name' => 'EslBarCode', 'in' => 'formData', - 'schema' => [ - 'description' => '门店创建时间：结束时间。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-03-08T02:58:16Z', - ], + 'schema' => ['description' => '价签条码，使用门店ID+价签条码查询时，不用填写货架号和层号。', 'type' => 'string', 'required' => false, 'example' => '18bc5a63****'], ], [ 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID。', - 'type' => 'string', - 'required' => false, - 'example' => 's-dxsxx****', - ], + 'schema' => ['description' => '门店ID或商家自定义门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], ], [ - 'name' => 'FromDate', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => '门店创建时间：开始时间。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-03-06T02:58:16Z', - ], + 'schema' => ['description' => '分页参数：当前页码，默认值1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ExtraParams', + 'name' => 'ItemTitle', 'in' => 'formData', - 'schema' => [ - 'description' => '系统保留字段，请忽略；', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '商品名称。', 'type' => 'string', 'required' => false, 'example' => '纯牛奶'], ], [ - 'name' => 'TemplateVersion', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '门店配置的模板版本号；', - 'type' => 'string', - 'required' => false, - 'example' => '1.1.0', - ], + 'schema' => ['description' => '分页参数：每页显示条数，默认值10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'ExtraParams', + 'in' => 'formData', + 'schema' => ['description' => '系统保留字段，请忽略；', 'type' => 'string', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ @@ -2179,167 +1373,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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', - ], - 'Stores' => [ - 'description' => '门店信息列表。', + 'RequestId' => ['description' => '请求ID。', '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' => '错误码。取值说明如下：请求成功：不返回ErrorCode字段。 请求失败：返回ErrorCode字段。具体信息，请参见本文的错误码目录。', 'type' => 'string', 'example' => 'MandatoryParameters'], + 'Code' => ['description' => '后端错误码。', 'type' => 'string', 'example' => '-1001'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'null'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的%s。', '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' => [ - 'StoreId' => [ - 'description' => '门店ID。', - 'type' => 'string', - 'example' => 's-dxsxx**** ', - ], - 'ParentId' => [ - 'description' => '父门店ID。', - 'type' => 'string', - 'example' => 's-aasx****', - ], - 'TimeZone' => [ - 'description' => '门店时区配置', - 'type' => 'string', - 'example' => 'GMT+08:00', - ], - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2020-03-06T02:58:16Z', - ], - 'StoreName' => [ - 'description' => '门店名称。', - 'type' => 'string', - 'example' => '天猫旗舰店', - ], - 'GmtModified' => [ - 'description' => '修改时间。', - 'type' => 'string', - 'example' => '2020-03-06T02:58:16Z', - ], - 'TemplateVersion' => [ - 'description' => '门店模板版本号；', - 'type' => 'string', - 'example' => '1.1.0', - ], - 'Level' => [ - 'description' => '级别。', - 'type' => 'string', - 'example' => '1级', - ], - 'Phone' => [ - 'description' => '门店所在监督工商局的监督电话。', - 'type' => 'string', - 'example' => '0571-5666888', - ], - 'UserStoreCode' => [ - 'description' => '商家自定义门店ID。', - 'type' => 'string', - 'example' => '20200201', - ], - 'BarCodeEncode' => [ - 'description' => '条形码编码方式：0：Code128 ，1：EAN13（默认0）', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '1', - 'minimum' => '0', - 'example' => '0', - 'default' => '0', - ], - 'AutoUnbindOfflineEsl' => [ - 'title' => '是否启用自动解绑离线价签', - 'description' => '是否启用自动解绑离线价签', - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'false', - ], - 'AutoUnbindDays' => [ - 'title' => '自动解绑离线价签条件-价签离线天数', - 'description' => '自动解绑离线价签条件-价签离线天数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'default' => '36500', - ], + 'EslBarCode' => ['description' => '价签条码，使用门店ID+价签条码查询时，不用填写货架号和层号。', 'type' => 'string', 'example' => '18bc5a63****'], + 'TemplateSceneId' => ['description' => '自定义模板ID', 'type' => 'string', 'example' => '123456'], + 'ActionPrice' => ['description' => '实际销售价格（单位：分）。', 'type' => 'string', 'example' => '690'], + 'ItemTitle' => ['description' => '商品名称。', 'type' => 'string', 'example' => '麦麸吐司'], + 'PromotionStart' => ['description' => '促销开始时间 UTC格式 "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'"。', 'type' => 'string', 'example' => '2020-03-16T07:05:34Z'], + 'PriceUnit' => ['description' => '计价单位，最长64个字符；', 'type' => 'string', 'example' => '187'], + 'OriginalPrice' => ['description' => '原价（单位：分）。', 'type' => 'string', 'example' => '500'], + 'ItemId' => ['description' => '自定义商品条码。', 'type' => 'string', 'example' => '1234567'], + 'GmtModified' => ['description' => '修改时间。', 'type' => 'string', 'example' => '1656469716000'], + 'EslPic' => ['description' => '价签显示图片，请使用Base64解码工具解码成图片。', 'type' => 'string', 'example' => 'kUzlfuzgayDo5uTXW3D66Q'], + 'StoreId' => ['description' => '门店ID。', 'type' => 'string', 'example' => 's-pdwrrnkufn'], + 'ItemShortTitle' => ['description' => '商品简称，不输入则从商品全称中截取，最长64字符；', 'type' => 'string', 'example' => '牛奶'], + 'BindId' => ['description' => '绑定ID。', 'type' => 'string', 'example' => 'b4adf048-f36d-4da5-a8bb-ab4adbd5eb04'], + 'PromotionText' => ['description' => '促销文案，最长64个字符；', 'type' => 'string', 'example' => '买一送一'], + 'EslModel' => ['description' => '价签型号。', 'type' => 'string', 'example' => 'AESL0213'], + 'BePromotion' => ['description' => '是否匹配促销模板显示，默认值为false；', 'type' => 'boolean', 'example' => 'true'], + 'SkuId' => ['description' => '商品ID(SKU)。', 'type' => 'string', 'example' => '124'], + 'EslConnectAp' => ['description' => '价签链接基站Mac。', 'type' => 'string', 'example' => '11:22:33:44:55:66'], + 'EslStatus' => ['description' => '价签状态，返回值对应关系：'."\n" + ."\n" + .'- `ESL_STATUS_ONLINE`：在线，已绑定'."\n" + ."\n" + .'- `ESL_STATUS_OFFLINE`：离线，已绑定'."\n" + ."\n" + .'- `ESL_STATUS_UNBIND`：未绑定。', 'type' => 'string', 'example' => 'ESL_STATUS_ONLINE'], + 'TemplateId' => ['description' => '模板ID', 'type' => 'string', 'example' => '123456'], + 'PromotionEnd' => ['description' => '促销结束时间 UTC格式 "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'"。', 'type' => 'string', 'example' => '2020-03-17T07:05:34Z'], + 'ItemBarCode' => ['description' => '商品条码。', 'type' => 'string', 'example' => '690560583****'], + 'ContainerName' => ['title' => '绑定的模板区域名称', 'description' => '绑定的模板区域名称', 'type' => 'string', 'example' => '2'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], - '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":""}]', - 'title' => '查询门店', - 'summary' => '查询门店基础信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeStoreConfig' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + '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":""}]', + 'title' => '查询绑定信息', + 'summary' => '查询商品和价签的绑定信息。', + 'changeSet' => [ + ['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => '响应参数发生变更、错误码发生变更'], ], + ], + 'DescribeCompanyTemplateVersions' => [ + 'summary' => '版本列表', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2350,123 +1449,71 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'StoreId', + 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ - 'description' => '门店ID或商家自定义门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', + 'description' => '分页参数：当前页码，默认值1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [1 => '1'], + 'example' => '1', ], ], [ - 'name' => 'ExtraParams', + 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ - 'description' => '系统保留字段，请忽略', - 'type' => 'string', + 'description' => '分页参数：每页显示条数，默认值10。', + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'example' => '{}', + 'enumValueTitles' => [10 => '10'], + 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', - ], - 'ErrorMessage' => [ - 'description' => '错误消息。', - 'type' => 'string', - 'example' => 'The specified resource type is invalid.', + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [18 => '18'], + 'example' => '16', ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '6248311A-3296-5084-B057-D0EC3DCE5C47'], + 'ErrorMessage' => ['description' => '错误消息。', 'type' => 'string', 'example' => 'The specified resource type is invalid.'], 'Success' => [ - 'description' => '请求状态标识。', + 'description' => 'POP请求成功与否标识。', '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', - ], - 'StoreConfigInfo' => [ - 'description' => '门店配置信息列表。', - 'type' => 'object', - 'properties' => [ - 'StoreId' => [ - 'description' => '门店ID。', - 'type' => 'string', - 'example' => 's-dxsxx****', - ], - 'EnableNotification' => [ - 'description' => '是否启用钉钉异常消息通知。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'NotificationWebHook' => [ - 'description' => '钉钉消息的webHook地址。', - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?.', - ], - 'NotificationSilentTimes' => [ - 'description' => '用户配置的静默期，不发通知消息，JSON列表，单位为分钟，每个JSON字段表示一个静默期时间段，里面的值为UTC时间下一天里面的分钟数，from为静默期的起始分钟数，to为结束分钟数。', - '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', - ], - ], - ], + 'ErrorCode' => ['description' => '错误码。取值说明如下：请求成功：不返回ErrorCode字段。 请求失败：返回ErrorCode字段。具体信息，请参见本文的错误码列表。', 'type' => 'string', 'example' => 'MandatoryParameters'], + 'Code' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '-1001'], + 'Message' => ['description' => '响应消息，若成功请求为success', 'type' => 'string', 'example' => 'success'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数ErrMessage错误信息中的%s。', 'type' => 'string', 'example' => 'The specified store %s does not exist.'], + 'DynamicCode' => ['description' => '与本次请求相关的动态错误码。', 'type' => 'string', 'example' => 'PlatformResponseError.%s'], + 'PageSize' => ['description' => '分页参数：每页显示条数，默认值10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => '分页参数：当前页码，默认值1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Versions' => [ + 'description' => '版本列表。', + 'type' => 'array', + 'items' => [ + 'description' => '版本列表。', + 'type' => 'object', + 'properties' => [ + 'Version' => ['description' => '版本号。', 'type' => 'string', 'example' => '1.1.0'], ], ], ], @@ -2474,22 +1521,13 @@ ], ], ], - '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', - 'summary' => '查询门店配置信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + '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' => [], ], - 'DeleteItem' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeEslDevice' => [ + 'summary' => '增量查询价签绑定状态', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2498,107 +1536,72 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID或商家自定义门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', - ], + 'schema' => ['type' => 'string'], ], [ - 'name' => 'ItemBarCode', + 'name' => 'FromDate', 'in' => 'formData', - 'schema' => [ - 'description' => '商品条码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '693737264225', - ], + 'schema' => ['type' => 'string'], ], [ - 'name' => 'UnbindEslDevice', + 'name' => 'ToDate', 'in' => 'formData', - 'schema' => [ - 'description' => '是否解绑该商品已绑定的价签设备，默认值false', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['type' => 'string'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => ['type' => 'integer', 'format' => 'int64'], + 'PageSize' => ['type' => 'integer', 'format' => 'int64'], + 'RequestId' => ['type' => 'string'], + 'PageNumber' => ['type' => 'integer', 'format' => 'int64'], + 'Success' => ['type' => 'boolean'], + 'EslDetails' => [ + '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'], + ], + ], ], ], ], ], ], - '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' => '删除门店商品', - 'summary' => '删除门店商品。', + 'changeSet' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 0,\\n \\"PageSize\\": 0,\\n \\"RequestId\\": \\"\\",\\n \\"PageNumber\\": 0,\\n \\"Success\\": true,\\n \\"EslDetails\\": [\\n {\\n \\"EslBarCode\\": \\"\\",\\n \\"LastUpdateTime\\": \\"\\",\\n \\"ItemBarCode\\": 0,\\n \\"ItemId\\": 0,\\n \\"ItemShortTitle\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"StoreId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'BatchInsertItems' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeEslDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2607,529 +1610,247 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => '分页参数：当前页码，默认值1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => ['description' => '价签类型，可选值：'."\n" + ."\n" + .'- `ESL_TYPE_E_INK`：电子墨水屏幕'."\n" + ."\n" + .'- `ESL_TYPE_DM_LCD`：段码屏幕'."\n" + ."\n" + .'- `ESL_TYPE_FULL_COLOR`：彩色屏幕。', 'type' => 'string', 'required' => false, 'example' => 'ESL_TYPE_E_INK'], + ], + [ + 'name' => 'TypeEncode', + 'in' => 'formData', + 'schema' => ['title' => '类型编码'."\n" + .'取值范围如下：'."\n" + .'NORMAL 常规'."\n" + .'LOW_TEMPLATE 低温价签'."\n" + .'THREE_COLOR 三色价签'."\n" + .'ESL_TYPE_DM_LCD 段码屏幕'."\n" + .'ESL_TYPE_FULL_COLOR 彩色屏幕'."\n" + .'ESL_TYPE_MUTIMEDIA 多媒体', 'description' => '价签类型，可选值：'."\n" + ."\n" + .'- `NORMAL`：常规'."\n" + ."\n" + .'- `LOW_TEMPLATE`：低温'."\n" + ."\n" + .'- `THREE_COLOR`：三色'."\n" + ."\n" + .'- `ESL_TYPE_DM_LCD`：段码'."\n" + ."\n" + .'- `ESL_TYPE_FULL_COLOR`：彩色'."\n" + ."\n" + .'- `ESL_TYPE_MUTI_MEDIA`：多媒体。', 'type' => 'string', 'required' => false, 'example' => 'LOW_TEMPLATE'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => '分页参数：每页显示条数，默认值10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'ToBatteryLevel', + 'in' => 'formData', + 'schema' => ['description' => '电量区间右偏移，电量大于等于输入值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'], + ], + [ 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID或商家自定义门店ID，一次最多插入100条数据。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', - ], + 'schema' => ['description' => '门店ID或商家自定义门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], + ], + [ + 'name' => 'EslStatus', + 'in' => 'formData', + 'schema' => ['description' => '价签状态，可选值：'."\n" + ."\n" + .'- `ESL_STATUS_ONLINE`：在线，已绑定'."\n" + ."\n" + .'- `ESL_STATUS_OFFLINE`：离线，已绑定'."\n" + ."\n" + .'- `ESL_STATUS_UNBIND`：未绑定。', 'type' => 'string', 'required' => false, 'example' => 'ESL_STATUS_ONLINE'], + ], + [ + 'name' => 'EslBarCode', + 'in' => 'formData', + 'schema' => ['description' => '价签条码。', 'type' => 'string', 'required' => false, 'example' => '18bc5a63****'], + ], + [ + 'name' => 'FromBatteryLevel', + 'in' => 'formData', + 'schema' => ['description' => '电量区间左偏移，电量小于等于输入值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'ExtraParams', 'in' => 'formData', + 'schema' => ['description' => '扩展参数', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '系统扩展字段，请忽略；', - 'type' => 'string', - 'required' => false, - 'example' => '{}', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', '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'], + 'EslDevices' => [ + 'description' => '价签信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '价签类型，返回值对应关系：'."\n" + ."\n" + .'- `ESL_TYPE_E_INK`：电子墨水屏幕'."\n" + ."\n" + .'- `ESL_TYPE_DM_LCD`：段码屏幕'."\n" + ."\n" + .'- `ESL_TYPE_FULL_COLOR`：彩色屏幕。', 'type' => 'string', 'example' => 'ESL_TYPE_E_INK'], + 'StoreId' => ['description' => '门店ID。', 'type' => 'string', 'example' => 's-dxsxx****'], + 'EslBarCode' => ['description' => '价签条码。', 'type' => 'string', 'example' => '18bc5a63****'], + 'Model' => ['description' => '价签型号。', 'type' => 'string', 'example' => 'AESL0213'], + 'LastCommunicateTime' => ['description' => '最后通讯时间。', 'type' => 'string', 'example' => '2020-03-16T07:04:16Z'], + 'ScreenHeight' => ['description' => '屏幕高度，单位为px。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ScreenWidth' => ['description' => '屏幕宽度，单位为px。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'EslSignal' => ['description' => '价签信号', 'type' => 'integer', 'format' => 'int32', 'example' => '54'], + 'BatteryLevel' => ['description' => '电量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'EslStatus' => ['description' => '价签状态，返回值对应关系：'."\n" + ."\n" + .'- `ESL_STATUS_ONLINE`：在线，已绑定'."\n" + ."\n" + .'- `ESL_STATUS_OFFLINE`：离线，已绑定'."\n" + ."\n" + .'- `ESL_STATUS_UNBIND`：未绑定。', 'type' => 'string', 'example' => 'ESL_STATUS_ONLINE'], + 'Mac' => ['description' => '价签Mac地址。', 'type' => 'string', 'example' => '18:bc:5a:63:**:**'], + 'TypeEncode' => ['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", 'description' => '类型编码'."\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', 'example' => 'THREE_COLOR'], + 'LayoutId' => ['description' => '布局ID。仅支持传单个ID。', 'type' => 'string', 'example' => '7'], + 'LayoutName' => ['description' => '布局名称。', 'type' => 'string', 'example' => '新增布局'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], + ], + '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":""}]', + 'title' => '查询价签设备', + 'summary' => '查询价签设备信息。', + 'requestParamsDescription' => ' 根据电量区间查询暂时不支持', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-03-30T08:13:18.000Z', 'description' => '请求参数发生变更、响应参数发生变更、错误码发生变更'], + ], + ], + 'DescribeEslModelByTemplateVersion' => [ + 'summary' => '按版本查询设备类型', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], [ - 'name' => 'SyncByItemId', + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'TemplateVersion', 'in' => 'formData', 'schema' => [ - 'description' => '默认值为false，如果配置为true则商品信息会更新门店下其它ItemId字段相同的商品信息；如果一次商品列表中包含多个ItemId相同的商品，则以排在最后那个内容做更新；', - 'type' => 'boolean', + 'description' => '门店模板版本号；', + 'type' => 'string', 'required' => false, - 'example' => 'true', + 'enumValueTitles' => ['1.1.0' => '1.1.0'], + 'example' => '1.1.0', ], ], [ - 'name' => 'ItemInfo', + 'name' => 'PageNumber', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '商品信息列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ActionPrice' => [ - 'description' => '实际销售价格(单位:分)。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '500', - ], - 'ItemTitle' => [ - 'description' => '商品全称，最长100字符；', - 'type' => 'string', - 'required' => true, - 'example' => '光明儿童星', - ], - 'BrandName' => [ - 'description' => '品牌名称，最长64字符；', - 'type' => 'string', - 'required' => false, - 'example' => '光明乳业', - ], - 'SourceCode' => [ - 'description' => '溯源码，最长128个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '1234567', - ], - 'PriceUnit' => [ - 'description' => '计价单位，最长64个字符；', - 'type' => 'string', - 'required' => true, - 'example' => '箱', - ], - 'ForestFirstId' => [ - 'description' => '一类商品类目ID，最长32个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '食品', - ], - 'CustomizeFeatureF' => [ - 'description' => '自定义属性F，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性F', - ], - 'CustomizeFeatureA' => [ - 'description' => '自定义属性A，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性A', - ], - 'CustomizeFeatureK' => [ - 'description' => '自定义属性K，最长128个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性K', - ], - 'TemplateSceneId' => [ - 'description' => '客户自定义模板ID，如果有输入有效字符则匹配客户自定义模板进行商品展示，默认值为空字符“”；', - 'type' => 'string', - 'required' => false, - 'example' => '23452', - ], - 'CustomizeFeatureD' => [ - 'description' => '自定义属性D，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性D', - ], - 'MemberPrice' => [ - 'description' => '会员价(单位:分)。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '800', - ], - 'ModelNumber' => [ - 'description' => '型号，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '330', - ], - 'PromotionStart' => [ - 'description' => '促销开始时间 UTC格式 "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'"。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-10T00:00:00Z', - ], - 'CategoryName' => [ - 'description' => '品类，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '饮料', - ], - 'CustomizeFeatureE' => [ - 'description' => '自定义属性E，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性E', - ], - 'SuggestPrice' => [ - 'description' => '建议零售价(单位:分)。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '600', - ], - 'SaleSpec' => [ - 'description' => '规格，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '330毫升', - ], - 'PromotionText' => [ - 'description' => '促销文案，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '买一送一', - ], - 'PromotionReason' => [ - 'description' => '促销原因，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '儿童节活动', - ], - 'Rank' => [ - 'description' => '等级，最长32个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '1级', - ], - 'CustomizeFeatureG' => [ - 'description' => '自定义属性G，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性G', - ], - 'SalesPrice' => [ - 'description' => '销售价格(单位:分)。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1000', - ], - 'CustomizeFeatureH' => [ - 'description' => '自定义属性H，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性H', - ], - 'OriginalPrice' => [ - 'description' => '原价(单位:分)。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1000', - ], - 'CustomizeFeatureI' => [ - 'description' => '自定义属性I，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性I', - ], - 'ProductionPlace' => [ - 'description' => '产地，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '中国', - ], - 'CustomizeFeatureB' => [ - 'description' => '自定义属性B，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性B', - ], - 'ItemShortTitle' => [ - 'description' => '商品简称，不输入则从商品全称中截取，最长64字符；', - 'type' => 'string', - 'required' => false, - 'example' => '牛奶', - ], - 'CustomizeFeatureN' => [ - 'description' => '自定义属性N，最长128个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性N', - ], - 'BeMember' => [ - 'description' => '是否匹配会员模板显示，默认值为false；', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'TaxFee' => [ - 'description' => '税费信息，最长32个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '增值税', - ], - 'InventoryStatus' => [ - 'description' => '是否匹配缺货模板显示，可选值：'."\n" - ."\n" - .'- `OUT_OF_STOCK`：缺货'."\n" - ."\n" - .'- `NORMAL`：正常。'."\n" - ."\n" - .'默认值NORMAL，如果配置为OUT_OF_STOCK则会配置缺货模板进行显示', - 'type' => 'string', - 'required' => false, - 'example' => 'OUT_OF_STOCK', - ], - 'ItemPicUrl' => [ - 'description' => '商品图片URL，最长128个字符；', - 'type' => 'string', - 'required' => false, - 'example' => 'http://m.taobao.com/xxx.html', - ], - 'SupplierName' => [ - 'description' => '经销商，最长128个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '天猫超市', - ], - 'CustomizeFeatureL' => [ - 'description' => '自定义属性L，最长128个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性L', - ], - 'EnergyEfficiency' => [ - 'description' => '能效，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '2焦/毫升', - ], - 'CustomizeFeatureC' => [ - 'description' => '自定义属性C，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性C', - ], - 'ItemId' => [ - 'description' => '自定义商品条码，只允许输入构成整数的阿拉伯数字。', - 'type' => 'string', - 'required' => true, - 'example' => '1234567', - ], - 'Manufacturer' => [ - 'description' => '生产商，最长128个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '中国制造', - ], - 'Material' => [ - 'description' => '材质，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '新鲜牛奶', - ], - 'CustomizeFeatureJ' => [ - 'description' => '自定义属性J，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性J', - ], - 'CustomizeFeatureO' => [ - 'description' => '自定义属性O，最长128个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性O', - ], - 'CustomizeFeatureP' => [ - 'description' => '自定义属性P，最长512字符', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性P', - ], - 'CustomizeFeatureQ' => [ - 'description' => '自定义属性Q，最长512字符', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性Q', - ], - 'CustomizeFeatureR' => [ - 'description' => '自定义属性R，最长512字符', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性R', - ], - 'CustomizeFeatureS' => [ - 'description' => '自定义属性S，最长512字符', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性S', - ], - 'CustomizeFeatureT' => [ - 'description' => '自定义属性T，最长512字符', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性T', - ], - 'CustomizeFeatureU' => [ - 'description' => '自定义属性U，最长512字符', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性U', - ], - 'CustomizeFeatureV' => [ - 'description' => '自定义属性V，最长512字符', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性V', - ], - 'CustomizeFeatureW' => [ - 'description' => '自定义属性W，最长512字符', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性W', - ], - 'CustomizeFeatureX' => [ - 'description' => '自定义属性X，最长512字符', - 'type' => 'string', - 'required' => false, - 'example' => '345678', - ], - 'CustomizeFeatureY' => [ - 'description' => '自定义属性Y，最长512字符', - 'type' => 'string', - 'required' => false, - 'example' => 'YYY', - ], - 'CustomizeFeatureZ' => [ - 'description' => '自定义属性Z，最长512字符', - 'type' => 'string', - 'required' => false, - 'example' => 'ZZZZ', - ], - 'SkuId' => [ - 'description' => '商品ID(SKU)，最长64个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '1234567', - ], - 'CustomizeFeatureM' => [ - 'description' => '自定义属性M，最长128个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '自定义属性M', - ], - 'BePromotion' => [ - 'description' => '是否匹配促销模板显示，默认值为false；', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'BeSourceCode' => [ - 'description' => '是否匹配溯源模板显示，默认值为false；', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'ForestSecondId' => [ - 'description' => '二类商品类目ID，最长32个字符；', - 'type' => 'string', - 'required' => false, - 'example' => '饮料', - ], - 'ItemQrCode' => [ - 'description' => '商品二维码地址，最长1024个字符；', - 'type' => 'string', - 'required' => false, - 'example' => 'http://m.taobao.com/xxx.html', - ], - 'ItemInfoIndex' => [ - 'description' => '商品信息坐标，此字段不用填。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PromotionEnd' => [ - 'description' => '促销结束时间 UTC格式 "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'"。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-01T00:00:00Z', - ], - 'ItemBarCode' => [ - 'description' => '商品条码，字符不区分大小写，最长64；', - 'type' => 'string', - 'required' => true, - 'example' => '690560583****', - ], - 'BeClearance' => [ - 'description' => '是否匹配出清，默认值为false；', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 500, - ], + 'schema' => ['description' => '分页参数：当前页码，默认值1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => '分页参数：每页显示条数，默认值10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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', - ], - 'BatchResults' => [ - 'description' => '批量返回结果。', + 'TotalCount' => ['title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'RequestId' => ['description' => '请求ID。', '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' => '错误码。取值说明如下：请求成功：不返回ErrorCode字段。 请求失败：返回ErrorCode字段。具体信息，请参见本文的错误码列表。', 'type' => 'string', 'example' => 'MandatoryParameters'], + 'Code' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '-1001'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数ErrMessage错误信息中的%s。', 'type' => 'string', 'example' => 'The specified store %s does not exist.'], + 'DynamicCode' => ['description' => '动态错误码', 'type' => 'string', 'example' => 'PlatformResponseError.%s'], + 'PageNumber' => ['description' => '分页参数：当前页码，默认值1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页参数：每页显示条数，默认值10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'EslModels' => [ + 'description' => '模板版本信息列表。', 'type' => 'array', 'items' => [ + 'description' => '模板版本信息列表。', 'type' => 'object', 'properties' => [ - 'Index' => [ - 'description' => '请求序列下标。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Message' => [ - 'description' => '消息。', - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => '当前商品插入成功与否标识。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'string', - 'example' => 'MandatoryParameters', - ], + 'ModelId' => ['description' => '模型ID', 'type' => 'string', 'example' => '9946366490094af4ab16bfe023ad5f22'], + 'Name' => ['description' => '模型名称。', 'type' => 'string', 'example' => 'test'], + 'Image' => ['description' => '商品图片。', 'type' => 'string', 'example' => '/9xwqexcdaxasada....'], + 'DeviceType' => ['description' => '设备类型', 'type' => 'string', 'example' => '3'], + 'Vendor' => ['description' => '厂商名称'."\n" + ."\n", 'type' => 'string', 'example' => 'ali'], + 'ScreenWidth' => ['description' => '屏幕宽度。', 'type' => 'integer', 'format' => 'int32'], + 'ScreenHeight' => ['description' => '屏幕高度。', 'type' => 'integer', 'format' => 'int32'], + 'EslSize' => ['description' => '价签型号。', 'type' => 'string', 'example' => '800X480'], + 'EslPhysicalSize' => ['description' => '内存大小。单位：gib', 'type' => 'string'], ], ], ], @@ -3137,30 +1858,12 @@ ], ], ], - '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":""}]', - 'title' => 'BatchInsertItems', - 'summary' => '批量新增或修改商品信息，一次最大商品数量为100条，每次不能包含相同的商品条码。', - 'requestParamsDescription' => '商品信息的下列字段会用于匹配模板显示，优先级从高到低'."\n" - ."\n" - .'- TemplateSceneId：尝试匹配客户自定义模板；'."\n" - .'- InventoryStatus：尝试匹配缺货模板；'."\n" - .'- BeMember：尝试匹配会员模板；'."\n" - .'- BeSourceCode && BePromotion：尝试匹配营销模板；'."\n" - .'- BeSourceCode：尝试匹配溯源模板；'."\n" - .'- BePromotion：尝试匹配促销模板；'."\n" - .'- BeClearance：尝试匹配出清模板；', - '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' => [], ], 'DescribeItems' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3171,102 +1874,52 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：每页显示条数，默认值20。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '分页参数：每页显示条数，默认值20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：当前页码，默认值1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页参数：当前页码，默认值1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'ItemTitle', 'in' => 'formData', - 'schema' => [ - 'description' => '商品标题。', - 'type' => 'string', - 'required' => false, - 'example' => '纯牛奶', - ], + 'schema' => ['description' => '商品标题。', 'type' => 'string', 'required' => false, 'example' => '纯牛奶'], ], [ 'name' => 'SkuId', 'in' => 'formData', - 'schema' => [ - 'description' => 'SkuID。', - 'type' => 'string', - 'required' => false, - 'example' => '1234565', - ], + 'schema' => ['description' => 'SkuID。', 'type' => 'string', 'required' => false, 'example' => '1234565'], ], [ 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID或商家自定义门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', - ], + 'schema' => ['description' => '门店ID或商家自定义门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], ], [ 'name' => 'ItemBarCode', 'in' => 'formData', - 'schema' => [ - 'description' => '商品条码;', - 'type' => 'string', - 'required' => false, - 'example' => '6941297417178', - ], + 'schema' => ['description' => '商品条码;', 'type' => 'string', 'required' => false, 'example' => '6941297417178'], ], [ 'name' => 'ItemId', 'in' => 'formData', - 'schema' => [ - 'description' => '商品id', - 'type' => 'string', - 'required' => false, - 'example' => '6959294202901', - ], + 'schema' => ['description' => '商品id', 'type' => 'string', 'required' => false, 'example' => '6959294202901'], ], [ 'name' => 'BePromotion', 'in' => 'formData', - 'schema' => [ - 'description' => '是否匹配促销模板显示，默认值为false；', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '是否匹配促销模板显示，默认值为false；', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'description' => '系统保留字段，请忽略；', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '系统保留字段，请忽略；', 'type' => 'string', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ @@ -3274,435 +1927,114 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TemplateSceneId' => [ - 'description' => '自定义模板ID', - 'type' => 'string', - 'example' => '1223', - ], - 'ErrorMessage' => [ - 'description' => '错误消息。', - 'type' => 'string', - 'example' => 'The specified resource type is invalid.', - ], - 'Success' => [ - 'description' => '请求状态标识。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '出错提示消息', - 'type' => 'string', - 'example' => 'success', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n", - 'type' => 'string', - 'example' => 'The specified store %s does not exist.', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'DynamicCode' => [ - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'PlatformResponseError.%s', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', - ], - 'ErrorCode' => [ - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MandatoryParameters', - ], - 'Code' => [ - 'description' => '内部错误码。', - 'type' => 'string', - 'example' => '-1001', - ], - 'PageNumber' => [ - 'description' => '分页参数：当前页码，默认值1。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页参数：每页显示条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'TemplateSceneId' => ['description' => '自定义模板ID', 'type' => 'string', 'example' => '1223'], + 'ErrorMessage' => ['description' => '错误消息。', 'type' => 'string', 'example' => 'The specified resource type is invalid.'], + 'Success' => ['description' => '请求状态标识。', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '出错提示消息', 'type' => 'string', 'example' => 'success'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的**%s**。'."\n", 'type' => 'string', 'example' => 'The specified store %s does not exist.'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'DynamicCode' => ['description' => '动态错误码', 'type' => 'string', 'example' => 'PlatformResponseError.%s'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'MandatoryParameters'], + 'Code' => ['description' => '内部错误码。', 'type' => 'string', 'example' => '-1001'], + 'PageNumber' => ['description' => '分页参数：当前页码，默认值1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页参数：每页显示条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Items' => [ 'description' => '商品信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ActionPrice' => [ - 'description' => '实际销售价格（单位：分）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'ItemTitle' => [ - 'description' => '商品标题。', - 'type' => 'string', - 'example' => '纯牛奶', - ], - 'BrandName' => [ - 'description' => '品牌名称，最长64字符；', - 'type' => 'string', - 'example' => '阿里巴巴', - ], - 'SourceCode' => [ - 'description' => '溯源码，最长128个字符；', - 'type' => 'string', - 'example' => '123456', - ], - 'PriceUnit' => [ - 'description' => '计价单位，最长64个字符；', - 'type' => 'string', - 'example' => '瓶', - ], - 'ForestFirstId' => [ - 'description' => '一类商品类目ID。', - 'type' => 'string', - 'example' => '酒类', - ], - 'CustomizeFeatureF' => [ - 'description' => '自定义属性F。', - 'type' => 'string', - 'example' => '自定义属性F', - ], - 'CustomizeFeatureA' => [ - 'description' => '自定义属性A。', - 'type' => 'string', - 'example' => '自定义属性A', - ], - 'CustomizeFeatureK' => [ - 'description' => '自定义属性K。', - 'type' => 'string', - 'example' => '自定义属性K', - ], - 'TemplateSceneId' => [ - 'description' => '自定义模板ID', - 'type' => 'string', - 'example' => '11223', - ], - 'CustomizeFeatureD' => [ - 'description' => '自定义属性D。', - 'type' => 'string', - 'example' => '自定义属性D', - ], - 'MemberPrice' => [ - 'description' => '会员价（单位：分）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4000', - ], - 'PromotionStart' => [ - 'description' => '促销开始时间 UTC格式 "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'"。', - 'type' => 'string', - 'example' => '2022-04-25T16:00:00Z', - ], - 'ModelNumber' => [ - 'description' => '型号，最长64个字符；', - 'type' => 'string', - 'example' => 'CH8850AS', - ], - 'CategoryName' => [ - 'description' => '品类，最长64个字符；', - 'type' => 'string', - 'example' => '手机', - ], - 'CustomizeFeatureE' => [ - 'description' => '自定义属性E。', - 'type' => 'string', - 'example' => '自定义属性E', - ], - 'SuggestPrice' => [ - 'description' => '建议零售价（单位：分）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'SaleSpec' => [ - 'description' => '规格，最长64个字符；', - 'type' => 'string', - 'example' => '1台/盒', - ], - 'PromotionText' => [ - 'description' => '促销文案，最长64个字符；', - 'type' => 'string', - 'example' => '买一送一', - ], - 'Rank' => [ - 'description' => '等级，最长32个字符；', - 'type' => 'string', - 'example' => '一级', - ], - 'PromotionReason' => [ - 'description' => '促销原因，最长64个字符；', - 'type' => 'string', - 'example' => '情人节活动', - ], - 'CustomizeFeatureG' => [ - 'description' => '自定义属性G。', - 'type' => 'string', - 'example' => '自定义属性G', - ], - 'SalesPrice' => [ - 'description' => '销售价格（单位：分）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'CustomizeFeatureH' => [ - 'description' => '自定义属性H。', - 'type' => 'string', - 'example' => '自定义属性H', - ], - 'OriginalPrice' => [ - 'description' => '原价（单位：分）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'GmtModified' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '2020-03-09T00:00:00Z', - ], - 'CustomizeFeatureI' => [ - 'description' => '自定义属性I。', - 'type' => 'string', - 'example' => '自定义属性I', - ], - 'ProductionPlace' => [ - 'description' => '产地，最长64个字符；', - 'type' => 'string', - 'example' => '中国', - ], - 'CustomizeFeatureB' => [ - 'description' => '自定义属性B。', - 'type' => 'string', - 'example' => '1:1:16', - ], - 'ItemShortTitle' => [ - 'description' => '商品简称，不输入则从商品全称中截取，最长64字符；', - 'type' => 'string', - 'example' => '牛奶', - ], - 'CustomizeFeatureN' => [ - 'description' => '自定义属性N。', - 'type' => 'string', - 'example' => '自定义属性N', - ], - 'BeMember' => [ - 'description' => '是否匹配会员模板显示，默认值为false；', - 'type' => 'boolean', - 'example' => 'false', - ], - 'TaxFee' => [ - 'description' => '税费信息，最长32个字符；', - 'type' => 'string', - 'example' => '增值税', - ], - 'InventoryStatus' => [ - 'description' => '库存状态，返回值对应关系：'."\n" - ."\n" - .'- `OUT_OF_STOCK`：缺货'."\n" - ."\n" - .'- `NORMAL`：正常。', - 'type' => 'string', - 'example' => 'OUT_OF_STOCK', - ], - 'SupplierName' => [ - 'description' => '社区镜像认证企业名称。', - 'type' => 'string', - 'example' => '天猫超市', - ], - 'ItemPicUrl' => [ - 'description' => '商品图片URL。', - 'type' => 'string', - 'example' => 'http://m.taobao.com/xxx.html', - ], - 'EnergyEfficiency' => [ - 'description' => '能效，最长64个字符；', - 'type' => 'string', - 'example' => '1kw/h', - ], - 'CustomizeFeatureL' => [ - 'description' => '自定义属性L。', - 'type' => 'string', - 'example' => '自定义属性L', - ], - 'CustomizeFeatureC' => [ - 'description' => '自定义属性C。', - 'type' => 'string', - 'example' => '自定义属性C', - ], - 'ItemId' => [ - 'description' => '自定义商品条码，只允许输入构成整数的阿拉伯数字。', - 'type' => 'string', - 'example' => '123456', - ], - 'Manufacturer' => [ - 'description' => '生产商，最长128个字符；', - 'type' => 'string', - 'example' => '广东省深圳', - ], - 'Material' => [ - 'description' => '材质，最长64个字符；', - 'type' => 'string', - 'example' => '金属', - ], - 'CustomizeFeatureO' => [ - 'description' => '自定义属性O。', - 'type' => 'string', - 'example' => '自定义属性O', - ], - 'CustomizeFeatureP' => [ - 'description' => '自定义属性P', - 'type' => 'string', - 'example' => '自定义属性P', - ], - 'CustomizeFeatureQ' => [ - 'description' => '自定义属性Q', - 'type' => 'string', - 'example' => '自定义属性Q', - ], - 'CustomizeFeatureR' => [ - 'description' => '自定义属性R', - 'type' => 'string', - 'example' => '自定义属性R', - ], - 'CustomizeFeatureS' => [ - 'description' => '自定义属性S', - 'type' => 'string', - 'example' => '自定义属性S', - ], - 'CustomizeFeatureT' => [ - 'description' => '自定义属性T', - 'type' => 'string', - 'example' => '自定义属性T', - ], - 'CustomizeFeatureU' => [ - 'description' => '自定义属性U', - 'type' => 'string', - 'example' => '自定义属性U', - ], - 'CustomizeFeatureV' => [ - 'description' => '自定义属性V', - 'type' => 'string', - 'example' => '自定义属性V', - ], - 'CustomizeFeatureW' => [ - 'description' => '自定义属性W', - 'type' => 'string', - 'example' => '自定义属性W', - ], - 'CustomizeFeatureX' => [ - 'description' => '自定义属性X', - 'type' => 'string', - 'example' => '自定义属性X', - ], - 'CustomizeFeatureY' => [ - 'description' => '自定义属性Y', - 'type' => 'string', - 'example' => '自定义属性Y', - ], - 'CustomizeFeatureZ' => [ - 'description' => '自定义属性Z', - 'type' => 'string', - 'example' => '自定义属性Z', - ], - 'CustomizeFeatureJ' => [ - 'description' => '自定义属性J。', - 'type' => 'string', - 'example' => '酸酸甜甜，肉厚饱满', - ], - 'GmtCreate' => [ - 'description' => '敏感数据识别规则的创建时间。格式：时间戳。单位：毫秒。', - 'type' => 'string', - 'example' => '2020-03-09T00:00:00Z', - ], - 'CustomizeFeatureM' => [ - 'description' => '自定义属性M。', - 'type' => 'string', - 'example' => '自定义属性M', - ], - 'BePromotion' => [ - 'description' => '是否匹配促销模板显示，默认值为false；', - 'type' => 'boolean', - 'example' => 'false', - ], - 'SkuId' => [ - 'description' => 'SKuID。', - 'type' => 'string', - 'example' => '123456', - ], - 'BeSourceCode' => [ - 'description' => '是否匹配溯源模板显示，默认值为false；', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ForestSecondId' => [ - 'description' => '二类商品类目ID。', - 'type' => 'string', - 'example' => '白酒', - ], - 'ItemQrCode' => [ - 'description' => '商品二维码地址，最长1024个字符；', - 'type' => 'string', - 'example' => 'http://m.taobao.com/xxx.html', - ], - 'ItemInfoIndex' => [ - 'description' => '商品信息坐标，此字段不用填。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PromotionEnd' => [ - 'description' => '促销结束时间 UTC格式 "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'"。', - 'type' => 'string', - 'example' => '2020-02-11T00:00:00Z', - ], - 'ItemBarCode' => [ - 'description' => '商品条码。', - 'type' => 'string', - 'example' => '01838', - ], - 'BeClearance' => [ - 'description' => '是否添加了自定义属性。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'ActionPrice' => ['description' => '实际销售价格（单位：分）。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'], + 'ItemTitle' => ['description' => '商品标题。', 'type' => 'string', 'example' => '纯牛奶'], + 'BrandName' => ['description' => '品牌名称，最长64字符；', 'type' => 'string', 'example' => '阿里巴巴'], + 'SourceCode' => ['description' => '溯源码，最长128个字符；', 'type' => 'string', 'example' => '123456'], + 'PriceUnit' => ['description' => '计价单位，最长64个字符；', 'type' => 'string', 'example' => '瓶'], + 'ForestFirstId' => ['description' => '一类商品类目ID。', 'type' => 'string', 'example' => '酒类'], + 'CustomizeFeatureF' => ['description' => '自定义属性F。', 'type' => 'string', 'example' => '自定义属性F'], + 'CustomizeFeatureA' => ['description' => '自定义属性A。', 'type' => 'string', 'example' => '自定义属性A'], + 'CustomizeFeatureK' => ['description' => '自定义属性K。', 'type' => 'string', 'example' => '自定义属性K'], + 'TemplateSceneId' => ['description' => '自定义模板ID', 'type' => 'string', 'example' => '11223'], + 'CustomizeFeatureD' => ['description' => '自定义属性D。', 'type' => 'string', 'example' => '自定义属性D'], + 'MemberPrice' => ['description' => '会员价（单位：分）。', 'type' => 'integer', 'format' => 'int32', 'example' => '4000'], + 'PromotionStart' => ['description' => '促销开始时间 UTC格式 "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'"。', 'type' => 'string', 'example' => '2022-04-25T16:00:00Z'], + 'ModelNumber' => ['description' => '型号，最长64个字符；', 'type' => 'string', 'example' => 'CH8850AS'], + 'CategoryName' => ['description' => '品类，最长64个字符；', 'type' => 'string', 'example' => '手机'], + 'CustomizeFeatureE' => ['description' => '自定义属性E。', 'type' => 'string', 'example' => '自定义属性E'], + 'SuggestPrice' => ['description' => '建议零售价（单位：分）。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'], + 'SaleSpec' => ['description' => '规格，最长64个字符；', 'type' => 'string', 'example' => '1台/盒'], + 'PromotionText' => ['description' => '促销文案，最长64个字符；', 'type' => 'string', 'example' => '买一送一'], + 'Rank' => ['description' => '等级，最长32个字符；', 'type' => 'string', 'example' => '一级'], + 'PromotionReason' => ['description' => '促销原因，最长64个字符；', 'type' => 'string', 'example' => '情人节活动'], + 'CustomizeFeatureG' => ['description' => '自定义属性G。', 'type' => 'string', 'example' => '自定义属性G'], + 'SalesPrice' => ['description' => '销售价格（单位：分）。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'], + 'CustomizeFeatureH' => ['description' => '自定义属性H。', 'type' => 'string', 'example' => '自定义属性H'], + 'OriginalPrice' => ['description' => '原价（单位：分）。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'], + 'GmtModified' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-03-09T00:00:00Z'], + 'CustomizeFeatureI' => ['description' => '自定义属性I。', 'type' => 'string', 'example' => '自定义属性I'], + 'ProductionPlace' => ['description' => '产地，最长64个字符；', 'type' => 'string', 'example' => '中国'], + 'CustomizeFeatureB' => ['description' => '自定义属性B。', 'type' => 'string', 'example' => '1:1:16'], + 'ItemShortTitle' => ['description' => '商品简称，不输入则从商品全称中截取，最长64字符；', 'type' => 'string', 'example' => '牛奶'], + 'CustomizeFeatureN' => ['description' => '自定义属性N。', 'type' => 'string', 'example' => '自定义属性N'], + 'BeMember' => ['description' => '是否匹配会员模板显示，默认值为false；', 'type' => 'boolean', 'example' => 'false'], + 'TaxFee' => ['description' => '税费信息，最长32个字符；', 'type' => 'string', 'example' => '增值税'], + 'InventoryStatus' => ['description' => '库存状态，返回值对应关系：'."\n" + ."\n" + .'- `OUT_OF_STOCK`：缺货'."\n" + ."\n" + .'- `NORMAL`：正常。', 'type' => 'string', 'example' => 'OUT_OF_STOCK'], + 'SupplierName' => ['description' => '社区镜像认证企业名称。', 'type' => 'string', 'example' => '天猫超市'], + 'ItemPicUrl' => ['description' => '商品图片URL。', 'type' => 'string', 'example' => 'http://m.taobao.com/xxx.html'], + 'EnergyEfficiency' => ['description' => '能效，最长64个字符；', 'type' => 'string', 'example' => '1kw/h'], + 'CustomizeFeatureL' => ['description' => '自定义属性L。', 'type' => 'string', 'example' => '自定义属性L'], + 'CustomizeFeatureC' => ['description' => '自定义属性C。', 'type' => 'string', 'example' => '自定义属性C'], + 'ItemId' => ['description' => '自定义商品条码，只允许输入构成整数的阿拉伯数字。', 'type' => 'string', 'example' => '123456'], + 'Manufacturer' => ['description' => '生产商，最长128个字符；', 'type' => 'string', 'example' => '广东省深圳'], + 'Material' => ['description' => '材质，最长64个字符；', 'type' => 'string', 'example' => '金属'], + 'CustomizeFeatureO' => ['description' => '自定义属性O。', 'type' => 'string', 'example' => '自定义属性O'], + 'CustomizeFeatureP' => ['description' => '自定义属性P', 'type' => 'string', 'example' => '自定义属性P'], + 'CustomizeFeatureQ' => ['description' => '自定义属性Q', 'type' => 'string', 'example' => '自定义属性Q'], + 'CustomizeFeatureR' => ['description' => '自定义属性R', 'type' => 'string', 'example' => '自定义属性R'], + 'CustomizeFeatureS' => ['description' => '自定义属性S', 'type' => 'string', 'example' => '自定义属性S'], + 'CustomizeFeatureT' => ['description' => '自定义属性T', 'type' => 'string', 'example' => '自定义属性T'], + 'CustomizeFeatureU' => ['description' => '自定义属性U', 'type' => 'string', 'example' => '自定义属性U'], + 'CustomizeFeatureV' => ['description' => '自定义属性V', 'type' => 'string', 'example' => '自定义属性V'], + 'CustomizeFeatureW' => ['description' => '自定义属性W', 'type' => 'string', 'example' => '自定义属性W'], + 'CustomizeFeatureX' => ['description' => '自定义属性X', 'type' => 'string', 'example' => '自定义属性X'], + 'CustomizeFeatureY' => ['description' => '自定义属性Y', 'type' => 'string', 'example' => '自定义属性Y'], + 'CustomizeFeatureZ' => ['description' => '自定义属性Z', 'type' => 'string', 'example' => '自定义属性Z'], + 'CustomizeFeatureJ' => ['description' => '自定义属性J。', 'type' => 'string', 'example' => '酸酸甜甜，肉厚饱满'], + 'GmtCreate' => ['description' => '敏感数据识别规则的创建时间。格式：时间戳。单位：毫秒。', 'type' => 'string', 'example' => '2020-03-09T00:00:00Z'], + 'CustomizeFeatureM' => ['description' => '自定义属性M。', 'type' => 'string', 'example' => '自定义属性M'], + 'BePromotion' => ['description' => '是否匹配促销模板显示，默认值为false；', 'type' => 'boolean', 'example' => 'false'], + 'SkuId' => ['description' => 'SKuID。', 'type' => 'string', 'example' => '123456'], + 'BeSourceCode' => ['description' => '是否匹配溯源模板显示，默认值为false；', 'type' => 'boolean', 'example' => 'false'], + 'ForestSecondId' => ['description' => '二类商品类目ID。', 'type' => 'string', 'example' => '白酒'], + 'ItemQrCode' => ['description' => '商品二维码地址，最长1024个字符；', 'type' => 'string', 'example' => 'http://m.taobao.com/xxx.html'], + 'ItemInfoIndex' => ['description' => '商品信息坐标，此字段不用填。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PromotionEnd' => ['description' => '促销结束时间 UTC格式 "yyyy-MM-dd\'T\'HH:mm:ss\'Z\'"。', 'type' => 'string', 'example' => '2020-02-11T00:00:00Z'], + 'ItemBarCode' => ['description' => '商品条码。', 'type' => 'string', 'example' => '01838'], + 'BeClearance' => ['description' => '是否添加了自定义属性。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], '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' => '查询商品', 'summary' => '查询商品信。', - ], - 'AddUser' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2022-07-18T13:13:48.000Z', 'description' => '响应参数发生变更'], ], + ], + 'DescribeStoreByTemplateVersion' => [ + 'summary' => '查询模板应用到的门店', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3711,109 +2043,60 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'UserId', - 'in' => 'formData', - 'schema' => [ - 'description' => '阿里云子账号UID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '134****', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '客户端token', - 'type' => 'string', - 'required' => false, - 'example' => '1*', - ], - ], - [ - 'name' => 'ExtraParams', + 'name' => 'TemplateVersion', 'in' => 'formData', - 'schema' => [ - 'description' => '系统扩展字段，请忽略；', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '门店模板版本号；', 'type' => 'string', 'required' => false, 'example' => '1.1.0'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '请求ID。', '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' => 'HTTP状态码。', 'type' => 'string', 'example' => '-1001'], + 'Message' => ['description' => '响应消息，若成功请求为success', 'type' => 'string', 'example' => 'success'], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的%s。', 'type' => 'string', 'example' => 'The specified store %s does not exist.'], + 'DynamicCode' => ['description' => '与本次请求相关的动态错误码。', 'type' => 'string', 'example' => 'PlatformResponseError.%s'], + 'Stores' => [ + 'description' => '门店信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '门店信息列表。', + 'type' => 'object', + 'properties' => [ + 'StoreName' => ['description' => '门店名称。', 'type' => 'string', 'example' => '天猫旗舰店'], + 'StoreId' => ['description' => '门店ID。', 'type' => 'string', 'example' => 's-nxwd8sutd6'], + 'ParentId' => ['description' => '父门店ID。', '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', 'description' => ''], + 'Level' => ['description' => '级别。', 'type' => 'string', 'example' => '1级'], + 'TemplateVersion' => ['description' => '门店模板版本号；', 'type' => 'string', 'example' => '1.1.0'], + 'TimeZone' => ['description' => '时区。', 'type' => 'string', 'example' => 'GMT+08:00'], + ], + ], ], ], ], ], ], - '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":""}]', - 'title' => '新增用户', - 'summary' => '新增用户。', - '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' => [], ], - 'DeleteUser' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeStoreConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3822,32 +2105,19 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'UserId', + 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'description' => '阿里云子账号UID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1344***', - ], + 'schema' => ['description' => '门店ID或商家自定义门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], ], [ 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'description' => '系统扩展字段，请忽略；', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '系统保留字段，请忽略', 'type' => 'string', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ @@ -3855,66 +2125,55 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '请求ID。', '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' => '门店ID。', 'type' => 'string', 'example' => 's-dxsxx****'], + 'EnableNotification' => ['description' => '是否启用钉钉异常消息通知。', 'type' => 'boolean', 'example' => 'true'], + 'NotificationWebHook' => ['description' => '钉钉消息的webHook地址。', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?.'], + 'NotificationSilentTimes' => ['description' => '用户配置的静默期，不发通知消息，JSON列表，单位为分钟，每个JSON字段表示一个静默期时间段，里面的值为UTC时间下一天里面的分钟数，from为静默期的起始分钟数，to为结束分钟数。', 'type' => 'string', 'example' => '[{"from":960,"to":1320},{"from":1170,"to":1230}]'], + 'SubscribeContents' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Category' => ['type' => 'string', 'description' => ''], + 'Enable' => ['type' => 'boolean', 'description' => ''], + 'Threshold' => ['type' => 'string', 'description' => ''], + 'AtAll' => ['type' => 'boolean', 'description' => ''], + 'AtMobileList' => ['type' => 'string', 'description' => ''], + ], + 'description' => '', + ], + 'description' => '', + ], + ], ], ], + 'description' => '', ], ], ], - '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' => '删除用户', - 'summary' => '删除用户。', + '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', + 'summary' => '查询门店配置信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], ], - 'AssignUser' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeStores' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3923,63 +2182,54 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Stores', + 'name' => 'UserStoreCode', 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID列表。', - 'type' => 'string', - 'required' => false, - 'example' => '[s-dxsxxxxxx,s-dxsyyyyyyy]', - ], + 'schema' => ['description' => '商家自定义门店ID。', 'type' => 'string', 'required' => false, 'example' => '123456'], ], [ - 'name' => 'UserId', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => '阿里云子账号UID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1344***', - ], + 'schema' => ['description' => '分页参数：当前页码，默认值1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'UserType', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '用户类型，可选值：'."\n" - ."\n" - .'- `USER_TYPE_COMPANY_ROOT`：高级商家管理员，商家和门店相关账号的增删改查；'."\n" - ."\n" - .'- `USER_TYPE_COMPANY_ADMIN`：商家管理员，商家下的门店相关账号的增删改查；'."\n" - ."\n" - .'- `USER_TYPE_STORE_ADMIN`：门店管理员，一个门店管理员可关联多个门店，但一个门店仅能关联一个门店管理员；'."\n" - ."\n" - .'- `USER_TYPE_STORE_OPERATOR`：门店操作员，仅能关联一个门店；'."\n" - ."\n" - .'- `USER_TYPE_GUEST`：没有任何权限的访客。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'USER_TYPE_COMPANY_OWNER', - ], + 'schema' => ['description' => '分页参数：每页显示条数，默认值10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'StoreName', + 'in' => 'formData', + 'schema' => ['description' => '门店名称。', 'type' => 'string', 'required' => false, 'example' => '天猫超市'], + ], + [ + 'name' => 'ToDate', + 'in' => 'formData', + 'schema' => ['description' => '门店创建时间：结束时间。', 'type' => 'string', 'required' => false, 'example' => '2020-03-08T02:58:16Z'], + ], + [ + 'name' => 'StoreId', + 'in' => 'formData', + 'schema' => ['description' => '门店ID。', 'type' => 'string', 'required' => false, 'example' => 's-dxsxx****'], + ], + [ + 'name' => 'FromDate', + 'in' => 'formData', + 'schema' => ['description' => '门店创建时间：开始时间。', 'type' => 'string', 'required' => false, 'example' => '2020-03-06T02:58:16Z'], ], [ 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'description' => '扩展参数', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '系统保留字段，请忽略；', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], + [ + 'name' => 'TemplateVersion', + 'in' => 'formData', + 'schema' => ['description' => '门店配置的模板版本号；', 'type' => 'string', 'required' => false, 'example' => '1.1.0'], ], ], 'responses' => [ @@ -3987,66 +2237,59 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '请求ID。', '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'], + 'Stores' => [ + 'description' => '门店信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StoreId' => ['description' => '门店ID。', 'type' => 'string', 'example' => 's-dxsxx**** '], + 'ParentId' => ['description' => '父门店ID。', 'type' => 'string', 'example' => 's-aasx****'], + 'TimeZone' => ['description' => '门店时区配置', 'type' => 'string', 'example' => 'GMT+08:00'], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-03-06T02:58:16Z'], + 'StoreName' => ['description' => '门店名称。', 'type' => 'string', 'example' => '天猫旗舰店'], + 'GmtModified' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2020-03-06T02:58:16Z'], + 'TemplateVersion' => ['description' => '门店模板版本号；', 'type' => 'string', 'example' => '1.1.0'], + 'Level' => ['description' => '级别。', 'type' => 'string', 'example' => '1级'], + 'Phone' => ['description' => '门店所在监督工商局的监督电话。', 'type' => 'string', 'example' => '0571-5666888'], + 'UserStoreCode' => ['description' => '商家自定义门店ID。', 'type' => 'string', 'example' => '20200201'], + 'BarCodeEncode' => ['description' => '条形码编码方式：0：Code128 ，1：EAN13（默认0）', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1', 'minimum' => '0', 'example' => '0', 'default' => '0'], + 'AutoUnbindOfflineEsl' => ['title' => '是否启用自动解绑离线价签', 'description' => '是否启用自动解绑离线价签', 'type' => 'boolean', 'example' => 'true', 'default' => 'false'], + 'AutoUnbindDays' => ['title' => '自动解绑离线价签条件-价签离线天数', 'description' => '自动解绑离线价签条件-价签离线天数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '36500'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], - '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', - 'summary' => '分配用户权限。', + '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":""}]', + 'title' => '查询门店', + 'summary' => '查询门店基础信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UnassignUser' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2022-11-23T03:19:05.000Z', 'description' => '响应参数发生变更'], ], + ], + 'DescribeTemplateByModel' => [ + 'summary' => '模板查询。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4055,32 +2298,34 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'UserId', + 'name' => 'EslSize', 'in' => 'formData', - 'schema' => [ - 'description' => '阿里云子账号UID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1344***', - ], + 'schema' => ['description' => '价签尺寸', 'type' => 'string', 'required' => false, 'example' => '200X200'], ], [ - 'name' => 'ExtraParams', + 'name' => 'DeviceType', 'in' => 'formData', - 'schema' => [ - 'description' => '系统保留字段，请忽略', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '设备类型', 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'TemplateVersion', + 'in' => 'formData', + 'schema' => ['description' => '门店模板版本号；', 'type' => 'string', 'required' => false, 'example' => '1.1.0'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => '分页参数：当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => '分页参数：每页显示条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -4088,67 +2333,54 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '请求ID。', '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' => '错误码。取值说明如下：请求成功：不返回ErrorCode字段。 请求失败：返回ErrorCode字段。具体信息，请参见本文的错误码列表。', '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' => '模板ID', 'type' => 'string', 'example' => '772629024140898304'], + 'TemplateName' => ['description' => '模板名称', 'type' => 'string', 'example' => '常规'], + 'EslSize' => ['description' => '价签尺寸', 'type' => 'string', 'example' => '250X122'], + 'EslType' => ['description' => '价签类型，返回值对应关系：-[unk]esl_type_e_ink[unk]：电子墨水屏幕-[unk]px_type_dm_lcd[unk]：段码屏幕-[unk]x-ddl_type_full_color[unk]：彩色屏幕。', 'type' => 'string'], + 'Width' => ['description' => '宽。单位：px。', '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' => '匹配自定义模板ID显示', 'type' => 'string', 'example' => '大甩卖'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], - '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', - 'summary' => '取消用户权限。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + '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' => '响应参数发生变更'], + ['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => '响应参数发生变更'], + ], ], 'DescribeUserLog' => [ 'summary' => '查询用户的操作日志记录。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4159,174 +2391,104 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ItemShortTitle', 'in' => 'formData', - 'schema' => [ - 'description' => '商品短标题。', - 'type' => 'string', - 'required' => false, - 'example' => '牛奶', - ], + 'schema' => ['description' => '商品短标题。', 'type' => 'string', 'required' => false, 'example' => '牛奶'], ], [ 'name' => 'OperationType', 'in' => 'formData', - 'schema' => [ - 'description' => '日志类型，可选值：'."\n" - ."\n" - .'- `OPERATION_TYPE_BIND`：价签绑定'."\n" - ."\n" - .'- `OPERATION_TYPE_UNBIND`：价签解绑'."\n" - ."\n" - .'- `OPERATION_TYPE_FORCE_UPDATE`：价签刷新 - 主动刷新'."\n" - ."\n" - .'- `OPERATION_TYPE_ITEM_CHANGE_UPDATE`：价签刷新 - 商品更新'."\n" - ."\n" - .'- `OPERATION_TYPE_ALL_UPDATE`：价签刷新 - 门店级刷新'."\n" - ."\n" - .'- `OPERATION_TYPE_SEND_FAILED_RETRY`：操作重试 - 发送失败'."\n" - ."\n" - .'- `OPERATION_TYPE_DISPLAY_FAILED_RETRY`：操作重试 - 显示失败'."\n" - ."\n" - .'- `OPERATION_TYPE_LIGHT_UP_ESL_LED`：价签亮灯。', - 'type' => 'string', - 'required' => false, - 'example' => 'OPERATION_TYPE_BIND', - ], + 'schema' => ['description' => '日志类型，可选值：'."\n" + ."\n" + .'- `OPERATION_TYPE_BIND`：价签绑定'."\n" + ."\n" + .'- `OPERATION_TYPE_UNBIND`：价签解绑'."\n" + ."\n" + .'- `OPERATION_TYPE_FORCE_UPDATE`：价签刷新 - 主动刷新'."\n" + ."\n" + .'- `OPERATION_TYPE_ITEM_CHANGE_UPDATE`：价签刷新 - 商品更新'."\n" + ."\n" + .'- `OPERATION_TYPE_ALL_UPDATE`：价签刷新 - 门店级刷新'."\n" + ."\n" + .'- `OPERATION_TYPE_SEND_FAILED_RETRY`：操作重试 - 发送失败'."\n" + ."\n" + .'- `OPERATION_TYPE_DISPLAY_FAILED_RETRY`：操作重试 - 显示失败'."\n" + ."\n" + .'- `OPERATION_TYPE_LIGHT_UP_ESL_LED`：价签亮灯。', 'type' => 'string', 'required' => false, 'example' => 'OPERATION_TYPE_BIND'], ], [ 'name' => 'EslBarCode', 'in' => 'formData', - 'schema' => [ - 'description' => '价签条码。', - 'type' => 'string', - 'required' => false, - 'example' => '18bc5a63****', - ], + 'schema' => ['description' => '价签条码。', 'type' => 'string', 'required' => false, 'example' => '18bc5a63****'], ], [ 'name' => 'FromDate', 'in' => 'formData', - 'schema' => [ - 'description' => '查询操作日志：开始时间。按照ISO8601标准表示，使用UTC+0时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-03-18T02:26:28Z', - ], + 'schema' => ['description' => '查询操作日志：开始时间。按照ISO8601标准表示，使用UTC+0时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2020-03-18T02:26:28Z'], ], [ 'name' => 'ItemBarCode', 'in' => 'formData', - 'schema' => [ - 'description' => '商品条码。', - 'type' => 'string', - 'required' => false, - 'example' => '690560583****', - ], + 'schema' => ['description' => '商品条码。', 'type' => 'string', 'required' => false, 'example' => '690560583****'], ], [ 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID或商家自定义门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', - ], + 'schema' => ['description' => '门店ID或商家自定义门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], ], [ 'name' => 'ToDate', 'in' => 'formData', - 'schema' => [ - 'description' => '查询操作日志：结束时间。按照ISO8601标准表示，使用UTC+0时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - 'example' => '2020-03-17T02:26:28Z', - ], + 'schema' => ['description' => '查询操作日志：结束时间。按照ISO8601标准表示，使用UTC+0时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2020-03-17T02:26:28Z'], ], [ 'name' => 'LogId', 'in' => 'formData', - 'schema' => [ - 'description' => '日志ID。', - 'type' => 'string', - 'required' => false, - 'example' => '123456', - ], + 'schema' => ['description' => '日志ID。', 'type' => 'string', 'required' => false, 'example' => '123456'], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：每页显示条数，默认值10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '分页参数：每页显示条数，默认值10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'OperationStatus', 'in' => 'formData', - 'schema' => [ - 'description' => '日志状态，可选值：'."\n" - ."\n" - .'- `OPERATION_STATUS_NEW`：新建'."\n" - ."\n" - .'- `OPERATION_STATUS_SENT`：已发送'."\n" - ."\n" - .'- `OPERATION_STATUS_DISPLAY`：已显示'."\n" - ."\n" - .'- `OPERATION_STATUS_DELETE`：已删除'."\n" - ."\n" - .'- `OPERATION_STATUS_BREAK`：中断'."\n" - ."\n" - .'- `OPERATION_STATUS_DEVICE_RETRY_DISPLAY`：重试中'."\n" - ."\n" - .'- `OPERATION_STATUS_SEND_FAILED`：发送失败'."\n" - ."\n" - .'- `OPERATION_STATUS_DISPLAY_FAILED`：显示失败。', - 'type' => 'string', - 'required' => false, - 'example' => 'OPERATION_STATUS_NEW', - ], + 'schema' => ['description' => '日志状态，可选值：'."\n" + ."\n" + .'- `OPERATION_STATUS_NEW`：新建'."\n" + ."\n" + .'- `OPERATION_STATUS_SENT`：已发送'."\n" + ."\n" + .'- `OPERATION_STATUS_DISPLAY`：已显示'."\n" + ."\n" + .'- `OPERATION_STATUS_DELETE`：已删除'."\n" + ."\n" + .'- `OPERATION_STATUS_BREAK`：中断'."\n" + ."\n" + .'- `OPERATION_STATUS_DEVICE_RETRY_DISPLAY`：重试中'."\n" + ."\n" + .'- `OPERATION_STATUS_SEND_FAILED`：发送失败'."\n" + ."\n" + .'- `OPERATION_STATUS_DISPLAY_FAILED`：显示失败。', 'type' => 'string', 'required' => false, 'example' => 'OPERATION_STATUS_NEW'], ], [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：当前页码，默认值1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页参数：当前页码，默认值1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'description' => '阿里云账号UID。', - 'type' => 'string', - 'required' => false, - 'example' => '134****', - ], + 'schema' => ['description' => '阿里云账号UID。', 'type' => 'string', 'required' => false, 'example' => '134****'], ], [ 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'description' => '系统保留字段，请忽略；', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '系统保留字段，请忽略；', 'type' => 'string', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ @@ -4334,215 +2496,91 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', - ], - 'ErrorMessage' => [ - 'description' => '错误消息。', - 'type' => 'string', - 'example' => 'The specified resource type is invalid.', - ], - 'Success' => [ - 'description' => 'POP请求成功与否标识。', - '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', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF'], + 'ErrorMessage' => ['description' => '错误消息。', 'type' => 'string', 'example' => 'The specified resource type is invalid.'], + 'Success' => ['description' => 'POP请求成功与否标识。', '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' => '日志信息列表。', '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' => '阿里云子账号UID。', - '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' => '日志类型，可选值：'."\n" - ."\n" - .'- `OPERATION_TYPE_BIND`：价签绑定'."\n" - ."\n" - .'- `OPERATION_TYPE_UNBIND`：价签解绑'."\n" - ."\n" - .'- `OPERATION_TYPE_FORCE_UPDATE`：价签刷新 - 主动刷新'."\n" - ."\n" - .'- `OPERATION_TYPE_ITEM_CHANGE_UPDATE`：价签刷新 - 商品更新'."\n" - ."\n" - .'- `OPERATION_TYPE_ALL_UPDATE`：价签刷新 - 门店级刷新'."\n" - ."\n" - .'- `OPERATION_TYPE_SEND_FAILED_RETRY`：操作重试 - 发送失败'."\n" - ."\n" - .'- `OPERATION_TYPE_DISPLAY_FAILED_RETRY`：操作重试 - 显示失败'."\n" - ."\n" - .'- `OPERATION_TYPE_TIMEOUT_RETRY`：操作重试 - 操作超时'."\n" - ."\n" - .'- `OPERATION_TYPE_ESL_NOT_FOUND_RETRY`：操作重试 - 未知设备'."\n" - ."\n" - .'- `OPERATION_TYPE_TEMPLATE_NOT_FOUND_RETRY`：操作重试 - 未知模板'."\n" - ."\n" - .'- `OPERATION_TYPE_DRAW_PICTURE_FAILED_RETRY`：操作重试- 异常模板'."\n" - ."\n" - .'- `OPERATION_TYPE_BATCH_TIMES_DIRECTIONAL_REFRESH`：价签刷新 - 商品导入'."\n" - ."\n" - .'- `OPERATION_TYPE_ON_LINE_RETRY`：价签刷新 - 上线重试'."\n" - ."\n" - .'- `OPERATION_TYPE_LIGHT_UP_ESL_LED`：亮灯。', - 'type' => 'string', - 'example' => 'OPERATION_TYPE_BIND', - ], - 'OperationResponseTime' => [ - 'description' => '操作响应时间。', - 'type' => 'string', - 'example' => '2020-03-17T02:26:17Z', - ], - 'OperationStatus' => [ - 'description' => '日志状态，返回值对应关系：'."\n" - ."\n" - .'- `OPERATION_STATUS_NEW`：新建操作'."\n" - ."\n" - .'- `OPERATION_STATUS_SENT`：发送操作'."\n" - ."\n" - .'- `OPERATION_STATUS_DISPLAY`：完成操作'."\n" - ."\n" - .'- `OPERATION_STATUS_DELETE`：删除操作'."\n" - ."\n" - .'- `OPERATION_STATUS_DEVICE_RETRY_DISPLAY`：重试操作'."\n" - ."\n" - .'- `OPERATION_STATUS_SEND_FAILED`：发送失败'."\n" - ."\n" - .'- `OPERATION_STATUS_DISPLAY_FAILED`：刷新失败。', - 'type' => 'string', - 'example' => 'OPERATION_STATUS_NEW', - ], - 'StoreId' => [ - 'description' => '门店ID。', - 'type' => 'string', - 'example' => 's-dxsxxx****', - ], - 'ItemShortTitle' => [ - 'description' => '商品短标题。', - 'type' => 'string', - 'example' => '牛奶', - ], - 'LogId' => [ - 'description' => '日志ID。', - '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' => '耗时（单位：ms）。', - 'type' => 'string', - 'example' => '10', - ], - 'ItemBarCode' => [ - 'description' => '商品条码。', - 'type' => 'string', - 'example' => '690560583****', - ], - 'I18nResultKey' => [ - 'type' => 'string', - ], + 'EslBarCode' => ['description' => '价签条码。', 'type' => 'string', 'example' => '18bc5a63****'], + 'OperationSendTime' => ['description' => '操作发送时间。', 'type' => 'string', 'example' => '2020-03-17T02:25:17Z'], + 'ActionPrice' => ['description' => '实际销售价格（单位：分）。', 'type' => 'string', 'example' => '500'], + 'UserId' => ['description' => '阿里云子账号UID。', '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' => '日志类型，可选值：'."\n" + ."\n" + .'- `OPERATION_TYPE_BIND`：价签绑定'."\n" + ."\n" + .'- `OPERATION_TYPE_UNBIND`：价签解绑'."\n" + ."\n" + .'- `OPERATION_TYPE_FORCE_UPDATE`：价签刷新 - 主动刷新'."\n" + ."\n" + .'- `OPERATION_TYPE_ITEM_CHANGE_UPDATE`：价签刷新 - 商品更新'."\n" + ."\n" + .'- `OPERATION_TYPE_ALL_UPDATE`：价签刷新 - 门店级刷新'."\n" + ."\n" + .'- `OPERATION_TYPE_SEND_FAILED_RETRY`：操作重试 - 发送失败'."\n" + ."\n" + .'- `OPERATION_TYPE_DISPLAY_FAILED_RETRY`：操作重试 - 显示失败'."\n" + ."\n" + .'- `OPERATION_TYPE_TIMEOUT_RETRY`：操作重试 - 操作超时'."\n" + ."\n" + .'- `OPERATION_TYPE_ESL_NOT_FOUND_RETRY`：操作重试 - 未知设备'."\n" + ."\n" + .'- `OPERATION_TYPE_TEMPLATE_NOT_FOUND_RETRY`：操作重试 - 未知模板'."\n" + ."\n" + .'- `OPERATION_TYPE_DRAW_PICTURE_FAILED_RETRY`：操作重试- 异常模板'."\n" + ."\n" + .'- `OPERATION_TYPE_BATCH_TIMES_DIRECTIONAL_REFRESH`：价签刷新 - 商品导入'."\n" + ."\n" + .'- `OPERATION_TYPE_ON_LINE_RETRY`：价签刷新 - 上线重试'."\n" + ."\n" + .'- `OPERATION_TYPE_LIGHT_UP_ESL_LED`：亮灯。', 'type' => 'string', 'example' => 'OPERATION_TYPE_BIND'], + 'OperationResponseTime' => ['description' => '操作响应时间。', 'type' => 'string', 'example' => '2020-03-17T02:26:17Z'], + 'OperationStatus' => ['description' => '日志状态，返回值对应关系：'."\n" + ."\n" + .'- `OPERATION_STATUS_NEW`：新建操作'."\n" + ."\n" + .'- `OPERATION_STATUS_SENT`：发送操作'."\n" + ."\n" + .'- `OPERATION_STATUS_DISPLAY`：完成操作'."\n" + ."\n" + .'- `OPERATION_STATUS_DELETE`：删除操作'."\n" + ."\n" + .'- `OPERATION_STATUS_DEVICE_RETRY_DISPLAY`：重试操作'."\n" + ."\n" + .'- `OPERATION_STATUS_SEND_FAILED`：发送失败'."\n" + ."\n" + .'- `OPERATION_STATUS_DISPLAY_FAILED`：刷新失败。', 'type' => 'string', 'example' => 'OPERATION_STATUS_NEW'], + 'StoreId' => ['description' => '门店ID。', 'type' => 'string', 'example' => 's-dxsxxx****'], + 'ItemShortTitle' => ['description' => '商品短标题。', 'type' => 'string', 'example' => '牛奶'], + 'LogId' => ['description' => '日志ID。', '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' => '耗时（单位：ms）。', 'type' => 'string', 'example' => '10'], + 'ItemBarCode' => ['description' => '商品条码。', 'type' => 'string', 'example' => '690560583****'], + 'I18nResultKey' => ['type' => 'string', 'description' => ''], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], @@ -4551,16 +2589,11 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], ], 'DescribeUsers' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4571,83 +2604,49 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'UserType', 'in' => 'formData', - 'schema' => [ - 'description' => '用户类型，可选值：'."\n" - ."\n" - .'- `USER_TYPE_COMPANY_OWNER`：商家主账号'."\n" - ."\n" - .'- `USER_TYPE_COMPANY_ROOT`：高级商家管理员'."\n" - ."\n" - .'- `USER_TYPE_COMPANY_ADMIN`：商家管理员'."\n" - ."\n" - .'- `USER_TYPE_STORE_ADMIN`：门店管理员'."\n" - ."\n" - .'- `USER_TYPE_STORE_OPERATOR`：门店操作员'."\n" - ."\n" - .'- `USER_TYPE_GUEST`：没有任何权限的访客。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'USER_TYPE_COMPANY_OWNER', - ], + 'schema' => ['description' => '用户类型，可选值：'."\n" + ."\n" + .'- `USER_TYPE_COMPANY_OWNER`：商家主账号'."\n" + ."\n" + .'- `USER_TYPE_COMPANY_ROOT`：高级商家管理员'."\n" + ."\n" + .'- `USER_TYPE_COMPANY_ADMIN`：商家管理员'."\n" + ."\n" + .'- `USER_TYPE_STORE_ADMIN`：门店管理员'."\n" + ."\n" + .'- `USER_TYPE_STORE_OPERATOR`：门店操作员'."\n" + ."\n" + .'- `USER_TYPE_GUEST`：没有任何权限的访客。'."\n", 'type' => 'string', 'required' => false, 'example' => 'USER_TYPE_COMPANY_OWNER'], ], [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：当前页码，默认值1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页参数：当前页码，默认值1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'description' => '阿里云子账号UID。', - 'type' => 'string', - 'required' => false, - 'example' => '1344***', - ], + 'schema' => ['description' => '阿里云子账号UID。', 'type' => 'string', 'required' => false, 'example' => '1344***'], ], [ 'name' => 'UserName', 'in' => 'formData', - 'schema' => [ - 'description' => '用户姓名。', - 'type' => 'string', - 'required' => false, - 'example' => '张三', - ], + 'schema' => ['description' => '用户姓名。', 'type' => 'string', 'required' => false, 'example' => '张三'], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：每页显示条数，默认值10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '分页参数：每页显示条数，默认值10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'description' => '系统保留字段，请忽略；', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '系统保留字段，请忽略；', 'type' => 'string', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ @@ -4655,136 +2654,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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', - ], + 'RequestId' => ['description' => '请求ID。', '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' => '用户信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'UserType' => [ - 'description' => '用户类型，可选值：'."\n" - ."\n" - .'- `USER_TYPE_COMPANY_OWNER`：商家主账号'."\n" - ."\n" - .'- `USER_TYPE_COMPANY_ROOT`：高级商家管理员'."\n" - ."\n" - .'- `USER_TYPE_COMPANY_ADMIN`：商家管理员'."\n" - ."\n" - .'- `USER_TYPE_STORE_ADMIN`：门店管理员'."\n" - ."\n" - .'- `USER_TYPE_STORE_OPERATOR`：门店操作员'."\n" - ."\n" - .'- `USER_TYPE_GUEST`：没有任何权限的访客。', - 'type' => 'string', - 'example' => 'USER_TYPE_COMPANY_OWNER', - ], - 'UserId' => [ - 'description' => '阿里云子账号UID。', - 'type' => 'string', - 'example' => '1344***', - ], - 'Stores' => [ - 'description' => '门店ID列表。', - 'type' => 'string', - 'example' => '[s-dxsxxxxxx,s-dxsyyyyyyy]', - ], - 'UserName' => [ - 'description' => '用户姓名。', - 'type' => 'string', - 'example' => '张三', - ], - 'Bid' => [ - 'description' => '账号类型；'."\n" - .'26842：阿里云', - 'type' => 'string', - 'example' => '26842', - ], - 'OwnerId' => [ - 'description' => '阿里云主账号；', - 'type' => 'string', - 'example' => '1212124434535', - ], + 'UserType' => ['description' => '用户类型，可选值：'."\n" + ."\n" + .'- `USER_TYPE_COMPANY_OWNER`：商家主账号'."\n" + ."\n" + .'- `USER_TYPE_COMPANY_ROOT`：高级商家管理员'."\n" + ."\n" + .'- `USER_TYPE_COMPANY_ADMIN`：商家管理员'."\n" + ."\n" + .'- `USER_TYPE_STORE_ADMIN`：门店管理员'."\n" + ."\n" + .'- `USER_TYPE_STORE_OPERATOR`：门店操作员'."\n" + ."\n" + .'- `USER_TYPE_GUEST`：没有任何权限的访客。', 'type' => 'string', 'example' => 'USER_TYPE_COMPANY_OWNER'], + 'UserId' => ['description' => '阿里云子账号UID。', 'type' => 'string', 'example' => '1344***'], + 'Stores' => ['description' => '门店ID列表。', 'type' => 'string', 'example' => '[s-dxsxxxxxx,s-dxsyyyyyyy]'], + 'UserName' => ['description' => '用户姓名。', 'type' => 'string', 'example' => '张三'], + 'Bid' => ['description' => '账号类型；'."\n" + .'26842：阿里云', 'type' => 'string', 'example' => '26842'], + 'OwnerId' => ['description' => '阿里云主账号；', 'type' => 'string', 'example' => '1212124434535'], 'DingTalkInfos' => [ 'description' => '钉钉账号信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DingTalkCompanyId' => [ - 'description' => '钉钉商家ID', - 'type' => 'string', - 'example' => '13124', - ], - 'DingTalkUserId' => [ - 'description' => '钉钉用户ID', - 'type' => 'string', - 'example' => '3455566', - ], + 'DingTalkCompanyId' => ['description' => '钉钉商家ID', 'type' => 'string', 'example' => '13124'], + 'DingTalkUserId' => ['description' => '钉钉用户ID', 'type' => 'string', 'example' => '3455566'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], @@ -4794,16 +2717,13 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-26T06:18:37.000Z', 'description' => '错误码发生变更'], + ], ], 'GetUser' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4814,29 +2734,17 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'description' => '阿里云子账号UID。', - 'type' => 'string', - 'required' => false, - 'example' => '1344***', - ], + 'schema' => ['description' => '阿里云子账号UID。', 'type' => 'string', 'required' => false, 'example' => '1344***'], ], [ 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'description' => '系统保留字段，请忽略；', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '系统保留字段，请忽略；', 'type' => 'string', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ @@ -4844,127 +2752,63 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '请求ID。', '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' => '用户信息。', 'type' => 'object', 'properties' => [ - 'UserType' => [ - 'description' => '用户类型，可选值：'."\n" - ."\n" - .'USER_TYPE_COMPANY_OWNER：商家主账号'."\n" - .'USER_TYPE_COMPANY_ROOT：高级商家管理员'."\n" - .'USER_TYPE_COMPANY_ADMIN：商家管理员'."\n" - .'USER_TYPE_STORE_ADMIN：门店管理员'."\n" - .'USER_TYPE_STORE_OPERATOR：门店操作员'."\n" - .'USER_TYPE_GUEST：没有任何权限的访客。', - 'type' => 'string', - 'example' => 'USER_TYPE_COMPANY_OWNER', - ], - 'UserId' => [ - 'description' => '阿里云子账号UID。', - 'type' => 'string', - 'example' => '1344***', - ], - 'Stores' => [ - 'description' => '门店ID列表。', - 'type' => 'string', - 'example' => '[s-dxsxxxxxx,s-dxsyyyyyyy]', - ], - 'UserName' => [ - 'description' => '用户姓名。', - 'type' => 'string', - 'example' => '张三', - ], - 'Bid' => [ - 'description' => '账号类型；'."\n" - ."\n" - .'26842：阿里云', - 'type' => 'string', - 'example' => '26842', - ], - 'OwnerId' => [ - 'description' => '阿里云主账号', - 'type' => 'string', - 'example' => '12143124132', - ], + 'UserType' => ['description' => '用户类型，可选值：'."\n" + ."\n" + .'USER_TYPE_COMPANY_OWNER：商家主账号'."\n" + .'USER_TYPE_COMPANY_ROOT：高级商家管理员'."\n" + .'USER_TYPE_COMPANY_ADMIN：商家管理员'."\n" + .'USER_TYPE_STORE_ADMIN：门店管理员'."\n" + .'USER_TYPE_STORE_OPERATOR：门店操作员'."\n" + .'USER_TYPE_GUEST：没有任何权限的访客。', 'type' => 'string', 'example' => 'USER_TYPE_COMPANY_OWNER'], + 'UserId' => ['description' => '阿里云子账号UID。', 'type' => 'string', 'example' => '1344***'], + 'Stores' => ['description' => '门店ID列表。', 'type' => 'string', 'example' => '[s-dxsxxxxxx,s-dxsyyyyyyy]'], + 'UserName' => ['description' => '用户姓名。', 'type' => 'string', 'example' => '张三'], + 'Bid' => ['description' => '账号类型；'."\n" + ."\n" + .'26842：阿里云', 'type' => 'string', 'example' => '26842'], + 'OwnerId' => ['description' => '阿里云主账号', 'type' => 'string', 'example' => '12143124132'], 'DingTalkInfos' => [ 'description' => '钉钉账号信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DingTalkCompanyId' => [ - 'description' => '钉钉商家ID', - 'type' => 'string', - 'example' => '131242', - ], - 'DingTalkUserId' => [ - 'description' => '钉钉用户ID；', - 'type' => 'string', - 'example' => '34352525', - ], + 'DingTalkCompanyId' => ['description' => '钉钉商家ID', 'type' => 'string', 'example' => '131242'], + 'DingTalkUserId' => ['description' => '钉钉用户ID；', 'type' => 'string', 'example' => '34352525'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], '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' => '查询单个用户', 'summary' => '查询单个用户信息。', - ], - 'AddApDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2024-04-26T06:18:36.000Z', 'description' => '错误码发生变更'], ], + ], + 'QueryTemplateListByGroupId' => [ + 'summary' => '根据分组id查询模板', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4973,73 +2817,24 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'StoreId', - 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID或商家自定义门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', - ], - ], - [ - 'name' => 'ApMac', - 'in' => 'formData', - 'schema' => [ - 'description' => '基站设备的Mac地址，可调用DescribeApDevices获取。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '11:22:33:44:55:66', - ], - ], - [ - 'name' => 'Remark', - 'in' => 'formData', - 'schema' => [ - 'description' => '备注。', - 'type' => 'string', - 'required' => false, - 'example' => '天猫店的基站设备', - ], - ], - [ - 'name' => 'ClientToken', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => '客户端token', - 'type' => 'string', - 'required' => false, - 'example' => '1*', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32'], ], [ - 'name' => 'ExtraParams', + 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '系统保留字段，请忽略；', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['type' => 'string', 'required' => true], ], [ - 'name' => 'SerialNumber', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '设备SN号', - 'type' => 'string', - 'required' => false, - 'example' => '18****', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32'], ], ], 'responses' => [ @@ -5047,66 +2842,53 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => ['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'], + ], + ], ], ], ], ], ], - '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' => '增加基站设备', - 'summary' => '增加指定MAC地址的基站设备，会自动尝试进行激活。', - 'requestParamsDescription' => 'Remark字段，暂不支持。', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteApDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2024-04-26T06:18:35.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-07-18T13:15:18.000Z', 'description' => 'OpenAPI 下线'], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"Success\\": true,\\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\\": true\\n }\\n ]\\n}","type":"json"}]', + ], + 'SyncAddMaterial' => [ + 'summary' => '异步添加媒体素材', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5117,106 +2899,59 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ApMac', - 'in' => 'formData', - 'schema' => [ - 'description' => '基站设备的Mac地址。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '11:22:33:44:55:66', - ], - ], - [ - 'name' => 'StoreId', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID或商家自定义门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', - ], + 'schema' => ['description' => '素材名称', 'type' => 'string', 'required' => true, 'example' => 'xx图片'], ], [ - 'name' => 'ExtraParams', + 'name' => 'Content', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '素材链接', 'type' => 'string', 'required' => true, 'example' => 'https://iotx-alg-picture-auto.oss-cn-shanghai.aliyuncs.com/0622/zxytest/12.jpg'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'SyncAddEslMaterialResponse', + 'description' => 'SyncAddEslMaterialResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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', - ], + 'Result' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'Success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '基本信息', 'description' => '基本信息', 'type' => 'string', 'example' => 'success'], + 'DynamicMessage' => ['title' => 'POP动态补充信息', 'description' => 'POP动态补充信息', 'type' => 'string', 'example' => 'The specified store %s does not exist.'], + 'DynamicCode' => ['title' => 'POP动态补充信息', 'description' => 'POP动态补充信息', 'type' => 'string'], + 'ErrorCode' => ['title' => '错误类型 参考 ErrorCodes枚举', 'description' => '错误类型 参考 ErrorCodes枚举', 'type' => 'string', 'example' => 'MandatoryParameters'], + ], + ], + 'RequestId' => ['description' => '请求ID'."\n", 'type' => 'string', 'example' => '450E6CA4-5C5D-5DED-86C2-2B577C291764'."\n"], + 'Success' => ['description' => '是否成功'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '调用失败时，返回的出错信息。'."\n" + ."\n", 'type' => 'string', 'example' => 'success'], + 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'MandatoryParameters'], + 'ErrorMessage' => ['description' => '调用失败时，返回的出错信息。'."\n" + ."\n", 'type' => 'string', 'example' => 'The specified resource type is invalid.'], + 'Code' => ['description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'DynamicCode' => ['description' => '动态码', 'type' => 'string', 'example' => 'PlatformResponseError.%s'."\n"], + 'DynamicMessage' => ['description' => '动态错误信息，用于替换返回参数ErrMessage错误信息中的%s。'."\n" + ."\n", 'type' => 'string', 'example' => 'The specified store %s does not exist.'], ], ], ], ], - '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' => '删除基站设备', - 'summary' => '删除指定MAC地址的基站设备。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + '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' => [], ], - 'ActivateApDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UnassignUser' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5227,41 +2962,17 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ApMac', - 'in' => 'formData', - 'schema' => [ - 'description' => '基站设备的Mac地址。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '11:22:33:44:55:66', - ], - ], - [ - 'name' => 'StoreId', + 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID或商家自定义门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', - ], + 'schema' => ['description' => '阿里云子账号UID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1344***'], ], [ 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'description' => '系统保留字段，请忽略', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '系统保留字段，请忽略', 'type' => 'string', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ @@ -5269,66 +2980,32 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '请求ID。', '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'], ], + 'description' => '', ], ], ], - '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', - 'summary' => '激活基站设备', + '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', + 'summary' => '取消用户权限。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeApDevices' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2024-04-26T06:18:34.000Z', 'description' => '错误码发生变更'], ], + ], + 'UnbindEslDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5337,94 +3014,49 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'StoreId', + 'name' => 'EslBarCode', 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID或商家自定义门店ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 's-dxsxx****', - ], + 'schema' => ['description' => '价签条码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '18bc5a63****'], ], [ - 'name' => 'ApMac', + 'name' => 'ItemBarCode', 'in' => 'formData', - 'schema' => [ - 'description' => '基站设备的Mac地址。', - 'type' => 'string', - 'required' => false, - 'example' => '112233445566', - ], + 'schema' => ['description' => '商品条码。', 'type' => 'string', 'required' => false, 'example' => '690560583****'], ], [ - 'name' => 'Status', + 'name' => 'Column', 'in' => 'formData', - 'schema' => [ - 'description' => '设备在线或离线状态 ，true：在线、false：离线。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '陈列系统的逻辑列。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'PageSize', + 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：每页显示条数，默认值10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '门店ID或商家自定义门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], ], [ - 'name' => 'PageNumber', + 'name' => 'Shelf', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：当前页码，默认值1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '陈列系统的货架号。', 'type' => 'string', 'required' => false, 'example' => '20200201'], ], [ - 'name' => 'Model', + 'name' => 'Layer', 'in' => 'formData', - 'schema' => [ - 'description' => '设备型号。', - 'type' => 'string', - 'required' => false, - 'example' => 'aliyun', - ], + 'schema' => ['description' => '陈列系统的层号。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'BeActivate', + 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'description' => '设备的激活状态。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '扩展参数', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'ExtraParams', + 'name' => 'ContainerName', 'in' => 'formData', - 'schema' => [ - 'description' => '系统保留字段，请忽略', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], ], 'responses' => [ @@ -5432,697 +3064,33 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '基站设备列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '在线状态：离线。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'StoreId' => [ - 'description' => '门店ID。', - 'type' => 'string', - 'example' => 's-cxsds****', - ], - 'Model' => [ - 'description' => '设备型号。', - 'type' => 'string', - 'example' => 'aliyun', - ], - 'Remark' => [ - 'description' => '备注。', - 'type' => 'string', - 'example' => '测试数据', - ], - 'BeActivate' => [ - 'description' => '是否激活。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Mac' => [ - 'description' => '设备的mac地址。', - 'type' => 'string', - 'example' => '112233445566', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', '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'], ], + 'description' => '', ], ], ], - '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' => '查询基站设备', - 'summary' => '查询基站设备信息。', - 'requestParamsDescription' => ' ', + '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' => '解绑价签设备', + 'summary' => '解绑价签设备。', + 'description' => '该接口分为陈列模式和普通模式两种。陈列模式是用陈列货位和价签条码进行解绑，普通模式是用商品条码和价签条码进行解绑。', + 'requestParamsDescription' => '普通模式下，StoreId+EslBarCode必填； 陈列模式下，StoreId+EslBarCode+Shelf+Layer+Column必填，当前货位上要有入参的EslBarCode，ItemBarCode如果填写要和陈列货位上的信息保存一致。', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ApplyCompanyTemplateVersionToStores' => [ - 'summary' => '版本应用到门店。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'TemplateVersion', - 'in' => 'formData', - 'schema' => [ - 'description' => '门店模板版本号；', - 'type' => 'string', - 'required' => true, - 'example' => '1.1.0', - ], - ], - [ - 'name' => 'Stores', - 'in' => 'formData', - 'schema' => [ - 'description' => '门店ID列表。请转为JSON字符串', - 'type' => 'string', - 'required' => false, - 'example' => '[\\"s-y9eoecc7mu\\"]', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应消息，若成功请求为success', - 'type' => 'string', - 'example' => 'success', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数ErrMessage错误信息中的%s。', - 'type' => 'string', - 'example' => 'The specified store %s does not exist.', - ], - 'DynamicCode' => [ - 'description' => '错误代码', - 'type' => 'string', - 'example' => 'PlatformResponseError.%s', - ], - ], - ], - ], - ], - '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' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'TemplateVersion', - 'in' => 'formData', - 'schema' => [ - 'description' => '门店模板版本号；', - 'type' => 'string', - 'required' => false, - 'example' => '1.1.0', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '-1001', - ], - 'Message' => [ - 'description' => '响应消息，若成功请求为success', - 'type' => 'string', - 'example' => 'success', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数**ErrMessage**错误信息中的%s。', - 'type' => 'string', - 'example' => 'The specified store %s does not exist.', - ], - 'DynamicCode' => [ - 'description' => '与本次请求相关的动态错误码。', - 'type' => 'string', - 'example' => 'PlatformResponseError.%s', - ], - 'Stores' => [ - 'description' => '门店信息列表。', - 'type' => 'array', - 'items' => [ - 'description' => '门店信息列表。', - 'type' => 'object', - 'properties' => [ - 'StoreName' => [ - 'description' => '门店名称。', - 'type' => 'string', - 'example' => '天猫旗舰店', - ], - 'StoreId' => [ - 'description' => '门店ID。', - 'type' => 'string', - 'example' => 's-nxwd8sutd6', - ], - 'ParentId' => [ - 'description' => '父门店ID。', - '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', - 'example' => '1级', - ], - 'TemplateVersion' => [ - 'description' => '门店模板版本号；', - 'type' => 'string', - 'example' => '1.1.0', - ], - 'TimeZone' => [ - 'description' => '时区。', - 'type' => 'string', - 'example' => 'GMT+08:00', - ], - ], - ], - ], - ], - ], - ], - ], - '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', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：当前页码，默认值1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - 1 => '1', - ], - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：每页显示条数，默认值10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - 10 => '10', - ], - 'example' => '10', - ], - ], - ], - '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' => '请求ID。', - 'type' => 'string', - 'example' => '6248311A-3296-5084-B057-D0EC3DCE5C47', - ], - 'ErrorMessage' => [ - 'description' => '错误消息。', - 'type' => 'string', - 'example' => 'The specified resource type is invalid.', - ], - 'Success' => [ - 'description' => 'POP请求成功与否标识。', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'True' => 'True', - ], - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '错误码。取值说明如下：请求成功：不返回ErrorCode字段。 请求失败：返回ErrorCode字段。具体信息，请参见本文的错误码列表。', - 'type' => 'string', - 'example' => 'MandatoryParameters', - ], - 'Code' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '-1001', - ], - 'Message' => [ - 'description' => '响应消息，若成功请求为success', - 'type' => 'string', - 'example' => 'success', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数ErrMessage错误信息中的%s。', - 'type' => 'string', - 'example' => 'The specified store %s does not exist.', - ], - 'DynamicCode' => [ - 'description' => '与本次请求相关的动态错误码。', - 'type' => 'string', - 'example' => 'PlatformResponseError.%s', - ], - 'PageSize' => [ - 'description' => '分页参数：每页显示条数，默认值10。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '分页参数：当前页码，默认值1。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Versions' => [ - 'description' => '版本列表。', - 'type' => 'array', - 'items' => [ - 'description' => '版本列表。', - 'type' => 'object', - 'properties' => [ - 'Version' => [ - 'description' => '版本号。', - 'type' => 'string', - 'example' => '1.1.0', - ], - ], - ], - ], - ], - ], - ], - ], - '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', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'TemplateVersion', - 'in' => 'formData', - 'schema' => [ - 'description' => '门店模板版本号；', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - '1.1.0' => '1.1.0', - ], - 'example' => '1.1.0', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：当前页码，默认值1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：每页显示条数，默认值10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '错误码。取值说明如下：请求成功：不返回ErrorCode字段。 请求失败：返回ErrorCode字段。具体信息，请参见本文的错误码列表。', - 'type' => 'string', - 'example' => 'MandatoryParameters', - ], - 'Code' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '-1001', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'success', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数ErrMessage错误信息中的%s。', - 'type' => 'string', - 'example' => 'The specified store %s does not exist.', - ], - 'DynamicCode' => [ - 'description' => '动态错误码', - 'type' => 'string', - 'example' => 'PlatformResponseError.%s', - ], - 'PageNumber' => [ - 'description' => '分页参数：当前页码，默认值1。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页参数：每页显示条数，默认值10。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'EslModels' => [ - 'description' => '模板版本信息列表。', - 'type' => 'array', - 'items' => [ - 'description' => '模板版本信息列表。', - 'type' => 'object', - 'properties' => [ - 'ModelId' => [ - 'description' => '模型ID', - 'type' => 'string', - 'example' => '9946366490094af4ab16bfe023ad5f22', - ], - 'Name' => [ - 'description' => '模型名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'Image' => [ - 'description' => '商品图片。', - 'type' => 'string', - 'example' => '/9xwqexcdaxasada....', - ], - 'DeviceType' => [ - 'description' => '设备类型', - 'type' => 'string', - 'example' => '3', - ], - 'Vendor' => [ - 'description' => '厂商名称'."\n" - ."\n", - 'type' => 'string', - 'example' => 'ali', - ], - 'ScreenWidth' => [ - 'description' => '屏幕宽度。', - 'type' => 'integer', - 'format' => 'int32', - ], - 'ScreenHeight' => [ - 'description' => '屏幕高度。', - 'type' => 'integer', - 'format' => 'int32', - ], - 'EslSize' => [ - 'description' => '价签型号。', - 'type' => 'string', - 'example' => '800X480', - ], - 'EslPhysicalSize' => [ - 'description' => '内存大小。单位：gib', - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], + 'changeSet' => [ + ['createdAt' => '2022-07-18T13:15:02.000Z', 'description' => '请求参数发生变更、错误码发生变更'], ], - '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', - ], + 'UpdateEslDeviceLight' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6131,508 +3099,110 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], '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', + 'name' => 'LedColor', 'in' => 'formData', - 'schema' => [ - 'description' => '门店模板版本号；', - 'type' => 'string', - 'required' => false, - 'example' => '1.1.0', - ], + 'schema' => ['description' => '亮灯颜色，可选值：'."\n" + ."\n" + .'- `GREEN`：绿色'."\n" + ."\n" + .'- `RED`：红色'."\n" + ."\n" + .'- `BLUE`：蓝色'."\n" + ."\n" + .'- `OFF`：关闭。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GREEN'], ], [ - 'name' => 'PageNumber', + 'name' => 'Frequency', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '亮灯频率，可选值：'."\n" + ."\n" + .'- `ALWAYS`：持续亮灯'."\n" + ."\n" + .'- `HEIGHT`：高频率亮灯'."\n" + ."\n" + .'- `MIDDLE`：中频率亮灯'."\n" + ."\n" + .'- `NORMAL`：正常频率亮灯。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NORMAL'], ], [ - 'name' => 'PageSize', + 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数：每页显示条数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => '错误码。取值说明如下：请求成功：不返回ErrorCode字段。 请求失败：返回ErrorCode字段。具体信息，请参见本文的错误码列表。', - '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' => '模板ID', - 'type' => 'string', - 'example' => '772629024140898304', - ], - 'TemplateName' => [ - 'description' => '模板名称', - 'type' => 'string', - 'example' => '常规', - ], - 'EslSize' => [ - 'description' => '价签尺寸', - 'type' => 'string', - 'example' => '250X122', - ], - 'EslType' => [ - 'description' => '价签类型，返回值对应关系：-[unk]esl_type_e_ink[unk]：电子墨水屏幕-[unk]px_type_dm_lcd[unk]：段码屏幕-[unk]x-ddl_type_full_color[unk]：彩色屏幕。', - 'type' => 'string', - ], - 'Width' => [ - 'description' => '宽。单位：px。', - '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' => '匹配自定义模板ID显示', - 'type' => 'string', - '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"}]', - ], - 'DescribeAvailableEslModels' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'schema' => ['description' => '门店ID或商家自定义门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], ], [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'ModelId', + 'name' => 'ItemBarCode', 'in' => 'formData', - 'schema' => [ - 'title' => '设备模型id', - 'description' => '设备模型id', - 'type' => 'string', - 'required' => false, - 'example' => '6cd23870539e43759e65eef5b6808a49', - ], + 'schema' => ['description' => '商品条码。', 'type' => 'string', 'required' => false, 'example' => '6905605836648'], ], [ - 'name' => 'Name', + 'name' => 'LightUpTime', 'in' => 'formData', - 'schema' => [ - 'title' => '模型名称', - 'description' => '模型名称', - 'type' => 'string', - 'required' => false, - 'example' => 'aa_ssaaa', - ], + 'schema' => ['description' => '亮灯时长，单位：s，取值大于1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '30'], ], [ - 'name' => 'PageNumber', + 'name' => 'EslBarCode', 'in' => 'formData', - 'schema' => [ - 'title' => '分页号', - 'description' => '分页号', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '价签条码。', 'type' => 'string', 'required' => false, 'example' => '18bc5a631ak9'], ], [ - 'name' => 'PageSize', + 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'title' => '分页大小', - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => '扩展参数', 'type' => 'string', 'required' => false, 'example' => '{}'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'DescribeAvailableEslModelsResponse', - 'description' => 'DescribeAvailableEslModelsResponse', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '436', - ], - 'PageSize' => [ - 'description' => '分页参数：每页显示条数，默认值10。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '分页参数：当前页码，默认值1。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'EslModels' => [ - 'description' => '价签信息列表。', + 'RequestId' => ['description' => 'POP请求ID。', 'type' => 'string', 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF'], + 'ErrorMessage' => ['description' => '错误消息。', 'type' => 'string', 'example' => 'The specified resource type is invalid.'], + 'Success' => ['description' => 'POP请求成功与否标识。', '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' => [ - 'description' => '价签信息列表。', 'type' => 'object', 'properties' => [ - 'ModelId' => [ - 'title' => '模型id', - 'description' => '模型id', - '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', - ], + 'EslBarCode' => ['description' => '价签条码', 'type' => 'string', 'example' => '18bc5a63****'], + 'ErrorMessage' => ['description' => '错误消息。', 'type' => 'string', 'example' => 'The specified ESL device does not exist.'], ], + 'description' => '', ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E69C8998-1787-4999-8C75-D663FF1173CF', - ], - 'Success' => [ - 'description' => '请求状态标识。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '响应消息，若成功请求为success', - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorCode' => [ - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MandatoryParameters', - ], - 'ErrorMessage' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'The specified resource type is invalid.', - ], - 'Code' => [ - 'description' => '状态码。返回200代表成功。', - 'type' => 'string', - 'example' => '-1001', - ], - 'DynamicCode' => [ - 'description' => '动态错误码。', - 'type' => 'string', - 'example' => 'PlatformResponseError.%s', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数ErrMessage错误信息中的%s。', - 'type' => 'string', - 'example' => 'The specified store %s does not exist.', - ], ], + 'description' => '', ], ], ], - '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', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'TemplateId', - 'in' => 'formData', - 'schema' => [ - 'description' => '模板ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '742842379343605760', - ], - ], - [ - 'name' => 'ExtraParams', - 'in' => 'formData', - 'schema' => [ - 'description' => '系统扩展字段，请忽略；', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A7571D49-9B36-5782-AD3D-32C8436D45B7', - ], - 'ErrorMessage' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'The specified resource type is invalid.', - ], - 'Success' => [ - 'description' => 'POP请求成功与否标识。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '错误码。取值说明如下：请求成功：不返回ErrorCode字段。 请求失败：返回ErrorCode字段。具体信息，请参见本文的错误码列表。', - 'type' => 'string', - 'example' => 'MandatoryParameters', - ], - 'Code' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '-1001', - ], - 'Message' => [ - 'description' => '错误代码。', - 'type' => 'string', - 'example' => 'success', - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数ErrMessage错误信息中的%s。', - '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 \\"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' => '操作价签的Led灯', + 'summary' => '操作价签的Led灯，进行频率和色彩的变换。', + 'requestParamsDescription' => ' ItemBarCode和EslBarCode二选一，两个都填时EslBarCode优先级比较高。'."\n" + .'只填EslBarCode时，点亮单个价签。'."\n" + .'只填ItemBarCode时，点亮该商品条码绑定的所有价签。', + 'responseParamsDescription' => ' 使用EslBarCode点亮时，返回成功或失败；'."\n" + .'使用ItemBarCode点亮时，返回成功数量和失败数量，以及失败的价签信息。', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-26T06:18:34.000Z', 'description' => '错误码发生变更'], ], - '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', - ], + 'UpdateStore' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6643,179 +3213,57 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'Scene', + 'name' => 'StoreId', 'in' => 'formData', - 'schema' => [ - 'description' => '使用场景，选择合适的使用场景', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'NORMAL', - ], + 'schema' => ['description' => '门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-dxsxx****'], ], [ - 'name' => 'ExtraParams', + 'name' => 'UserStoreCode', 'in' => 'formData', - 'schema' => [ - 'description' => '系统扩展字段，请忽略；', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => '商家自定义门店ID。', 'type' => 'string', 'required' => false, 'example' => '123456'], ], [ - 'name' => 'EslSize', + 'name' => 'StoreName', 'in' => 'formData', - 'schema' => [ - 'description' => '价签尺寸', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '800X480', - ], + 'schema' => ['description' => '门店名称。', 'type' => 'string', 'required' => false, 'example' => '天猫超市'], ], [ - 'name' => 'TemplateName', + 'name' => 'Phone', 'in' => 'formData', - 'schema' => [ - 'description' => '模板名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '促销', - 'maxLength' => 128, - 'minLength' => 0, - ], + 'schema' => ['description' => '门店所在监督工商局的监督电话。', 'type' => 'string', 'required' => false, 'example' => '0571-5666888'], ], [ - 'name' => 'Layout', + 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'description' => '布局信息。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '2', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => '系统保留字段，请忽略；', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ 'name' => 'TemplateVersion', 'in' => 'formData', - 'schema' => [ - 'description' => '门店模板版本；', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1.1.0', - ], - ], - [ - 'name' => 'DeviceType', - 'in' => 'formData', - 'schema' => [ - 'description' => '设备类型', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '3', - ], - ], - [ - 'name' => 'TemplateType', - 'in' => 'formData', - 'schema' => [ - 'description' => '模板类型', - 'type' => 'string', - 'required' => false, - 'example' => 'normal', - ], - ], - [ - 'name' => 'IfPromotion', - 'in' => 'formData', - 'schema' => [ - 'description' => '是否促销，取值：-true：是。-false：否。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'IfSourceCode', - 'in' => 'formData', - 'schema' => [ - 'description' => '是否溯源，取值：-true：是。-false：否。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'IfDefault', - 'in' => 'formData', - 'schema' => [ - 'description' => '是否默认模板，取值：-true：是。-false：否。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'IfMember', - 'in' => 'formData', - 'schema' => [ - 'description' => '是否会员，取值：-true：是。-false：否。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '门店模板版本；', 'type' => 'string', 'required' => false, 'example' => '1.1.0'], ], [ - 'name' => 'IfOutOfInventory', + 'name' => 'Timezone', 'in' => 'formData', - 'schema' => [ - 'description' => '是否缺货，取值：-true：是。-false：否。', - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['description' => '时区。', 'type' => 'string', 'required' => false, 'example' => 'GMT+08:00'], ], [ - 'name' => 'Vendor', + 'name' => 'BarCodeEncode', 'in' => 'formData', - 'schema' => [ - 'description' => '设备厂商。', - 'type' => 'string', - 'required' => false, - 'example' => 'ali', - ], + 'schema' => ['description' => '条形码编码方式：0：Code128 ，1：EAN13（默认0）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1', 'minimum' => '0', 'example' => '0', 'default' => '0'], ], [ - 'name' => 'GroupId', + 'name' => 'AutoUnbindOfflineEsl', 'in' => 'formData', - 'schema' => [ - 'description' => '模板组id', - 'type' => 'string', - 'required' => false, - 'example' => '9', - ], + 'schema' => ['title' => '是否启用自动解绑离线价签', 'description' => '是否自动解绑离线价签', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], [ - 'name' => 'TemplateSceneId', + 'name' => 'AutoUnbindDays', 'in' => 'formData', - 'schema' => [ - 'description' => '自定义模板ID', - 'type' => 'string', - 'required' => false, - 'example' => '大甩卖', - ], + 'schema' => ['title' => '自动解绑离线价签条件-价签离线天数', 'description' => '自动解绑时间，单位：日', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '36500', 'minimum' => '7', 'example' => '1', 'default' => '36500'], ], ], 'responses' => [ @@ -6823,74 +3271,32 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - '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' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应消息，若成功请求为success', - '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' => '请求ID。', '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'], ], + 'description' => '', ], ], ], - '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' => '[{"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":""}]', + 'title' => '修改门店信息', + 'summary' => '修改门店基础信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-11-23T03:19:05.000Z', 'description' => '请求参数发生变更'], ], - '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"}]', ], - 'SyncAddMaterial' => [ - 'summary' => '异步添加媒体素材', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateStoreConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6901,170 +3307,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' => 'xx图片', - ], + 'schema' => ['description' => '用户配置的静默期，不发通知消息，JSON列表，单位为分钟，每个JSON字段表示一个静默期时间段，里面的值为UTC时间下一天里面的分钟数，from为静默期的起始分钟数，to为结束分钟数。', 'type' => 'string', 'required' => false, 'example' => '[{"from":960,"to":1320},{"from":1170,"to":1230}]'], ], [ - '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', - ], - ], - ], - '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' => 'POP动态补充信息', - 'type' => 'string', - 'example' => 'The specified store %s does not exist.', - ], - 'DynamicCode' => [ - 'title' => 'POP动态补充信息', - 'description' => 'POP动态补充信息', - 'type' => 'string', - ], - 'ErrorCode' => [ - 'title' => '错误类型 参考 ErrorCodes枚举', - 'description' => '错误类型 参考 ErrorCodes枚举', - 'type' => 'string', - 'example' => 'MandatoryParameters', - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID'."\n", - 'type' => 'string', - 'example' => '450E6CA4-5C5D-5DED-86C2-2B577C291764'."\n", - ], - 'Success' => [ - 'description' => '是否成功'."\n" - ."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '调用失败时，返回的出错信息。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorCode' => [ - 'description' => '错误码', - 'type' => 'string', - 'example' => 'MandatoryParameters', - ], - 'ErrorMessage' => [ - 'description' => '调用失败时，返回的出错信息。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'The specified resource type is invalid.', - ], - 'Code' => [ - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - 'DynamicCode' => [ - 'description' => '动态码', - 'type' => 'string', - 'example' => 'PlatformResponseError.%s'."\n", - ], - 'DynamicMessage' => [ - 'description' => '动态错误信息，用于替换返回参数ErrMessage错误信息中的%s。'."\n" - ."\n", - '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' => [], + 'schema' => ['description' => '是否启用钉钉异常消息通知，true 启用，false不启用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'BearerToken' => [], + 'name' => 'StoreId', + 'in' => 'formData', + 'schema' => ['description' => '门店ID或商家自定义门店ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 's-sds1233****'], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'NotificationWebHook', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => '钉钉消息的webHook地址。', 'type' => 'string', 'required' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?.'], ], [ - 'name' => 'GroupId', + 'name' => 'ExtraParams', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => '系统扩展字段，请忽略；', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'PageSize', + 'name' => 'SubscribeContents', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => '订阅内容。', 'type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -7072,316 +3345,325 @@ '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' => '本次请求的ID。', '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'], ], + 'description' => '', ], ], ], + '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' => '修改门店配置', + 'summary' => '修改门店的配置信息。', + 'changeSet' => [], ], ], 'endpoints' => [ + ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚（悉尼）已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => 'cloudesl-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => 'cloudesl-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cloudesl.cn-hangzhou.aliyuncs.com', 'endpoint' => 'cloudesl.cn-hangzhou.aliyuncs.com', 'vpc' => 'cloudesl-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-south-1', 'regionName' => '印度（孟买）已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'cloudesl.aliyuncs.com', 'endpoint' => 'cloudesl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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' => '您暂时无权执行操作 %s'], + ['code' => 'ActionPermissionErrorPub', 'message' => 'You are not authorized to perform the action %s.', 'http_code' => 411, 'description' => '您暂时无权执行操作 %s'], + ['code' => 'AlarmError', 'message' => 'An error occurred while processing the specified alert.', 'http_code' => 510, 'description' => '报警信息错误'], + ['code' => 'ApDeviceActivateErrorPub', 'message' => 'Failed to activate the AP device.', 'http_code' => 418, 'description' => '基站设备激活失败'], + ['code' => 'ApDeviceActivateErrorPub', 'message' => 'Failed to active the AP device.', 'http_code' => 418, 'description' => '激活AP设备失败'], + ['code' => 'ApDeviceAlreadyExistPub', 'message' => 'The specified AP device already exists.', 'http_code' => 418, 'description' => '基站设备已存在'], + ['code' => 'ApDeviceInStorePub', 'message' => 'The store contains an AP device.', 'http_code' => 418, 'description' => '该门店还存在基站设备'], + ['code' => 'ApDeviceOtherStorePub', 'message' => 'The specified AP device is being used by another store.', 'http_code' => 418, 'description' => '基站设备正被其它门店使用'], + ['code' => 'ApDeviceRegisterErrorPub', 'message' => 'Failed to register the AP device.', 'http_code' => 418, 'description' => '基站设备注册失败'], + ['code' => 'ApNumberLimitPub', 'message' => 'The number of AP devices under the store exceeds the limit.', 'http_code' => 418, 'description' => '您门店下的基站数量超出限制'], + ['code' => 'BetaTestLabelError', 'message' => 'You are not authorized to use the public beta version.', 'http_code' => 405, 'description' => '未允许参加公测'], + ['code' => 'BetaTestLabelErrorPub', 'message' => 'You are not authorized to use the public preview version.', 'http_code' => 418, 'description' => '未允许参加公测'], + ['code' => 'BeyondBatchLimit', 'message' => 'The maximum number of items that you can insert is exceeded.', 'http_code' => 405, 'description' => '超出批量限制'], + ['code' => 'BeyondBatchLimitPub', 'message' => 'The maximum number of items that you can insert is exceeded.', 'http_code' => 418, 'description' => '超出批量限制'], + ['code' => 'CompanyAlreadyExist', 'message' => 'The specified company already exists.', 'http_code' => 405, 'description' => '商家已存在'], + ['code' => 'CompanyAlreadyExistPub', 'message' => 'The specified company already exists.', 'http_code' => 418, 'description' => '商家已存在'], + ['code' => 'CompanyDataNotMigratePub', 'message' => 'The specified company data is not migrated.', 'http_code' => 418, 'description' => '商家数据未迁移'], + ['code' => 'CompanyError', 'message' => 'An error occurred while processing your request related to companies.', 'http_code' => 506, 'description' => '商家错误'], + ['code' => 'CompanyOwnerError', 'message' => 'Failed to configure the specified company.', 'http_code' => 405, 'description' => '配置商家出错'], + ['code' => 'CompanyOwnerErrorPub', 'message' => 'Failed to configure the specified company.', 'http_code' => 418, 'description' => '配置商家出错'], + ['code' => 'CompanyTemplatePermissionErrorPub', 'message' => 'You are not authorized to operate on the specified company template %s.', 'http_code' => 411, 'description' => '您暂无权限操作企业模板'], + ['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' => '模板和容器不匹配'], + ['code' => 'CreateCompanyError', 'message' => 'Failed to create a company.', 'http_code' => 405, 'description' => '创建商家出错'], + ['code' => 'CreateCompanyErrorPub', 'message' => 'Failed to create a company.', 'http_code' => 418, 'description' => '创建商家出错'], + ['code' => 'DeviceError', 'message' => 'An error occurred while processing your request related to devices.', 'http_code' => 508, 'description' => '设备错误'], + ['code' => 'DingTalkAlreadyExistPub', 'message' => 'The specified DingTalk information already exists.', 'http_code' => 418, 'description' => '钉钉信息已存在'], + ['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' => '您指定的参数 %s 不合法'], + ['code' => 'ErrorParameterPub', 'message' => 'The parameter %s is invalid.', 'http_code' => 413, 'description' => '您指定的参数 %s 不合法'], + ['code' => 'EslDeviceInPlanogramPositionPub', 'message' => 'The ESL device is used in planogram position.', 'http_code' => 418, 'description' => '该价签正在陈列模式下使用'], + ['code' => 'EslDeviceInStore', 'message' => 'The store contains an ESL device.', 'http_code' => 405, 'description' => '该门店还存在价签'], + ['code' => 'EslDeviceInStorePub', 'message' => 'The store contains an ESL device.', 'http_code' => 418, 'description' => '该门店还存在价签'], + ['code' => 'EslDeviceNotMatchEslPositionPub', 'message' => 'The specified ESL device does not match the ESL position.', 'http_code' => 418, 'description' => '指定价签与价签位置信息不符合'], + ['code' => 'EslDeviceOtherStore', 'message' => 'The specified ESL device is being used by another store', 'http_code' => 405, 'description' => '价签设备正被其它门店使用'], + ['code' => 'EslDeviceOtherStorePub', 'message' => 'The specified ESL device is being used by another store', 'http_code' => 418, 'description' => '价签设备正被其它门店使用'], + ['code' => 'FailInsertItemPub', 'message' => 'Failed to insert the same item.', 'http_code' => 412, 'description' => '插入同一个商品失败'], + ['code' => 'InternalError', 'message' => 'An error occurred while processing API operations of Cloud ESL.', 'http_code' => 500, 'description' => '平台接口错误'], + ['code' => 'InvalidActionPermissionPub', 'message' => 'The specified action permission is invalid.', 'http_code' => 412, 'description' => '指定的操作权限无效。'], + ['code' => 'InvalidCompanyTemplatePub', 'message' => 'The company template is invalid.', 'http_code' => 412, 'description' => '企业模板不合法'], + ['code' => 'InvalidCompanyTemplateScenePub', 'message' => 'The specified company template scenario is invalid.', 'http_code' => 412, 'description' => '企业模板适用场景不合法'], + ['code' => 'InvalidDeviceMac', 'message' => 'The specified device MAC address is invalid.', 'http_code' => 400, 'description' => '设备地址不合法'], + ['code' => 'InvalidDeviceMacPub', 'message' => 'The specified device MAC address is invalid.', 'http_code' => 412, 'description' => '设备地址不合法'], + ['code' => 'InvalidEslBarCode', 'message' => 'The specified ESL bar code is invalid.', 'http_code' => 400, 'description' => '价签条码不合法'], + ['code' => 'InvalidEslBarCodePub', 'message' => 'The specified ESL bar code is invalid.', 'http_code' => 412, 'description' => '价签条码不合法'], + ['code' => 'InvalidFileSize', 'message' => 'The specified size of the material is invalid.', 'http_code' => 412, 'description' => '素材尺寸格式不合法'], + ['code' => 'InvalidHttpSignaturePub', 'message' => 'The HTTP signature is invalid.', 'http_code' => 412, 'description' => 'POP请求的签名不合法'], + ['code' => 'InvalidItemBarCode', 'message' => 'The specified item bar code is invalid.', 'http_code' => 400, 'description' => '商品条码不合法'], + ['code' => 'InvalidItemBarCodePub', 'message' => 'The specified item bar code is invalid.', 'http_code' => 412, 'description' => '商品条码不合法'], + ['code' => 'InvalidMaterialId', 'message' => 'The material id is invalid.', 'http_code' => 418, 'description' => '输入的materialId无效'], + ['code' => 'InvalidPageNumber', 'message' => 'The specified starting page number is invalid.', 'http_code' => 400, 'description' => '分页数不合法'], + ['code' => 'InvalidPageNumberPub', 'message' => 'The specified starting page number is invalid.', 'http_code' => 412, 'description' => '分页数不合法'], + ['code' => 'InvalidPageSize', 'message' => 'The specified number of entries to return on each page is invalid.', 'http_code' => 400, 'description' => '分页大小不合法'], + ['code' => 'InvalidPageSizePub', 'message' => 'The specified number of entries to return on each page is invalid.', 'http_code' => 412, 'description' => '分页大小不合法'], + ['code' => 'InvalidParameter.DataViolated', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => '数据冲突'], + ['code' => 'InvalidParameter.ValidationFailure', 'message' => 'An error occurred while validating parameters.', 'http_code' => 400, 'description' => '参数校验失败'], + ['code' => 'InvalidPlatformType', 'message' => 'The specified system type is invalid.', 'http_code' => 400, 'description' => '系统类型不合法'], + ['code' => 'InvalidPlatformTypePub', 'message' => 'The specified system type is invalid.', 'http_code' => 412, 'description' => '系统类型不合法'], + ['code' => 'InvalidResourceType', 'message' => 'The specified resource type is invalid.', 'http_code' => 400, 'description' => '资源类型不合法'], + ['code' => 'InvalidResourceTypePub', 'message' => 'The specified resource type is invalid.', 'http_code' => 412, 'description' => '资源类型不合法'], + ['code' => 'InvalidShelfTypePub', 'message' => 'The specified shelf type is invalid.', 'http_code' => 412, 'description' => '货架属性不合法'], + ['code' => 'InvalidUserType', 'message' => 'The specified user type is invalid.', 'http_code' => 400, 'description' => '用户类型不合法'], + ['code' => 'InvalidUserTypePub', 'message' => 'The specified user type is invalid.', 'http_code' => 412, 'description' => '用户类型不合法'], + ['code' => 'ItemAlreadyExistPub', 'message' => 'The item already exists.', 'http_code' => 412, 'description' => '该商品已存在'], + ['code' => 'ItemBindEslDevice', 'message' => 'The item has been bound to an ESL device.', 'http_code' => 405, 'description' => '商品还存在价签设备绑定'], + ['code' => 'ItemBindEslDevicePub', 'message' => 'The item has been bound to an ESL device.', 'http_code' => 418, 'description' => '商品还存在价签设备绑定'], + ['code' => 'ItemError', 'message' => 'An error occurred while processing your request related to items.', 'http_code' => 509, 'description' => '商品错误'], + ['code' => 'ItemInStore', 'message' => 'The store contains an item.', 'http_code' => 405, 'description' => '该门店还存在商品'], + ['code' => 'ItemInStorePub', 'message' => 'The store contains an item.', 'http_code' => 418, 'description' => '该门店还存在商品'], + ['code' => 'ItemNotMatch', 'message' => 'The specified item does not match the item that has been bound to the specified ESL device.', 'http_code' => 405, 'description' => '指定商品同已绑定价签设备的商品不符'], + ['code' => 'ItemNotMatchPlanogramPositionPub', 'message' => 'The specified item does not match the planogram position.', 'http_code' => 418, 'description' => '指定商品与陈列信息不符合'], + ['code' => 'ItemNotMatchPub', 'message' => 'The specified item does not match the item that has been bound to the specified ESL device.', 'http_code' => 418, 'description' => '指定商品同已绑定价签设备的商品不符'], + ['code' => 'ItemNumberLimitPub', 'message' => 'The number of products under the store exceeds the limit.', 'http_code' => 418, 'description' => '您门店下的商品数量超出限制'], + ['code' => 'ItemNumLimit', 'message' => 'The maximum number of items is %s.', 'http_code' => 410, 'description' => '商品数量最多为 %s。'], + ['code' => 'LayerBindOtherRailPub', 'message' => 'The layer has been bound to another rail.', 'http_code' => 418, 'description' => '该货架层正绑定着其他导轨'], + ['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' => '系统内部错误'], + ['code' => 'LockErrorPub', 'message' => 'An error occurred while processing your request.', 'http_code' => 418, 'description' => '系统内部错误'], + ['code' => 'MandatoryParameter', 'message' => 'Missing parameter %s.', 'http_code' => 403, 'description' => '您必须指定参数 %s'], + ['code' => 'MandatoryParameterPub', 'message' => 'Missing parameter %s.', 'http_code' => 413, 'description' => '您必须指定参数 %s'], + ['code' => 'MaterialContainIllegalContent', 'message' => 'The material contains illegal content.', 'http_code' => 416, 'description' => '上传素材包含敏感信息'], + ['code' => 'MaterialHasBindToItem', 'message' => 'The material has been bound to the items.', 'http_code' => 418, 'description' => '该素材已与部分商品绑定'], + ['code' => 'MaterialInfoParserError', 'message' => 'Type of material is invalid.', 'http_code' => 418, 'description' => '不支持当前类型媒体素材'], + ['code' => 'MissingParameter', 'message' => 'You must specify the parameters.', 'http_code' => 400, 'description' => '缺少参数'], + ['code' => 'MoreThanOneStore', 'message' => 'The specified store operator can only manage one store.', 'http_code' => 405, 'description' => '门店操作员只允许管理一家门店'], + ['code' => 'MoreThanOneStorePub', 'message' => 'The specified store operator can only manage one store.', 'http_code' => 418, 'description' => '门店操作员只允许管理一家门店'], + ['code' => 'NotAcquireLockPub', 'message' => 'The lock is not acquired.', 'http_code' => 417, 'description' => '没有获取到锁'], + ['code' => 'NotAllowDifferentDeviceTypePub', 'message' => 'The specified Not allow Different device type to copy template.', 'http_code' => 418, 'description' => '不允许跨设备类型复制模板'], + ['code' => 'NotBindEslDevice', 'message' => 'The specified ESL device has not been bound.', 'http_code' => 405, 'description' => '价签设备未绑定'], + ['code' => 'NotBindEslDevicePub', 'message' => 'The specified ESL device has not been bound.', 'http_code' => 418, 'description' => '价签设备未绑定'], + ['code' => 'NotFindAlarm', 'message' => 'The specified alert does not exist.', 'http_code' => 404, 'description' => '您指定的报警项不存在'], + ['code' => 'NotFindAlarmPub', 'message' => 'The specified alert does not exist.', 'http_code' => 417, 'description' => '您指定的报警项不存在'], + ['code' => 'NotFindApDevicePub', 'message' => 'The specified AP device does not exist.', 'http_code' => 417, 'description' => '您指定的基站设备不存在'], + ['code' => 'NotFindCompany', 'message' => 'The specified company does not exist.', 'http_code' => 404, 'description' => '您使用的商家不存在'], + ['code' => 'NotFindCompanyAccount', 'message' => 'The Alibaba Cloud account of the specified company does not exist.', 'http_code' => 404, 'description' => '商家所属的阿里云主账号不存在'], + ['code' => 'NotFindCompanyAccountPub', 'message' => 'The Alibaba Cloud account of the specified company does not exist.', 'http_code' => 417, 'description' => '商家所属的阿里云主账号不存在'], + ['code' => 'NotFindCompanyConfigPub', 'message' => 'The specified company configuration does not exist.', 'http_code' => 417, 'description' => '您指定的商家配置信息不存在'], + ['code' => 'NotFindCompanyConfigStatusPub', 'message' => 'The specified company configuration status does not exist.', 'http_code' => 417, 'description' => '您指定的商家配置状态不存在'], + ['code' => 'NotFindCompanyIdByConfigPub', 'message' => 'The company ID cannot be found based on the company configuration information.', 'http_code' => 417, 'description' => '根据商家配置信息找不到商家ID'], + ['code' => 'NotFindCompanyPub', 'message' => 'The specified company does not exist.', 'http_code' => 417, 'description' => '您使用的商家不存在'], + ['code' => 'NotFindCompanySessionTokenPub', 'message' => 'The specified session token does not exist.', 'http_code' => 417, 'description' => '您指定的商家没配置访问令牌'], + ['code' => 'NotFindCompanyTemplatePub', 'message' => 'The specified company template does not exist.', 'http_code' => 417, 'description' => '您指定的企业模板不存在'], + ['code' => 'NotFindEslDevice', 'message' => 'The specified ESL device does not exist.', 'http_code' => 404, 'description' => '您指定的价签设备不存在'], + ['code' => 'NotFindEslDevicePub', 'message' => 'The specified ESL device does not exist.', 'http_code' => 417, 'description' => '您指定的价签设备不存在'], + ['code' => 'NotFindEslPositionPub', 'message' => 'The specified ESL position does not exist.', 'http_code' => 417, 'description' => '您指定的价签位置不存在'], + ['code' => 'NotFindItem', 'message' => 'The specified item does not exist.', 'http_code' => 404, 'description' => '您指定的商品不存在'], + ['code' => 'NotFindItemPub', 'message' => 'The specified item does not exist.', 'http_code' => 417, 'description' => '您指定的商品不存在'], + ['code' => 'NotFindOperatorAccount', 'message' => 'The specified RAM user of the operator does not exist.', 'http_code' => 404, 'description' => '操作者的阿里云子账号不存在'], + ['code' => 'NotFindOperatorAccountPub', 'message' => 'The specified RAM user of the operator does not exist.', 'http_code' => 417, 'description' => '操作者的阿里云子账号不存在'], + ['code' => 'NotFindOperatorUser', 'message' => 'The specified ESL user of the operator does not exist.', 'http_code' => 404, 'description' => '操作者的云价签用户不存在'], + ['code' => 'NotFindOperatorUserPub', 'message' => 'The specified ESL user of the operator does not exist.', 'http_code' => 417, 'description' => '操作者的云价签用户不存在'], + ['code' => 'NotFindPlanogramPositionPub', 'message' => 'The specified planogram position does not exist.', 'http_code' => 417, 'description' => '您指定的陈列信息不存在'], + ['code' => 'NotFindPlanogramShelfPub', 'message' => 'The specified planogram shelf does not exist.', 'http_code' => 417, 'description' => '您指定的陈列货架不存在'], + ['code' => 'NotFindRailMappingPub', 'message' => 'The specified rail mapping does not exist.', 'http_code' => 417, 'description' => '您指定的导轨映射关系不存在'], + ['code' => 'NotFindRamUser', 'message' => 'The specified RAM user does not exist.', 'http_code' => 404, 'description' => '找不到对应的RAM账号'], + ['code' => 'NotFindRamUserPub', 'message' => 'The specified RAM user does not exist.', 'http_code' => 417, 'description' => '找不到对应的RAM账号'], + ['code' => 'NotFindResource', 'message' => 'The specified resource %s does not exist.', 'http_code' => 404, 'description' => '您使用的资源 %s 不存在'], + ['code' => 'NotFindResourcePub', 'message' => 'The specified resource %s does not exist.', 'http_code' => 417, 'description' => '您使用的资源 %s 不存在'], + ['code' => 'NotFindRoleByRoleCodePub', 'message' => 'The specified role code does not exist.', 'http_code' => 417, 'description' => '根据角色编码找不到角色'], + ['code' => 'NotFindStore', 'message' => 'The specified store %s does not exist.', 'http_code' => 404, 'description' => '您使用的门店 %s 不存在'], + ['code' => 'NotFindStorePub', 'message' => 'The specified store %s does not exist.', 'http_code' => 417, 'description' => '您使用的门店 %s 不存在'], + ['code' => 'NotFindTaoCustomItem', 'message' => 'Failed to get the information about the Taobao item using user-defined information.', 'http_code' => 404, 'description' => '通过顾客的自定义信息找不到淘宝相关商品信息'], + ['code' => 'NotFindTaoItem', 'message' => 'Failed to get the item information from Taobao.', 'http_code' => 404, 'description' => '找不到淘宝相关商品信息'], + ['code' => 'NotFindTaoItemByOuterId', 'message' => 'Failed to get the Taobao item using outer ID.', 'http_code' => 404, 'description' => '找不到商家自定义ID对应的淘宝商品'], + ['code' => 'NotFindTaoItemPrice', 'message' => 'Failed to get the price of the Taobao item.', 'http_code' => 404, 'description' => '找不到淘宝商品价格'], + ['code' => 'NotFindTaoItemPromotion', 'message' => 'Failed to get the Taobao item promotion information.', 'http_code' => 404, 'description' => '找不到淘宝商品促销信息'], + ['code' => 'NotFindTaoItemSku', 'message' => 'Failed to get the Taobao SKU ID.', 'http_code' => 404, 'description' => '找不到淘宝商品SkuID'], + ['code' => 'NotFindTaoItemSkuPrice', 'message' => 'Failed to get the price of the Taobao item SKU.', 'http_code' => 404, 'description' => '找不到淘宝商品SKU的价格'], + ['code' => 'NotFindTaoPromotion', 'message' => 'Failed to get the Taobao promotion.', 'http_code' => 404, 'description' => '找不到淘宝促销'], + ['code' => 'NotFindTaoSkuPromotion', 'message' => 'Failed to get the Taobao item SKU promotion information.', 'http_code' => 404, 'description' => '找不到淘宝商品SKU的促销信息'], + ['code' => 'NotFindTaoToken', 'message' => 'Failed to get the access token.', 'http_code' => 404, 'description' => '找不到淘宝授权'], + ['code' => 'NotFindUser', 'message' => 'The specified ESL user does not exist.', 'http_code' => 404, 'description' => '您指定的价签用户不存在'], + ['code' => 'NotFindUserAccount', 'message' => 'The specified RAM user does not exist.', 'http_code' => 404, 'description' => '请求的阿里云子账号不存在'], + ['code' => 'NotFindUserAccountPub', 'message' => 'The specified RAM user does not exist.', 'http_code' => 417, 'description' => '请求的阿里云子账号不存在'], + ['code' => 'NotFindUserPub', 'message' => 'The specified ESL user does not exist.', 'http_code' => 417, 'description' => '您指定的价签用户不存在'], + ['code' => 'NotFoundTheMaterial', 'message' => 'Failed to found the material in the brand.', 'http_code' => 418, 'description' => '无法获取当前媒体资源'], + ['code' => 'OAuthException', 'message' => 'An error occurred while processing your request.', 'http_code' => 405, 'description' => '系统内部错误'], + ['code' => 'OAuthExceptionPub', 'message' => 'An error occurred while processing your request.', 'http_code' => 418, 'description' => '系统内部错误'], + ['code' => 'OperationFail.CompanyNotFound', 'message' => 'The specified company does not exist.', 'http_code' => 400, 'description' => '商家不存在'], + ['code' => 'OperationFail.DuplicatedBind', 'message' => 'The specified ESL device has already been bound.', 'http_code' => 403, 'description' => '重复绑定'], + ['code' => 'OperationFail.EslDeviceNotBound', 'message' => 'The specified ESL device has not been bound.', 'http_code' => 403, 'description' => '价签设备未绑定'], + ['code' => 'OperationFail.EslDeviceNotFound', 'message' => 'The specified ESL device does not exist.', 'http_code' => 403, 'description' => '价签设备不存在'], + ['code' => 'OperationFail.ItemNotFound', 'message' => 'The specified item does not exist.', 'http_code' => 403, 'description' => '商品不存在'], + ['code' => 'OperationFail.StoreNotFound', 'message' => 'The specified store does not exist.', 'http_code' => 403, 'description' => '店铺不存在'], + ['code' => 'PermissionError', 'message' => 'You are not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => '权限不足'], + ['code' => 'PlanogramPositionAlreadyExistPub', 'message' => 'The specified planogram position already exists.', 'http_code' => 418, 'description' => '陈列信息已存在'], + ['code' => 'PlanogramShelfAlreadyExistPub', 'message' => 'The specified planogram shelf already exists.', 'http_code' => 418, 'description' => '陈列货架已存在'], + ['code' => 'PlatformError', 'message' => 'An error occurred while processing your API request on the platform.', 'http_code' => 500, 'description' => '平台接口错误'], + ['code' => 'PlatformFailActivateAp', 'message' => 'Failed to activate the specified access point.', 'http_code' => 406, 'description' => '内部激活基站设备出错'], + ['code' => 'PlatformFailBatchInsertItem', 'message' => 'Failed to insert multiple items.', 'http_code' => 406, 'description' => '内部商品批量修改出错'], + ['code' => 'PlatformFailBindAp', 'message' => 'Failed to bind the specified access point.', 'http_code' => 406, 'description' => '内部绑定基站设备出错'], + ['code' => 'PlatformFailBindEslDevice', 'message' => 'Failed to bind the specified ESL device.', 'http_code' => 406, 'description' => '内部绑定价签设备出错'], + ['code' => 'PlatformFailCreateCompany', 'message' => 'Failed to create a company.', 'http_code' => 406, 'description' => '内部新建商家出错'], + ['code' => 'PlatformFailCreateStore', 'message' => 'Failed to create a store.', 'http_code' => 406, 'description' => '内部新建门店出错'], + ['code' => 'PlatformFailDeleteEslDevice', 'message' => 'Failed to delete the specified ESL device.', 'http_code' => 406, 'description' => '内部删除价签设备出错'], + ['code' => 'PlatformFailGetEslDevice', 'message' => 'Failed to query the specified ESL device.', 'http_code' => 406, 'description' => '内部获取价签设备信息出错'], + ['code' => 'PlatformFailInsertItem', 'message' => 'Failed to insert an item.', 'http_code' => 406, 'description' => '内部商品修改出错'], + ['code' => 'PlatformFailSearchAp', 'message' => 'Failed to query the specified access point.', 'http_code' => 406, 'description' => '内部获取基站设备信息出错'], + ['code' => 'PlatformFailUnbindAp', 'message' => 'Failed to unbind the specified access point.', 'http_code' => 406, 'description' => '内部解绑基站设备出错'], + ['code' => 'PlatformFailUnbindEslDevice', 'message' => 'Failed to unbind the specified ESL device.', 'http_code' => 406, 'description' => '内部解绑价签设备出错'], + ['code' => 'PlatformResponseError', 'message' => 'An error occurred while processing your request.', 'http_code' => 416, 'description' => '内部操作响应出错'], + ['code' => 'PlatformResponseErrorPub.%s', 'message' => 'An error %s occurred while processing your request.', 'http_code' => 416, 'description' => '内部操作响应出错 %s'], + ['code' => 'PlatformResponseErrorPub.ActivateAp', 'message' => 'An error occurred while processing your request.', 'http_code' => 416, 'description' => '处理请求时出错'], + ['code' => 'PlatformResponseErrorPub.BindEslDevice', 'message' => 'An error occurred while processing your request.', 'http_code' => 416, 'description' => '处理请求时出错'], + ['code' => 'PlatformResponseNone', 'message' => 'Failed to respond to your request.', 'http_code' => 406, 'description' => '内部操作没有响应'], + ['code' => 'PlatformResponseNonePub', 'message' => 'Failed to respond to your request.', 'http_code' => 416, 'description' => '内部操作没有响应'], + ['code' => 'PlatformResponseParserError', 'message' => 'Failed to parse the response to your request.', 'http_code' => 406, 'description' => '内部操作响应解析出错'], + ['code' => 'PlatformResponseParserErrorPub', 'message' => 'Failed to parse the response to your request.', 'http_code' => 416, 'description' => '内部操作响应解析出错'], + ['code' => 'PublicMaterial', 'message' => 'The public material cannot be operated.', 'http_code' => 418, 'description' => '公共素材无法编辑'], + ['code' => 'PublicMaterial', 'message' => 'The public material cannott be operated.', 'http_code' => 418, 'description' => '公共素材库内容不可编辑'], + ['code' => 'RailNotBelongStorePub', 'message' => 'The specified rail is being used by another store.', 'http_code' => 418, 'description' => '导轨设备正被其它门店使用'], + ['code' => 'RamAuthFailed', 'message' => 'Failed to authenticate the specified RAM user.', 'http_code' => 405, 'description' => 'RAM校验失败'], + ['code' => 'RamAuthFailedPub', 'message' => 'Failed to authenticate the specified RAM user.', 'http_code' => 418, 'description' => 'RAM校验失败'], + ['code' => 'RamSettingError', 'message' => 'Failed to process your RAM settings.', 'http_code' => 405, 'description' => '用户RAM配置错误'], + ['code' => 'RamSettingErrorPub', 'message' => 'Failed to process your RAM settings.', 'http_code' => 418, 'description' => '用户RAM配置错误'], + ['code' => 'ResourcePermissionError', 'message' => 'You are not authorized to operate on the specified resource %s.', 'http_code' => 401, 'description' => '您暂时无权操作资源 %s'], + ['code' => 'ResourcePermissionErrorPub', 'message' => 'You are not authorized to manage the specified resource %s.', 'http_code' => 411, 'description' => '您暂时无权操作资源 %s'], + ['code' => 'ReviewImageError', 'message' => 'Failed to review image.', 'http_code' => 418, 'description' => '预览图片失败'], + ['code' => 'SendPictureToEslErrorPub', 'message' => 'Failed to send picture to ESL device.', 'http_code' => 418, 'description' => '发送图片到价签设备失败'], + ['code' => 'ServerLocationNotConfirmedErrorPub', 'message' => 'The server location is not confirmed.', 'http_code' => 418, 'description' => '服务器地址未确认'], + ['code' => 'SettingError', 'message' => 'The specified configurations are invalid.', 'http_code' => 502, 'description' => '用户配置错误'], + ['code' => 'ShelfNumberLimitPub', 'message' => 'The number of shelves under the store exceeds the limit.', 'http_code' => 418, 'description' => '您门店下的货架数量超出限制'], + ['code' => 'StoreBelongOther', 'message' => 'The specified store %s has been assigned to another store administrator.', 'http_code' => 409, 'description' => '您指定的门店 %s 已分配门店管理员'], + ['code' => 'StoreBelongOtherPub', 'message' => 'The specified store %s has been assigned to another store administrator.', 'http_code' => 419, 'description' => '您指定的门店 %s 已分配门店管理员'], + ['code' => 'StoreError', 'message' => 'An error occurred while processing your request related to stores.', 'http_code' => 507, 'description' => '店铺账号错误'], + ['code' => 'StoreNumberLimitPub', 'message' => 'The number of stores exceeds the limit.', 'http_code' => 418, 'description' => '您的门店数量超出限制'], + ['code' => 'StoreNumLimit', 'message' => 'The maximum number of stores is %s.', 'http_code' => 410, 'description' => '门店数量最多为 %s。'], + ['code' => 'StoreOutsideCompany', 'message' => 'The specified store under the company does not exist.', 'http_code' => 405, 'description' => '商家下找不到请求的门店'], + ['code' => 'StoreOutsideCompanyPub', 'message' => 'The specified store for the company does not exist.', 'http_code' => 418, 'description' => '商家下找不到请求的门店'], + ['code' => 'SystemError', 'message' => 'A system error occurred while processing your request.', 'http_code' => 500, 'description' => '系统错误'], + ['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' => '没有公测资格'], + ['code' => 'UnbindingStoreEslErrorPub', 'message' => 'In Unbinding, please wait', 'http_code' => 418, 'description' => '您的门店下价签设备正在解绑中'], + ['code' => 'UnexpectedError', 'message' => 'An error occurred while processing your request.', 'http_code' => 405, 'description' => '未知错误'], + ['code' => 'UnexpectedErrorPub', 'message' => 'An error occurred while processing your request.', 'http_code' => 418, 'description' => '未知错误'], + ['code' => 'UnknownError', 'message' => 'An error occurred while processing your request.', 'http_code' => 501, 'description' => '发生了未知错误。'], + ['code' => 'UserAlreadyExist', 'message' => 'The specified user already exists.', 'http_code' => 405, 'description' => '用户已存在'], + ['code' => 'UserAlreadyExistPub', 'message' => 'The specified user already exists.', 'http_code' => 418, 'description' => '用户已存在'], + ['code' => 'UserAssignGuest', 'message' => 'Users cannot be assigned as guests.', 'http_code' => 405, 'description' => '不允许把用户授权为未分配权限'], + ['code' => 'UserAssignGuestPub', 'message' => 'Users cannot be assigned as guests.', 'http_code' => 418, 'description' => '不允许把用户授权为未分配权限'], + ['code' => 'UserCompanyRootExist', 'message' => 'The specified company root administrator already exists.', 'http_code' => 405, 'description' => '高级商家管理员已存在'], + ['code' => 'UserCompanyRootExistPub', 'message' => 'The specified company root administrator already exists.', 'http_code' => 418, 'description' => '高级商家管理员已存在'], + ['code' => 'UserDeleteNotGuest', 'message' => 'Only guests can be deleted.', 'http_code' => 405, 'description' => '只允许删除未分配权限用户'], + ['code' => 'UserDeleteNotGuestPub', 'message' => 'Only guests can be deleted.', 'http_code' => 418, 'description' => '只允许删除未分配权限用户'], + ['code' => 'UserError', 'message' => 'An error occurred while processing your request.', 'http_code' => 504, 'description' => '用户系统错误'], + ['code' => 'UserInStore', 'message' => 'The store contains a user.', 'http_code' => 405, 'description' => '该门店还存在用户'], + ['code' => 'UserInStorePub', 'message' => 'The store contains a user.', 'http_code' => 418, 'description' => '该门店还存在用户'], + ['code' => 'UserOutsideCompany', 'message' => 'The operator and the specified user do not belong to the same company.', 'http_code' => 405, 'description' => '操作用户和请求用户所属商家不一致'], + ['code' => 'UserOutsideCompanyPub', 'message' => 'The operator and the specified user do not belong to the same company.', 'http_code' => 418, 'description' => '操作用户和请求用户所属商家不一致'], + ['code' => 'UserStoreCodeAlreadyExistPub', 'message' => 'The specified userStoreCode already exists.', 'http_code' => 418, 'description' => '商家内部门店ID已存在'], + ['code' => 'UserTypePermissionError', 'message' => 'You are not authorized to operate on the specified user type %s.', 'http_code' => 401, 'description' => '您暂时无权操作用户类型 %s'], + ['code' => 'UserTypePermissionErrorPub', 'message' => 'You are not authorized to manage the specified user type %s.', 'http_code' => 411, 'description' => '您暂时无权操作用户类型 %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', + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ActivateApDevice'], + ['description' => '错误码发生变更', 'api' => 'AddApDevice'], + ['description' => '错误码发生变更', 'api' => 'AddUser'], + ['description' => '错误码发生变更', 'api' => 'AssignUser'], + ['description' => '错误码发生变更', 'api' => 'DeleteApDevice'], + ], + 'createdAt' => '2024-04-26T06:18:58.000Z', + 'description' => '', ], [ - 'regionId' => 'me-east-1', - 'endpoint' => 'cloudesl.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateStore'], + ['description' => '响应参数发生变更', 'api' => 'DescribeStores'], + ['description' => '请求参数发生变更', 'api' => 'UpdateStore'], + ], + 'createdAt' => '2022-11-23T03:20:32.000Z', + 'description' => '增加自动删除离线价签配置', ], [ - 'regionId' => 'rus-west-1-pop', - 'endpoint' => 'cloudesl.aliyuncs.com', + 'apis' => [ + ['description' => '错误码发生变更、请求参数发生变更', 'api' => 'AddCompanyTemplate'], + ['description' => '错误码发生变更、请求参数发生变更', 'api' => 'BindEslDevice'], + ['description' => '响应参数发生变更、错误码发生变更', 'api' => 'DescribeBinders'], + ['description' => '响应参数发生变更', 'api' => 'DescribeEslDevices'], + ['description' => '响应参数发生变更', 'api' => 'DescribeTemplateByModel'], + ['description' => 'OpenAPI 下线', 'api' => 'QueryTemplateListByGroupId'], + ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'UnbindEslDevice'], + ], + 'createdAt' => '2022-07-18T13:15:44.000Z', + 'description' => '多媒体一屏多价功能支持', ], [ - 'regionId' => 'us-east-1', - 'endpoint' => 'cloudesl.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'BatchInsertItems'], + ['description' => '响应参数发生变更', 'api' => 'DescribeItems'], + ], + 'createdAt' => '2022-07-18T13:14:34.000Z', + 'description' => '出清模板支持', ], [ - 'regionId' => 'us-west-1', - 'endpoint' => 'cloudesl.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'AddMaterial'], + ], + 'createdAt' => '2022-05-30T08:48:26.000Z', + 'description' => '云价签1.2.0接口版本发布', ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'cloudesl.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更、错误码发生变更', 'api' => 'DescribeEslDevices'], + ], + 'createdAt' => '2022-03-30T09:08:37.000Z', + 'description' => '-增加电子价签模板可视化功能.', ], ], ]; |