diff options
Diffstat (limited to 'data/en_us/imagesearch/2021-05-01/api-docs.php')
| -rw-r--r-- | data/en_us/imagesearch/2021-05-01/api-docs.php | 1553 |
1 files changed, 1553 insertions, 0 deletions
diff --git a/data/en_us/imagesearch/2021-05-01/api-docs.php b/data/en_us/imagesearch/2021-05-01/api-docs.php new file mode 100644 index 0000000..2375671 --- /dev/null +++ b/data/en_us/imagesearch/2021-05-01/api-docs.php @@ -0,0 +1,1553 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'ImageSearch', + 'version' => '2021-05-01', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'SearchByUrl', + 'SearchByPic', + 'GetProductInfoByIds', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'SearchByUrl' => [ + 'summary' => '使用Url进行搜索', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PicUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'https://oss-test.oss-cn-shanghai.aliyuncs.com/xxxx.jpg', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '88888888', + 'minimum' => '0', + 'example' => '88888888', + 'enum' => [ + '0', + '1', + '2', + '3', + '4', + '5', + '6', + '7', + '8', + '9', + '20', + '21', + '22', + '88888888', + ], + ], + ], + [ + 'name' => 'Pid', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mm_xxx_xxx_xxx', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Region', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '280,486,232,351', + ], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '499', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'Num', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Url,UserType', + ], + ], + [ + 'name' => 'RelationId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1125526', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Auctions' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ItemId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'Title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ShortTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SubTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'PicUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '//img.alicdn.com/i1/FXXXXXXXXXX.jpg', + ], + 'ReservePrice' => [ + 'description' => '', + 'type' => 'string', + 'example' => '158', + ], + 'ZkFinalPrice' => [ + 'description' => '', + 'type' => 'string', + 'example' => '98', + ], + 'PriceAfterCoupon' => [ + 'description' => '', + 'type' => 'string', + 'example' => '90', + ], + 'UserType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Provcity' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Nick' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SellerId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '32590610', + ], + 'Volume' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'LevelOneCategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CouponTotalCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100000', + ], + 'CouponRemainCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CouponStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-05-01', + ], + 'CouponEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-06-01', + ], + 'CouponStartFee' => [ + 'description' => '', + 'type' => 'string', + 'example' => '98.000000', + ], + 'CouponAmount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'CouponInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CommissionRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '180', + ], + 'CouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '//uland.taobao.com/cxxxxxx', + ], + 'DeeplinkCouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'example' => '//s.click.taobao.com/t?xxxxxx', + ], + 'DeeplinkUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'ShopTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'MaxCommission' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MaxCommissionRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '20.4', + ], + 'MaxCommissionClickUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://s.click.taobao.com/t?e=xxxx', + ], + 'MaxCommissionCouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://s.click.taobao.com/t?e=xxxx', + ], + ], + ], + ], + ], + 'RankScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.337', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', + ], + 'PicInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MainRegion' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => '280,486,232,351', + ], + 'MultiCategoryId' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '88888888', + ], + 'Score' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.34', + ], + ], + ], + ], + ], + ], + 'MultiRegion' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => '280,486,232,351', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'PidNotExist', + 'errorMessage' => 'The parameter specified Pid not exist', + ], + [ + 'errorCode' => 'InvalidPid', + 'errorMessage' => 'The parameter Pid no specified', + ], + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'The request has invalid parameters.', + ], + [ + 'errorCode' => 'InstanceStatusError', + 'errorMessage' => 'Your instance is unavailable.', + ], + [ + 'errorCode' => 'TimeoutForTransferImage', + 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', + ], + [ + 'errorCode' => 'NoSpecifiedSearchPic', + 'errorMessage' => 'The search image is not specified.', + ], + [ + 'errorCode' => 'InvalidCategory', + 'errorMessage' => 'The specified category is invalid.', + ], + [ + 'errorCode' => 'OverflowMaxResultNum', + 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', + ], + [ + 'errorCode' => 'OverflowMaxReturnNum', + 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', + ], + [ + 'errorCode' => 'InvalidStartParameter', + 'errorMessage' => 'The specified parameter start is inavlid.', + ], + [ + 'errorCode' => 'InvalidNumParameter', + 'errorMessage' => 'The specified parameter num is invalid.', + ], + [ + 'errorCode' => 'InvalidIntAttr', + 'errorMessage' => 'The specified int_attr field is invalid.', + ], + [ + 'errorCode' => 'UnsupportedPicFormat', + 'errorMessage' => 'The specified image format is invalid.', + ], + [ + 'errorCode' => 'InvalidFilterClause', + 'errorMessage' => 'The specified filtering condition is invalid.', + ], + [ + 'errorCode' => 'IncorrectOrientation', + 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', + ], + [ + 'errorCode' => 'UnsupportedPicPixels', + 'errorMessage' => 'The specified pixels is not supported.', + ], + [ + 'errorCode' => 'SearchTimeout', + 'errorMessage' => 'The request is timed out.', + ], + [ + 'errorCode' => 'NoSpecifiedPicContent', + 'errorMessage' => 'The parameter PicContent no specified.', + ], + [ + 'errorCode' => 'InvalidCustomContent', + 'errorMessage' => 'The specified parameter CustomContent is not valid.', + ], + [ + 'errorCode' => 'InvalidPicContent', + 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', + ], + [ + 'errorCode' => 'InvalidPicUrl', + 'errorMessage' => 'The specified parameter PicUrl is not valid.', + ], + [ + 'errorCode' => 'NotRegisterBeforeInvoke', + 'errorMessage' => 'Need register token: pid before invoke.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownException', + 'errorMessage' => 'An internal server error occurred.', + ], + [ + 'errorCode' => 'NetworkException', + 'errorMessage' => 'A network error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'The request is timeout.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Auctions\\": [\\n {\\n \\"Result\\": {\\n \\"ItemId\\": \\"0gkRpWudf8Qk6G0AqU6NZH2t6-4asdasdaszxczxpz\\",\\n \\"Title\\": \\"xxx套装\\",\\n \\"ShortTitle\\": \\"yyy套装\\",\\n \\"SubTitle\\": \\"xxx套装\\",\\n \\"PicUrl\\": \\"//img.alicdn.com/i1/FXXXXXXXXXX.jpg\\",\\n \\"ReservePrice\\": \\"158\\",\\n \\"ZkFinalPrice\\": \\"98\\",\\n \\"PriceAfterCoupon\\": \\"90\\",\\n \\"UserType\\": 0,\\n \\"Provcity\\": \\"广东 深圳\\",\\n \\"Nick\\": \\"衣服专卖店\\",\\n \\"SellerId\\": \\"32590610\\",\\n \\"Volume\\": 500,\\n \\"LevelOneCategoryName\\": \\"童装/婴儿装/亲子装\\",\\n \\"CategoryName\\": \\"连衣裙\\",\\n \\"CouponTotalCount\\": \\"100000\\",\\n \\"CouponRemainCount\\": 0,\\n \\"CouponStartTime\\": \\"2021-05-01\\",\\n \\"CouponEndTime\\": \\"2021-06-01\\",\\n \\"CouponStartFee\\": \\"98.000000\\",\\n \\"CouponAmount\\": 5,\\n \\"CouponInfo\\": \\"满98.0元减5.0元\\",\\n \\"CommissionRate\\": \\"180\\",\\n \\"CouponShareUrl\\": \\"//uland.taobao.com/cxxxxxx\\",\\n \\"DeeplinkCouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"Url\\": \\"//s.click.taobao.com/t?xxxxxx\\",\\n \\"DeeplinkUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"ShopTitle\\": \\"xx旗舰店\\",\\n \\"MaxCommission\\": {\\n \\"MaxCommissionRate\\": \\"20.4\\",\\n \\"MaxCommissionClickUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\",\\n \\"MaxCommissionCouponShareUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\"\\n }\\n },\\n \\"RankScore\\": 0.337\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"PicInfo\\": {\\n \\"MainRegion\\": {\\n \\"Region\\": \\"280,486,232,351\\",\\n \\"MultiCategoryId\\": [\\n {\\n \\"CategoryId\\": 88888888,\\n \\"Score\\": 0.34\\n }\\n ]\\n },\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"280,486,232,351\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'SearchByPic' => [ + 'summary' => '使用图片进行搜索', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PicContent', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '88888888', + 'minimum' => '0', + 'example' => '88888888', + 'enum' => [ + '0', + '1', + '2', + '3', + '4', + '5', + '6', + '7', + '8', + '9', + '20', + '21', + '22', + '88888888', + ], + ], + ], + [ + 'name' => 'Pid', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mm_xxx_xxx_xxx', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Region', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '280,486,232,351', + ], + ], + [ + 'name' => 'Start', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '499', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'Num', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Url,UserType', + ], + ], + [ + 'name' => 'RelationId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1125526', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'sucess', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Auctions' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ItemId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'Title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ShortTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SubTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'PicUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '//img.alicdn.com/i1/FXXXXXXXXXX.jpg', + ], + 'ReservePrice' => [ + 'description' => '', + 'type' => 'string', + 'example' => '158', + ], + 'ZkFinalPrice' => [ + 'description' => '', + 'type' => 'string', + 'example' => '98', + ], + 'PriceAfterCoupon' => [ + 'description' => '', + 'type' => 'string', + 'example' => '90', + ], + 'UserType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Provcity' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Nick' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SellerId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '32590610', + ], + 'Volume' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'LevelOneCategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CouponTotalCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100000', + ], + 'CouponRemainCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CouponStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-05-01', + ], + 'CouponEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-06-01', + ], + 'CouponStartFee' => [ + 'description' => '', + 'type' => 'string', + 'example' => '98.000000', + ], + 'CouponAmount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'CouponInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CommissionRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '180', + ], + 'CouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '//uland.taobao.com/xxxxxxx', + ], + 'DeeplinkCouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'example' => '//s.click.taobao.com/t?xxxxxx', + ], + 'DeeplinkUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'ShopTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'MaxCommission' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MaxCommissionRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '20.4', + ], + 'MaxCommissionClickUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://s.click.taobao.com/t?e=xxxx', + ], + 'MaxCommissionCouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://uland.taobao.com/coupon/xxxx', + ], + ], + ], + ], + ], + 'RankScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.337', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', + ], + 'PicInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MainRegion' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => '280,486,232,351', + ], + 'MultiCategoryId' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '88888888', + ], + 'Score' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.34', + ], + ], + ], + ], + ], + ], + 'MultiRegion' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '', + 'type' => 'string', + 'example' => '280,486,232,351', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPicContent', + 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', + ], + [ + 'errorCode' => 'InvalidPid', + 'errorMessage' => 'The parameter Pid no specified', + ], + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'The request has invalid parameters.', + ], + [ + 'errorCode' => 'NoSpecifiedSearchPic', + 'errorMessage' => 'The search image is not specified.', + ], + [ + 'errorCode' => 'InvalidCategory', + 'errorMessage' => 'The specified category is invalid.', + ], + [ + 'errorCode' => 'OverflowMaxResultNum', + 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', + ], + [ + 'errorCode' => 'OverflowMaxReturnNum', + 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', + ], + [ + 'errorCode' => 'InvalidStartParameter', + 'errorMessage' => 'The specified parameter start is inavlid.', + ], + [ + 'errorCode' => 'InvalidNumParameter', + 'errorMessage' => 'The specified parameter num is invalid.', + ], + [ + 'errorCode' => 'InvalidIntAttr', + 'errorMessage' => 'The specified int_attr field is invalid.', + ], + [ + 'errorCode' => 'UnsupportedPicFormat', + 'errorMessage' => 'The specified image format is invalid.', + ], + [ + 'errorCode' => 'InvalidFilterClause', + 'errorMessage' => 'The specified filtering condition is invalid.', + ], + [ + 'errorCode' => 'IncorrectOrientation', + 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', + ], + [ + 'errorCode' => 'UnsupportedPicPixels', + 'errorMessage' => 'The specified pixels is not supported.', + ], + [ + 'errorCode' => 'SearchTimeout', + 'errorMessage' => 'The request is timed out.', + ], + [ + 'errorCode' => 'NoSpecifiedPicContent', + 'errorMessage' => 'The parameter PicContent no specified.', + ], + [ + 'errorCode' => 'InvalidCustomContent', + 'errorMessage' => 'The specified parameter CustomContent is not valid.', + ], + [ + 'errorCode' => 'NotRegisterBeforeInvoke', + 'errorMessage' => 'Need register token: pid before invoke.', + ], + ], + 403 => [ + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownException', + 'errorMessage' => 'An internal server error occurred.', + ], + [ + 'errorCode' => 'NetworkException', + 'errorMessage' => 'A network error occurred.', + ], + [ + 'errorCode' => 'InternalException', + 'errorMessage' => 'An internal server error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'The request is timeout.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"sucess\\",\\n \\"Data\\": {\\n \\"Auctions\\": [\\n {\\n \\"Result\\": {\\n \\"ItemId\\": \\"casdcascascasc-dsasdasdasdasdas\\",\\n \\"Title\\": \\"xxx套装\\",\\n \\"ShortTitle\\": \\"yyy套装\\",\\n \\"SubTitle\\": \\"xxx套装\\",\\n \\"PicUrl\\": \\"//img.alicdn.com/i1/FXXXXXXXXXX.jpg\\",\\n \\"ReservePrice\\": \\"158\\",\\n \\"ZkFinalPrice\\": \\"98\\",\\n \\"PriceAfterCoupon\\": \\"90\\",\\n \\"UserType\\": 0,\\n \\"Provcity\\": \\"广东 深圳\\",\\n \\"Nick\\": \\"衣服专卖店\\",\\n \\"SellerId\\": \\"32590610\\",\\n \\"Volume\\": 500,\\n \\"LevelOneCategoryName\\": \\"童装/婴儿装/亲子装\\",\\n \\"CategoryName\\": \\"连衣裙\\",\\n \\"CouponTotalCount\\": \\"100000\\",\\n \\"CouponRemainCount\\": 0,\\n \\"CouponStartTime\\": \\"2021-05-01\\",\\n \\"CouponEndTime\\": \\"2021-06-01\\",\\n \\"CouponStartFee\\": \\"98.000000\\",\\n \\"CouponAmount\\": 5,\\n \\"CouponInfo\\": \\"满98.0元减5.0元\\",\\n \\"CommissionRate\\": \\"180\\",\\n \\"CouponShareUrl\\": \\"//uland.taobao.com/xxxxxxx\\",\\n \\"DeeplinkCouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"Url\\": \\"//s.click.taobao.com/t?xxxxxx\\",\\n \\"DeeplinkUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"ShopTitle\\": \\"xx旗舰店\\",\\n \\"MaxCommission\\": {\\n \\"MaxCommissionRate\\": \\"20.4\\",\\n \\"MaxCommissionClickUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\",\\n \\"MaxCommissionCouponShareUrl\\": \\"https://uland.taobao.com/coupon/xxxx\\"\\n }\\n },\\n \\"RankScore\\": 0.337\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"PicInfo\\": {\\n \\"MainRegion\\": {\\n \\"Region\\": \\"280,486,232,351\\",\\n \\"MultiCategoryId\\": [\\n {\\n \\"CategoryId\\": 88888888,\\n \\"Score\\": 0.34\\n }\\n ]\\n },\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"280,486,232,351\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'GetProductInfoByIds' => [ + 'summary' => '获取商品信息', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ItemIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '111,22,33', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mm_xxx_xxx_xxx', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Url,UserType', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Auctions' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InputItemId' => [ + 'type' => 'string', + ], + 'ItemId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'Title' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ShortTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SubTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'PicUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => '//img.alicdn.com/i1/FXXXXXXXXXX.jpg', + ], + 'ReservePrice' => [ + 'description' => '', + 'type' => 'string', + 'example' => '150', + ], + 'ZkFinalPrice' => [ + 'description' => '', + 'type' => 'string', + 'example' => '98', + ], + 'PriceAfterCoupon' => [ + 'description' => '', + 'type' => 'string', + 'example' => '90', + ], + 'UserType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Provcity' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Nick' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SellerId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '32590610', + ], + 'CategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Volume' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'LevelOneCategoryName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CouponTotalCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '10000', + ], + 'CouponRemainCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CouponStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-05-01', + ], + 'CouponEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-06-01', + ], + 'CouponStartFee' => [ + 'description' => '', + 'type' => 'string', + 'example' => '98.000000', + ], + 'CouponAmount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'CouponInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CommissionRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '180', + ], + 'CouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'DeeplinkCouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'DeeplinkUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'tbopen://m.taobao.com/tbopen/index.html?', + ], + 'ShopTitle' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'MaxCommission' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MaxCommissionRate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '20.4', + ], + 'MaxCommissionClickUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://s.click.taobao.com/t?e=xxxx', + ], + 'MaxCommissionCouponShareUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://s.click.taobao.com/t?e=xxxx', + ], + ], + ], + ], + ], + 'RankScore' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.34', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'PidNotExist', + 'errorMessage' => 'The parameter specified Pid not exist', + ], + [ + 'errorCode' => 'InvalidPid', + 'errorMessage' => 'The parameter Pid no specified', + ], + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'The request has invalid parameters.', + ], + [ + 'errorCode' => 'InstanceStatusError', + 'errorMessage' => 'Your instance is unavailable.', + ], + [ + 'errorCode' => 'TimeoutForTransferImage', + 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', + ], + [ + 'errorCode' => 'InvalidInstance', + 'errorMessage' => 'The specified instance name is invalid.', + ], + [ + 'errorCode' => 'InvalidItemIds', + 'errorMessage' => 'ItemIds parameter overflow number max 40.', + ], + [ + 'errorCode' => 'OverflowMaxResultNum', + 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', + ], + [ + 'errorCode' => 'OverflowMaxReturnNum', + 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', + ], + [ + 'errorCode' => 'InvalidStartParameter', + 'errorMessage' => 'The specified parameter start is inavlid.', + ], + [ + 'errorCode' => 'InvalidNumParameter', + 'errorMessage' => 'The specified parameter num is invalid.', + ], + [ + 'errorCode' => 'InvalidIntAttr', + 'errorMessage' => 'The specified int_attr field is invalid.', + ], + [ + 'errorCode' => 'UnsupportedPicFormat', + 'errorMessage' => 'The specified image format is invalid.', + ], + [ + 'errorCode' => 'InvalidFilterClause', + 'errorMessage' => 'The specified filtering condition is invalid.', + ], + [ + 'errorCode' => 'IncorrectOrientation', + 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', + ], + [ + 'errorCode' => 'UnsupportedPicPixels', + 'errorMessage' => 'The specified pixels is not supported.', + ], + [ + 'errorCode' => 'SearchTimeout', + 'errorMessage' => 'The request is timed out.', + ], + [ + 'errorCode' => 'NoSpecifiedPicContent', + 'errorMessage' => 'The parameter PicContent no specified.', + ], + [ + 'errorCode' => 'InvalidCustomContent', + 'errorMessage' => 'The specified parameter CustomContent is not valid.', + ], + [ + 'errorCode' => 'InvalidPicContent', + 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', + ], + [ + 'errorCode' => 'InvalidPicUrl', + 'errorMessage' => 'The specified parameter PicUrl is not valid.', + ], + [ + 'errorCode' => 'NotRegisterBeforeInvoke', + 'errorMessage' => 'Need register token: pid before invoke.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform this operation.', + ], + [ + 'errorCode' => 'DeniedRequest', + 'errorMessage' => 'Your request was denied due to instance flow control.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'An internal server error occurred.', + ], + [ + 'errorCode' => 'NetworkException', + 'errorMessage' => 'A network error occurred.', + ], + [ + 'errorCode' => 'RequestTimeout', + 'errorMessage' => 'The request is timeout.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Auctions\\": [\\n {\\n \\"Result\\": {\\n \\"InputItemId\\": \\"123000123\\",\\n \\"ItemId\\": \\"Oqz93kougf9bkN7f4ACMtJ\\",\\n \\"Title\\": \\"xxx套装\\",\\n \\"ShortTitle\\": \\"xxx套装\\",\\n \\"SubTitle\\": \\"xxx套装\\",\\n \\"PicUrl\\": \\"//img.alicdn.com/i1/FXXXXXXXXXX.jpg\\",\\n \\"ReservePrice\\": \\"150\\",\\n \\"ZkFinalPrice\\": \\"98\\",\\n \\"PriceAfterCoupon\\": \\"90\\",\\n \\"UserType\\": 0,\\n \\"Provcity\\": \\"广东 深圳\\",\\n \\"Nick\\": \\"衣服专卖店\\",\\n \\"SellerId\\": \\"32590610\\",\\n \\"CategoryName\\": \\"连衣裙\\",\\n \\"Volume\\": 500,\\n \\"LevelOneCategoryName\\": \\"童装/婴儿装/亲子装\\",\\n \\"CouponTotalCount\\": \\"10000\\",\\n \\"CouponRemainCount\\": 0,\\n \\"CouponStartTime\\": \\"2021-05-01\\",\\n \\"CouponEndTime\\": \\"2021-06-01\\",\\n \\"CouponStartFee\\": \\"98.000000\\",\\n \\"CouponAmount\\": 8,\\n \\"CouponInfo\\": \\"满98.0元减5.0元\\",\\n \\"CommissionRate\\": \\"180\\",\\n \\"CouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"DeeplinkCouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"Url\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"DeeplinkUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"ShopTitle\\": \\"xx旗舰店\\",\\n \\"MaxCommission\\": {\\n \\"MaxCommissionRate\\": \\"20.4\\",\\n \\"MaxCommissionClickUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\",\\n \\"MaxCommissionCouponShareUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\"\\n }\\n },\\n \\"RankScore\\": 0.34\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'imagesearch.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'imagesearch.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'imagesearch.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'imagesearch.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'imagesearch.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'imagesearch.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'imagesearch.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'imagesearch.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'imagesearch.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'imagesearch.ap-south-1.aliyuncs.com', + ], + ], +]; |