'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'linkedmall', 'version' => '2018-01-16', ], 'directories' => [ [ 'id' => 114581, 'title' => '营销优惠', 'type' => 'directory', 'children' => [ 'GrantPromotionToUser', ], ], [ 'id' => 114583, 'title' => '互动活动', 'type' => 'directory', 'children' => [ 'StartUserGame', 'PushUserGameProcess', 'GetActivityGameInfo', 'GetUserTokenPage', 'ListActivityAtmosphere', 'ListActivityGameInfo', 'ListUserGameProcess', 'QueryUserGameProcess', ], ], [ 'id' => 114592, 'title' => '积分', 'type' => 'directory', 'children' => [ 'DeductUserPoint', 'FreezeUserPoint', 'GiveUserPoint', 'GrantUserPoint', 'RefundUserPoint', 'UnFreezeUserPoint', 'ListUserPointRecords', 'QueryUserPoint', ], ], [ 'id' => 114601, 'title' => '商品', 'type' => 'directory', 'children' => [ 'AddItemLimitRule', 'AddSupplierNewItems', 'DeleteBizItems', 'ModifyBizItems', 'ModifyItemLimitRule', 'QueryItemDetailTea', 'QueryItemDetailInner', 'QueryItemInventory', 'GetItemPromotion', 'QueryActivityItems', 'QueryBizItemList', 'QueryBizItems', 'QueryGuideItemGroup', ], ], [ 'id' => 114615, 'title' => '订单', 'type' => 'directory', 'children' => [ 'CreateVirtualProductOrder', 'SettleOrder', 'QueryOrderAndPaymentList', 'QueryOrderCommissionRate', 'QueryOrderDetailInner', 'QueryOrderIdByPayId', 'QueryOrderInfoAfterSale', 'QueryOrderItemInfoByPaymentIdForAiZhanYou', 'QueryOrderList', 'QueryOrderLogistics', 'QueryLogistics', 'RenderH5Order', 'RepayOrder', ], ], [ 'id' => 114629, 'title' => '交易', 'type' => 'directory', 'children' => [ 'CreateOrderV2', 'EnableOrder', 'CancelOrder', 'RenderOrder', ], ], [ 'id' => 114634, 'title' => '逆向', 'type' => 'directory', 'children' => [ 'ApplyRefund', 'CancelRefund', 'SubmitReturnGoodLogistics', 'QueryRefundApplicationDetail', 'InitApplyRefund', ], ], [ 'id' => 114640, 'title' => '消息', 'type' => 'directory', 'children' => [ 'QueryMessages', 'RemoveMessages', ], ], [ 'id' => 114643, 'title' => '公共', 'type' => 'directory', 'children' => [ 'DeleteItemLimitRule', 'ModifyBasicAndBizItems', 'GetCustomServiceUrl', 'GetGuidePage', 'GetLoginPage', 'GetSwitchUrl', 'GetUserInfo', 'QueryAgreement', 'QueryAllCities', 'QueryBestSession4Items', 'QueryStatements', 'QueryUnfinishedSessions', 'QueryWithholdTrade', 'ExecuteNode', 'RefundPoint', 'RefuseMerchantSyncTask', 'SyncMerchantInfo', ], ], [ 'id' => 114661, 'title' => '活动', 'type' => 'directory', 'children' => [ 'ListItemActivities', 'QueryUnfinishedActivities', 'QueryBizItemsWithActivity', 'QueryUnfinishedSessions4Items', ], ], [ 'id' => 114666, 'title' => '支付退款', 'type' => 'directory', 'children' => [ 'CreateWithholdTrade', 'CreatePayUrl', 'GetWithholdSignPageUrl', 'RefundOrder', 'RepayForPayUrl', 'UnsignWithholdAgreement', ], ], [ 'id' => 114675, 'title' => '废弃', 'type' => 'directory', 'children' => [ 'CreateOrder', 'QueryItemDetail', ], ], [ 'id' => 114678, 'title' => '电影', 'type' => 'directory', 'children' => [ 'QueryAllCinemas', 'QueryHotMovies', 'QueryMovieComments', 'QueryMovieSchedules', 'QueryMovieSeats', 'QueryMovieTickets', 'QueryUpcomingMovies', 'ReleaseMovieSeat', 'ReserveMovieSeat', ], ], [ 'id' => 114689, 'title' => '账户', 'type' => 'directory', 'children' => [ 'QueryBatchRegistAnonymousTbAccountResult', 'BatchRegistAnonymousTbAccount', 'ValidateTaobaoAccount', 'RegistAnonymousTbAccount', ], ], [ 'id' => 114694, 'title' => '类目', 'type' => 'directory', 'children' => [ 'GetCategoryChain', 'GetCategoryList', ], ], [ 'id' => 114697, 'title' => '收货退货', 'type' => 'directory', 'children' => [ 'ConfirmDisburse', ], ], [ 'id' => 114699, 'title' => '地址', 'type' => 'directory', 'children' => [ 'AddAddress', 'UpdateAddress', 'QueryAddress', 'QueryAddressDetail', 'QueryAddressList', 'RemoveAddress', ], ], [ 'id' => 172869, 'title' => '其他', 'type' => 'directory', 'children' => [ 'AddItemToSubBizs', 'CreateSettleConfirm', 'ModifyOrderDeliveryAddress', 'QueryAdvertisementSettleInfo', 'QueryBizItemListWithCache', 'QueryBudgetTicketItemListByBizId', 'QueryGuideItemGroupWithOutInventory', 'QueryInventoryOfItemsInBizItemGroup', 'QueryItemInSubBizs', 'QueryMediaSettleInfo', 'RegisterSettleAccount', 'ApplyRefundWithDesignatedTbUid', 'CancelOrderWithDesignatedTbUid', 'CancelRealTbAccountSupport', 'CancelRefundWithDesignatedTbUid', 'ConfirmDisburseWithDesignatedTbUid', 'CreateOrderPayUrlForOutDiscount', 'CreateOrderTransactionDetailFile', 'CreateOrderWithDesignatedTbUid', 'CreateOutDiscountOrderWithDesignatedTbUid', 'DownloadCpsBillFile', 'DownloadItemBillFile', 'DownloadOrderTransactionDetailFile', 'EnableOrderWithDesignatedTbUid', 'InitApplyRefundWithDesignatedTbUid', 'InitModifyRefund', 'InitModifyRefundWithDesignatedTbUid', 'ModifyRefund', 'ModifyRefundWithDesignatedTbUid', 'ModifySettleAccount', 'ModifySupplierPriceAndPriceCent', 'OpenRealTbAccountSupport', 'QueryBizItemListV2', 'QueryGuideItemGroupForCrowdOperation', 'QueryItemInventoryV2', 'QueryOrderAndPaymentListWithDesignatedTbUid', 'QueryOrderListWithDesignatedTbUid', 'QueryOrderLogisticsWithDesignatedTbUid', 'QueryRealTbAccountSupport', 'QueryRefundApplyWithDesignatedTbUid', 'QueryUserAccount', 'RebindTbAccount', 'RefreshSettlementOrderAccount', 'RegisterUserAccount', 'RenderOrderWithDesignatedTbUid', 'RepayWithDesignatedTbUid', 'SubmitReturnGoodLogisticsWithDesignatedTbUid', 'ModifyBasicItemSupplierPrice', 'QuerySupplierItemBillDownloadUrl', 'QueryChannelItemBillDownloadUrl', 'QuerySellerLicense', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'GrantPromotionToUser' => [ 'summary' => '给指定用户发放指定的优惠券,需提前在linkedmall控制台创建对应的优惠。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'required' => true, 'example' => 'LMALL20211118****', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'required' => true, ], ], [ 'name' => 'PromotionId', 'in' => 'query', 'schema' => [ 'title' => '优惠元数据ID', 'description' => '优惠元数据ID', 'type' => 'string', 'required' => true, 'example' => '66482394364783****', ], ], [ 'name' => 'SecurityCode', 'in' => 'query', 'schema' => [ 'title' => '安全码', 'description' => '安全码', 'type' => 'string', 'required' => false, 'example' => '6aa6ea6af00b453eafc3128d41858bf6', ], ], [ 'name' => 'ExpireSeconds', 'in' => 'query', 'schema' => [ 'title' => '过期时间', 'description' => '过期时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2554265', ], ], [ 'name' => 'GrantWay', 'in' => 'query', 'schema' => [ 'title' => '发放方式', 'description' => '发放方式', 'type' => 'string', 'required' => false, 'example' => 'latour2', ], ], [ 'name' => 'IdempotentId', 'in' => 'query', 'schema' => [ 'title' => '幂等ID', 'description' => '幂等ID', 'type' => 'string', 'required' => true, 'example' => '20211212211381431746-1202', ], ], [ 'name' => 'GrantMode', 'in' => 'query', 'schema' => [ 'title' => '发放模式', 'description' => '发放模式', 'type' => 'string', 'required' => false, 'example' => 'NORMAL', 'default' => 'SECURITY_CODE', ], ], [ 'name' => 'body', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'object', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '79C01D47-3C44-57D9-BC99-1B33F7ED14B8', ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'Model' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'PromotionInstanceId' => [ 'description' => '促销实例id。', 'type' => 'string', 'example' => '123456', ], 'EffectiveStartTime' => [ 'description' => '生效开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '123243444', ], 'EffectiveEndTime' => [ 'description' => '生效结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '12322333232', ], 'SubBizCode' => [ 'description' => '子业务号', 'type' => 'string', 'example' => 'ef2b8********f824830b7e55a0dc5', ], 'Success' => [ 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79C01D47-3C44-57D9-BC99-1B33F7ED14B8\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"success\\",\\n \\"Model\\": {\\n \\"PromotionInstanceId\\": \\"123456\\",\\n \\"EffectiveStartTime\\": 123243444,\\n \\"EffectiveEndTime\\": 12322333232,\\n \\"SubBizCode\\": \\"ef2b8********f824830b7e55a0dc5\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]', 'title' => '发放优惠券权益', ], 'StartUserGame' => [ 'summary' => '内部接口,用户新参与活动玩法,仅供多端商城使用。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'required' => true, 'example' => 'LMALL20288*****003', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'title' => '业务方用户ID', 'description' => '业务方用户ID', 'type' => 'string', 'required' => true, 'example' => '123', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '账号类型', 'type' => 'string', 'required' => false, 'example' => 'ANONY', 'default' => 'UNDEFINED', ], ], [ 'name' => 'GameId', 'in' => 'query', 'schema' => [ 'title' => '玩法ID', 'description' => '玩法ID', 'type' => 'string', 'required' => true, 'example' => '673474835708274689', ], ], [ 'name' => 'ActivityId', 'in' => 'query', 'schema' => [ 'title' => '活动ID', 'description' => '活动ID', 'type' => 'string', 'required' => true, 'example' => '671091829240653825', ], ], [ 'name' => 'RouteId', 'in' => 'query', 'schema' => [ 'title' => '路线ID', 'description' => '路线ID', 'type' => 'string', 'required' => false, 'example' => 'RouteId1', ], ], [ 'name' => 'UserApp', 'in' => 'query', 'schema' => [ 'title' => '用户APP', 'description' => '用户APP', 'type' => 'string', 'required' => false, 'example' => 'MAC', ], ], [ 'name' => 'ExtInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'object', 'required' => false, 'example' => '{\\"channelId\\":\\"test\\"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '79C01D47-3C44-57D9-BC99-1B33F7ED14B8', ], 'Code' => [ 'description' => '接口返回码', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'SUCCESS', ], 'Model' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'ProcessId' => [ 'title' => '进度ID', 'description' => '进度ID', 'type' => 'string', 'example' => '1916', ], 'GameId' => [ 'type' => 'string', ], 'ActivityId' => [ 'type' => 'string', ], 'Name' => [ 'type' => 'string', ], 'Type' => [ 'type' => 'string', ], 'Desc' => [ 'type' => 'string', ], 'BizId' => [ 'type' => 'string', ], 'CurrentShowContent' => [ 'title' => '进度内容', 'description' => '进度内容', 'type' => 'string', ], 'Status' => [ 'title' => '状态', 'description' => '状态', 'type' => 'string', ], 'CurrentStepStatus' => [ 'title' => '当前步骤状态', 'description' => '当前步骤状态', 'type' => 'string', ], 'CurrentStepId' => [ 'title' => '当前步骤ID', 'description' => '当前步骤ID', 'type' => 'string', ], 'ExtInfo' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'string', ], 'RouteId' => [ 'title' => '路线ID', 'description' => '路线ID', 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79C01D47-3C44-57D9-BC99-1B33F7ED14B8\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Model\\": {\\n \\"ProcessId\\": \\"1916\\",\\n \\"GameId\\": \\"\\",\\n \\"ActivityId\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Desc\\": \\"\\",\\n \\"BizId\\": \\"\\",\\n \\"CurrentShowContent\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"CurrentStepStatus\\": \\"\\",\\n \\"CurrentStepId\\": \\"\\",\\n \\"ExtInfo\\": \\"\\",\\n \\"RouteId\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => '用户新参与活动玩法', ], 'PushUserGameProcess' => [ 'summary' => '内部接口,推进用户玩法进度,仅供多端商城使用。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'description' => '业务的唯一标识号,由阿里云提供'."\n" ."\n", 'type' => 'string', 'required' => true, 'example' => 'LMALL20******001', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'description' => '客户侧用户ID', 'type' => 'string', 'required' => true, 'example' => '22******343', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '固定值:ANONY', 'type' => 'string', 'required' => false, 'example' => 'ANONY', 'default' => 'UNDEFINED', ], ], [ 'name' => 'ProcessId', 'in' => 'query', 'schema' => [ 'description' => '进度ID', 'type' => 'string', 'required' => true, 'example' => '6734******4397953', ], ], [ 'name' => 'CurrentStepId', 'in' => 'query', 'schema' => [ 'description' => '当前步骤ID', 'type' => 'string', 'required' => true, 'example' => '""', ], ], [ 'name' => 'body', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '请求体', 'type' => 'object', 'required' => false, 'example' => '{\\"orderNo\\":\\"20211204211241160338-120\\",\\"serialNumber\\":\\"0\\",\\"voucherId\\":\\"202112040007300238170AD22N26\\",\\"userId\\":\\"2088312906117381\\"}', ], ], [ 'name' => 'ExtInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '扩展信息', 'type' => 'object', 'required' => false, 'example' => '{\\"gmtCreate\\":\\"2022-01-01 00:00:00\\"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '1718921E-C8D4-55E1-B8D4-114AE537C1B7', ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'Success', ], 'Model' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'ProcessId' => [ 'description' => '进度ID', 'type' => 'string', 'example' => ' '."\n" .'6734******4397953'."\n", ], 'GameId' => [ 'description' => '玩法ID', 'type' => 'string', 'example' => '67176******67874', ], 'ActivityId' => [ 'description' => '活动ID', 'type' => 'string', 'example' => '123', ], 'Name' => [ 'description' => '名称', 'type' => 'string', 'example' => '""', ], 'Type' => [ 'description' => '类型', 'type' => 'string', 'example' => '""', ], 'Desc' => [ 'description' => '描述', 'type' => 'string', 'example' => '""', ], 'CurrentShowContent' => [ 'description' => '进度内容', 'type' => 'string', 'example' => '""', ], 'Status' => [ 'description' => '状态', 'type' => 'string', 'example' => '""', ], 'CurrentStepStatus' => [ 'description' => '当前步骤状态', 'type' => 'string', 'example' => '""', ], 'CurrentStepId' => [ 'description' => '当前步骤ID', 'type' => 'string', 'example' => '""', ], 'ExtInfo' => [ 'description' => '扩展信息', 'type' => 'string', 'example' => '{"key":"value"}', ], 'RouteId' => [ 'description' => '路线ID', 'type' => 'string', 'example' => 'RouteId_1', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1718921E-C8D4-55E1-B8D4-114AE537C1B7\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"Success\\",\\n \\"Model\\": {\\n \\"ProcessId\\": \\"\\\\t\\\\n6734******4397953\\\\n\\",\\n \\"GameId\\": \\"67176******67874\\",\\n \\"ActivityId\\": \\"123\\",\\n \\"Name\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Type\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Desc\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CurrentShowContent\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Status\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CurrentStepStatus\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CurrentStepId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ExtInfo\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"RouteId\\": \\"RouteId_1\\"\\n }\\n}","type":"json"}]', 'title' => '推进用户玩法进度', ], 'GetActivityGameInfo' => [ 'summary' => '获取活动玩法信息。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'description' => '业务的唯一标识号,由阿里云提供', 'type' => 'string', 'required' => true, 'example' => 'LMALL20211224****', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'description' => '客户侧用户ID', 'type' => 'string', 'required' => true, 'example' => '287384877****', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '固定值:ANONY', 'type' => 'string', 'required' => false, 'example' => 'ANONY', 'default' => 'UNDEFINED', ], ], [ 'name' => 'ActivityId', 'in' => 'query', 'schema' => [ 'description' => '活动ID', 'type' => 'string', 'required' => true, 'example' => '673', ], ], [ 'name' => 'GameId', 'in' => 'query', 'schema' => [ 'description' => '玩法ID', 'type' => 'string', 'required' => true, 'example' => '673476420068894723', ], ], [ 'name' => 'ExtInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '扩展信息', 'type' => 'object', 'required' => false, 'example' => '{"key":"value"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '直接取入参值返回,用于日志追踪', 'type' => 'string', 'example' => '79C01D47-3C44-57D9-BC99-1B33F7ED****', ], 'Code' => [ 'description' => '成功:"SUCCESS"。错误码见后面小节', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'Model' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'UserProcessDTO' => [ 'title' => '用户进度', 'description' => '用户进度', 'type' => 'string', ], 'GameDTO' => [ 'title' => '玩法信息', 'description' => '玩法信息', 'type' => 'string', ], 'UserGameCoinInfos' => [ 'title' => '玩法币信息', 'description' => '玩法币信息', 'type' => 'string', ], 'ExtInfo' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'string', 'example' => '{"key":"value"}', ], 'GameShowInfo' => [ 'title' => '玩法展示信息', 'description' => '玩法展示信息', 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79C01D47-3C44-57D9-BC99-1B33F7ED****\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Model\\": {\\n \\"UserProcessDTO\\": \\"\\",\\n \\"GameDTO\\": \\"\\",\\n \\"UserGameCoinInfos\\": \\"\\",\\n \\"ExtInfo\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"GameShowInfo\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => '获取活动玩法信息', 'description' => '获取活动玩法信息', ], 'GetUserTokenPage' => [ 'summary' => '内部接口,仅供多端商城使用,获取用户登录态链接。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'required' => true, 'example' => 'LMALL20******001', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'title' => '业务方用户ID', 'description' => '业务方用户ID', 'type' => 'string', 'required' => true, 'example' => '22******234', ], ], [ 'name' => 'UserNick', 'in' => 'query', 'schema' => [ 'title' => '用户昵称', 'description' => '用户昵称', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'ExpireSeconds', 'in' => 'query', 'schema' => [ 'title' => '过期时间', 'description' => '过期时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '86400', 'minimum' => '60', 'example' => '86400', ], ], [ 'name' => 'ExtJson', 'in' => 'query', 'schema' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'string', 'required' => false, 'example' => '{}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'B7E4EF89-DBC3-5CD0-9993-02D8C13E7177', ], 'Code' => [ 'title' => '响应码', 'description' => '响应码', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'title' => '提示信息', 'description' => '提示信息', 'type' => 'string', 'example' => 'SUCCESS', ], 'Model' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'Url' => [ 'title' => '页面地址', 'description' => '页面地址', 'type' => 'string', 'example' => '""', ], ], ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'invalidParam', 'errorMessage' => '参数格式异常', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7E4EF89-DBC3-5CD0-9993-02D8C13E7177\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Model\\": {\\n \\"Url\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n}","type":"json"}]', 'title' => '获取用户登录态链接', ], 'ListActivityAtmosphere' => [ 'summary' => '内部接口,罗列活动氛围数据,仅供多端商城使用。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'description' => '业务ID', 'type' => 'string', 'required' => true, 'example' => 'LMALL20******001', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'description' => '客户侧用户ID', 'type' => 'string', 'required' => true, 'example' => '22******364', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '固定值:ANONY', 'type' => 'string', 'required' => false, 'example' => 'ANONY', 'default' => 'UNDEFINED', ], ], [ 'name' => 'ActivityId', 'in' => 'query', 'schema' => [ 'description' => '活动ID', 'type' => 'string', 'required' => false, 'example' => '673', ], ], [ 'name' => 'GameId', 'in' => 'query', 'schema' => [ 'description' => '玩法ID', 'type' => 'string', 'required' => false, 'example' => '671******37088', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '状态', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页显示的条数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '20', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '当前页码,从1开始', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', 'description' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', 'type' => 'integer', 'format' => 'int64', 'example' => '12', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'E090F1A0-7454-5F36-933C-E6332CE2****', ], 'Code' => [ 'description' => '成功时,返回"SUCCESS"。错误码见后面小节', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'PageSize' => [ 'description' => '每页多少条记录,最大为20条', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], 'PageNumber' => [ 'description' => '分页页码,从1开始', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Model' => [ 'description' => '返回结果', 'type' => 'array', 'items' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'BizUid' => [ 'description' => '业务用户ID', 'type' => 'string', 'example' => '22******37'."\n", ], 'Status' => [ 'description' => '状态', 'type' => 'string', 'example' => '""', ], 'Message' => [ 'description' => '返回消息', 'type' => 'string', 'example' => '""', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 12,\\n \\"RequestId\\": \\"E090F1A0-7454-5F36-933C-E6332CE2****\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"Model\\": [\\n {\\n \\"BizUid\\": \\"22******37\\\\n\\",\\n \\"Status\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询活动氛围信息列表', ], 'ListActivityGameInfo' => [ 'summary' => '内部接口,查询活动玩法列表,仅供多端商城使用。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'description' => '业务ID', 'type' => 'string', 'required' => true, 'example' => 'LMALL20******002', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'description' => '客户侧用户ID', 'type' => 'string', 'required' => true, 'example' => '22******263', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '固定值:ANONY', 'type' => 'string', 'required' => false, 'example' => 'ANONY', 'default' => 'UNDEFINED', ], ], [ 'name' => 'ActivityId', 'in' => 'query', 'schema' => [ 'description' => '活动ID', 'type' => 'string', 'required' => false, 'example' => '673', ], ], [ 'name' => 'GameId', 'in' => 'query', 'schema' => [ 'description' => '玩法ID', 'type' => 'string', 'required' => false, 'example' => '6717******67874', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '玩法状态', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '玩法类型', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页多少条记录,最大为20条', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '20', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '分页页码,从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1638104750323', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1639104750323', ], ], [ 'name' => 'Statuses', 'in' => 'query', 'schema' => [ 'description' => '状态列表', 'type' => 'string', 'required' => false, 'example' => '[]', ], ], [ 'name' => 'SubType', 'in' => 'query', 'schema' => [ 'description' => '玩法子类型', 'type' => 'string', 'required' => false, 'example' => '""', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', 'description' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', 'type' => 'integer', 'format' => 'int64', 'example' => '19', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'F1339E71-CB73-5440-BD39-1C98A8ED50E3', ], 'Code' => [ 'description' => '成功时,返回"SUCCESS"。错误码见后面小节', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'PageSize' => [ 'description' => '每⻚多少条记录,最⼤20条', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], 'PageNumber' => [ 'description' => '当前页码,从1开始', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Model' => [ 'description' => '返回结果', 'type' => 'array', 'items' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'GameShowInfo' => [ 'description' => '玩法展示信息', 'type' => 'string', 'example' => '""', ], 'ExtInfo' => [ 'description' => '扩展信息', 'type' => 'string', 'example' => '{"key":"value"}', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 19,\\n \\"RequestId\\": \\"F1339E71-CB73-5440-BD39-1C98A8ED50E3\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"Model\\": [\\n {\\n \\"GameShowInfo\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ExtInfo\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询活动玩法列表', ], 'ListUserGameProcess' => [ 'summary' => '内部接口,查询活动玩法进度,仅供多端商城使用。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'description' => '业务ID', 'type' => 'string', 'required' => true, 'example' => 'LMALL20******002', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'description' => '客户侧用户ID', 'type' => 'string', 'required' => true, 'example' => '22******352', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '固定值:ANONY', 'type' => 'string', 'required' => false, 'example' => 'ANONY', 'default' => 'UNDEFINED', ], ], [ 'name' => 'ActivityId', 'in' => 'query', 'schema' => [ 'description' => '活动ID', 'type' => 'string', 'required' => false, 'example' => '673', ], ], [ 'name' => 'GameId', 'in' => 'query', 'schema' => [ 'description' => '玩法ID', 'type' => 'string', 'required' => false, 'example' => '67347******4689', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '玩法状态', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '玩法类型', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每⻚多少条记录,最⼤20条', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '20', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '当前页码,从1开始', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1637958044395', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1639017538838', ], ], [ 'name' => 'Statuses', 'in' => 'query', 'schema' => [ 'description' => '状态列表', 'type' => 'string', 'required' => false, 'example' => '[]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', 'description' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', 'type' => 'integer', 'format' => 'int64', 'example' => '12', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '07127DEC-D093-54B5-884A-29D49CBE95A5', ], 'Code' => [ 'description' => '成功时,返回"SUCCESS"。错误码见后面小节', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'PageSize' => [ 'description' => '每页多少条记录,最大为20条', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], 'PageNumber' => [ 'description' => '当前页码,从1开始', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Model' => [ 'description' => '返回结果', 'type' => 'array', 'items' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'ProcessId' => [ 'description' => '进度ID', 'type' => 'string', 'example' => '1916', ], 'GameId' => [ 'description' => '玩法ID', 'type' => 'string', 'example' => '67347******4689'."\n", ], 'ActivityId' => [ 'description' => '活动ID', 'type' => 'string', 'example' => '673', ], 'Name' => [ 'description' => '玩法名称', 'type' => 'string', 'example' => '""', ], 'Type' => [ 'description' => '玩法类型', 'type' => 'string', 'example' => '""', ], 'Desc' => [ 'description' => '玩法描述', 'type' => 'string', 'example' => '""', ], 'CurrentShowContent' => [ 'description' => '进度内容', 'type' => 'string', 'example' => '""', ], 'Status' => [ 'description' => '玩法状态', 'type' => 'string', 'example' => '""', ], 'CurrentStepStatus' => [ 'description' => '当前步骤状态', 'type' => 'string', 'example' => '""', ], 'CurrentStepId' => [ 'description' => '当前步骤ID', 'type' => 'string', 'example' => '""', ], 'ExtInfo' => [ 'description' => '扩展信息', 'type' => 'string', 'example' => '{"key":"value"}', ], 'RouteId' => [ 'description' => '路线ID', 'type' => 'string', 'example' => '619', ], 'CreateTime' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1638451941000', ], 'ModifyTime' => [ 'description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1642662319000', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 12,\\n \\"RequestId\\": \\"07127DEC-D093-54B5-884A-29D49CBE95A5\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"Model\\": [\\n {\\n \\"ProcessId\\": \\"1916\\",\\n \\"GameId\\": \\"67347******4689\\\\n\\",\\n \\"ActivityId\\": \\"673\\",\\n \\"Name\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Type\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Desc\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CurrentShowContent\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Status\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CurrentStepStatus\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CurrentStepId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ExtInfo\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"RouteId\\": \\"619\\",\\n \\"CreateTime\\": 1638451941000,\\n \\"ModifyTime\\": 1642662319000\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询用户玩法进度', ], 'QueryUserGameProcess' => [ 'summary' => '内部接口,查询用户活动玩法进度,仅供多端商城使用。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'description' => '业务ID', 'type' => 'string', 'required' => true, 'example' => 'LMALL20******002', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'description' => '客户侧用户ID', 'type' => 'string', 'required' => true, 'example' => '22******372', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '固定值:ANONY', 'type' => 'string', 'required' => false, 'example' => 'ANONY', 'default' => 'UNDEFINED', ], ], [ 'name' => 'ProcessId', 'in' => 'query', 'schema' => [ 'description' => '进度ID', 'type' => 'string', 'required' => true, 'example' => '6******352', ], ], [ 'name' => 'ExtInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '扩展信息', 'type' => 'object', 'required' => false, 'example' => '{"key":"value"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '45B9EF4E-4D18-59B2-85E6-9B568F73C79D', ], 'Code' => [ 'description' => '成功时,返回"SUCCESS"。错误码见后面小节', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'Model' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'ProcessId' => [ 'description' => '进度ID', 'type' => 'string', 'example' => '6******352'."\n", ], 'GameId' => [ 'description' => '玩法ID', 'type' => 'string', 'example' => '6******723', ], 'ActivityId' => [ 'description' => '活动ID', 'type' => 'string', 'example' => '134', ], 'Name' => [ 'description' => '名称', 'type' => 'string', 'example' => '""', ], 'Type' => [ 'description' => '类型', 'type' => 'string', 'example' => '""', ], 'Desc' => [ 'description' => '描述', 'type' => 'string', 'example' => '""', ], 'CurrentShowContent' => [ 'description' => '进度内容', 'type' => 'string', 'example' => '""', ], 'Status' => [ 'description' => '状态', 'type' => 'string', 'example' => '""', ], 'CurrentStepStatus' => [ 'description' => '当前步骤状态', 'type' => 'string', 'example' => '""', ], 'CurrentStepId' => [ 'description' => '当前步骤ID', 'type' => 'string', 'example' => '""', ], 'ExtInfo' => [ 'description' => '扩展信息', 'type' => 'string', 'example' => '{"key":"value"}', ], 'RouteId' => [ 'description' => '路线ID', 'type' => 'string', 'example' => 'RouteId_1', ], 'CreateTime' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1638451941000', ], 'ModifyTime' => [ 'description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1648451941000', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"45B9EF4E-4D18-59B2-85E6-9B568F73C79D\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Model\\": {\\n \\"ProcessId\\": \\"6******352\\\\n\\",\\n \\"GameId\\": \\"6******723\\",\\n \\"ActivityId\\": \\"134\\",\\n \\"Name\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Type\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Desc\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CurrentShowContent\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Status\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CurrentStepStatus\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CurrentStepId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ExtInfo\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"RouteId\\": \\"RouteId_1\\",\\n \\"CreateTime\\": 1638451941000,\\n \\"ModifyTime\\": 1648451941000\\n }\\n}","type":"json"}]', 'title' => '查询用户活动玩法进度', ], 'DeductUserPoint' => [ 'summary' => '扣减用户积分,调用方需提前开通LM积分服务。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'required' => true, 'example' => 'LMALL20******003', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'title' => '业务方用户ID', 'description' => '业务方用户ID', 'type' => 'string', 'required' => true, 'example' => '22******637', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '固定值:ANONY', 'type' => 'string', 'required' => false, 'example' => 'ANONY', 'default' => 'UNDEFINED', ], ], [ 'name' => 'IdempotentId', 'in' => 'query', 'schema' => [ 'title' => '幂等ID', 'description' => '幂等ID', 'type' => 'string', 'required' => true, 'example' => '202112******31746-1202', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'string', 'required' => true, 'example' => '136', ], ], [ 'name' => 'Amount', 'in' => 'query', 'schema' => [ 'title' => '数额', 'description' => '数额', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', ], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => [ 'title' => '发放主题', 'description' => '发放主题', 'type' => 'string', 'required' => true, 'example' => '***积分扣减', ], ], [ 'name' => 'Message', 'in' => 'query', 'schema' => [ 'title' => '发放说明', 'description' => '发放说明', 'type' => 'string', 'required' => false, 'example' => '***积分扣减'."\n", ], ], [ 'name' => 'ExtInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'object', 'required' => false, 'example' => '{"key":"value"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '79C01D47-3C44-57D9-BC99-1B33F7ED14B8', ], 'Code' => [ 'description' => 'SUCCESS表示成功', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'Model' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'RecordId' => [ 'title' => '流水记录ID', 'description' => '流水记录ID', 'type' => 'string', 'example' => '""', ], 'BizId' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'example' => 'LMALL20******003'."\n", ], 'BizUid' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => ' '."\n" .'22******637'."\n", ], 'AccountId' => [ 'title' => '账号ID', 'description' => '账号ID', 'type' => 'string', 'example' => '11******18', ], 'Name' => [ 'title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '***积分扣减', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => '***积分扣减'."\n", ], 'Action' => [ 'title' => '操作', 'description' => '操作', 'type' => 'string', 'example' => '""', ], 'Amount' => [ 'title' => '本次操作数额', 'description' => '本次操作数额', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'Rest' => [ 'title' => '账户积分余额', 'description' => '账户积分余额', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', ], 'RuleId' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'string', 'example' => '136', ], 'IdempotentId' => [ 'title' => '幂等ID', 'description' => '幂等ID', 'type' => 'string', 'example' => '20211212******31746-1202'."\n", ], 'Status' => [ 'title' => '状态', 'description' => '状态', 'type' => 'string', 'example' => '""', ], 'ExtInfo' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'object', 'example' => '{"key":"value"}', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79C01D47-3C44-57D9-BC99-1B33F7ED14B8\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Model\\": {\\n \\"RecordId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"BizId\\": \\"LMALL20******003\\\\n\\",\\n \\"BizUid\\": \\"\\\\t\\\\n22******637\\\\n\\",\\n \\"AccountId\\": \\"11******18\\",\\n \\"Name\\": \\"***积分扣减\\",\\n \\"Description\\": \\"***积分扣减\\\\n\\",\\n \\"Action\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Amount\\": 10,\\n \\"Rest\\": 2000,\\n \\"RuleId\\": \\"136\\",\\n \\"IdempotentId\\": \\"20211212******31746-1202\\\\n\\",\\n \\"Status\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ExtInfo\\": {\\n \\"key\\": \\"value\\"\\n }\\n }\\n}","type":"json"}]', 'title' => '扣减用户积分', ], 'FreezeUserPoint' => [ 'summary' => '冻结用户积分,调用方需提前开通LM积分服务。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'required' => true, 'example' => 'LMALL20******001', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'title' => '业务方用户ID', 'description' => '业务方用户ID', 'type' => 'string', 'required' => true, 'example' => '22******3748', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '固定值:ANONY', 'type' => 'string', 'required' => false, 'example' => 'ANONY', 'default' => 'UNDEFINED', ], ], [ 'name' => 'IdempotentId', 'in' => 'query', 'schema' => [ 'title' => '幂等ID', 'description' => '幂等ID', 'type' => 'string', 'required' => true, 'example' => '202112******31746-1202', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'string', 'required' => true, 'example' => '136', ], ], [ 'name' => 'Amount', 'in' => 'query', 'schema' => [ 'title' => '数额', 'description' => '数额', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000', ], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => [ 'title' => '发放主题', 'description' => '发放主题', 'type' => 'string', 'required' => true, 'example' => '***积分冻结', ], ], [ 'name' => 'Message', 'in' => 'query', 'schema' => [ 'title' => '发放说明', 'description' => '发放说明', 'type' => 'string', 'required' => false, 'example' => '***积分冻结', ], ], [ 'name' => 'ExtInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'object', 'required' => false, 'example' => '{"key":"value"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '5E2D59BA-4EB0-45C4-A0D7-D98C1A4B320B', ], 'Code' => [ 'description' => '成功:"SUCCESS"。错误码见后面小节', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'Model' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'RecordId' => [ 'title' => '流水记录ID', 'description' => '流水记录ID', 'type' => 'string', 'example' => '71******92', ], 'BizId' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'example' => 'LMALL20******008', ], 'BizUid' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '22******3748', ], 'AccountId' => [ 'title' => '账号ID', 'description' => '账号ID', 'type' => 'string', 'example' => '11******26', ], 'Name' => [ 'title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '***积分冻结', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => '***积分冻结', ], 'Action' => [ 'title' => '操作', 'description' => '操作', 'type' => 'string', 'example' => '""', ], 'Amount' => [ 'title' => '本次操作数额', 'description' => '本次操作数额', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], 'Rest' => [ 'title' => '账户积分余额', 'description' => '账户积分余额', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', ], 'RuleId' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'string', 'example' => '""', ], 'IdempotentId' => [ 'title' => '幂等ID', 'description' => '幂等ID', 'type' => 'string', 'example' => '202112******31746-1202'."\n", ], 'Status' => [ 'title' => '状态', 'description' => '状态', 'type' => 'string', 'example' => '""', ], 'ExtInfo' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'object', 'example' => '{"key":"value"}', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E2D59BA-4EB0-45C4-A0D7-D98C1A4B320B\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Model\\": {\\n \\"RecordId\\": \\"71******92\\",\\n \\"BizId\\": \\"LMALL20******008\\",\\n \\"BizUid\\": \\"22******3748\\",\\n \\"AccountId\\": \\"11******26\\",\\n \\"Name\\": \\"***积分冻结\\",\\n \\"Description\\": \\"***积分冻结\\",\\n \\"Action\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Amount\\": 1000,\\n \\"Rest\\": 2000,\\n \\"RuleId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"IdempotentId\\": \\"202112******31746-1202\\\\n\\",\\n \\"Status\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ExtInfo\\": {\\n \\"key\\": \\"value\\"\\n }\\n }\\n}","type":"json"}]', 'title' => '冻结用户积分', ], 'GiveUserPoint' => [ 'summary' => '赠送用户积分,调用方需提前开通LM积分服务。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'required' => true, 'example' => 'LMALL20******01', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'title' => '业务方用户ID', 'description' => '业务方用户ID', 'type' => 'string', 'required' => true, 'example' => '22******67', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '固定值:ANONY', 'type' => 'string', 'required' => false, 'example' => 'ANONY', 'default' => 'UNDEFINED', ], ], [ 'name' => 'IdempotentId', 'in' => 'query', 'schema' => [ 'title' => '幂等ID', 'description' => '幂等ID', 'type' => 'string', 'required' => true, 'example' => '20211212******1746-1202', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'string', 'required' => true, 'example' => '136', ], ], [ 'name' => 'Amount', 'in' => 'query', 'schema' => [ 'title' => '数额', 'description' => '数额', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000', ], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => [ 'title' => '发放主题', 'description' => '发放主题', 'type' => 'string', 'required' => true, 'example' => '***赠送用户积分', ], ], [ 'name' => 'Message', 'in' => 'query', 'schema' => [ 'title' => '发放说明', 'description' => '发放说明', 'type' => 'string', 'required' => false, 'example' => '***赠送用户积分', ], ], [ 'name' => 'ExtInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'object', 'required' => false, 'example' => '{}', ], ], [ 'name' => 'TargetBizUid', 'in' => 'query', 'schema' => [ 'title' => '获赠用户ID', 'description' => '获赠用户ID', 'type' => 'string', 'required' => true, 'example' => '22******45', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '0854F82D-7912-52A1-8EF5-2D1662C50C36', ], 'Code' => [ 'description' => '成功时,返回"SUCCESS"。错误码见后面小节', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'Model' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'RecordId' => [ 'title' => '流水记录ID', 'description' => '流水记录ID', 'type' => 'string', 'example' => '""', ], 'BizId' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'example' => 'LMALL20******002', ], 'BizUid' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '22******67'."\n", ], 'AccountId' => [ 'title' => '账号ID', 'description' => '账号ID', 'type' => 'string', 'example' => '11******18', ], 'Name' => [ 'title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '***积分赠与', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => '***积分赠与', ], 'Action' => [ 'title' => '操作', 'description' => '操作', 'type' => 'string', 'example' => '""', ], 'Amount' => [ 'title' => '本次操作数额', 'description' => '本次操作数额', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], 'Rest' => [ 'title' => '账户积分余额', 'description' => '账户积分余额', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', ], 'RuleId' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'string', 'example' => '136', ], 'IdempotentId' => [ 'title' => '幂等ID', 'description' => '幂等ID', 'type' => 'string', 'example' => '20211212******1746-1202'."\n", ], 'Status' => [ 'title' => '状态', 'description' => '状态', 'type' => 'string', 'example' => '""', ], 'ExtInfo' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'object', 'example' => '{"key":"value"}', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0854F82D-7912-52A1-8EF5-2D1662C50C36\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Model\\": {\\n \\"RecordId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"BizId\\": \\"LMALL20******002\\",\\n \\"BizUid\\": \\"22******67\\\\n\\",\\n \\"AccountId\\": \\"11******18\\",\\n \\"Name\\": \\"***积分赠与\\",\\n \\"Description\\": \\"***积分赠与\\",\\n \\"Action\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Amount\\": 1000,\\n \\"Rest\\": 2000,\\n \\"RuleId\\": \\"136\\",\\n \\"IdempotentId\\": \\"20211212******1746-1202\\\\n\\",\\n \\"Status\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ExtInfo\\": {\\n \\"key\\": \\"value\\"\\n }\\n }\\n}","type":"json"}]', 'title' => '赠送用户积分', ], 'GrantUserPoint' => [ 'summary' => '发放用户积分,调用方需提前开通LM积分服务。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'required' => true, 'example' => 'LMALL20******001', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'title' => '业务方用户ID', 'description' => '业务方用户ID', 'type' => 'string', 'required' => true, 'example' => '22******3527', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '固定值:ANONY', 'type' => 'string', 'required' => false, 'example' => 'ANONY', 'default' => 'UNDEFINED', ], ], [ 'name' => 'IdempotentId', 'in' => 'query', 'schema' => [ 'title' => '幂等ID', 'description' => '幂等ID', 'type' => 'string', 'required' => true, 'example' => '202112******31746-1202', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'string', 'required' => true, 'example' => '136', ], ], [ 'name' => 'Amount', 'in' => 'query', 'schema' => [ 'title' => '数额', 'description' => '数额', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000', ], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => [ 'title' => '发放主题', 'description' => '发放主题', 'type' => 'string', 'required' => true, 'example' => 'xxx活动积分发放', ], ], [ 'name' => 'Message', 'in' => 'query', 'schema' => [ 'title' => '发放说明', 'description' => '发放说明', 'type' => 'string', 'required' => false, 'example' => '活动积分发放', ], ], [ 'name' => 'ExtInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'object', 'required' => false, 'example' => '{"key":"value"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '1718921E-C8D4-55E1-B8D4-114AE537C1B7', ], 'Code' => [ 'description' => '成功时,返回"SUCCESS"。错误码见后面小节', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'Model' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'RecordId' => [ 'title' => '流水记录ID', 'description' => '流水记录ID', 'type' => 'string', 'example' => '6529', ], 'BizId' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'example' => 'LMALL20******002', ], 'BizUid' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '22******3527'."\n", ], 'AccountId' => [ 'title' => '账号ID', 'description' => '账号ID', 'type' => 'string', 'example' => '69******45', ], 'Name' => [ 'title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '***积分发放', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => '***积分发放', ], 'Action' => [ 'title' => '操作', 'description' => '操作', 'type' => 'string', ], 'Amount' => [ 'title' => '本次操作数额', 'description' => '本次操作数额', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], 'Rest' => [ 'title' => '账户积分余额', 'description' => '账户积分余额', 'type' => 'integer', 'format' => 'int64', 'example' => '5000', ], 'RuleId' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'string', 'example' => '136', ], 'IdempotentId' => [ 'title' => '幂等ID', 'description' => '幂等ID', 'type' => 'string', 'example' => '202112******31746-1202'."\n", ], 'Status' => [ 'title' => '状态', 'description' => '状态', 'type' => 'string', ], 'ExtInfo' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'object', 'example' => '{"key":"value"}', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1718921E-C8D4-55E1-B8D4-114AE537C1B7\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Model\\": {\\n \\"RecordId\\": \\"6529\\",\\n \\"BizId\\": \\"LMALL20******002\\",\\n \\"BizUid\\": \\"22******3527\\\\n\\",\\n \\"AccountId\\": \\"69******45\\",\\n \\"Name\\": \\"***积分发放\\",\\n \\"Description\\": \\"***积分发放\\",\\n \\"Action\\": \\"\\",\\n \\"Amount\\": 1000,\\n \\"Rest\\": 5000,\\n \\"RuleId\\": \\"136\\",\\n \\"IdempotentId\\": \\"202112******31746-1202\\\\n\\",\\n \\"Status\\": \\"\\",\\n \\"ExtInfo\\": {\\n \\"key\\": \\"value\\"\\n }\\n }\\n}","type":"json"}]', 'title' => '发放用户积分', ], 'RefundUserPoint' => [ 'summary' => '退还用户积分'."\n" .'。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'required' => true, 'example' => 'LMALL2000***12', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'title' => '业务方用户ID', 'description' => '业务方用户ID', 'type' => 'string', 'required' => true, 'example' => '1', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '固定值:ANONY', 'type' => 'string', 'required' => false, 'example' => 'ANONY', 'default' => 'UNDEFINED', ], ], [ 'name' => 'IdempotentId', 'in' => 'query', 'schema' => [ 'title' => '幂等ID', 'description' => '幂等ID', 'type' => 'string', 'required' => true, 'example' => '123', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'string', 'required' => true, 'example' => '136', ], ], [ 'name' => 'Amount', 'in' => 'query', 'schema' => [ 'title' => '数额', 'description' => '数额', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '100', ], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => [ 'title' => '发放主题', 'description' => '发放主题', 'type' => 'string', 'required' => true, 'example' => '7天无理由退货退换', ], ], [ 'name' => 'Message', 'in' => 'query', 'schema' => [ 'title' => '发放说明', 'description' => '发放说明', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'ExtInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'object', 'required' => false, 'enumValueTitles' => [], 'example' => '{"key":"value"}', ], ], [ 'name' => 'OriginRecordId', 'in' => 'query', 'schema' => [ 'description' => '原始流失号', 'type' => 'string', 'required' => true, 'example' => 'PYPT**12', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '直接取入参值返回,用于日志追踪', 'type' => 'string', 'example' => '79C01D47-3C44-57D9-BC99-1B33F7ED****', ], 'Code' => [ 'description' => 'SUCCESS表示成功', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'Model' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'RecordId' => [ 'title' => '流水记录ID', 'description' => '流水记录ID', 'type' => 'string', 'example' => '414915628598****', ], 'BizId' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'example' => 'LMALL20211206****', ], 'BizUid' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '4851826221****', ], 'AccountId' => [ 'title' => '账号ID', 'description' => '账号ID', 'type' => 'string', 'example' => '180173763600****', ], 'Name' => [ 'title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '***积分退回', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => '积分退回', ], 'Action' => [ 'title' => '操作', 'description' => '操作', 'type' => 'string', 'example' => '""', ], 'Amount' => [ 'title' => '本次操作数额', 'description' => '本次操作数额', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Rest' => [ 'title' => '账户积分余额', 'description' => '账户积分余额', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', ], 'RuleId' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'string', 'example' => '33046', ], 'IdempotentId' => [ 'title' => '幂等ID', 'description' => '幂等ID', 'type' => 'string', 'example' => '202112******31746-1202'."\n", ], 'Status' => [ 'title' => '状态', 'description' => '状态', 'type' => 'string', 'example' => '""', ], 'ExtInfo' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'object', 'example' => '{"key":"value"}', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79C01D47-3C44-57D9-BC99-1B33F7ED****\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Model\\": {\\n \\"RecordId\\": \\"414915628598****\\",\\n \\"BizId\\": \\"LMALL20211206****\\",\\n \\"BizUid\\": \\"4851826221****\\",\\n \\"AccountId\\": \\"180173763600****\\",\\n \\"Name\\": \\"***积分退回\\",\\n \\"Description\\": \\"积分退回\\",\\n \\"Action\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Amount\\": 1,\\n \\"Rest\\": 2000,\\n \\"RuleId\\": \\"33046\\",\\n \\"IdempotentId\\": \\"202112******31746-1202\\\\n\\",\\n \\"Status\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ExtInfo\\": {\\n \\"key\\": \\"value\\"\\n }\\n }\\n}","type":"json"}]', 'title' => '退还用户积分', 'description' => '退还用户积分'."\n", ], 'UnFreezeUserPoint' => [ 'summary' => '解冻用户积分,调用方需提前开通LM积分服务。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'required' => true, 'example' => 'LMALL20******05', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'title' => '业务方用户ID', 'description' => '业务方用户ID', 'type' => 'string', 'required' => true, 'example' => '22******37', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '固定值:ANONY', 'type' => 'string', 'required' => false, 'example' => 'ANONY', 'default' => 'UNDEFINED', ], ], [ 'name' => 'IdempotentId', 'in' => 'query', 'schema' => [ 'title' => '幂等ID', 'description' => '幂等ID', 'type' => 'string', 'required' => true, 'example' => '20211212******31746-1202', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'string', 'required' => true, 'example' => '136', ], ], [ 'name' => 'Amount', 'in' => 'query', 'schema' => [ 'title' => '数额', 'description' => '数额', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000', ], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => [ 'title' => '发放主题', 'description' => '发放主题', 'type' => 'string', 'required' => true, 'example' => '***积分解冻', ], ], [ 'name' => 'Message', 'in' => 'query', 'schema' => [ 'title' => '发放说明', 'description' => '发放说明', 'type' => 'string', 'required' => false, 'example' => '***积分解冻', ], ], [ 'name' => 'ExtInfo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'object', 'required' => false, 'example' => '{}'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '6103AD7B-21C2-523B-89D0-579DA58D08E8', ], 'Code' => [ 'description' => '成功时,返回"SUCCESS"。错误码见后面小节', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'Model' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'RecordId' => [ 'title' => '流水记录ID', 'description' => '流水记录ID', 'type' => 'string', 'example' => '""', ], 'BizId' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'example' => 'LMALL20******001', ], 'BizUid' => [ 'title' => '用户ID', 'description' => '用户ID', 'type' => 'string', 'example' => '22******37'."\n", ], 'AccountId' => [ 'title' => '账号ID', 'description' => '账号ID', 'type' => 'string', 'example' => '17******31', ], 'Name' => [ 'title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '***积分解冻', ], 'Description' => [ 'title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => '***积分解冻', ], 'Action' => [ 'title' => '操作', 'description' => '操作', 'type' => 'string', 'example' => '""', ], 'Amount' => [ 'title' => '本次操作数额', 'description' => '本次操作数额', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], 'Rest' => [ 'title' => '账户积分余额', 'description' => '账户积分余额', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', ], 'RuleId' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'string', 'example' => '136', ], 'IdempotentId' => [ 'title' => '幂等ID', 'description' => '幂等ID', 'type' => 'string', 'example' => '20211212******31746-1202'."\n", ], 'Status' => [ 'title' => '状态', 'description' => '状态', 'type' => 'string', 'example' => '""', ], 'ExtInfo' => [ 'title' => '扩展信息', 'description' => '扩展信息', 'type' => 'object', 'example' => '{"key":"value"}', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6103AD7B-21C2-523B-89D0-579DA58D08E8\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Model\\": {\\n \\"RecordId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"BizId\\": \\"LMALL20******001\\",\\n \\"BizUid\\": \\"22******37\\\\n\\",\\n \\"AccountId\\": \\"17******31\\",\\n \\"Name\\": \\"***积分解冻\\",\\n \\"Description\\": \\"***积分解冻\\",\\n \\"Action\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Amount\\": 1000,\\n \\"Rest\\": 2000,\\n \\"RuleId\\": \\"136\\",\\n \\"IdempotentId\\": \\"20211212******31746-1202\\\\n\\",\\n \\"Status\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ExtInfo\\": {\\n \\"key\\": \\"value\\"\\n }\\n }\\n}","type":"json"}]', 'title' => '解冻用户积分', ], 'ListUserPointRecords' => [ 'summary' => '查询用户积分流水记录,调用方需提前开通LM积分服务。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'required' => true, 'example' => 'LMALL20******001', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'title' => '业务方用户ID', 'description' => '业务方用户ID', 'type' => 'string', 'required' => true, 'example' => '22******67', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '固定值:ANONY', 'type' => 'string', 'required' => false, 'example' => 'ANONY', 'default' => 'UNDEFINED', ], ], [ 'name' => 'PointAction', 'in' => 'query', 'schema' => [ 'title' => '操作', 'description' => '操作', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'RecordId', 'in' => 'query', 'schema' => [ 'title' => '规则ID', 'description' => '规则ID', 'type' => 'string', 'required' => false, 'example' => '""', ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'title' => '数额', 'description' => '数额', 'type' => 'string', 'required' => false, 'example' => '136', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'title' => '发放主题', 'description' => '发放主题', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '1640958044395', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '发放说明', 'description' => '发放说明', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '1638958044395', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '当前⻚码,从1开始', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页显示的条数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '20', ], ], [ 'name' => 'PointActions', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '199DFDCB-2225-5748-8D1A-528DD6C76563', ], 'Code' => [ 'description' => '成功:"SUCCESS"。错误码见后面小节', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'PageNumber' => [ 'description' => '当前页码,从1开始', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => '每页显示的条数', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'TotalCount' => [ 'description' => '记录总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '19', ], 'Model' => [ 'description' => '积分记录列表', 'type' => 'array', 'items' => [ 'description' => '积分记录列表', 'type' => 'object', 'properties' => [ 'RecordId' => [ 'description' => '积分记录ID', 'type' => 'string', 'example' => '5******4', ], 'Name' => [ 'description' => '积分记录名称', 'type' => 'string', 'example' => '***积分冻结', ], 'Description' => [ 'description' => '积分记录描述', 'type' => 'string', 'example' => '***积分冻结', ], 'Action' => [ 'type' => 'string', ], 'Amount' => [ 'description' => '积分数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], 'Rest' => [ 'type' => 'integer', 'format' => 'int64', ], 'RuleId' => [ 'description' => '规则ID', 'type' => 'string', 'example' => '710', ], 'IdempotentId' => [ 'description' => '幂等ID', 'type' => 'string', 'example' => '20211215******8117-1200', ], 'Status' => [ 'description' => '状态', 'type' => 'string', 'example' => '""', ], 'ExtInfo' => [ 'description' => '扩展信息', 'type' => 'object', 'example' => '{"key":"value"}', ], 'CreateTime' => [ 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1638451941000', ], 'ModifyTime' => [ 'description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1648451941000', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"199DFDCB-2225-5748-8D1A-528DD6C76563\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 19,\\n \\"Model\\": [\\n {\\n \\"RecordId\\": \\"5******4\\",\\n \\"Name\\": \\"***积分冻结\\",\\n \\"Description\\": \\"***积分冻结\\",\\n \\"Action\\": \\"\\",\\n \\"Amount\\": 1000,\\n \\"Rest\\": 0,\\n \\"RuleId\\": \\"710\\",\\n \\"IdempotentId\\": \\"20211215******8117-1200\\",\\n \\"Status\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ExtInfo\\": {\\n \\"key\\": \\"value\\"\\n },\\n \\"CreateTime\\": 1638451941000,\\n \\"ModifyTime\\": 1648451941000\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询用户积分流水记录', ], 'QueryUserPoint' => [ 'summary' => '查询用户积分,调用方需提前开通LM积分服务。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'required' => true, 'example' => 'LMALL20******002', ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'title' => '业务方用户ID', 'description' => '业务方用户ID', 'type' => 'string', 'required' => true, 'example' => '22******3646', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '固定值:ANONY', 'type' => 'string', 'required' => false, 'example' => 'ANONY', 'default' => 'UNDEFINED', ], ], [ 'name' => 'ExtInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '扩展信息', 'type' => 'object', 'required' => false, 'example' => '{"key":"value"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '1718921E-C8D4-55E1-B8D4-114AE537C1B7', ], 'Code' => [ 'description' => '成功时,返回"SUCCESS"。错误码见后面小节', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'Model' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'AccountId' => [ 'title' => '账户ID', 'description' => '账户ID', 'type' => 'string', 'example' => '11******466', ], 'BizId' => [ 'title' => '业务ID', 'description' => '业务ID', 'type' => 'string', 'example' => 'LMALL20******008', ], 'BizUid' => [ 'title' => '业务方用户ID', 'description' => '业务方用户ID', 'type' => 'string', 'example' => '22******3646', ], 'Status' => [ 'title' => '账号状态', 'description' => '账号状态', 'type' => 'string', 'example' => '4', ], 'CurrentAmount' => [ 'title' => '当前积分余额', 'description' => '当前积分余额', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], 'HistoryAmount' => [ 'title' => '历史累计积分', 'description' => '历史累计积分', 'type' => 'integer', 'format' => 'int64', 'example' => '5000', ], 'FrozenAmount' => [ 'title' => '当前冻结积分', 'description' => '当前冻结积分', 'type' => 'integer', 'format' => 'int64', 'example' => '4000', ], 'Level' => [ 'title' => '账号等级', 'description' => '账号等级', 'type' => 'string', 'example' => '1', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1639037068811', ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1642662319000', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1718921E-C8D4-55E1-B8D4-114AE537C1B7\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Model\\": {\\n \\"AccountId\\": \\"11******466\\",\\n \\"BizId\\": \\"LMALL20******008\\",\\n \\"BizUid\\": \\"22******3646\\",\\n \\"Status\\": \\"4\\",\\n \\"CurrentAmount\\": 1000,\\n \\"HistoryAmount\\": 5000,\\n \\"FrozenAmount\\": 4000,\\n \\"Level\\": \\"1\\",\\n \\"CreateTime\\": 1639037068811,\\n \\"ModifyTime\\": 1642662319000\\n }\\n}","type":"json"}]', 'title' => '查询用户积分', ], 'AddItemLimitRule' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'description' => '业务ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LMALL20******001', ], ], [ 'name' => 'SubBizCode', 'in' => 'query', 'schema' => [ 'description' => '子业务号', 'type' => 'string', 'required' => false, 'example' => 'eaab4******59205ec608b2144ba', ], ], [ 'name' => 'LmActivityId', 'in' => 'query', 'schema' => [ 'description' => '活动ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '679', ], ], [ 'name' => 'LmItemId', 'in' => 'query', 'schema' => [ 'description' => 'lm侧商品ID', 'type' => 'string', 'required' => false, 'example' => '10000055-******09769', ], ], [ 'name' => 'ItemId', 'in' => 'query', 'schema' => [ 'description' => '商品ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '59******0266', ], ], [ 'name' => 'UpperNum', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => '规则类型', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'BeginTime', 'in' => 'query', 'schema' => [ 'description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1638958044395'."\n", ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1647446400000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'SUCCESS表示成功', 'type' => 'string', 'example' => 'SUCCESS', ], 'Model' => [ 'description' => '返回结果', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '7BAC5B75-8208-5788-829D-AD7640085D38', ], 'RuleId' => [ 'description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '109', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Model\\": 1,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"7BAC5B75-8208-5788-829D-AD7640085D38\\",\\n \\"RuleId\\": 109\\n}","type":"json"}]', 'title' => '创建商品限购规则', 'summary' => '创建商品限购规则。', ], 'AddSupplierNewItems' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'description' => '业务的唯一标识号,由阿里云提供'."\n" ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LMALL2000***12', ], ], [ 'name' => 'ItemList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '商品列表', 'type' => 'array', 'items' => [ 'description' => '商品列表', 'type' => 'object', 'properties' => [ 'LmItemId' => [ 'description' => 'lm侧商品ID', 'type' => 'string', 'required' => false, 'example' => '10000035-61936646****', ], 'ItemId' => [ 'description' => '商品ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '61936646****', ], 'SkuList' => [ 'description' => '商品sku列表', 'type' => 'array', 'format' => 'int64', 'items' => [ 'description' => '商品sku列表', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '[475786598****]', ], 'required' => false, 'maxItems' => 100, ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '成功时,返回"SUCCESS"。错误码见后面小节', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'RequestId' => [ 'description' => '直接取入参值返回,用于日志追踪', 'type' => 'string', 'example' => 'F2D3CA1E-28BE-5E1C-B55F-81C8F290****', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"F2D3CA1E-28BE-5E1C-B55F-81C8F290****\\"\\n}","type":"json"}]', 'title' => '添加商品到基础库和渠道业务库', 'summary' => '添加商品到基础库和渠道业务库。', 'description' => "\n" .'添加商品到基础库和渠道业务库', ], 'DeleteBizItems' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'description' => '业务id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LMALL2*****001', ], ], [ 'name' => 'SubBizId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'ItemIdList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '商品id列表', 'type' => 'array', 'items' => [ 'description' => '商品id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '324123312231', ], 'required' => true, 'maxItems' => 20, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '接口返回码', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'SUCCESS', ], 'RequestId' => [ 'description' => '请求id', 'type' => 'string', 'example' => '79C01D47-3C44-57D9-BC99-1B33F7ED14B8', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"79C01D47-3C44-57D9-BC99-1B33F7ED14B8\\"\\n}","type":"json"}]', 'title' => '删除业务商品库中商品', 'summary' => '删除业务商品库中的商品。', ], 'ModifyBizItems' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'description' => '业务的唯一标识号,由阿里云提供'."\n" ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LMALL20211119****', ], ], [ 'name' => 'SubBizId', 'in' => 'query', 'schema' => [ 'description' => '子渠道ID', 'type' => 'string', 'required' => false, 'example' => '12c6b6e98bb34475bcd38df73****', ], ], [ 'name' => 'ItemList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '商品信息列表', 'type' => 'array', 'items' => [ 'description' => '商品信息列表', 'type' => 'object', 'properties' => [ 'LmItemId' => [ 'description' => 'Lm侧商品ID', 'type' => 'string', 'required' => false, 'example' => '10000035-61936646****', ], 'ItemId' => [ 'description' => '商品Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '62553137****', ], 'SkuList' => [ 'description' => '商品sku列表', 'type' => 'array', 'items' => [ 'description' => '商品sku列表', 'type' => 'object', 'properties' => [ 'StatusAction' => [ 'description' => 'sku状态', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'PriceCent' => [ 'description' => '销售价格(分),priceCent表示客户端的销售价格,返回值以分为单位', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2790', ], 'SkuId' => [ 'description' => '商品的SkuId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '472266643****', ], 'Points' => [ 'description' => '积分数量', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1999', ], 'PointsAmount' => [ 'description' => '积分抵扣价格', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1290', ], 'BenefitId' => [ 'description' => '商品权益ID', 'type' => 'string', 'required' => false, 'example' => '202108181714875327', ], 'Quantity' => [ 'description' => 'sku库存', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20000', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 100, ], ], 'required' => false, ], 'required' => true, 'maxItems' => 20, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '直接取入参值返回,用于日志追踪', 'type' => 'string', 'example' => '204F5C60-0B34-5718-AF93-9BD26B37****', ], 'Code' => [ 'description' => '成功:"SUCCESS"。错误码见后面小节', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'PageNumber' => [ 'description' => '当前⻚码,从1开始', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '每⻚多少条记录,最⼤20条', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '19', ], 'FailedItemList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Item' => [ 'description' => '商品更新失败列表', 'type' => 'array', 'items' => [ 'description' => '商品更新失败列表', 'type' => 'object', 'properties' => [ 'LmItemId' => [ 'description' => 'lm侧商品ID', 'type' => 'string', 'example' => '10000102-65305223****', ], 'ItemId' => [ 'description' => '商品ID', 'type' => 'integer', 'format' => 'int64', 'example' => '65305223****'."\n", ], 'SkuIdList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Sku' => [ 'description' => '商品skuId列表', 'type' => 'array', 'items' => [ 'description' => '商品skuId列表', 'type' => 'string', 'example' => '[425341098****]', ], ], ], ], ], ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"204F5C60-0B34-5718-AF93-9BD26B37****\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 19,\\n \\"FailedItemList\\": {\\n \\"Item\\": [\\n {\\n \\"LmItemId\\": \\"10000102-65305223****\\",\\n \\"ItemId\\": 0,\\n \\"SkuIdList\\": {\\n \\"Sku\\": [\\n \\"[425341098****]\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '更新业务商品库中商品信息', 'summary' => '更新业务商品库中商品信息。', 'description' => '更新业务商品库中商品信息', ], 'ModifyItemLimitRule' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'description' => '业务ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LMALL20******001', ], ], [ 'name' => 'SubBizCode', 'in' => 'query', 'schema' => [ 'description' => '子业务号', 'type' => 'string', 'required' => false, 'example' => '5ab43d1******41abdd23629bed001a0', ], ], [ 'name' => 'LmActivityId', 'in' => 'query', 'schema' => [ 'description' => '活动ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '679', ], ], [ 'name' => 'LmItemId', 'in' => 'query', 'schema' => [ 'description' => 'lm侧商品ID', 'type' => 'string', 'required' => false, 'example' => '10000055-******09839', ], ], [ 'name' => 'ItemId', 'in' => 'query', 'schema' => [ 'description' => '商品ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '655******148', ], ], [ 'name' => 'UpperNum', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, ], ], [ 'name' => 'RuleId', 'in' => 'query', 'schema' => [ 'description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '136', ], ], [ 'name' => 'RuleType', 'in' => 'query', 'schema' => [ 'description' => '规则类型', 'type' => 'integer', 'format' => 'int32', 'required' => false, ], ], [ 'name' => 'BeginTime', 'in' => 'query', 'schema' => [ 'description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1639539460838', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1648483200000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => 'SUCCESS表示成功', 'type' => 'string', 'example' => 'SUCCESS', ], 'Model' => [ 'description' => '返回结果', 'type' => 'boolean', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'SUCCESS', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'BCB20091-68E0-5D29-BE90-125954BB58E2', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Model\\": true,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"BCB20091-68E0-5D29-BE90-125954BB58E2\\"\\n}","type":"json"}]', 'title' => '修改商品限购规则', 'summary' => '修改商品的限购规则。', ], 'QueryItemDetailTea' => [ 'summary' => '根据商品id查询业务商品库中的商品信息,新版SDK使用这个。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], [ 'PrivateKey' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '103077', 'abilityTreeNodes' => [ 'FEATURElinkedmallMY1IED', ], ], 'parameters' => [ [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'description' => '业务的唯一标识号,由阿里云提供'."\n" ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LMALL20211013****', ], ], [ 'name' => 'ItemId', 'in' => 'query', 'schema' => [ 'description' => '商品id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '66644894****', ], ], [ 'name' => 'LmItemId', 'in' => 'query', 'schema' => [ 'description' => 'lm侧商品id', 'type' => 'string', 'required' => false, 'example' => '10001036-66644894****', ], ], [ 'name' => 'UseAnonymousTbAccount', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'required' => false, ], ], [ 'name' => 'ThirdPartyUserId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'BizUid', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'DivisionCode', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Ip', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'UserFlag', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '直接取入参值返回,用于日志追踪', 'type' => 'string', 'example' => 'BA157565-3358-5D80-9330-************', ], 'Success' => [ 'description' => '调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'SubMessage' => [ 'description' => '子错误信息', 'type' => 'string', 'example' => '""', ], 'Code' => [ 'description' => 'SUCCESS表示成功', 'type' => 'string', 'example' => 'SUCCESS', ], 'Message' => [ 'description' => '失败时,返回具体原因', 'type' => 'string', 'example' => 'The specified parameter lmItemId or itemId value is not valid.', ], 'SubCode' => [ 'description' => '子错误码', 'type' => 'string', 'example' => '""', ], 'Item' => [ 'description' => '商品信息', 'type' => 'object', 'properties' => [ 'ItemTitle' => [ 'description' => '商品标题', 'type' => 'string', 'example' => '乐事65g白葡萄汽水味气泡薯片', ], 'MinPoints' => [ 'description' => '最少积分', 'type' => 'integer', 'format' => 'int64', 'example' => '2990', ], 'DescOption' => [ 'description' => '商品详情描述', 'type' => 'string', 'example' => '"
"',
],
'VideoPicUrl' => [
'description' => '视频头图链接地址',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg'."\n",
],
'ExtJson' => [
'description' => '拓展字段',
'type' => 'string',
'example' => '{\\"delivery_version\\":\\"1\\"}',
],
'IsSellerPayPostfee' => [
'description' => '是否卖家包邮',
'type' => 'boolean',
'example' => 'true',
],
'LmItemCategory' => [
'description' => '商品类别',
'type' => 'string',
'example' => 'entity',
],
'SellerPayPostfee' => [
'description' => '是否卖家包邮',
'type' => 'boolean',
'example' => 'true',
],
'ReservePrice' => [
'description' => '划线价',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'Quantity' => [
'description' => '库存数量',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'VideoUrl' => [
'description' => '视频链接地址',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg',
],
'CustomizedAttributeMap' => [
'description' => '买家信息',
'type' => 'object',
'example' => '{}',
],
'IforestProps' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'IforestProp' => [
'description' => '商品详情页商品名称下面的三列属性',
'type' => 'array',
'items' => [
'description' => '商品详情页商品名称下面的三列属性',
'type' => 'object',
'example' => '""',
],
],
],
],
'LmItemId' => [
'description' => 'lm侧商品id',
'type' => 'string',
'example' => '10000035-61936646****',
],
'SellerId' => [
'description' => '卖家Id',
'type' => 'integer',
'format' => 'int64',
'example' => '329488****',
],
'TbShopName' => [
'description' => '淘宝店铺名称',
'type' => 'string',
'example' => '橘子郡',
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'example' => '60646253****',
],
'CanSell' => [
'description' => '是否可售',
'type' => 'boolean',
'example' => 'true',
],
'CenterInventory' => [
'description' => '主站是否有库存',
'type' => 'boolean',
'example' => 'true',
],
'SellerType' => [
'description' => '卖家类型:0-淘宝卖家,1-天猫卖家',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'TotalSoldQuantity' => [
'description' => '商品在tmall的销量',
'type' => 'integer',
'format' => 'int32',
'example' => '1999',
],
'MainPicUrl' => [
'description' => '主图地址',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg',
],
'MinPrice' => [
'description' => '商品价格',
'type' => 'integer',
'format' => 'int64',
'example' => '1990',
],
'IsCanSell' => [
'description' => '是否可售',
'type' => 'boolean',
'example' => 'true',
],
'CategoryId' => [
'description' => '类目id',
'type' => 'integer',
'format' => 'int64',
'example' => '20177****',
],
'DescPath' => [
'description' => '商品详情图片地址',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg',
],
'Properties' => [
'description' => '产品参数',
'type' => 'object',
'example' => '{}',
],
'Skus' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Sku' => [
'description' => '商品sku列表',
'type' => 'array',
'items' => [
'description' => '商品sku列表',
'type' => 'object',
'properties' => [
'PriceCent' => [
'description' => '客户端销售价格,目前不支持不同区域不同定价',
'type' => 'integer',
'format' => 'int64',
'example' => '2890',
],
'LmItemId' => [
'description' => 'lm侧商品id',
'type' => 'string',
'example' => '10000102-64426301****',
],
'PointPrice' => [
'description' => '积分价格',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'CanSell' => [
'description' => '是否可售',
'type' => 'boolean',
'example' => 'true',
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'example' => '62887962****',
],
'SkuTitle' => [
'description' => 'sku名称,如:白色/64G。由各个属性拼成,/分割',
'type' => 'string',
'example' => '白色/64G',
],
'ExtJson' => [
'description' => '拓展字段',
'type' => 'string',
'example' => '{\\"delivery_version\\":\\"1\\"}',
],
'SkuProperties' => [
'description' => '商品sku参数',
'type' => 'object',
'example' => '{}',
],
'SkuId' => [
'description' => 'skuId,虚拟商品为-1',
'type' => 'integer',
'format' => 'int64',
'example' => '465309897****',
],
'SkuPicUrl' => [
'description' => 'sku图片',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg',
],
'Points' => [
'description' => '积分',
'type' => 'integer',
'format' => 'int64',
'example' => '1990',
],
'ReservePrice' => [
'description' => '划线价',
'type' => 'integer',
'format' => 'int64',
'example' => '1990',
],
'PointsAmount' => [
'description' => '积分金额',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Quantity' => [
'description' => '库存数量,虚拟商品为-1',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'CustomizedAttributeMap' => [
'description' => '买家信息',
'type' => 'object',
'example' => '{}',
],
'SimpleQuantity' => [
'description' => '废弃',
'type' => 'string',
'example' => '“”',
],
'HasQuantity' => [
'description' => '废弃',
'type' => 'boolean',
'example' => 'true',
],
'CanNotBeSoldMassage' => [
'type' => 'string',
],
'CanNotBeSoldCode' => [
'type' => 'string',
],
],
],
],
],
],
'ItemImages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ItemImage' => [
'description' => '商品图片列表',
'type' => 'array',
'items' => [
'description' => '商品图片列表',
'type' => 'string',
'example' => '["//img.alicdn.com/imgextra/i3/174226****/O1CN01DdG5Zl1SnK749X6Me_!!1742262291.jpg"]',
],
],
],
],
'SimpleQuantity' => [
'type' => 'string',
],
'HasQuantity' => [
'type' => 'boolean',
],
'TotalSoldSimpleQuantity' => [
'type' => 'string',
],
'ItemTotalSimpleValue' => [
'type' => 'string',
],
'FirstPicUrl' => [
'type' => 'string',
],
'CanNotBeSoldCode' => [
'type' => 'string',
],
'CanNotBeSoldMassage' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
202 => [
[
'errorCode' => 'UNAVAILABLE_VALID_PO_DURING_LATEST_TREE_MONTH',
'errorMessage' => 'UNAVAILABLE_VALID_PO_DURING_LATEST_TREE_MONTH',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA157565-3358-5D80-9330-************\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"The specified parameter lmItemId or itemId value is not valid.\\",\\n \\"SubCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Item\\": {\\n \\"ItemTitle\\": \\"乐事65g白葡萄汽水味气泡薯片\\",\\n \\"MinPoints\\": 2990,\\n \\"DescOption\\": \\"\\\\\\"
\\\\\\"\\",\\n \\"VideoPicUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\\\n\\",\\n \\"ExtJson\\": \\"{\\\\\\\\\\\\\\"delivery_version\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\",\\n \\"IsSellerPayPostfee\\": true,\\n \\"LmItemCategory\\": \\"entity\\",\\n \\"SellerPayPostfee\\": true,\\n \\"ReservePrice\\": 2990,\\n \\"Quantity\\": 1,\\n \\"VideoUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\",\\n \\"CustomizedAttributeMap\\": {},\\n \\"IforestProps\\": {\\n \\"IforestProp\\": [\\n \\"\\"\\n ]\\n },\\n \\"LmItemId\\": \\"10000035-61936646****\\",\\n \\"SellerId\\": 0,\\n \\"TbShopName\\": \\"橘子郡\\",\\n \\"ItemId\\": 0,\\n \\"CanSell\\": true,\\n \\"CenterInventory\\": true,\\n \\"SellerType\\": 0,\\n \\"TotalSoldQuantity\\": 1999,\\n \\"MainPicUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\",\\n \\"MinPrice\\": 1990,\\n \\"IsCanSell\\": true,\\n \\"CategoryId\\": 0,\\n \\"DescPath\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\",\\n \\"Properties\\": {},\\n \\"Skus\\": {\\n \\"Sku\\": [\\n {\\n \\"PriceCent\\": 2890,\\n \\"LmItemId\\": \\"10000102-64426301****\\",\\n \\"PointPrice\\": 2990,\\n \\"CanSell\\": true,\\n \\"ItemId\\": 0,\\n \\"SkuTitle\\": \\"白色/64G\\",\\n \\"ExtJson\\": \\"{\\\\\\\\\\\\\\"delivery_version\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\",\\n \\"SkuProperties\\": {},\\n \\"SkuId\\": 0,\\n \\"SkuPicUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\",\\n \\"Points\\": 1990,\\n \\"ReservePrice\\": 1990,\\n \\"PointsAmount\\": 0,\\n \\"Quantity\\": 4,\\n \\"CustomizedAttributeMap\\": {},\\n \\"SimpleQuantity\\": \\"“”\\",\\n \\"HasQuantity\\": true,\\n \\"CanNotBeSoldMassage\\": \\"\\",\\n \\"CanNotBeSoldCode\\": \\"\\"\\n }\\n ]\\n },\\n \\"ItemImages\\": {\\n \\"ItemImage\\": [\\n \\"[\\\\\\"//img.alicdn.com/imgextra/i3/174226****/O1CN01DdG5Zl1SnK749X6Me_!!1742262291.jpg\\\\\\"]\\"\\n ]\\n },\\n \\"SimpleQuantity\\": \\"\\",\\n \\"HasQuantity\\": true,\\n \\"TotalSoldSimpleQuantity\\": \\"\\",\\n \\"ItemTotalSimpleValue\\": \\"\\",\\n \\"FirstPicUrl\\": \\"\\",\\n \\"CanNotBeSoldCode\\": \\"\\",\\n \\"CanNotBeSoldMassage\\": \\"\\"\\n }\\n}","type":"json"}]',
'title' => '查询商品详情',
'description' => '本接口可以查询到商品的详情信息',
'responseParamsDescription' => 'item数据结构:'."\n"
."\n\n"
.'特别提示:lmItemCategory : entity(淘宝实物商品)/aliComBenifit(虚拟商品)'."\n"
."\n\n"
.'以下为实物商品item返回:'."\n"
."\n"
.' {'."\n"
.' "skus": ['."\n"
.' {'."\n"
.' "skuId": "skuId",'."\n"
.' "skuPicUrl": "sku图⽚",'."\n"
.' "skuTitle": "sku名称",'."\n"
.' "priceCent": "客户端销售价格,⽬前不⽀持商品不同区域不同定价",'."\n"
.' "skuPropertities": "Map json string",'."\n"
.' "reservePrice":"划线价",'."\n"
.' "canSell": "是否可售卖"'."\n"
.' }'."\n"
.' ],'."\n"
.' "lmitemid":"linkedmall商品ID",'."\n"
.' "itemId": "商品ID",'."\n"
.' "itemTitle": "商品标题",'."\n"
.' "lmItemCategory":" entity(淘宝实物商品),aliComBenifit(虚拟商品)",'."\n"
.' "itemImages": ["轮播图地址"],'."\n"
.' "reservePrice": "划线价",'."\n"
.' "categoryId": "类⽬ID",'."\n"
.' "totalSoldQuantity": "商品在tmall的销量",'."\n"
.' "descOption":"商品详情",'."\n"
.' "properties(产品参数)": {'."\n"
.' "name" : ["描述"]'."\n"
.' ...'."\n"
.' },'."\n"
.' "iforestProps(商品详情⻚商品名称下⾯的三列属性)": ['."\n"
.' {"主要属性1": "描述1"},'."\n"
.' {"主要属性2": "描述2"}'."\n"
.' ...'."\n"
.' ],'."\n"
.' "sellerPayPostfee": "是否包邮",'."\n"
.' "canSell": "是否可售卖",'."\n"
.' "sellerId": "卖家ID",'."\n"
.' "sellerType": "卖家类型: 0-淘宝卖家, 1-天猫卖家",'."\n"
.' "videoUrl": "视频链接地址",'."\n"
.' "videoPicUrl": "视频头图链接地址",'."\n"
.' "tbShopName": "淘宝店铺名称",'."\n"
.' "extJson(扩展字段,json-map结构)": {'."\n"
.' "food_pro_date": "⽣产⽇期,仅⽤于⻝品类商品",'."\n"
.' "extraPeriod": "保质期,仅⽤于⻝品类商品",'."\n"
.' "tax_invoice": "税率"'."\n"
.' }'."\n"
.' }'."\n"
."\n"
.'以下为虚拟商品item返回(虚拟商品以卡密形式返回):'."\n"
."\n"
.' {'."\n"
.' "code": "SUCCESS",'."\n"
.' "item": {'."\n"
.' "canSell": true,'."\n"
.' "centerInventory": true,'."\n"
.' "customizedAttributeMap": {},'."\n"
.' "descOption": "充值账号:⼿机号码\\n到账时间:1-10分钟\\n到账查询:⽅式1,⼿机短信可以收到产品激活提醒;⽅式2;⽅式2.微信>>公众号“搜狐视频会员”可收到产品激活提醒\\n权益说明:⼀个⽉搜狐视频会员;充值成功后https://tv.sohu.com/了解产品权益\\n注意事项:⽆",'."\n"
.' "descPath": "",'."\n"
.' "extJson": "{}",'."\n"
.' "isCanSell": true,'."\n"
.' "isSellerPayPostfee": false,'."\n"
.' "itemId": 190400709219454990,'."\n"
.' "itemImages": [],'."\n"
.' "itemTitle": "搜狐视频会员⽉卡-20元-直充-⾃营",'."\n"
.' "lmItemCategory": "aliComBenifit",'."\n"
.' "lmItemId": "10001036-190400709219454990",'."\n"
.' "mainPicUrl": "",'."\n"
.' "minPoints": 0,'."\n"
.' "minPrice": 1100,'."\n"
.' "quantity": -1,'."\n"
.' "reservePrice": 2000,'."\n"
.' "sellerId": 374544688,'."\n"
.' "sellerPayPostfee": false,'."\n"
.' "skus": ['."\n"
.' {'."\n"
.' "canSell": true,'."\n"
.' "customizedAttributeMap": {},'."\n"
.' "extJson": "{\\"operator\\": \\"WB672926\\", \\"eagleEyeId\\":'."\n"
.' \\"0b0d57b516112325810714238d09a3\\", \\"skipElectionCheck\\": false}",'."\n"
.' "itemId": 190400709219454990,'."\n"
.' "pointPrice": 1100,'."\n"
.' "points": 0,'."\n"
.' "pointsAmount": 0,'."\n"
.' "priceCent": 1100,'."\n"
.' "quantity": -1,'."\n"
.' "skuId": -1'."\n"
.' }'."\n"
.' ],'."\n"
.' "tbShopName": ""'."\n"
.' },'."\n"
.' "message": "",'."\n"
.' "requestId": "5C6B29D1-AE3B-4D0F-B324-4C1747E39DCF",'."\n"
.' "subCode": "",'."\n"
.' "subMessage": "",'."\n"
.' "success": true'."\n"
.' }',
],
'QueryItemDetailInner' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL2021081*****',
],
],
[
'name' => 'ItemId',
'in' => 'query',
'schema' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '61358168****',
],
],
[
'name' => 'LmItemId',
'in' => 'query',
'schema' => [
'description' => 'lm侧商品id',
'type' => 'string',
'required' => false,
'example' => '10000055-58233812****',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
'example' => '9f99f38030254728***'."\n",
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和ThirdPartyUserId填写一样的值',
'type' => 'string',
'required' => false,
'example' => '9f99f38030254728***',
],
],
[
'name' => 'DivisionCode',
'in' => 'query',
'schema' => [
'description' => '四级配送区域编码,查询该区域库存。该字段通过queryAddress接⼝获取',
'type' => 'string',
'required' => false,
'example' => '510132',
],
],
[
'name' => 'Ip',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'string',
'required' => false,
'example' => '49.93.0.222',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'BA157565-3358-5D80-9330-************',
],
'Item' => [
'description' => '商品信息',
'type' => 'object',
'properties' => [
'ItemTitle' => [
'description' => '商品标题',
'type' => 'string',
'example' => '乐事65g白葡萄汽水味气泡薯片',
],
'City' => [
'description' => '所属城市',
'type' => 'string',
'example' => '昆明',
],
'MinPoints' => [
'description' => '最少积分',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'DescOption' => [
'description' => '商品详情描述',
'type' => 'string',
'example' => '"
"',
],
'IsSellerPayPostfee' => [
'description' => '是否卖家包邮',
'type' => 'boolean',
'example' => 'true',
],
'LmItemCategory' => [
'description' => '商品类别',
'type' => 'string',
'example' => 'entity',
],
'SellerPayPostfee' => [
'description' => '是否卖家包邮',
'type' => 'boolean',
'example' => 'true',
],
'ReservePrice' => [
'description' => '划线价',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'Quantity' => [
'description' => '库存数量',
'type' => 'integer',
'format' => 'int32',
'example' => '5000',
],
'SellerId' => [
'description' => '卖家Id',
'type' => 'integer',
'format' => 'int64',
'example' => '329488****',
],
'TbShopName' => [
'description' => '淘宝店铺名称',
'type' => 'string',
'example' => '橘子郡',
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'example' => '60646253****',
],
'CanSell' => [
'description' => '是否可售',
'type' => 'boolean',
'example' => 'true',
],
'CenterInventory' => [
'description' => '主站是否有库存',
'type' => 'boolean',
'example' => 'true',
],
'TotalSoldQuantity' => [
'description' => '商品在tmall的销量',
'type' => 'integer',
'format' => 'int32',
'example' => '1999',
],
'MainPicUrl' => [
'description' => '主图地址',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg',
],
'MinPrice' => [
'description' => '商品价格',
'type' => 'integer',
'format' => 'int64',
'example' => '1990',
],
'IsCanSell' => [
'description' => '是否可售',
'type' => 'boolean',
'example' => 'true',
],
'LmShopId' => [
'description' => 'lm侧店铺ID',
'type' => 'integer',
'format' => 'int64',
'example' => '1002****',
],
'CategoryId' => [
'description' => '类目id,如没有类目数据则传入0',
'type' => 'integer',
'format' => 'int64',
'example' => '20177****',
],
'SellerNick' => [
'description' => '卖家nick',
'type' => 'string',
'example' => '巴中人五香嘴',
],
'DescPath' => [
'description' => '商品详情图片地址',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg',
],
'Properties' => [
'description' => '产品参数',
'type' => 'object',
'example' => '{}',
],
'Province' => [
'description' => '省份',
'type' => 'string',
'example' => '北京市',
],
'Skus' => [
'description' => '商品sku列表',
'type' => 'array',
'items' => [
'description' => '商品sku列表',
'type' => 'object',
'properties' => [
'Status' => [
'description' => 'sku状态',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'PriceCent' => [
'description' => '客户端销售价格,目前不支持不同区域不同定价',
'type' => 'integer',
'format' => 'int64',
'example' => '2890',
],
'SkuPvs' => [
'type' => 'string',
],
'LmItemId' => [
'description' => 'lm侧商品id',
'type' => 'string',
'example' => '10000102-64426301****',
],
'PointPrice' => [
'description' => '积分价格',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'example' => '62887962****',
],
'SkuTitle' => [
'description' => 'sku名称,如:白色/64G。由各个属性拼成,/分割',
'type' => 'string',
'example' => '白色/64G',
],
'ExtJson' => [
'description' => '拓展字段',
'type' => 'string',
'example' => '{"key":"value"}',
],
'SkuId' => [
'description' => 'skuid',
'type' => 'integer',
'format' => 'int64',
'example' => '465309897****',
],
'SkuPicUrl' => [
'description' => 'sku图片',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg',
],
'Points' => [
'description' => '积分',
'type' => 'integer',
'format' => 'int64',
'example' => '1990',
],
'PointsAmount' => [
'description' => '积分金额',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ReservePrice' => [
'description' => '划线价',
'type' => 'integer',
'format' => 'int64',
'example' => '1990',
],
'SkuDesc' => [
'description' => 'sku详情',
'type' => 'string',
'example' => '""',
],
'Quantity' => [
'description' => '库存数量,虚拟商品为-1',
'type' => 'integer',
'format' => 'int32',
'example' => '4100',
],
],
],
],
'SkuPropertys' => [
'description' => 'sku详情信息',
'type' => 'array',
'items' => [
'description' => 'sku详情信息',
'type' => 'object',
'properties' => [
'Text' => [
'type' => 'string',
],
'Id' => [
'type' => 'integer',
'format' => 'int64',
],
'Values' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Text' => [
'type' => 'string',
],
'Id' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
'CategoryIds' => [
'description' => '类目列表',
'type' => 'array',
'items' => [
'description' => '类目列表',
'type' => 'integer',
'format' => 'int64',
],
],
'IforestProps' => [
'description' => '商品详情页商品名称下面的三列属性',
'type' => 'array',
'items' => [
'description' => '商品详情页商品名称下面的三列属性',
'type' => 'object',
'example' => '[{},{}]',
],
],
'ItemImages' => [
'description' => '商品图片列表',
'type' => 'array',
'items' => [
'description' => '商品图片列表',
'type' => 'string',
'example' => '["//img.alicdn.com/imgextra/i3/174226****/O1CN01DdG5Zl1SnK749X6Me_!!1742262291.jpg"]',
],
],
'FirstPicUrl' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"BA157565-3358-5D80-9330-************\\",\\n \\"Item\\": {\\n \\"ItemTitle\\": \\"乐事65g白葡萄汽水味气泡薯片\\",\\n \\"City\\": \\"昆明\\",\\n \\"MinPoints\\": 2990,\\n \\"DescOption\\": \\"\\\\\\"
\\\\\\"\\",\\n \\"IsSellerPayPostfee\\": true,\\n \\"LmItemCategory\\": \\"entity\\",\\n \\"SellerPayPostfee\\": true,\\n \\"ReservePrice\\": 2990,\\n \\"Quantity\\": 5000,\\n \\"SellerId\\": 0,\\n \\"TbShopName\\": \\"橘子郡\\",\\n \\"ItemId\\": 0,\\n \\"CanSell\\": true,\\n \\"CenterInventory\\": true,\\n \\"TotalSoldQuantity\\": 1999,\\n \\"MainPicUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\",\\n \\"MinPrice\\": 1990,\\n \\"IsCanSell\\": true,\\n \\"LmShopId\\": 0,\\n \\"CategoryId\\": 0,\\n \\"SellerNick\\": \\"巴中人五香嘴\\",\\n \\"DescPath\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\",\\n \\"Properties\\": {},\\n \\"Province\\": \\"北京市\\",\\n \\"Skus\\": [\\n {\\n \\"Status\\": 2,\\n \\"PriceCent\\": 2890,\\n \\"SkuPvs\\": \\"\\",\\n \\"LmItemId\\": \\"10000102-64426301****\\",\\n \\"PointPrice\\": 2990,\\n \\"ItemId\\": 0,\\n \\"SkuTitle\\": \\"白色/64G\\",\\n \\"ExtJson\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"SkuId\\": 0,\\n \\"SkuPicUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\",\\n \\"Points\\": 1990,\\n \\"PointsAmount\\": 0,\\n \\"ReservePrice\\": 1990,\\n \\"SkuDesc\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Quantity\\": 4100\\n }\\n ],\\n \\"SkuPropertys\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Id\\": 0,\\n \\"Values\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Id\\": 0\\n }\\n ]\\n }\\n ],\\n \\"CategoryIds\\": [\\n 0\\n ],\\n \\"IforestProps\\": [\\n [\\n {},\\n {}\\n ]\\n ],\\n \\"ItemImages\\": [\\n \\"[\\\\\\"//img.alicdn.com/imgextra/i3/174226****/O1CN01DdG5Zl1SnK749X6Me_!!1742262291.jpg\\\\\\"]\\"\\n ],\\n \\"FirstPicUrl\\": \\"\\"\\n }\\n}","type":"json"}]',
'title' => '查询商品详情(内部使用)',
'summary' => '查询商品详情(内部使用)。',
'description' => '查询商品详情(内部使用)'."\n",
],
'QueryItemInventory' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL2******002',
],
],
[
'name' => 'DivisionCode',
'in' => 'query',
'schema' => [
'description' => '四级配送区域编码,查询该区域库存。该字段通过queryAddress接⼝获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '410503006',
],
],
[
'name' => 'Ip',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'string',
'required' => false,
'example' => '113.77.105.73',
],
],
[
'name' => 'ItemList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '查询列表,⼀次查询itemId最多20个',
'type' => 'array',
'items' => [
'description' => '商品列表信息',
'type' => 'object',
'properties' => [
'LmItemId' => [
'description' => 'lm侧商品id',
'type' => 'string',
'required' => false,
'example' => '10000710-635764300767',
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '630730743485',
],
'SkuIdList' => [
'description' => '商品skuId列表',
'type' => 'array',
'format' => 'int64',
'items' => [
'description' => 'SKU的ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '4890674122805',
],
'required' => false,
'maxItems' => 100,
],
],
'required' => false,
],
'required' => true,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '1F2E68C6-FD20-5121-89FF-65F555EE1F15',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'True',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => 'SUCCESS',
],
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => 'SUCCESS',
],
'ItemList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Item' => [
'description' => '商品库存数据列表',
'type' => 'array',
'items' => [
'description' => '商品列表信息',
'type' => 'object',
'properties' => [
'LmItemId' => [
'description' => 'lm侧商品id',
'type' => 'string',
'example' => '10000710-635764300767',
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'example' => '631145057663',
],
'SkuList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Sku' => [
'description' => '商品sku列表',
'type' => 'array',
'items' => [
'description' => '商品sku列表',
'type' => 'object',
'properties' => [
'SkuId' => [
'description' => 'skuId',
'type' => 'integer',
'format' => 'int64',
'example' => '4901251235576',
],
'Inventory' => [
'description' => '库存',
'type' => 'object',
'properties' => [
'Quantity' => [
'description' => '库存数量',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1F2E68C6-FD20-5121-89FF-65F555EE1F15\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"SUCCESS\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"SUCCESS\\",\\n \\"ItemList\\": {\\n \\"Item\\": [\\n {\\n \\"LmItemId\\": \\"10000710-635764300767\\",\\n \\"ItemId\\": 631145057663,\\n \\"SkuList\\": {\\n \\"Sku\\": [\\n {\\n \\"SkuId\\": 4901251235576,\\n \\"Inventory\\": {\\n \\"Quantity\\": 1\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询商品库存数量',
'summary' => '交易场景查询库存。',
'description' => '批量查询商品库存,⼀次最多20个商品ID'."\n"
."\n"
.'注意:建议每次查询⼀个商品,商品太多可能会有较⼤延迟',
'requestParamsDescription' => 'itemLists参考示例:'."\n"
."\n"
.' ['."\n"
.' {'."\n"
.' "itemId": 11111111,'."\n"
.' "skuIdList": [111,222,333]'."\n"
.' },'."\n"
.' ...'."\n"
.' ]',
],
'GetItemPromotion' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******003',
],
],
[
'name' => 'ItemId',
'in' => 'query',
'schema' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '9223372036854775807',
'minimum' => '0',
'example' => '66262416****',
],
],
[
'name' => 'LmItemId',
'in' => 'query',
'schema' => [
'description' => 'lm侧商品id',
'type' => 'string',
'required' => false,
'example' => '10000035-6193664*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '7152F15C-7298-5531-9A76-2ED2C331****',
],
'Success' => [
'description' => '调用是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => 'SUCCESS',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => 'SUCCESS',
],
'ItemPromotionModel' => [
'description' => '返回的商品促销信息',
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '结束时间',
'type' => 'string',
'example' => '2022-02-06 10:01:00',
],
'StartTime' => [
'description' => '开始时间',
'type' => 'string',
'example' => '2022-01-01 00:00:00',
],
'SkuPromotion' => [
'description' => 'sku促销信息',
'type' => 'object',
'example' => '{}',
],
'PromotionFlag' => [
'description' => '是否促销',
'type' => 'boolean',
'example' => 'true',
],
'PromotionName' => [
'description' => '优惠名称',
'type' => 'string',
'example' => '优惠劵',
],
'LmItemId' => [
'description' => 'lm侧商品id',
'type' => 'string',
'example' => '10000035-63064613****',
],
'PromotionDesc' => [
'description' => '优惠描述',
'type' => 'string',
'example' => '""',
],
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '66440412****',
],
'PromotionId' => [
'description' => '优惠元数据ID',
'type' => 'string',
'example' => '68476201884251****',
],
'ExtInfo' => [
'description' => '扩展信息',
'type' => 'object',
'example' => '{"key":"value"}',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7152F15C-7298-5531-9A76-2ED2C331****\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"SUCCESS\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"SUCCESS\\",\\n \\"ItemPromotionModel\\": {\\n \\"EndTime\\": \\"2022-02-06 10:01:00\\",\\n \\"StartTime\\": \\"2022-01-01 00:00:00\\",\\n \\"SkuPromotion\\": {},\\n \\"PromotionFlag\\": true,\\n \\"PromotionName\\": \\"优惠劵\\",\\n \\"LmItemId\\": \\"10000035-63064613****\\",\\n \\"PromotionDesc\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ItemId\\": 0,\\n \\"PromotionId\\": \\"68476201884251****\\",\\n \\"ExtInfo\\": {\\n \\"key\\": \\"value\\"\\n }\\n }\\n}","type":"json"}]',
'title' => '获取商品促销信息',
'summary' => '获取商品促销信息'."\n"
.'。',
'description' => '获取商品促销信息'."\n",
],
'QueryActivityItems' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL2000***12',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页页码,从1开始。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的条数。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '20',
'minimum' => '1',
'example' => '20',
],
],
[
'name' => 'LmActivityId',
'in' => 'query',
'schema' => [
'description' => '活动ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '679',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '539E5C68-D8B5-57EC-9D9B-58AFD9E0****',
],
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'PageNumber' => [
'description' => '分页页码,从1开始。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'description' => '每页显示的条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'TotalCount' => [
'description' => '总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '12',
],
'LmActivityItemModelList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmActivityItemModel' => [
'description' => '活动商品信息',
'type' => 'array',
'items' => [
'description' => '活动商品信息',
'type' => 'object',
'properties' => [
'ItemTitle' => [
'description' => '商品标题',
'type' => 'string',
'example' => '红塔山(硬欣经典)香烟',
],
'TbSellerId' => [
'description' => '淘宝卖家ID',
'type' => 'integer',
'format' => 'int64',
'example' => '285278****',
],
'SellableQuantity' => [
'description' => '可售库存',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'TbShopId' => [
'description' => '淘宝店铺ID',
'type' => 'integer',
'format' => 'int64',
'example' => '13089****',
],
'LmItemId' => [
'description' => 'lm侧商品ID',
'type' => 'string',
'example' => '10006138-63786616****',
],
'TbShopName' => [
'description' => '淘宝店铺名称',
'type' => 'string',
'example' => '好爸爸旗舰店',
],
'ItemActivityQuantity' => [
'description' => '活动商品库存,-1表示无限制',
'type' => 'integer',
'format' => 'int32',
'example' => '-1',
],
'LmActivityId' => [
'description' => '活动ID',
'type' => 'integer',
'format' => 'int64',
'example' => '679',
],
'CanSell' => [
'description' => '是否可售',
'type' => 'boolean',
'example' => 'true',
],
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '65332479****',
],
'MainPicUrl' => [
'description' => '商品主图',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg'."\n",
],
'Tips' => [
'type' => 'string',
],
'LmShopId' => [
'description' => 'lm侧店铺ID',
'type' => 'string',
'example' => '1002****',
],
'ItemActivityStatus' => [
'description' => '商品活动状态',
'type' => 'string',
],
'SkuModelList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmActivityItemSkuModel' => [
'description' => '商品SKU列表',
'type' => 'array',
'items' => [
'description' => '商品SKU列表',
'type' => 'object',
'properties' => [
'ReservedPrice' => [
'description' => '商品原价(单位分)',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'Tips' => [
'type' => 'string',
],
'LmItemId' => [
'description' => 'lm侧商品ID',
'type' => 'string',
'example' => '10000035-63064613****',
],
'SkuId' => [
'description' => 'skuID',
'type' => 'integer',
'format' => 'int64',
'example' => '478531731****',
],
'LmActivityId' => [
'description' => 'lm活动ID',
'type' => 'integer',
'format' => 'int64',
'example' => '679',
],
'ActivityStatus' => [
'description' => '活动状态',
'type' => 'string',
],
'BizId' => [
'description' => '业务ID',
'type' => 'string',
'example' => 'LMALL20211013****',
],
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '64092072****',
],
'SkuPicUrl' => [
'description' => 'sku图片',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg'."\n",
],
'ActivityPrice' => [
'description' => '活动价(单位分)',
'type' => 'integer',
'format' => 'int64',
'example' => '1990',
],
'SkuTitle' => [
'description' => 'sku标题',
'type' => 'string',
'example' => '白色/64G',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"539E5C68-D8B5-57EC-9D9B-58AFD9E0****\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 12,\\n \\"LmActivityItemModelList\\": {\\n \\"LmActivityItemModel\\": [\\n {\\n \\"ItemTitle\\": \\"红塔山(硬欣经典)香烟\\",\\n \\"TbSellerId\\": 0,\\n \\"SellableQuantity\\": 200,\\n \\"TbShopId\\": 0,\\n \\"LmItemId\\": \\"10006138-63786616****\\",\\n \\"TbShopName\\": \\"好爸爸旗舰店\\",\\n \\"ItemActivityQuantity\\": -1,\\n \\"LmActivityId\\": 679,\\n \\"CanSell\\": true,\\n \\"ItemId\\": 0,\\n \\"MainPicUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\\\n\\",\\n \\"Tips\\": \\"\\",\\n \\"LmShopId\\": \\"1002****\\",\\n \\"ItemActivityStatus\\": \\"\\",\\n \\"SkuModelList\\": {\\n \\"LmActivityItemSkuModel\\": [\\n {\\n \\"ReservedPrice\\": 2990,\\n \\"Tips\\": \\"\\",\\n \\"LmItemId\\": \\"10000035-63064613****\\",\\n \\"SkuId\\": 0,\\n \\"LmActivityId\\": 679,\\n \\"ActivityStatus\\": \\"\\",\\n \\"BizId\\": \\"LMALL20211013****\\",\\n \\"ItemId\\": 0,\\n \\"SkuPicUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\\\n\\",\\n \\"ActivityPrice\\": 1990,\\n \\"SkuTitle\\": \\"白色/64G\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询指定活动的商品信息',
'summary' => '通过此接⼝可以查询指定活动中的商品信息。',
'description' => '通过此接⼝可以查询指定活动中的商品信息',
],
'QueryBizItemList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20211202****',
],
],
[
'name' => 'SubBizId',
'in' => 'query',
'schema' => [
'description' => '子渠道id',
'type' => 'string',
'required' => false,
'example' => 'sQuuSHY*************',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每⻚数量范围(1-20)默认20',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '20',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '请求⻚码,默认为1',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => '用户ID',
'type' => 'string',
'required' => false,
'example' => '2114255235****',
],
],
[
'name' => 'LmItemIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'lm侧商品ID列表',
'type' => 'object',
'required' => false,
'example' => '[\\"10000791-65975997****\\"]',
],
],
[
'name' => 'ItemIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '商品ID列表',
'type' => 'object',
'required' => false,
'example' => '[63524643****]',
],
],
[
'name' => 'CategoryId',
'in' => 'query',
'schema' => [
'description' => '类目ID,0表示查询1级类目',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '50003449',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '5B9B6D8D-A78D-521D-B6B6-08CDC182****',
],
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'The specified parameter %s value is not valid.',
],
'PageNumber' => [
'description' => '当前页码',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '每页商品数量',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalCount' => [
'description' => '总商品数量',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'ItemList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Item' => [
'description' => '商品列表,如果code=SUCCESS,此项必须',
'type' => 'array',
'items' => [
'description' => '商品列表,如果code=SUCCESS,此项必须',
'type' => 'object',
'properties' => [
'ExtJson' => [
'description' => '拓展字段',
'type' => 'string',
'example' => '""',
],
'MainPicUrl' => [
'description' => '主图地址',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg',
],
'ItemTitle' => [
'description' => '商品标题',
'type' => 'string',
'example' => '生椰拿铁',
],
'LmItemId' => [
'description' => 'lm侧商品ID',
'type' => 'string',
'example' => '10000102-65931326****',
],
'SellerId' => [
'description' => '卖家ID',
'type' => 'integer',
'format' => 'int64',
'example' => '284324****',
],
'CategoryId' => [
'description' => '最后⼀级的类⽬ID,之后会提供类⽬查询接⼝来获取商品所属类⽬信息',
'type' => 'integer',
'format' => 'int64',
'example' => '50050579',
],
'CanSell' => [
'description' => '是否可售卖,不包含库存为0的逻辑判断',
'type' => 'boolean',
'example' => 'true',
],
'CustomizedItemName' => [
'type' => 'string',
],
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '64944233****',
],
'ReservePrice' => [
'description' => '商详页显示的划线价',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'TaobaoShopName' => [
'description' => '淘宝店铺名称',
'type' => 'string',
'example' => '橘子郡',
],
'SkuList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Sku' => [
'description' => '商品sku列表',
'type' => 'array',
'items' => [
'description' => '商品sku列表',
'type' => 'object',
'properties' => [
'PriceCent' => [
'description' => '销售价格(分),priceCent表示客户端的销售价格,返回值以分为单位',
'type' => 'integer',
'format' => 'int64',
'example' => '1990',
],
'SkuId' => [
'description' => '商品的SkuId',
'type' => 'integer',
'format' => 'int64',
'example' => '482694857****',
],
'TaoBaoCurrentPrice' => [
'description' => '"淘宝当前售价,淘宝天猫官⽅的实际售卖价格,⾮供货价,仅⽤来做价格对⽐⽤,前端建议不显示,可显示划线价',
'type' => 'integer',
'format' => 'int64',
'example' => '4990',
],
'CanSell' => [
'description' => '是否可售',
'type' => 'boolean',
'example' => 'true',
],
'SkuPicUrl' => [
'description' => 'sku图片地址',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg'."\n",
],
'Points' => [
'description' => '积分数量',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'SkuTitle' => [
'description' => '商品sku名称',
'type' => 'string',
'example' => '白色/64G',
],
'PointsAmount' => [
'description' => '积分抵扣价格',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'BenefitId' => [
'description' => '商品权益ID',
'type' => 'string',
'example' => '202109240050220000008822****',
],
'CustomizedAttributeMap' => [
'description' => '买家信息',
'type' => 'object',
'example' => '{}',
],
'GradePriceModels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'GradePriceModel' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Recommend' => [
'type' => 'boolean',
],
'ShowName' => [
'type' => 'string',
],
'PriceCent' => [
'type' => 'integer',
'format' => 'int64',
],
'Icon' => [
'type' => 'string',
],
'PointPrice' => [
'type' => 'integer',
'format' => 'int64',
],
'Exclusive' => [
'type' => 'boolean',
],
'CharacteristicName' => [
'type' => 'string',
],
'AccessUrl' => [
'type' => 'string',
],
'SubBizCode' => [
'type' => 'string',
],
'CharacteristicCode' => [
'type' => 'string',
],
'CanBuy' => [
'type' => 'boolean',
],
'Points' => [
'description' => '积分数量',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'PointsAmount' => [
'description' => '积分抵扣价格',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'UserLabelList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UserLabelList' => [
'description' => '用户标签列表',
'type' => 'array',
'items' => [
'description' => '用户标签列表',
'type' => 'string',
'example' => '""',
],
],
],
],
],
],
],
],
],
'UserLabelList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UserLabelList' => [
'description' => '用户标签列表',
'type' => 'array',
'items' => [
'description' => '用户标签列表',
'type' => 'string',
'example' => '""',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5B9B6D8D-A78D-521D-B6B6-08CDC182****\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 10,\\n \\"ItemList\\": {\\n \\"Item\\": [\\n {\\n \\"ExtJson\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MainPicUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\",\\n \\"ItemTitle\\": \\"生椰拿铁\\",\\n \\"LmItemId\\": \\"10000102-65931326****\\",\\n \\"SellerId\\": 0,\\n \\"CategoryId\\": 50050579,\\n \\"CanSell\\": true,\\n \\"CustomizedItemName\\": \\"\\",\\n \\"ItemId\\": 0,\\n \\"ReservePrice\\": 2990,\\n \\"TaobaoShopName\\": \\"橘子郡\\",\\n \\"SkuList\\": {\\n \\"Sku\\": [\\n {\\n \\"PriceCent\\": 1990,\\n \\"SkuId\\": 0,\\n \\"TaoBaoCurrentPrice\\": 4990,\\n \\"CanSell\\": true,\\n \\"SkuPicUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\\\n\\",\\n \\"Points\\": 2990,\\n \\"SkuTitle\\": \\"白色/64G\\",\\n \\"PointsAmount\\": 2990,\\n \\"BenefitId\\": \\"202109240050220000008822****\\",\\n \\"CustomizedAttributeMap\\": {},\\n \\"GradePriceModels\\": {\\n \\"GradePriceModel\\": [\\n {\\n \\"Recommend\\": true,\\n \\"ShowName\\": \\"\\",\\n \\"PriceCent\\": 0,\\n \\"Icon\\": \\"\\",\\n \\"PointPrice\\": 0,\\n \\"Exclusive\\": true,\\n \\"CharacteristicName\\": \\"\\",\\n \\"AccessUrl\\": \\"\\",\\n \\"SubBizCode\\": \\"\\",\\n \\"CharacteristicCode\\": \\"\\",\\n \\"CanBuy\\": true,\\n \\"Points\\": 2990,\\n \\"PointsAmount\\": 2990,\\n \\"UserLabelList\\": {\\n \\"UserLabelList\\": [\\n \\"\\\\\\"\\\\\\"\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"UserLabelList\\": {\\n \\"UserLabelList\\": [\\n \\"\\\\\\"\\\\\\"\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取客户专属商品库全部商品',
'summary' => '获取客户专属商品库全部商品(分⻚查询业务商品库)。',
'description' => '客户选品后,Linkedmall会把客户选中的商品放在⼀个客户专属的商品库中。客户通过这个接⼝可以查询到专属商品库中的全部商品。 '."\n"
."\n"
.'注意:返回商品数据中canSell字段不包含商品库存为0的逻辑判断,即库存为0时返回的canSell也可能为true。',
'responseParamsDescription' => 'itenList示例:'."\n"
."\n"
.' {'."\n"
.' "requestId": "da6fd480-3fc6-4912-a161-995807f2d7bb",'."\n"
.' "code": "SUCCESS",'."\n"
.' "message": null,'."\n"
.' "pageNumber": 1,'."\n"
.' "totalCount": 1,'."\n"
.' "pageSize": 20,'."\n"
.' "itemList": ['."\n"
.' {'."\n"
.' "skuList": ['."\n"
.' {'."\n"
.' "skuId": "skuId",'."\n"
.' "skuPicUrl": "sku图⽚",'."\n"
.' "skuTitle": "sku名称,如 ⽩⾊/64G ,由各个属性拼成,斜线分隔",'."\n"
.' "priceCent": "销售价格(分) 注释:priceCent表示客户端的销售价格,返回值以分为单位",'."\n"
.' "taoBaoCurrentPrice": "淘宝当前售价,淘宝天猫官⽅的实际售卖价格,⾮供货价,仅⽤来做价格对⽐⽤,前端建议不显示,可显示划线价",'."\n"
.' "canSell": "商品是否可以销售 true:可以,false:不可以"'."\n"
.' }'."\n"
.' ],'."\n"
.' "itemId": "商品ID",'."\n"
.' "itemTitle": "商品标题",'."\n"
.' "mainPicUrl": "主图地址",'."\n"
.' "reservePrice": "商详⻚显示的划线价",'."\n"
.' "categoryId": "最后⼀级的类⽬ID,之后会提供类⽬查询接⼝来获取商品所属类⽬信息",'."\n"
.' "canSell": "是否可售卖"//不包含库存为0逻辑的判断'."\n"
.' }'."\n"
.' ]'."\n"
.' }',
],
'QueryBizItems' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'SubBizId',
'in' => 'query',
'schema' => [
'description' => '子业务ID',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页商品数量',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '20',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页页码,从1开始。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => '用户ID',
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Model' => [
'type' => 'string',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '96B4141C-A3CD-5162-B435-4780A75E3D97',
],
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'PageNumber' => [
'description' => '分页页码,从1开始。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '每页商品数量',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalCount' => [
'description' => '商品总数',
'type' => 'integer',
'format' => 'int32',
'example' => '19',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Model\\": \\"\\",\\n \\"RequestId\\": \\"96B4141C-A3CD-5162-B435-4780A75E3D97\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 19\\n}","type":"json"}]',
'title' => '获取客户专属商品库全部商品',
'summary' => '获取客户专属商品库全部商品。',
],
'QueryGuideItemGroup' => [
'summary' => '获取导购商品组商品列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******002',
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => [
'description' => '商品组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test01',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页页码,从1开始',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页商品数量',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '20',
],
],
[
'name' => 'ItemState',
'in' => 'query',
'schema' => [
'description' => '商品状态 ALL: 所有;AVAILABLE_FOR_SALE:可售的;NOT_FOR_SALE:不可售的',
'type' => 'string',
'required' => false,
'example' => 'AVAILABLE_FOR_SALE',
'enum' => [
'AVAILABLE_FOR_SALE',
'NOT_FOR_SALE',
'ALL',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '1B82570B-7167-5D41-A74F-CD8DC2C54A49',
],
'Success' => [
'description' => '请求是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
],
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '205',
],
'GuideItemGroup' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ItemInfo' => [
'description' => '商品组商品信息',
'type' => 'array',
'items' => [
'description' => '商品组商品信息',
'type' => 'object',
'properties' => [
'PriceCent' => [
'description' => '商品销售价格(分)',
'type' => 'integer',
'format' => 'int64',
'example' => '990',
],
'MainPicUrl' => [
'description' => '主图地址',
'type' => 'string',
],
'ItemTitle' => [
'description' => '商品标题',
'type' => 'string',
'example' => '南枣核桃糕(圆盒)'."\n",
],
'LmItemId' => [
'description' => 'lm侧商品ID',
'type' => 'string',
'example' => '10001036-******0492928',
],
'PointPrice' => [
'description' => '积分价格(分)',
'type' => 'integer',
'format' => 'int64',
'example' => '990',
],
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '66******1055',
],
'Points' => [
'description' => '积分数量',
'type' => 'integer',
'format' => 'int64',
'example' => '69',
],
'PointsAmount' => [
'description' => '积分抵扣价格',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ReservePrice' => [
'description' => '商品原价(元),可⽤于显示划线价',
'type' => 'string',
'example' => '20.0',
],
'ItemUrl' => [
'description' => '商品详情链接',
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B82570B-7167-5D41-A74F-CD8DC2C54A49\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"205\\",\\n \\"GuideItemGroup\\": {\\n \\"ItemInfo\\": [\\n {\\n \\"PriceCent\\": 990,\\n \\"MainPicUrl\\": \\"\\",\\n \\"ItemTitle\\": \\"南枣核桃糕(圆盒)\\\\n\\",\\n \\"LmItemId\\": \\"10001036-******0492928\\",\\n \\"PointPrice\\": 990,\\n \\"ItemId\\": 0,\\n \\"Points\\": 69,\\n \\"PointsAmount\\": 0,\\n \\"ReservePrice\\": \\"20.0\\",\\n \\"ItemUrl\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取导购商品组商品列表',
],
'CreateVirtualProductOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20210508****',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '221122411****',
],
],
[
'name' => 'OutTradeId',
'in' => 'query',
'schema' => [
'description' => '客户唯⼀订单号,未提供时,由阿⾥云创建',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '963****',
],
],
[
'name' => 'ItemId',
'in' => 'query',
'schema' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'docRequired' => true,
'example' => '66985559****',
],
],
[
'name' => 'Quantity',
'in' => 'query',
'schema' => [
'description' => '下单数量',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'TotalAmount',
'in' => 'query',
'schema' => [
'description' => '订单总金额',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '4990',
'default' => '0',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '拓展字段:这个字段⾥包括mobileNo字段,传⼊接⼊卡密的⼿机号,chargeAccount约定为充值账号',
'type' => 'string',
'required' => false,
'example' => '{\\"chargeAccount\\":\\"1510380****\\",\\"mobileNo\\":\\"186****3931\\"}',
'default' => '{}',
],
],
[
'name' => 'DeliveryAddress',
'in' => 'query',
'schema' => [
'description' => '收货地址',
'type' => 'string',
'required' => false,
'example' => '北京市朝阳区*******************',
],
],
[
'name' => 'OrderExpireTime',
'in' => 'query',
'schema' => [
'description' => '订单失效时间,单位秒,默认15分钟',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '900',
'example' => '900',
'default' => '900',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃,填AccountType即可',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '必须对应C端唯⼀⼀个⽤户,企业不可使⽤⼀个ID代所有⽤户下单',
'type' => 'string',
'required' => false,
'example' => '221122411****'."\n",
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
'default' => '',
],
],
[
'name' => 'LmItemId',
'in' => 'query',
'schema' => [
'description' => 'lm侧商品id',
'type' => 'string',
'required' => false,
'example' => '10001036-66644894****',
],
],
[
'name' => 'ItemList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '商品列表',
'type' => 'array',
'items' => [
'description' => '商品列表',
'type' => 'object',
'properties' => [
'SkuId' => [
'description' => '商品skuId',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '456458315****',
],
'LmItemId' => [
'description' => 'LM侧商品Id',
'type' => 'string',
'required' => false,
'example' => '10001036-66644894****'."\n",
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '66985559****'."\n",
],
'Quantity' => [
'description' => '下单数量',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '3B55509D-20AC-5BD5-9A81-D6B7382E****',
],
'Success' => [
'description' => '调用是否成功。',
'type' => 'boolean',
'example' => 'True',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => 'SUCCESS',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => 'SUCCESS',
],
'TotalCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'LogsId' => [
'type' => 'string',
'example' => '1',
],
'Model' => [
'description' => '订单信息,从返回的model对象中取出LmOrderList字段',
'type' => 'object',
'properties' => [
'RedirectUrl' => [
'description' => '重定向地址',
'type' => 'string',
'example' => 'https://console.authing.cn/console/g*********',
],
'LmOrderList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmOrderList' => [
'description' => '订单主订单列表',
'type' => 'array',
'items' => [
'description' => '订单主订单列表',
'type' => 'object',
'properties' => [
'LmOrderId' => [
'description' => '订单主订单号',
'type' => 'string',
'example' => '39435****',
],
],
],
],
],
],
'PayTradeIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PayTradeIds' => [
'description' => '交易单号',
'type' => 'array',
'items' => [
'description' => '交易单号',
'type' => 'string',
'example' => '[2324289*******,238478******]',
],
],
],
],
'OrderIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'OrderIds' => [
'description' => '淘宝订单id列表',
'type' => 'array',
'items' => [
'description' => '淘宝订单id列表',
'type' => 'string',
'example' => '[2113691583*****]',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3B55509D-20AC-5BD5-9A81-D6B7382E****\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"SUCCESS\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"SUCCESS\\",\\n \\"TotalCount\\": 5,\\n \\"LogsId\\": \\"1\\",\\n \\"Model\\": {\\n \\"RedirectUrl\\": \\"https://console.authing.cn/console/g*********\\",\\n \\"LmOrderList\\": {\\n \\"LmOrderList\\": [\\n {\\n \\"LmOrderId\\": \\"39435****\\"\\n }\\n ]\\n },\\n \\"PayTradeIds\\": {\\n \\"PayTradeIds\\": [\\n \\"[2324289*******,238478******]\\"\\n ]\\n },\\n \\"OrderIds\\": {\\n \\"OrderIds\\": [\\n \\"[2113691583*****]\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => '创建虚拟商品订单',
'summary' => '创建虚拟商品订单。',
'description' => '创建虚拟商品订单'."\n",
'responseParamsDescription' => 'LmOrderList: '."\n"
.' '."\n"
.' {'."\n"
.' "logsId":"",'."\n"
.' "code":"SUCCESS",'."\n"
.' "subCode":"",'."\n"
.' "requestId":"F0F823D7-04D3-4571-8593-01CA43C8A158",'."\n"
.' "success":true,'."\n"
.' "model":{'."\n"
.' "redirectUrl":"http://pre-wormhole.tmall.com/wow/wt/act/lm-pages?wh_page=order-list&env=wapa",'."\n"
.' "lmOrderList":['."\n"
.' {'."\n"
.' "lmOrderId":"77604001"'."\n"
.' }'."\n"
.' ],'."\n"
.' "payTradeIds":['."\n"
.' ],'."\n"
.' "orderIds":['."\n"
.' "77604001"'."\n"
.' ]'."\n"
.' },'."\n"
.' "message":"",'."\n"
.' "subMessage":""'."\n"
.' }',
],
'SettleOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'OutRequestNo',
'in' => 'formData',
'schema' => [
'description' => '外部请求号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'TradeNo',
'in' => 'formData',
'schema' => [
'description' => '交易流水号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'RoyaltyParameters',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'example' => '""',
],
],
[
'name' => 'ExtInfo',
'in' => 'formData',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
'example' => '{"key":"value"}',
],
],
[
'name' => 'OutTradeNo',
'in' => 'formData',
'schema' => [
'description' => '外部交易号',
'type' => 'string',
'required' => false,
'example' => '""',
],
],
[
'name' => 'MerchantId',
'in' => 'formData',
'schema' => [
'description' => '商户ID',
'type' => 'string',
'required' => false,
'example' => '64******721',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '79C01D47-3C44-57D9-BC99-1B33F7ED14B8',
],
'TradeOrderSettleResponse' => [
'description' => '返回的结果',
'type' => 'object',
'properties' => [
'TradeNo' => [
'description' => '交易流水号',
'type' => 'string',
'example' => '""',
],
'OutRequestNo' => [
'description' => '外部请求号',
'type' => 'string',
'example' => '""',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"79C01D47-3C44-57D9-BC99-1B33F7ED14B8\\",\\n \\"TradeOrderSettleResponse\\": {\\n \\"TradeNo\\": \\"\\\\\\"\\\\\\"\\",\\n \\"OutRequestNo\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n}","type":"json"}]',
'title' => '结清订单',
'summary' => '当订单交易完成后将钱款清算给各方。',
],
'QueryOrderAndPaymentList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传同样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '22******6718',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页多少条记录,最大20条',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '20',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前⻚码,从1开始',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'FilterOption',
'in' => 'query',
'schema' => [
'description' => '订单过滤条件,json序列化后的字符串',
'type' => 'string',
'required' => false,
'example' => '{\\"lmOrderList\\":[32******46],\\"enableStatus\\":-1}',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '3F43129B-020F-5F8A-88B0-9CBDE2AD6F52',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'PageSize' => [
'description' => '每页多少条记录,最大为20条',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'PageNumber' => [
'description' => '当前页码,从1开始',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalCount' => [
'description' => '总订单数量',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'PostFee' => [
'description' => '邮费',
'type' => 'object',
'properties' => [
'FundAmount' => [
'description' => '资金金额',
'type' => 'integer',
'format' => 'int64',
],
'FundType' => [
'description' => '资金类型',
'type' => 'string',
],
'FundAmountMoney' => [
'description' => 'FundAmount对应的等值金额',
'type' => 'integer',
'format' => 'int64',
],
],
],
'LmOrderList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmOrderList' => [
'description' => '订单详情列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LmOrderId' => [
'description' => '订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '44******82',
],
'EnableStatus' => [
'description' => '0:生效,1无效',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ExtJson' => [
'description' => '拓展字段',
'type' => 'string',
],
'OrderStatus' => [
'description' => '订单状态,6=交易成功',
'type' => 'integer',
'format' => 'int32',
'example' => '6',
],
'LmPaymentId' => [
'description' => 'lm现⾦⽀付订单号,⽀付宝账单⾥对应字段:商家订单号',
'type' => 'string',
],
'ShopName' => [
'description' => '店铺名',
'type' => 'string',
'example' => '****零食店',
],
'TbOrderId' => [
'description' => '淘宝订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '18******13134',
],
'OrderAmount' => [
'description' => '订单总金额',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'LogisticsStatus' => [
'description' => '物流状态(由于此字段为定时从主站同步的,会存在延迟,最⻓可能⼏天才同步)',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'CreateDate' => [
'description' => '下单时间,格式化(yyyy-MM-dd HH:mm:ss)',
'type' => 'string',
'example' => '2022-04-01 12:00:00',
],
'FundStructureModels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FundStructureModels' => [
'description' => '支付组成',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FundAmount' => [
'description' => '资金金额',
'type' => 'integer',
'format' => 'int64',
],
'FundType' => [
'description' => '资金类型',
'type' => 'string',
],
'FundAmountMoney' => [
'description' => '子订单金额,以分为单位',
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
'SubOrderList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SubOrderList' => [
'description' => '子订单列表',
'type' => 'array',
'items' => [
'description' => '子订单列表',
'type' => 'object',
'properties' => [
'LmOrderId' => [
'description' => '子订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '39******99',
],
'EnableStatus' => [
'description' => ' '."\n"
.'支付状态 0,⽣效;1,⽆效',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ItemTitle' => [
'description' => '商品名称',
'type' => 'string',
'example' => '南枣核桃糕(圆盒)',
],
'OrderStatus' => [
'description' => '订单状态,6=交易成功',
'type' => 'integer',
'format' => 'int32',
'example' => '6',
],
'SkuName' => [
'description' => '下单的商品sku显示的名称',
'type' => 'string',
'example' => '南枣核桃糕(圆盒)2盒装',
],
'LmItemId' => [
'description' => 'lm侧商品id',
'type' => 'string',
'example' => '10000055-******135427',
],
'SkuId' => [
'description' => '下单商品的skuId',
'type' => 'integer',
'format' => 'int64',
'example' => '471******886',
],
'Number' => [
'description' => '下单数量',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TbOrderId' => [
'description' => '淘宝子订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '13******61284',
],
'ItemPic' => [
'description' => '商品图片地址',
'type' => 'string',
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'example' => '656******550',
],
'ItemPriceList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ItemPriceList' => [
'description' => '商品价格列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FundAmount' => [
'description' => '资金金额',
'type' => 'integer',
'format' => 'int64',
],
'FundType' => [
'description' => '资金类型',
'type' => 'string',
],
'FundAmountMoney' => [
'description' => '子订单金额,以分为单位',
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
],
],
],
],
'PostFee' => [
'description' => '邮费',
'type' => 'object',
'properties' => [
'FundAmount' => [
'description' => '资金金额',
'type' => 'integer',
'format' => 'int64',
],
'FundType' => [
'description' => '资金类型',
'type' => 'string',
],
'FundAmountMoney' => [
'description' => 'FundAmount对应的等值金额',
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F43129B-020F-5F8A-88B0-9CBDE2AD6F52\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 5,\\n \\"PostFee\\": {\\n \\"FundAmount\\": 0,\\n \\"FundType\\": \\"\\",\\n \\"FundAmountMoney\\": 0\\n },\\n \\"LmOrderList\\": {\\n \\"LmOrderList\\": [\\n {\\n \\"LmOrderId\\": 0,\\n \\"EnableStatus\\": 1,\\n \\"ExtJson\\": \\"\\",\\n \\"OrderStatus\\": 6,\\n \\"LmPaymentId\\": \\"\\",\\n \\"ShopName\\": \\"****零食店\\",\\n \\"TbOrderId\\": 0,\\n \\"OrderAmount\\": 100,\\n \\"LogisticsStatus\\": 3,\\n \\"CreateDate\\": \\"2022-04-01 12:00:00\\",\\n \\"FundStructureModels\\": {\\n \\"FundStructureModels\\": [\\n {\\n \\"FundAmount\\": 0,\\n \\"FundType\\": \\"\\",\\n \\"FundAmountMoney\\": 0\\n }\\n ]\\n },\\n \\"SubOrderList\\": {\\n \\"SubOrderList\\": [\\n {\\n \\"LmOrderId\\": 0,\\n \\"EnableStatus\\": 0,\\n \\"ItemTitle\\": \\"南枣核桃糕(圆盒)\\",\\n \\"OrderStatus\\": 6,\\n \\"SkuName\\": \\"南枣核桃糕(圆盒)2盒装\\",\\n \\"LmItemId\\": \\"10000055-******135427\\",\\n \\"SkuId\\": 0,\\n \\"Number\\": 1,\\n \\"TbOrderId\\": 0,\\n \\"ItemPic\\": \\"\\",\\n \\"ItemId\\": 0,\\n \\"ItemPriceList\\": {\\n \\"ItemPriceList\\": [\\n {\\n \\"FundAmount\\": 0,\\n \\"FundType\\": \\"\\",\\n \\"FundAmountMoney\\": 0\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"PostFee\\": {\\n \\"FundAmount\\": 0,\\n \\"FundType\\": \\"\\",\\n \\"FundAmountMoney\\": 0\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询订单列表及支付流水',
'summary' => '查询订单列表及支付流水。',
'description' => '查询订单列表或者详情'."\n"
."\n"
.'注意:此接⼝⼀般⽤于查询某个已经⽀付订单的详情和⽀付信息,需要在filterOption中加⼊明确的订单id,如果单纯的查询订单列表请使⽤4.1章节的接⼝',
'requestParamsDescription' => '通过lmOrderId查询订单时的filterOption:'."\n"
."\n"
.' {'."\n"
.' "orderStatus":"12=待⽀付,2=已⽀付,4=已退款关闭,6=交易成功,8=被淘宝关闭 ",'."\n"
.' "logisticsStatus":" 1=未发货 -> 等待卖家发货 2=已发货 -> 等待买家确认收货 3=已收货-> 交易成功 4=已经退货 -> 交易失败 5=部分收货 -> 交易成功 6=部分发货中 8=还未创建物流订单",'."\n"
.' "lmOrderList":["主订单列表"], //订单号数量上限20个'."\n"
.' "filter": "createTime>12323 AND createTime<45454", //过滤条件,⽬前只⽀持创单时间, 传单时间的值为unix时间戳, ⽀持<,>,>=,<=, !=,=, AND,OR'."\n"
.' "enableStatus":"-1",//0,⽣效,1,⽆效,-1都查,不填默认为0,查订单详情时此字段要传。'."\n"
.' }'."\n"
."\n"
.'通过outTradeId查询订单时的filterOption:'."\n"
."\n"
.' {'."\n"
.' "orderStatus":"12=待⽀付,2=已⽀付,4=已退款关闭,6=交易成功,8=被淘宝关闭 ",'."\n"
.' "logisticsStatus":" 1=未发货 -> 等待卖家发货 2=已发货 -> 等待买家确认收货 3=已收货-> 交易成功 4=已经退货 -> 交易失败 5=部分收货 -> 交易成功 6=部分发货中 8=还未创建物流订单",'."\n"
.' "channelOrderIdList":["outTradeId"], //订单号数量上限20个'."\n"
.' "filter": "createTime>12323 AND createTime<45454", //过滤条件,⽬前只⽀持创单时间, 传单时间的值为unix时间戳, ⽀持<,>,>=,<=, !=,=, AND,OR'."\n"
.' "enableStatus":"-1",//0,⽣效,1,⽆效,-1都查,不填默认为0,查订单详情时此字段要传。'."\n"
.' }',
'responseParamsDescription' => '返回示例:'."\n"
."\n"
.' {'."\n"
.' "lmOrderList": ['."\n"
.' {'."\n"
.' "createDate": "下单时间,格式化(yyyy-MM-dd HH:mm:ss)",'."\n"
.' "lmOrderId": "订单号,对外统⼀使⽤此ID做主键操作",'."\n"
.' "tbOrderId": "淘宝订单号",'."\n"
.' "lmPaymentId": "lm现⾦⽀付订单号,⽀付宝账单⾥对应字段:商家订单号 ",'."\n"
.' "shopName": "店铺名",'."\n"
.' "logisticsStatus": "物流状态(由于此字段为定时从主站同步的,会存在延迟,最⻓可能⼏天才同步)",'."\n"
.' "enableStatus": "0,⽣效;1,⽆效",'."\n"
.' "orderAmount": "订单总⾦额",'."\n"
.' "orderStatus": "订单状态,6=交易成功",'."\n"
.' "subOrderList": ['."\n"
.' {'."\n"
.' "itemId": "itemId",'."\n"
.' "itemPic": "商品图⽚",'."\n"
.' "itemPriceList": ['."\n"
.' {'."\n"
.' "fundAmountMoney": "⼦订单⾦额,以分为单位"'."\n"
.' }'."\n"
.' ],'."\n"
.' "itemTitle": "商品名称",'."\n"
.' "number": "下单数量",'."\n"
.' "skuId": "下单的商品SkuId",'."\n"
.' "skuName": "下单的商品SKU显示名称",'."\n"
.' "orderStatus": "订单状态,6=交易成功",'."\n"
.' "lmOrderId": "⼦订单号",'."\n"
.' "tbOrderId": "淘宝⼦订单号"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.' }',
],
'QueryOrderCommissionRate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******002',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '221249435****',
],
],
[
'name' => 'LmOrderId',
'in' => 'query',
'schema' => [
'description' => 'lm订单号',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '45******23',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值:ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'A7BE4356-7F92-533E-A31B-2EBF2D67****',
],
'CommissionModels' => [
'description' => '佣金信息',
'type' => 'array',
'items' => [
'description' => '佣金信息',
'type' => 'object',
'properties' => [
'LmOrderId' => [
'description' => 'lm订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '45******23'."\n",
],
'CommissionInfo' => [
'description' => '佣金信息',
'type' => 'object',
'properties' => [
'RateType' => [
'description' => '费率类型,CONSTANT_RATE 表示固定⽐例',
'type' => 'string',
'example' => 'CONSTANT_RATE',
],
'RateConfig' => [
'description' => '费率信息',
'type' => 'object',
'properties' => [
'Configs' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ValueUnit' => [
'description' => '%%(费率单位,如1000%%表示10%的费率,250%%表示2.5%的费率)',
'type' => 'string',
'example' => '%%',
],
'Value' => [
'description' => '(费率)',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"A7BE4356-7F92-533E-A31B-2EBF2D67****\\",\\n \\"CommissionModels\\": [\\n {\\n \\"LmOrderId\\": 0,\\n \\"CommissionInfo\\": {\\n \\"RateType\\": \\"CONSTANT_RATE\\",\\n \\"RateConfig\\": {\\n \\"Configs\\": [\\n {\\n \\"ValueUnit\\": \\"%%\\",\\n \\"Value\\": 1000\\n }\\n ]\\n }\\n }\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询订单分佣比例',
'summary' => '您签署分佣协议后通过该接口获取订单的分佣比例。',
'description' => '客户可以调⽤本接⼝查询订单的分佣⽐例',
'responseParamsDescription' => 'commissionModels:'."\n"
.' '."\n"
.' ['."\n"
.' {'."\n"
.' "lmOrderId": "linkedmall订单号",'."\n"
.' "commissionInfo": ['."\n"
.' {'."\n"
.' "rateType": "费率类型,CONSTANT_RATE 表示固定⽐例",'."\n"
.' "rateConfig": ['."\n"
.' {'."\n"
.' "value": 1000(费率),'."\n"
.' "valueUnit": "%%(费率单位,如 1000%% 表示 10% 的费率,250%% 表示 2.5% 的费率)"'."\n"
.' }] '."\n"
.' }]'."\n"
.' }'."\n"
.' ]',
],
'QueryOrderDetailInner' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20210927****',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和ThirdPartyUserId填写一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '208823220453****',
],
],
[
'name' => 'FilterOption',
'in' => 'query',
'schema' => [
'description' => '过滤条件,格式:{"key1":"value1"}。',
'type' => 'string',
'required' => false,
'example' => '{\\"enableStatus\\":0,\\"lmOrderList\\":[42433****]}',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
'example' => '208823220453****'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'The specified parameter %s value is not valid.',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '6103AD7B-21C2-523B-89D0-579DA58D****',
],
'Model' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'order' => [
'description' => '返回订单信息',
'type' => 'object',
'properties' => [
'Eticket' => [
'type' => 'boolean',
],
'CreateDate' => [
'description' => '下单时间',
'type' => 'string',
'example' => '2022-04-01 16:33:23',
],
'LogisticsCompName' => [
'description' => '物流公司名称',
'type' => 'string',
'example' => '中通',
],
'ChannelCode' => [
'description' => '渠道ID',
'type' => 'string',
'example' => '*********',
],
'LogisticsMobilePhone' => [
'description' => '物流联系电话',
'type' => 'string',
'example' => '185****4801',
],
'ResExtInfo' => [
'description' => '拓展字段',
'type' => 'string',
'example' => '""',
],
'EnableStatus' => [
'description' => '0,⽣效;1,⽆效',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ChannelBizType' => [
'type' => 'string',
],
'Shipping' => [
'type' => 'string',
],
'OrderPayInfo' => [
'description' => '订单费用信息',
'type' => 'string',
'example' => '""',
],
'LogisticsStatusDesc' => [
'description' => '物流状态',
'type' => 'string',
'example' => '商品已下单',
],
'TbOrderId' => [
'description' => '淘宝子订单号',
'type' => 'string',
'example' => '25343894898952***',
],
'LogisticsStatus' => [
'description' => '物流状态',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'LmOrderId' => [
'description' => 'lm订单id',
'type' => 'integer',
'format' => 'int64',
'example' => '45609****',
],
'SellerId' => [
'description' => '卖家id',
'type' => 'integer',
'format' => 'int64',
'example' => '220941058****',
],
'ShopName' => [
'description' => '店铺名',
'type' => 'string',
'example' => '谢雪华的门店',
],
'OrderAmount' => [
'description' => '订单总金额',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'ExtInfo' => [
'description' => '拓展信息',
'type' => 'object',
'example' => '{\\"key\\":\\"value\\"}',
],
'EndTime' => [
'description' => '订单完结时间',
'type' => 'integer',
'format' => 'int64',
'example' => '2022-04-01 17:21:23',
],
'PayStatus' => [
'description' => '订单状态',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'LogisticsNo' => [
'description' => '物流单号',
'type' => 'string',
'example' => 'YT217467555****',
],
'LogisticsUserName' => [
'description' => '物流名称',
'type' => 'string',
'example' => '圆通',
],
'LogisticsAddress' => [
'description' => '物流地址',
'type' => 'string',
'example' => '北京市*******',
],
'PayWaterStatus' => [
'type' => 'integer',
'format' => 'int32',
],
'RefundStatus' => [
'description' => '退款状态',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'SellerNick' => [
'description' => '卖家nick',
'type' => 'string',
'example' => '点苍科技',
],
'ChannelOrderId' => [
'description' => '渠道订单号',
'type' => 'string',
'example' => '182378172837****',
],
'SubItemOrderList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SubItemOrder' => [
'description' => '子订单列表',
'type' => 'array',
'items' => [
'description' => '子订单列表',
'type' => 'object',
'properties' => [
'LmOrderId' => [
'description' => 'lm子订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '45609****',
],
'ItemPriceInfo' => [
'description' => '商品价格信息',
'type' => 'string',
'example' => '""',
],
'ItemTitle' => [
'description' => '商品标题',
'type' => 'string',
'example' => '葡萄吐司',
],
'TbSubOrderId' => [
'description' => '淘宝子订单ID',
'type' => 'integer',
'format' => 'int64',
'example' => '2487583728****',
],
'LmItemId' => [
'description' => 'lm侧商品id',
'type' => 'string',
'example' => '10000102-61638587****',
],
'TotalPaymentInfo' => [
'type' => 'string',
],
'ItemPic' => [
'description' => '商品图片地址',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg'."\n",
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'example' => '63194403****',
],
'ChannelCode' => [
'description' => '渠道ID',
'type' => 'string',
'example' => '*****',
],
'PayStatus' => [
'description' => '订单状态',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'SkuName' => [
'description' => '下单的商品sku显示的名称',
'type' => 'string',
'example' => '白色/64G',
],
'Number' => [
'description' => '下单数量',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SkuId' => [
'description' => 'skuId,虚拟商品为-1',
'type' => 'integer',
'format' => 'int64',
'example' => '473246257****',
],
'ItemPriceList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ItemPrice' => [
'description' => '商品价格列表',
'type' => 'array',
'items' => [
'description' => '价格列表',
'type' => 'object',
'properties' => [
'FundAmount' => [
'description' => '资⾦⾦额或数量,如现⾦单位为分,美分,积分为个,其它再约定,建议为最⼩的数量单位',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'TbOrderId' => [
'description' => '淘宝订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '2547326482****',
],
'FundType' => [
'description' => '资⾦类型,如现⾦,优惠券,代⾦券,积分等 :'."\n"
.'CASH_CNY_PAY,POINT_PAY',
'type' => 'string',
'example' => 'POINT_PAY',
],
'FundAmountMoney' => [
'description' => '对应的等值⾦额,单位为分。⽐如fundType为现⾦时,'."\n"
.'fundAmountMoney等于fundAmount,其它⾮现⾦类的⽀付,由渠道计算好相应的等值⾦额放在这'."\n"
.'⾥。',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'TbSubOrderId' => [
'description' => '淘宝子订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '2547326482****'."\n",
],
],
],
],
],
],
],
],
],
],
],
'FundStructureModels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FundStructure' => [
'description' => '订单金额模型',
'type' => 'array',
'items' => [
'description' => '订单金额模型'."\n"
."\n",
'type' => 'object',
'properties' => [
'FundAmount' => [
'description' => '资⾦⾦额或数量,如现⾦单位为分,美分,积分为个,其它再约定,建议为最⼩的数量单位',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'LmOrderId' => [
'description' => 'lm订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '51855****',
],
'FundType' => [
'description' => '资⾦类型,如现⾦,优惠券,代⾦券,积分等 :'."\n"
.'CASHCNYPAY,POINT_PAY'."\n"
."\n",
'type' => 'string',
'example' => 'POINT_PAY',
],
'FundAmountMoney' => [
'description' => '对应的等值⾦额,单位为分。⽐如fundType为现⾦时,'."\n"
.'fundAmountMoney等于fundAmount,其它⾮现⾦类的⽀付,由渠道计算好相应的等值⾦额放在这'."\n"
.'⾥。',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'TbSubOrderId' => [
'description' => '淘宝子订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '2874823748****',
],
],
],
],
],
],
'PostFee' => [
'description' => '邮费',
'type' => 'object',
'properties' => [
'FundAmount' => [
'description' => '资⾦⾦额或数量,如现⾦单位为分,美分,积分为个,其它再约定,建议为最⼩的数量单位',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'LmOrderId' => [
'description' => 'lm订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '52312****',
],
'FundType' => [
'description' => '资⾦类型,如现⾦,优惠券,代⾦券,积分等 :'."\n"
.'CASHCNYPAY,POINT_PAY'."\n"
."\n",
'type' => 'string',
'example' => 'POINT_PAY',
],
'FundAmountMoney' => [
'description' => '对应的等值⾦额,单位为分。⽐如fundType为现⾦时,'."\n"
.'fundAmountMoney等于fundAmount,其它⾮现⾦类的⽀付,由渠道计算好相应的等值⾦额放在这'."\n"
.'⾥。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'TbSubOrderId' => [
'description' => '淘宝子订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '2874823748****',
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\",\\n \\"RequestId\\": \\"6103AD7B-21C2-523B-89D0-579DA58D****\\",\\n \\"Model\\": {\\n \\"order\\": {\\n \\"Eticket\\": true,\\n \\"CreateDate\\": \\"2022-04-01 16:33:23\\",\\n \\"LogisticsCompName\\": \\"中通\\",\\n \\"ChannelCode\\": \\"*********\\",\\n \\"LogisticsMobilePhone\\": \\"185****4801\\",\\n \\"ResExtInfo\\": \\"\\\\\\"\\\\\\"\\",\\n \\"EnableStatus\\": 1,\\n \\"ChannelBizType\\": \\"\\",\\n \\"Shipping\\": \\"\\",\\n \\"OrderPayInfo\\": \\"\\\\\\"\\\\\\"\\",\\n \\"LogisticsStatusDesc\\": \\"商品已下单\\",\\n \\"TbOrderId\\": \\"25343894898952***\\",\\n \\"LogisticsStatus\\": 2,\\n \\"LmOrderId\\": 0,\\n \\"SellerId\\": 0,\\n \\"ShopName\\": \\"谢雪华的门店\\",\\n \\"OrderAmount\\": 2990,\\n \\"ExtInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"EndTime\\": 0,\\n \\"PayStatus\\": 2,\\n \\"LogisticsNo\\": \\"YT217467555****\\",\\n \\"LogisticsUserName\\": \\"圆通\\",\\n \\"LogisticsAddress\\": \\"北京市*******\\",\\n \\"PayWaterStatus\\": 0,\\n \\"RefundStatus\\": 4,\\n \\"SellerNick\\": \\"点苍科技\\",\\n \\"ChannelOrderId\\": \\"182378172837****\\",\\n \\"SubItemOrderList\\": {\\n \\"SubItemOrder\\": [\\n {\\n \\"LmOrderId\\": 0,\\n \\"ItemPriceInfo\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ItemTitle\\": \\"葡萄吐司\\",\\n \\"TbSubOrderId\\": 0,\\n \\"LmItemId\\": \\"10000102-61638587****\\",\\n \\"TotalPaymentInfo\\": \\"\\",\\n \\"ItemPic\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\\\n\\",\\n \\"ItemId\\": 0,\\n \\"ChannelCode\\": \\"*****\\",\\n \\"PayStatus\\": 2,\\n \\"SkuName\\": \\"白色/64G\\",\\n \\"Number\\": 1,\\n \\"SkuId\\": 0,\\n \\"ItemPriceList\\": {\\n \\"ItemPrice\\": [\\n {\\n \\"FundAmount\\": 2990,\\n \\"TbOrderId\\": 0,\\n \\"FundType\\": \\"POINT_PAY\\",\\n \\"FundAmountMoney\\": 2990,\\n \\"TbSubOrderId\\": 0\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"FundStructureModels\\": {\\n \\"FundStructure\\": [\\n {\\n \\"FundAmount\\": 2990,\\n \\"LmOrderId\\": 0,\\n \\"FundType\\": \\"POINT_PAY\\",\\n \\"FundAmountMoney\\": 2990,\\n \\"TbSubOrderId\\": 0\\n }\\n ]\\n },\\n \\"PostFee\\": {\\n \\"FundAmount\\": 100,\\n \\"LmOrderId\\": 0,\\n \\"FundType\\": \\"POINT_PAY\\",\\n \\"FundAmountMoney\\": 100,\\n \\"TbSubOrderId\\": 0\\n }\\n }\\n }\\n}","type":"json"}]',
'title' => '查询订单详情(内部使用)',
'summary' => '查询订单详情(内部使用)。',
'description' => '查询订单详情(内部使用)'."\n",
],
'QueryOrderIdByPayId' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '221249435****',
],
],
[
'name' => 'PaymentId',
'in' => 'query',
'schema' => [
'description' => '支付ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'PYPT******9379',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '79C01D47-3C44-57D9-BC99-1B33F7ED14B8',
],
'LmOrderIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmOrderIds' => [
'description' => '返回的订单id。',
'type' => 'array',
'items' => [
'description' => '返回的订单id。',
'type' => 'object',
'properties' => [
'LmOrderId' => [
'description' => 'lm订单ID',
'type' => 'integer',
'format' => 'int64',
'example' => '45******89',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"79C01D47-3C44-57D9-BC99-1B33F7ED14B8\\",\\n \\"LmOrderIds\\": {\\n \\"LmOrderIds\\": [\\n {\\n \\"LmOrderId\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '按付款ID查询订单ID',
'summary' => '查询订单场景使用。',
],
'QueryOrderInfoAfterSale' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'ChannelUserId',
'in' => 'query',
'schema' => [
'description' => '渠道用户ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '22******323',
],
],
[
'name' => 'LmOrderId',
'in' => 'query',
'schema' => [
'description' => 'lm订单号',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '40******84',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃,填AccountType即可',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
'example' => '22******323',
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值:ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'A107756D-18BF-56BC-9F33-8DFAA2279F17',
],
'Model' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'LmOrderId' => [
'description' => 'lm订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '45******66',
],
'ShopServiceTelephone' => [
'description' => '商家服务电话',
'type' => 'string',
],
'RefundAmount' => [
'description' => '退款金额',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'XiaomiCode' => [
'description' => '小蜜编码',
'type' => 'string',
'example' => '""',
],
'ShopName' => [
'description' => '店铺名称',
'type' => 'string',
'example' => '***旗舰店',
],
'CreateDate' => [
'description' => '下单时间',
'type' => 'string',
'example' => '2022-03-29',
],
'RefundRate' => [
'type' => 'string',
],
'ExtJson' => [
'description' => '扩展信息',
'type' => 'string',
'example' => '{}',
],
'OrderStatus' => [
'description' => '订单状态',
'type' => 'string',
'example' => '6',
],
'RefundPoints' => [
'description' => '退积分数',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'TbOrderId' => [
'description' => '淘宝订单ID',
'type' => 'integer',
'format' => 'int64',
'example' => '12******964113',
],
'Points' => [
'description' => '积分数',
'type' => 'integer',
'format' => 'int64',
'example' => '69',
],
'RefundStatus' => [
'description' => '退款状态',
'type' => 'string',
'example' => '1',
],
'PointsAmount' => [
'description' => '积分抵扣金额',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CashAmount' => [
'description' => '现金金额',
'type' => 'string',
'example' => '10',
],
'LogisticsList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Logistics' => [
'description' => '物流信息',
'type' => 'array',
'items' => [
'description' => '物流信息',
'type' => 'object',
'properties' => [
'LogisticsCompanyCode' => [
'description' => '物流公司代码',
'type' => 'string',
'example' => 'SF',
],
'LogisticsNo' => [
'description' => '物流单号',
'type' => 'string',
'example' => '731******8882',
],
'LogisticsStatus' => [
'description' => '物流状态',
'type' => 'string',
'example' => '3',
],
'LogisticsCompanyName' => [
'description' => '物流公司名称',
'type' => 'string',
'example' => '顺丰速运',
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"A107756D-18BF-56BC-9F33-8DFAA2279F17\\",\\n \\"Model\\": {\\n \\"LmOrderId\\": 0,\\n \\"ShopServiceTelephone\\": \\"\\",\\n \\"RefundAmount\\": 5,\\n \\"XiaomiCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ShopName\\": \\"***旗舰店\\",\\n \\"CreateDate\\": \\"2022-03-29\\",\\n \\"RefundRate\\": \\"\\",\\n \\"ExtJson\\": \\"{}\\",\\n \\"OrderStatus\\": \\"6\\",\\n \\"RefundPoints\\": 10,\\n \\"TbOrderId\\": 0,\\n \\"Points\\": 69,\\n \\"RefundStatus\\": \\"1\\",\\n \\"PointsAmount\\": 0,\\n \\"CashAmount\\": \\"10\\",\\n \\"LogisticsList\\": {\\n \\"Logistics\\": [\\n {\\n \\"LogisticsCompanyCode\\": \\"SF\\",\\n \\"LogisticsNo\\": \\"731******8882\\",\\n \\"LogisticsStatus\\": \\"3\\",\\n \\"LogisticsCompanyName\\": \\"顺丰速运\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => '查询订单售后服务信息',
'summary' => '内部接口不对外提供。',
],
'QueryOrderItemInfoByPaymentIdForAiZhanYou' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '业务用户ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '22******85759',
],
],
[
'name' => 'PaymentId',
'in' => 'query',
'schema' => [
'description' => '支付ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'P51M******15',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'DA2554FD-F21F-536F-A7B7-B96C3E5F****',
],
'LmOrderList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmOrderList' => [
'description' => '订单列表',
'type' => 'array',
'items' => [
'description' => '订单列表',
'type' => 'object',
'properties' => [
'LmOrderId' => [
'description' => 'lm订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '42******18',
],
'ItemName' => [
'description' => '商品名称',
'type' => 'string',
'example' => '南枣核桃糕(圆盒)'."\n",
],
'SkuName' => [
'description' => 'sku名称',
'type' => 'string',
'example' => '南枣核桃糕(圆盒)2盒装',
],
'SkuId' => [
'description' => '下单商品的skuId',
'type' => 'integer',
'format' => 'int64',
'example' => '433******8350',
],
'LmItemId' => [
'description' => 'Lm侧商品ID',
'type' => 'string',
'example' => '10000035-******31758',
],
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '599******711',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"DA2554FD-F21F-536F-A7B7-B96C3E5F****\\",\\n \\"LmOrderList\\": {\\n \\"LmOrderList\\": [\\n {\\n \\"LmOrderId\\": 0,\\n \\"ItemName\\": \\"南枣核桃糕(圆盒)\\\\n\\",\\n \\"SkuName\\": \\"南枣核桃糕(圆盒)2盒装\\",\\n \\"SkuId\\": 0,\\n \\"LmItemId\\": \\"10000035-******31758\\",\\n \\"ItemId\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '通过支付ID查询订单商品信息',
'summary' => '通过支付 ID 查询订单商品信息。',
],
'QueryOrderList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******005',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和ThirdPartyUserId填写一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '220******311',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每⻚多少条记录,最⼤20条',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '20',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前⻚码,从1开始',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'FilterOption',
'in' => 'query',
'schema' => [
'description' => '订单过滤条件,json序列化后的字符串',
'type' => 'string',
'required' => false,
'example' => '{\\"lmOrderList\\":[32******46],\\"enableStatus\\":-1}',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃,填AccountType即可',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用ID',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '6EC363BE-9A87-55AA-A9AF-44E77F0EEDCA',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'PageSize' => [
'description' => '每⻚多少条记录,最⼤20条',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'PageNumber' => [
'description' => '当前⻚码,从1开始',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalCount' => [
'description' => '总订单数量',
'type' => 'integer',
'format' => 'int64',
'example' => '19',
],
'PostFee' => [
'description' => '邮费',
'type' => 'object',
'properties' => [
'FundAmount' => [
'description' => '资金金额',
'type' => 'integer',
'format' => 'int64',
],
'FundType' => [
'description' => '支付方式',
'type' => 'string',
],
'FundAmountMoney' => [
'description' => '订单金额,以分为单位',
'type' => 'integer',
'format' => 'int64',
],
],
],
'LmOrderList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmOrderList' => [
'description' => '订单列表',
'type' => 'array',
'items' => [
'description' => '订单列表',
'type' => 'object',
'properties' => [
'LmOrderId' => [
'description' => 'lm订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '41******03',
],
'EnableStatus' => [
'description' => '0,⽣效;1,⽆效',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ExtJson' => [
'description' => '拓展字段',
'type' => 'string',
],
'OrderStatus' => [
'description' => '订单状态,6=交易成功',
'type' => 'integer',
'format' => 'int32',
'example' => '6',
],
'ShopName' => [
'description' => '店铺名',
'type' => 'string',
'example' => '****零食店'."\n",
],
'TbOrderId' => [
'description' => '淘宝订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '12******41253',
],
'OrderAmount' => [
'description' => '订单总金额',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'LogisticsStatus' => [
'description' => '物流状态',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'CreateDate' => [
'description' => '下单时间',
'type' => 'string',
'example' => '2022-04-01 12:00:00',
],
'FundStructureModels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FundStructureModels' => [
'description' => '支付组成',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FundAmount' => [
'description' => '资金金额',
'type' => 'integer',
'format' => 'int64',
],
'FundType' => [
'description' => '支付方式',
'type' => 'string',
],
'FundAmountMoney' => [
'description' => '订单金额,以分为单位',
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
'SubOrderList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SubOrderList' => [
'description' => '子订单列表',
'type' => 'array',
'items' => [
'description' => '子订单列表',
'type' => 'object',
'properties' => [
'LmOrderId' => [
'description' => 'lm子订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '37******63',
],
'EnableStatus' => [
'description' => ' '."\n"
.'0,⽣效;1,⽆效',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ItemTitle' => [
'description' => '商品名称',
'type' => 'string',
'example' => '南枣核桃糕(圆盒)',
],
'OrderStatus' => [
'description' => '订单状态',
'type' => 'integer',
'format' => 'int32',
'example' => '6',
],
'SkuName' => [
'description' => '下单商品的sku显示id',
'type' => 'string',
'example' => '南枣核桃糕(圆盒)2盒装'."\n",
],
'LmItemId' => [
'description' => 'lm侧商品id',
'type' => 'string',
'example' => '10000102-******170234',
],
'SkuId' => [
'description' => '下单商品的skuId',
'type' => 'integer',
'format' => 'int64',
'example' => '472******6880',
],
'Number' => [
'description' => '下单数量',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TbOrderId' => [
'description' => '淘宝订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '12******41253',
],
'ItemPic' => [
'description' => '商品图片地址',
'type' => 'string',
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'example' => '607******466',
],
'ItemPriceList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ItemPriceList' => [
'description' => '子订单金额列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FundAmount' => [
'description' => '资金金额',
'type' => 'integer',
'format' => 'int64',
],
'FundType' => [
'description' => '支付类型',
'type' => 'string',
],
'FundAmountMoney' => [
'description' => '子订单金额,以分为单位',
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
],
],
],
],
'PostFee' => [
'description' => '邮费',
'type' => 'object',
'properties' => [
'FundAmount' => [
'description' => '资金金额',
'type' => 'integer',
'format' => 'int64',
],
'FundType' => [
'description' => '支付方式',
'type' => 'string',
],
'FundAmountMoney' => [
'description' => '订单金额,以分为单位',
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EC363BE-9A87-55AA-A9AF-44E77F0EEDCA\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 19,\\n \\"PostFee\\": {\\n \\"FundAmount\\": 0,\\n \\"FundType\\": \\"\\",\\n \\"FundAmountMoney\\": 0\\n },\\n \\"LmOrderList\\": {\\n \\"LmOrderList\\": [\\n {\\n \\"LmOrderId\\": 0,\\n \\"EnableStatus\\": 0,\\n \\"ExtJson\\": \\"\\",\\n \\"OrderStatus\\": 6,\\n \\"ShopName\\": \\"****零食店\\\\n\\",\\n \\"TbOrderId\\": 0,\\n \\"OrderAmount\\": 100,\\n \\"LogisticsStatus\\": 3,\\n \\"CreateDate\\": \\"2022-04-01 12:00:00\\",\\n \\"FundStructureModels\\": {\\n \\"FundStructureModels\\": [\\n {\\n \\"FundAmount\\": 0,\\n \\"FundType\\": \\"\\",\\n \\"FundAmountMoney\\": 0\\n }\\n ]\\n },\\n \\"SubOrderList\\": {\\n \\"SubOrderList\\": [\\n {\\n \\"LmOrderId\\": 0,\\n \\"EnableStatus\\": 0,\\n \\"ItemTitle\\": \\"南枣核桃糕(圆盒)\\",\\n \\"OrderStatus\\": 6,\\n \\"SkuName\\": \\"南枣核桃糕(圆盒)2盒装\\\\n\\",\\n \\"LmItemId\\": \\"10000102-******170234\\",\\n \\"SkuId\\": 0,\\n \\"Number\\": 1,\\n \\"TbOrderId\\": 0,\\n \\"ItemPic\\": \\"\\",\\n \\"ItemId\\": 0,\\n \\"ItemPriceList\\": {\\n \\"ItemPriceList\\": [\\n {\\n \\"FundAmount\\": 0,\\n \\"FundType\\": \\"\\",\\n \\"FundAmountMoney\\": 0\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"PostFee\\": {\\n \\"FundAmount\\": 0,\\n \\"FundType\\": \\"\\",\\n \\"FundAmountMoney\\": 0\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询订单列表',
'summary' => '查询订单列表。',
'description' => '查询订单列表或者详情'."\n"
."\n"
.'注意:查询所有订单时,filterOption中只需要传enableStatus=-1即可,⽬前⽀lmOrderId查询和outTradeId查询',
'requestParamsDescription' => '通过lmOrderId查询订单时的filterOption:'."\n"
."\n"
.' {'."\n"
.' "orderStatus":"12=待⽀付,2=已⽀付,4=已退款关闭,6=交易成功,8=被淘宝关闭 ",'."\n"
.' "logisticsStatus":" 1=未发货 -> 等待卖家发货 2=已发货 -> 等待买家确认收货 3=已收货-> 交易成功 4=已经退货 -> 交易失败 5=部分收货 -> 交易成功 6=部分发货中 8=还未创建物流订单",'."\n"
.' "lmOrderList":["主订单列表"], //订单号数量上限20个'."\n"
.' "filter": "createTime>12323 AND createTime<45454", //过滤条件,⽬前只⽀持创单时间, 传单时间的值为unix时间戳, ⽀持<,>,>=,<=, !=,=, AND,OR'."\n"
.' "enableStatus":"-1",//0,⽣效,1,⽆效,-1都查,不填默认为0,查订单详情时此字段要传。'."\n"
.' }'."\n"
."\n"
.'通过outTradeId查询订单时的filterOption:'."\n"
."\n"
.' {'."\n"
.' "orderStatus":"12=待⽀付,2=已⽀付,4=已退款关闭,6=交易成功,8=被淘宝关闭 ",'."\n"
.' "logisticsStatus":" 1=未发货 -> 等待卖家发货 2=已发货 -> 等待买家确认收货 3=已收货-> 交易成功 4=已经退货 -> 交易失败 5=部分收货 -> 交易成功 6=部分发货中 8=还未创建物流订单",'."\n"
.' "channelOrderIdList":["outTradeId"], //订单号数量上限20个'."\n"
.' "filter": "createTime>12323 AND createTime<45454", //过滤条件,⽬前只⽀持创单时间, 传单时间的值为unix时间戳, ⽀持<,>,>=,<=, !=,=, AND,OR'."\n"
.' "enableStatus":"-1",//0,⽣效,1,⽆效,-1都查,不填默认为0,查订单详情时此字段要传。'."\n"
.' }',
'responseParamsDescription' => '实物商品lmOrderList返回值:'."\n"
."\n"
.' {'."\n"
.' "lmOrderList": ['."\n"
.' {'."\n"
.' "createDate": "下单时间,格式化(yyyy-MM-dd HH:mm:ss)",'."\n"
.' "lmOrderId": "订单号,对外统⼀使⽤此ID做主键操作",'."\n"
.' "tbOrderId": "淘宝订单号",'."\n"
.' "lmPaymentId": "lm现⾦⽀付订单号,⽀付宝账单⾥对应字段:商家订单号 ",'."\n"
.' "shopName": "店铺名",'."\n"
.' "logisticsStatus": "物流状态(由于此字段为定时从主站同步的,会存在延迟,最⻓可能⼏天才同步)",'."\n"
.' "enableStatus": "0,⽣效;1,⽆效",'."\n"
.' "orderAmount": "订单总⾦额",'."\n"
.' "orderStatus": "订单状态,6=交易成功",'."\n"
.' "subOrderList": ['."\n"
.' {'."\n"
.' "itemId": "itemId",'."\n"
.' "itemPic": "商品图⽚",'."\n"
.' "itemPriceList": ['."\n"
.' {'."\n"
.' "fundAmountMoney": "⼦订单⾦额,以分为单位"'."\n"
.' }'."\n"
.' ],'."\n"
.' "itemTitle": "商品名称",'."\n"
.' "number": "下单数量",'."\n"
.' "skuId": "下单的商品SkuId",'."\n"
.' "skuName": "下单的商品SKU显示名称",'."\n"
.' "orderStatus": "订单状态,6=交易成功",'."\n"
.' "lmOrderId": "⼦订单号",'."\n"
.' "tbOrderId": "淘宝⼦订单号"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
."\n"
.'虚拟卡密商品lmOrderList返回值,extJson中包含: '."\n"
.'cardDeadline 过期时间 '."\n"
.'cardPwd 密码 '."\n"
.'cardNumber 卡号'."\n"
."\n"
.' {'."\n"
.' "code":"SUCCESS",'."\n"
.' "pageNumber":1,'."\n"
.' "lmOrderList":['."\n"
.' {'."\n"
.' "tbOrderId":0,'."\n"
.' "orderAmount":1,'."\n"
.' "postFee1":{'."\n"
.' "fundType":""'."\n"
.' },'."\n"
.' "fundStructureModels":['."\n"
.' {'."\n"
.' "fundType":"lmPointPay",'."\n"
.' "fundAmount":0,'."\n"
.' "fundAmountMoney":1'."\n"
.' }'."\n"
.' ],'."\n"
.' "orderStatus":6,'."\n"
.' "extJson":"{"cardList": "[{\\"cardDeadline\\":\\"2022-09-17 10:38:22\\",\\"cardPwd\\":\\"161453\\",\\"cardNumber\\":\\"⽆卡号\\"}]", "mobileNo":"17777791080", "itemCategory": "aliComBenifit", "thirdPartyName": "fulu","thirdPartyItemId": "10000569", "virtualProductType": "fulu_卡密"}",'."\n"
.' "shopName":"福禄⽹游数卡专营店",'."\n"
.' "subOrderList":['."\n"
.' {'."\n"
.' "itemId":143244952485367808,'."\n"
.' "number":1,'."\n"
.' "itemPriceList":['."\n"
.' {'."\n"
.' "fundType":"lmCashCnyPay",'."\n"
.' "fundAmount":1,'."\n"
.' "fundAmountMoney":1'."\n"
.' }'."\n"
.' ],'."\n"
.' "itemPic":"http://img.alicdn.com/imgextra/i4/2208169446941/O1CN01NLYyHE2191huT56O1_!!2-item_pic.png",'."\n"
.' "itemTitle":"卡密测试=商品",'."\n"
.' "orderStatus":6,'."\n"
.' "lmOrderId":77604001,'."\n"
.' "enableStatus":0,'."\n"
.' "skuId":-1'."\n"
.' }'."\n"
.' ],'."\n"
.' "lmOrderId":77604001,'."\n"
.' "logisticsStatus":8,'."\n"
.' "enableStatus":0,'."\n"
.' "createDate":"2020-11-02 11:21:04"'."\n"
.' }'."\n"
.' ],'."\n"
.' "requestId":"7D681C2B-F902-4401-970E-3E919461C056",'."\n"
.' "postFee":{'."\n"
.' },'."\n"
.' "pageSize":1,'."\n"
.' "message":"SUCCESS"'."\n"
.' }',
],
'QueryOrderLogistics' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20210825****',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '22378277****',
],
],
[
'name' => 'LmOrderId',
'in' => 'query',
'schema' => [
'description' => 'lm订单号',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '42535****',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃,填AccountType即可',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
'example' => '22378277****'."\n",
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值:ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '1718921E-C8D4-55E1-B8D4-114AE537****',
],
'OrderLogistics' => [
'description' => '订单物流详情',
'type' => 'object',
'properties' => [
'LogisticsCompanyCode' => [
'description' => '本单物流公司code',
'type' => 'string',
'example' => 'ZTO',
],
'LogisticsCompanyName' => [
'description' => '本单物流公司名称',
'type' => 'string',
'example' => '中通',
],
'DataProvider' => [
'description' => '数据来源:如:菜鸟裹裹',
'type' => 'string',
'example' => '菜鸟裹裹'."\n",
],
'DataProviderTitle' => [
'description' => '数据来源说明,如:本数据由菜⻦裹裹提供',
'type' => 'string',
'example' => '本数据由菜⻦裹裹提供',
],
'LogisticsDetailList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LogisticsDetailList' => [
'description' => '物流详情列表',
'type' => 'array',
'items' => [
'description' => '物流详情列表',
'type' => 'object',
'properties' => [
'OcurrTimeStr' => [
'description' => '发生时间',
'type' => 'string',
'example' => '2022-04-01 16:33:23',
],
'StanderdDesc' => [
'description' => '物流信息',
'type' => 'string',
'example' => '商品已下单',
],
'StatusIcon' => [
'description' => '状态图标',
'type' => 'string',
'example' => '""',
],
],
],
],
],
],
'Receiver' => [
'description' => '收件人信息',
'type' => 'object',
'properties' => [
'Address' => [
'description' => '收件人地址',
'type' => 'string',
'example' => '北京市***********',
],
'Name' => [
'description' => '收件人姓名',
'type' => 'string',
'example' => '刘**',
],
'PhoneNumber' => [
'description' => '收件人联系电话',
'type' => 'string',
'example' => '185****4801',
],
'ZipCode' => [
'description' => '邮政编码',
'type' => 'string',
'example' => '457001',
],
],
],
'Fetcher' => [
'description' => '取件人',
'type' => 'object',
'properties' => [
'Address' => [
'description' => '取件地址',
'type' => 'string',
'example' => '北京市*******',
],
'Name' => [
'description' => '取件人姓名',
'type' => 'string',
'example' => '刘**',
],
'PhoneNumber' => [
'description' => '联系电话',
'type' => 'string',
'example' => '185****4801',
],
'ZipCode' => [
'description' => '邮政编码',
'type' => 'string',
'example' => '457001',
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"1718921E-C8D4-55E1-B8D4-114AE537****\\",\\n \\"OrderLogistics\\": {\\n \\"LogisticsCompanyCode\\": \\"ZTO\\",\\n \\"LogisticsCompanyName\\": \\"中通\\",\\n \\"DataProvider\\": \\"菜鸟裹裹\\\\n\\",\\n \\"DataProviderTitle\\": \\"本数据由菜⻦裹裹提供\\",\\n \\"LogisticsDetailList\\": {\\n \\"LogisticsDetailList\\": [\\n {\\n \\"OcurrTimeStr\\": \\"2022-04-01 16:33:23\\",\\n \\"StanderdDesc\\": \\"商品已下单\\",\\n \\"StatusIcon\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n },\\n \\"Receiver\\": {\\n \\"Address\\": \\"北京市***********\\",\\n \\"Name\\": \\"刘**\\",\\n \\"PhoneNumber\\": \\"185****4801\\",\\n \\"ZipCode\\": \\"457001\\"\\n },\\n \\"Fetcher\\": {\\n \\"Address\\": \\"北京市*******\\",\\n \\"Name\\": \\"刘**\\",\\n \\"PhoneNumber\\": \\"185****4801\\",\\n \\"ZipCode\\": \\"457001\\"\\n }\\n }\\n}","type":"json"}]',
'title' => '查询订单物流详情',
'summary' => '查询订单物流详情。',
'description' => '查询订单物流详情'."\n",
],
'QueryLogistics' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20210830****',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => false,
'example' => '213250002250****',
],
],
[
'name' => 'LmOrderId',
'in' => 'query',
'schema' => [
'description' => 'lm订单号',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '46802****',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
'example' => '213250002250****'."\n",
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值:ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'The specified parameter %s value is not valid.',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'E090F1A0-7454-5F36-933C-E6332CE2****',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Data' => [
'description' => '物流信息列表',
'type' => 'array',
'items' => [
'description' => '物流信息列表',
'type' => 'object',
'properties' => [
'LogisticsCompanyCode' => [
'description' => '本单物流公司code',
'type' => 'string',
'example' => 'ZTO',
],
'MailNo' => [
'description' => '运单号',
'type' => 'string',
'example' => '32178478218****',
],
'LogisticsCompanyName' => [
'description' => '本单物流公司名称',
'type' => 'string',
'example' => '中通',
],
'DataProvider' => [
'description' => '数据来源:如:菜鸟裹裹',
'type' => 'string',
'example' => '菜鸟裹裹',
],
'DataProviderTitle' => [
'description' => '数据来源说明,如:本数据由菜⻦裹裹提供',
'type' => 'string',
'example' => '本数据由菜⻦裹裹提供',
],
'LogisticsDetailList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LogisticsDetailList' => [
'description' => '物流详情列表',
'type' => 'array',
'items' => [
'description' => '物流详情列表',
'type' => 'object',
'properties' => [
'OcurrTimeStr' => [
'description' => '发生时间',
'type' => 'string',
'example' => '2022-04-01',
],
'StanderdDesc' => [
'description' => '物流信息',
'type' => 'string',
'example' => '商品已经下单',
],
],
],
],
],
],
'Goods' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Goods' => [
'description' => '货物信息列表',
'type' => 'array',
'items' => [
'description' => '货物信息列表',
'type' => 'object',
'properties' => [
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'example' => '62250669****',
],
'GoodName' => [
'description' => '货物名字,不保证有,⼀个主单只有⼀个商品可能没有该值,物流未获取物流'."\n"
.'公司物流号之前也没有该值',
'type' => 'string',
'example' => '""',
],
'Quantity' => [
'description' => '商品数量',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\",\\n \\"RequestId\\": \\"E090F1A0-7454-5F36-933C-E6332CE2****\\",\\n \\"Data\\": {\\n \\"Data\\": [\\n {\\n \\"LogisticsCompanyCode\\": \\"ZTO\\",\\n \\"MailNo\\": \\"32178478218****\\",\\n \\"LogisticsCompanyName\\": \\"中通\\",\\n \\"DataProvider\\": \\"菜鸟裹裹\\",\\n \\"DataProviderTitle\\": \\"本数据由菜⻦裹裹提供\\",\\n \\"LogisticsDetailList\\": {\\n \\"LogisticsDetailList\\": [\\n {\\n \\"OcurrTimeStr\\": \\"2022-04-01\\",\\n \\"StanderdDesc\\": \\"商品已经下单\\"\\n }\\n ]\\n },\\n \\"Goods\\": {\\n \\"Goods\\": [\\n {\\n \\"ItemId\\": 0,\\n \\"GoodName\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Quantity\\": 4\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询订单物流详情',
'summary' => '查询订单物流详情。',
'description' => '注意:请勿轮询调⽤此⽅法同步物流状态,物流同步接⼝5.6已给出',
'responseParamsDescription' => 'DataItem:'."\n"
.' '."\n"
.' {'."\n"
.' "mailNo": "运单号",'."\n"
.' "dataProvider": "数据来源:如:菜⻦裹裹",'."\n"
.' "dataProviderTitle": "数据来源说明,如:本数据由菜⻦裹裹提供",'."\n"
.' "logisticsCompanyCode": "本单物流公司Code",'."\n"
.' "logisticsCompanyName": "本单物流公司名称",'."\n"
.' "logisticsDetailList": ['."\n"
.' {'."\n"
.' "ocurrTimeStr": "发⽣时间",'."\n"
.' "standerdDesc": "物流信息"'."\n"
.' }],'."\n"
.' "goods": ['."\n"
.' {'."\n"
.' "goodName": "货物名字,不保证有,⼀个主单只有⼀个商品可能没有该值,物流未获取物流公司物流号之前也没有该值",'."\n"
.' "quantity": "商品数量",'."\n"
.' "itemid":"商品id"'."\n"
.' }]'."\n"
.' }',
],
'RenderH5Order' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和ThirdPartyUserId填写一样的值',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '208******6520',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
'example' => '208******6520',
],
],
[
'name' => 'BuyOrderRequestModel',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值:ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '96B4141C-A3CD-5162-B435-4780A75E3D97',
],
'Success' => [
'description' => '调用是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
],
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '205',
],
'TotalCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'LogsId' => [
'description' => '废弃',
'type' => 'string',
'example' => '1',
],
'Model' => [
'type' => 'object',
'properties' => [
'ExtInfo' => [
'description' => '扩展信息',
'type' => 'object',
],
'BuyerCurrentPoints' => [
'description' => '买家当前积分数',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
'LmItemInfoList' => [
'description' => 'lm商品信息列表',
'type' => 'array',
'items' => [
'description' => 'lm商品信息列表'."\n"
."\n",
'type' => 'object',
'properties' => [
'TbShopName' => [
'description' => '淘宝店铺名称',
'type' => 'string',
'example' => '***旗舰店',
],
'SellerId' => [
'description' => '卖家ID',
'type' => 'integer',
'format' => 'int64',
'example' => '42******044',
],
'LmItemId' => [
'description' => 'lm侧商品ID',
'type' => 'string',
'example' => '10000102-******94679',
],
'Message' => [
'description' => '消息',
'type' => 'string',
],
'CanSell' => [
'description' => '是否可售',
'type' => 'boolean',
'example' => 'true',
],
'Cash' => [
'description' => '现金数',
'type' => 'integer',
'format' => 'int64',
],
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '65******461',
],
'VirtualItemType' => [
'description' => '虚拟商品类型',
'type' => 'string',
],
'ItemName' => [
'description' => '商品名称',
'type' => 'string',
'example' => '南枣核桃糕(圆盒)'."\n",
],
'ActualPrice' => [
'description' => '实际价格',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'SkuName' => [
'description' => 'sku名称',
'type' => 'string',
'example' => '南枣核桃糕(圆盒)2盒装',
],
'SkuId' => [
'description' => '下单商品的skuId',
'type' => 'integer',
'format' => 'int64',
'example' => '46******9302',
],
'Points' => [
'description' => '积分数量',
'type' => 'integer',
'format' => 'int64',
'example' => '69',
],
'ItemUrl' => [
'description' => '商品详情链接',
'type' => 'string',
],
'SellerNick' => [
'description' => '卖家昵称',
'type' => 'string',
],
'Quantity' => [
'description' => '下单数量',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Features' => [
'type' => 'object',
],
'ItemPicUrl' => [
'description' => '商品图片URL',
'type' => 'string',
],
],
],
],
'DeliveryInfoList' => [
'description' => '配送信息列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '展示名称',
'type' => 'string',
],
'PostFee' => [
'description' => '邮费',
'type' => 'integer',
'format' => 'int64',
],
'ServiceType' => [
'description' => '服务类型',
'type' => 'integer',
'format' => 'int64',
],
'Id' => [
'type' => 'string',
],
],
],
],
'AddressInfoList' => [
'description' => '地址信息列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DivisionCode' => [
'description' => '区划码',
'type' => 'string',
'example' => '410223',
],
'Receiver' => [
'description' => '收货人',
'type' => 'string',
'example' => '张三',
],
'AddressDetail' => [
'description' => '地址详情',
'type' => 'string',
],
'Default' => [
'description' => '是否默认地址',
'type' => 'boolean',
'example' => 'true',
],
'AddressId' => [
'description' => '地址ID',
'type' => 'integer',
'format' => 'int64',
],
'ReceiverPhone' => [
'description' => '收货人电话',
'type' => 'string',
'example' => '158****3627',
],
],
],
],
'InvoiceInfo' => [
'description' => '发票信息',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '发票类型',
'type' => 'string',
],
'Desc' => [
'description' => '发票描述',
'type' => 'string',
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"96B4141C-A3CD-5162-B435-4780A75E3D97\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"205\\",\\n \\"TotalCount\\": 5,\\n \\"LogsId\\": \\"1\\",\\n \\"Model\\": {\\n \\"ExtInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"BuyerCurrentPoints\\": 1000,\\n \\"LmItemInfoList\\": [\\n {\\n \\"TbShopName\\": \\"***旗舰店\\",\\n \\"SellerId\\": 0,\\n \\"LmItemId\\": \\"10000102-******94679\\",\\n \\"Message\\": \\"\\",\\n \\"CanSell\\": true,\\n \\"Cash\\": 0,\\n \\"ItemId\\": 0,\\n \\"VirtualItemType\\": \\"\\",\\n \\"ItemName\\": \\"南枣核桃糕(圆盒)\\\\n\\",\\n \\"ActualPrice\\": 10,\\n \\"SkuName\\": \\"南枣核桃糕(圆盒)2盒装\\",\\n \\"SkuId\\": 0,\\n \\"Points\\": 69,\\n \\"ItemUrl\\": \\"\\",\\n \\"SellerNick\\": \\"\\",\\n \\"Quantity\\": 1,\\n \\"Features\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ItemPicUrl\\": \\"\\"\\n }\\n ],\\n \\"DeliveryInfoList\\": [\\n {\\n \\"DisplayName\\": \\"\\",\\n \\"PostFee\\": 0,\\n \\"ServiceType\\": 0,\\n \\"Id\\": \\"\\"\\n }\\n ],\\n \\"AddressInfoList\\": [\\n {\\n \\"DivisionCode\\": \\"410223\\",\\n \\"Receiver\\": \\"张三\\",\\n \\"AddressDetail\\": \\"\\",\\n \\"Default\\": true,\\n \\"AddressId\\": 0,\\n \\"ReceiverPhone\\": \\"158****3627\\"\\n }\\n ],\\n \\"InvoiceInfo\\": {\\n \\"Type\\": \\"\\",\\n \\"Desc\\": \\"\\"\\n }\\n }\\n}","type":"json"}]',
'title' => 'H5模式渲染订单',
'summary' => 'H5模式渲染订单。',
],
'RepayOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20210125****',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和ThirdPartyUserId填写一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9f99f38030254728***',
],
],
[
'name' => 'LmOrderId',
'in' => 'query',
'schema' => [
'description' => 'lm订单号',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '449975059**',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃,填AccountType即可',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧ID',
'type' => 'string',
'required' => false,
'example' => '9f99f38030254728***'."\n",
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'The specified parameter %s value is not valid.',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '322830A9-C820-5974-B409-7B32C41E8B42',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\",\\n \\"RequestId\\": \\"322830A9-C820-5974-B409-7B32C41E8B42\\"\\n}","type":"json"}]',
'title' => '继续支付订单',
'summary' => '用户如果没付款,可以调用该接口继续付款。',
],
'CreateOrderV2' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL202****0001',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '4012776630',
],
],
[
'name' => 'OutTradeId',
'in' => 'query',
'schema' => [
'description' => '客户唯一订单号,未提供时,由阿里云创建',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '949251510338846720',
],
],
[
'name' => 'ItemId',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'docRequired' => true,
'example' => '591831917868',
],
],
[
'name' => 'Quantity',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'TotalAmount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
'default' => '0',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '扩展字段',
'type' => 'string',
'required' => false,
'example' => '{\\"outShopId\\":\\"8044468\\"}',
'default' => '{}',
],
],
[
'name' => 'DeliveryAddress',
'in' => 'query',
'schema' => [
'description' => '收货地址',
'type' => 'string',
'required' => false,
'example' => '*****************************************************************************************************',
],
],
[
'name' => 'OrderExpireTime',
'in' => 'query',
'schema' => [
'description' => '订单失效时间,单位秒,默认15分钟',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '900',
'example' => '3600',
'default' => '900',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃,填AccountType即可',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '必须对应C端唯一一个用户,企业不可使用一个ID代所有用户下单',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
'default' => '',
],
],
[
'name' => 'LmItemId',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'string',
'required' => false,
'example' => '10016572-654408058233',
],
],
[
'name' => 'BuyerMessageMap',
'in' => 'query',
'schema' => [
'description' => 'key为sellerId,value值为备注内容的jsonString,例如{"186XXXX284":"备注内容...","186XXXX184":"备注内容..."}',
'type' => 'string',
'required' => false,
'example' => '{"186XXXX284":"备注内容…","186XXXX184":"备注内容…"}',
],
],
[
'name' => 'ItemList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '商品列表',
'type' => 'array',
'items' => [
'description' => '商品列表',
'type' => 'object',
'properties' => [
'SkuId' => [
'description' => '商品skuId',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '4586054386257',
],
'LmItemId' => [
'description' => 'Lm侧商品Id',
'type' => 'string',
'required' => false,
'example' => '10000102-630119724405',
],
'ItemId' => [
'description' => '商品Id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '649442334167',
],
'Quantity' => [
'description' => '下单数量',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '5',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '978A8742-1A38-54B5-98D9-F8713ACBC385',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'True',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '成功',
],
'Code' => [
'description' => '成功:"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => 'SUCCESS',
],
'TotalCount' => [
'description' => '总订单数量',
'type' => 'integer',
'format' => 'int64',
'example' => '7',
],
'LogsId' => [
'type' => 'string',
'example' => '1',
],
'Model' => [
'description' => '订单信息,从返回的model对象中取出LmOrderList字段',
'type' => 'object',
'properties' => [
'RedirectUrl' => [
'description' => '重定向地址',
'type' => 'string',
'example' => '""',
],
'LmOrderList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmOrderList' => [
'description' => '订单主订单列表',
'type' => 'array',
'items' => [
'description' => '订单主订单列表',
'type' => 'object',
'properties' => [
'LmOrderId' => [
'description' => '订单主订单号',
'type' => 'string',
'example' => '[5748****,5647****]',
],
],
],
],
],
],
'PayTradeIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PayTradeIds' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
],
'OrderIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'OrderIds' => [
'description' => '淘宝订单id列表',
'type' => 'array',
'items' => [
'description' => '淘宝订单id列表',
'type' => 'string',
'example' => '[25983948****.2588378****]',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"978A8742-1A38-54B5-98D9-F8713ACBC385\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"成功\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"SUCCESS\\",\\n \\"TotalCount\\": 7,\\n \\"LogsId\\": \\"1\\",\\n \\"Model\\": {\\n \\"RedirectUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"LmOrderList\\": {\\n \\"LmOrderList\\": [\\n {\\n \\"LmOrderId\\": \\"[5748****,5647****]\\"\\n }\\n ]\\n },\\n \\"PayTradeIds\\": {\\n \\"PayTradeIds\\": [\\n \\"\\"\\n ]\\n },\\n \\"OrderIds\\": {\\n \\"OrderIds\\": [\\n \\"[25983948****.2588378****]\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => '创建订单',
'summary' => '实物商品下单。',
'description' => '同下单接口订单相同,只创建订单不支付。',
'requestParamsDescription' => 'ItemList:'."\n"
."\n"
.' {'."\n"
.' "itemId" : "xxx",'."\n"
.' "skuId" : "xxx", '."\n"
.' "quantity": "下单数量 "'."\n"
.' }'."\n"
.'DeliveryAddress:'."\n"
."\n"
.' {'."\n"
.' "divisionCode":"区/县的4级divisionCode(街道/镇的上一级地址)" , //该字段可以通过queryAddress接口获取'."\n"
.' "townDivisionCode":"街道/镇的5级divisionCode", //该字段可以通过queryAddress接口获取'."\n"
.' "fullName":"收货人姓名",'."\n"
.' "mobile":"收货人电话"'."\n"
.' }'."\n",
'responseParamsDescription' => ' model: '."\n"
."\n"
.' {'."\n"
.' "lmOrderList":['."\n"
.' {'."\n"
.' "lmOrderId":"linkedmall主订单id"'."\n"
.' }'."\n"
.' ],'."\n"
.' "orderIds":["淘宝订单id"],'."\n"
.' "redirectUrl":"https://pages.tmall.com/wow/wt/act/lm-pages?wh_page=order-list"'."\n"
.' }',
],
'EnableOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL201912040001',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'OutTradeId',
'in' => 'query',
'schema' => [
'description' => '客户唯一订单号,未提供时,由阿里云创建',
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'LmOrderId',
'in' => 'query',
'schema' => [
'description' => '创建订单时的外放主订单id',
'type' => 'string',
'required' => false,
'docRequired' => true,
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '扩展字段',
'type' => 'string',
'required' => false,
'default' => '{}',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用Id',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
'default' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'SubMessage' => [
'type' => 'string',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时返回具体原因',
'type' => 'string',
],
'SubCode' => [
'type' => 'string',
],
'TotalCount' => [
'type' => 'integer',
'format' => 'int64',
],
'LogsId' => [
'type' => 'string',
],
'Model' => [
'type' => 'object',
'properties' => [
'RedirectUrl' => [
'type' => 'string',
],
'LmOrderList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmOrderList' => [
'description' => 'lm订单列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LmOrderId' => [
'description' => 'lm订单id',
'type' => 'string',
],
],
],
],
],
],
'PayTradeIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PayTradeIds' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
],
'OrderIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'OrderIds' => [
'description' => '订单列表',
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"\\",\\n \\"SubCode\\": \\"\\",\\n \\"TotalCount\\": 0,\\n \\"LogsId\\": \\"\\",\\n \\"Model\\": {\\n \\"RedirectUrl\\": \\"\\",\\n \\"LmOrderList\\": {\\n \\"LmOrderList\\": [\\n {\\n \\"LmOrderId\\": \\"\\"\\n }\\n ]\\n },\\n \\"PayTradeIds\\": {\\n \\"PayTradeIds\\": [\\n \\"\\"\\n ]\\n },\\n \\"OrderIds\\": {\\n \\"OrderIds\\": [\\n \\"\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => '订单支付',
'summary' => '调完仅创单接口,通过此接口进行支付。',
'description' => '1.此接口目前不支持重试,只有在明确返回“订单未找到或未同步,请稍后再试”的时候,才可以重试。'."\n"
."\n"
.'2.档返回支付未决时,(code=WITHHOLD_RESULT _STATUS_UNKNOWN),不代表订单支付失败,只有订单状态为8时,才能认为订单失败,其他状态可联系linkedmall技术支持确认,不可轻易将钱退给用户',
],
'CancelOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务Id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20210802****',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传同样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '208861290576****',
],
],
[
'name' => 'LmOrderId',
'in' => 'query',
'schema' => [
'description' => '阿里云主订单Id,最多只有一个',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '46992****',
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值:ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户唯一标识',
'type' => 'string',
'required' => false,
'example' => '207761290576****',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '920C6519-4888-599F-9FBA-991774BAA1DD',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'True',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '成功',
],
'Code' => [
'description' => '成功:"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => 'SUCCESS',
],
'LogsId' => [
'description' => '每次请求操作对应的操作日志号,由系统自动生成,返回给租户,可用于排查问题,双方日志中统一透出此标识',
'type' => 'string',
'example' => '1',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"920C6519-4888-599F-9FBA-991774BAA1DD\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"成功\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"SUCCESS\\",\\n \\"LogsId\\": \\"1\\"\\n}","type":"json"}]',
'title' => '取消订单',
'summary' => '创建订单成功,还未支付,可以关闭订单。',
'description' => '此订单可以不接,linkedmall有30分钟自动关单的逻辑。'."\n"
."\n"
.'该接口只适用于调用CreateOrderV2下单接口但未调用EnableOrder接支付接口的订单',
],
'RenderOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL2000***12',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和ThirdPartyUserId填写一样的值',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '2212850685759',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '拓展字段',
'type' => 'string',
'required' => false,
'example' => '{}',
'default' => '{}',
],
],
[
'name' => 'DeliveryAddress',
'in' => 'query',
'schema' => [
'description' => '收货地址',
'type' => 'string',
'required' => false,
'example' => '***********************************************************************',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '必须对应C端唯一一个用户,企业不可使用一个ID代替所有用户下单',
'type' => 'string',
'required' => false,
'example' => '2212850685759',
],
],
[
'name' => 'LmItemId',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'string',
'required' => false,
'example' => '10016572-654408058233',
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
[
'name' => 'ItemList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '商品列表',
'type' => 'array',
'items' => [
'description' => '商品列表',
'type' => 'object',
'properties' => [
'SkuId' => [
'description' => '商品SkuId',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '4415814743135',
],
'LmItemId' => [
'description' => 'LM侧商品Id',
'type' => 'string',
'required' => false,
'example' => '10016572-654408058233'."\n",
],
'ItemId' => [
'description' => '商品Id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '620033847326',
],
'Quantity' => [
'description' => '下单数量',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => 'DAAA6391-3339-5333-9E4D-C71CD26A231F',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'False',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '成果',
],
'Code' => [
'description' => '成功返回success',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败返回具体原因',
'type' => 'string',
'example' => 'SKU_IS_MISSING',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => 'SUCCESS',
],
'TotalCount' => [
'description' => '总记录数。',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'LogsId' => [
'description' => '无效字段',
'type' => 'string',
'example' => '1',
],
'Model' => [
'description' => '订单',
'type' => 'object',
'properties' => [
'RenderOrderInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RenderOrderInfos' => [
'description' => '渲染结果',
'type' => 'array',
'items' => [
'description' => '渲染结果',
'type' => 'object',
'properties' => [
'ExtInfo' => [
'type' => 'object',
],
'LmItemInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmItemInfos' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LmItemId' => [
'type' => 'string',
'example' => '10001036-254415474010492928',
],
'SellerId' => [
'type' => 'integer',
'format' => 'int64',
'example' => '107184918',
],
'Message' => [
'type' => 'string',
'example' => '成功',
],
'ItemId' => [
'type' => 'integer',
'format' => 'int64',
'example' => '658057729548',
],
'CanSell' => [
'type' => 'boolean',
],
'Cash' => [
'type' => 'integer',
'format' => 'int64',
],
'ItemName' => [
'description' => '商品名称',
'type' => 'string',
'example' => 'iphone12',
],
'ActualPrice' => [
'description' => '实际价格。',
'type' => 'integer',
'format' => 'int64',
],
'SkuName' => [
'type' => 'string',
'example' => 'liu_12',
],
'SkuId' => [
'type' => 'integer',
'format' => 'int64',
'example' => '4931861303981',
],
'Points' => [
'description' => '废弃字段',
'type' => 'integer',
'format' => 'int64',
'example' => '39',
],
'SellerNick' => [
'type' => 'string',
],
'Quantity' => [
'description' => '下单数量',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ItemPicUrl' => [
'type' => 'string',
],
],
],
],
],
],
'DeliveryInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DeliveryInfos' => [
'description' => '地址信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DisplayName' => [
'type' => 'string',
],
'PostFee' => [
'type' => 'integer',
'format' => 'int64',
],
'ServiceType' => [
'type' => 'integer',
'format' => 'int64',
],
'Id' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DAAA6391-3339-5333-9E4D-C71CD26A231F\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"成果\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SKU_IS_MISSING\\",\\n \\"SubCode\\": \\"SUCCESS\\",\\n \\"TotalCount\\": 5,\\n \\"LogsId\\": \\"1\\",\\n \\"Model\\": {\\n \\"RenderOrderInfos\\": {\\n \\"RenderOrderInfos\\": [\\n {\\n \\"ExtInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"LmItemInfos\\": {\\n \\"LmItemInfos\\": [\\n {\\n \\"LmItemId\\": \\"10001036-254415474010492928\\",\\n \\"SellerId\\": 107184918,\\n \\"Message\\": \\"成功\\",\\n \\"ItemId\\": 658057729548,\\n \\"CanSell\\": true,\\n \\"Cash\\": 0,\\n \\"ItemName\\": \\"iphone12\\",\\n \\"ActualPrice\\": 0,\\n \\"SkuName\\": \\"liu_12\\",\\n \\"SkuId\\": 4931861303981,\\n \\"Points\\": 39,\\n \\"SellerNick\\": \\"\\",\\n \\"Quantity\\": 1,\\n \\"ItemPicUrl\\": \\"\\"\\n }\\n ]\\n },\\n \\"DeliveryInfos\\": {\\n \\"DeliveryInfos\\": [\\n {\\n \\"DisplayName\\": \\"\\",\\n \\"PostFee\\": 0,\\n \\"ServiceType\\": 0,\\n \\"Id\\": \\"\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => '渲染订单',
'summary' => '渲染订单。',
'description' => '订单拆单、商品是否可售,订单渲染接口。'."\n"
."\n"
.' 注意:需要按照此接口返回的拆单结果(一般只有在一单多品的时候才会有拆单情况),依次下单(即根据结果中renderOrderInfos里的元素依次下单)',
'requestParamsDescription' => 'ItemList:'."\n"
."\n"
.' {'."\n"
.' "itemId" : "xxx",'."\n"
.' "skuId" : "xxx", '."\n"
.' "quantity": "下单数量 "'."\n"
.' }'."\n"
."\n"
.'DeliveryAddress:'."\n"
."\n"
.' {'."\n"
.' "divisionCode":"区/县的4级divisionCode(街道/镇的上一级地址)" , //该字段可以通过queryAddress接口获取'."\n"
.' "townDivisionCode":"街道/镇的5级divisionCode", //该字段可以通过queryAddress接口获取'."\n"
.' "fullName":"收货人姓名",'."\n"
.' "mobile":"收货人电话"'."\n"
.' }',
'responseParamsDescription' => 'RenderOrderInfos的数据结构:'."\n"
."\n"
.' {'."\n"
.' "lmItemInfos": ['."\n"
.' {'."\n"
.' "itemId": "商品ID", '."\n"
.' "skuId": "SkuID", '."\n"
.' "quantity": "购买数量",'."\n"
.' "canSell": "是否可售",'."\n"
.' "message": "商品备注,例如不可售的原因"'."\n"
.' } '."\n"
.' ],'."\n"
.' "deliveryInfos": ['."\n"
.' {'."\n"
.' "serviceType": "配送方式类型",'."\n"
.' "id": "配送方式ID", '."\n"
.' "postFee": "邮费单位",'."\n"
.' "displayName": "邮费前端展示文字"'."\n"
.' } '."\n"
.' ]'."\n"
.' }',
],
'ApplyRefund' => [
'summary' => '申请退款。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL201912230007',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '186******89',
],
],
[
'name' => 'SubLmOrderId',
'in' => 'query',
'schema' => [
'description' => '⼦订单ID,通过查询订单详情接⼝获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '42******33',
],
],
[
'name' => 'BizClaimType',
'in' => 'query',
'schema' => [
'description' => '退款类型。1 仅退款, 3 退货退款',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'ApplyRefundFee',
'in' => 'query',
'schema' => [
'description' => '申请退款金额,以分为单位',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '790',
],
],
[
'name' => 'ApplyRefundCount',
'in' => 'query',
'schema' => [
'description' => '退货数量,可不传',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'ApplyReasonTextId',
'in' => 'query',
'schema' => [
'description' => '退款原因ID。选择的reasonTextId,通过initApplyRefund接⼝获取',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '500325',
],
],
[
'name' => 'LeaveMessage',
'in' => 'formData',
'schema' => [
'description' => '留言。买家说明,某些原因要求必须留⾔',
'type' => 'string',
'required' => false,
'example' => '拍错',
],
],
[
'name' => 'GoodsStatus',
'in' => 'query',
'schema' => [
'description' => '货物状态。当退款类型:仅退款时,货物状态:为4未发货。所有状态:4: 未发货,6:已发货, 1: 未收到货, 2: 已收到货, 3:已寄回, 5:卖家确认收货',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '4',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => '',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值:ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
[
'name' => 'LeavePictureList',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '凭证列表,某些原因要求必须有凭证。需要传图⽚的URL地址,实现⽅式为强制下载,勿使⽤静态资源映射',
'type' => 'array',
'items' => [
'description' => '图片地址列表',
'type' => 'object',
'properties' => [
'Picture' => [
'description' => '图片地址',
'type' => 'string',
'required' => false,
'example' => 'https://lm-dk.oss-cn-hangzhou.aliyuncs.com/******06661.png',
],
'Desc' => [
'description' => '图片描述',
'type' => 'string',
'required' => false,
'example' => '瑕疵的商品图片!',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 5,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '5F0A38D5-F981-529A-911E-1B6D55DE568C',
],
'RefundApplicationData' => [
'description' => '申请的返回数据',
'type' => 'object',
'properties' => [
'DisputeType' => [
'description' => '任意退款类型',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'SubLmOrderId' => [
'description' => '当前发起逆向的子订单号',
'type' => 'string',
'example' => '53******67',
],
'DisputeStatus' => [
'description' => '逆向状态',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'DisputeId' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"5F0A38D5-F981-529A-911E-1B6D55DE568C\\",\\n \\"RefundApplicationData\\": {\\n \\"DisputeType\\": 0,\\n \\"SubLmOrderId\\": \\"53******67\\",\\n \\"DisputeStatus\\": 1,\\n \\"DisputeId\\": 0\\n }\\n}","type":"json"}]',
'title' => '申请退款',
'description' => '基于 initApplyRefund 接⼝获取退款信息,发起退款或者退货退款申请,该接⼝不⽀持退换货'."\n"
."\n"
.'注意: '."\n"
.'1.如果退款申请被卖家拒绝(通过queryRefundApplicationDetail接⼝查询到disputeStatus为6时),需要先取消退款申请(通过cancelRefund接⼝),再申请下⼀次 '."\n"
.'2.正常售中允许申请退款三次,售后允许申请退款两次,如遇超过次数后不能申请退款,需⾃⾏联系商家打开线上退款⼊⼝(售中和售后的界定边缘为:确认收货)'."\n"
."\n"
.'上传退款凭证须知:由于部分商家内部⼩⼆⽹络环境较差,请务必使⽤阿⾥云的oss服务作为您的图⽚存储,详细请参考:https://help.aliyun.com/document_detail/194635.htm',
'requestParamsDescription' => '凭证示例:'."\n"
.' '."\n"
.' "leavePictureLists": [ // ⽤户举证的图⽚信息,基于initApplyRefund接⼝返回的MustProof和选择的具体原因,要求⽤户是否上传图⽚'."\n"
.' {'."\n"
.' "picture": "14yre3y7rey347ry",'."\n"
.' "desc": "瑕疵的商品图⽚"'."\n"
.' }'."\n"
.' ]',
'responseParamsDescription' => '申请的返回数据示例:'."\n"
."\n"
.' {'."\n"
.' "subLmOrderId": "12131234", // 当前发起逆向的⼦订单号'."\n"
.' "disputeStatus": 1, // 逆向的状态'."\n"
.' "disputeType": 0, // 任意退款类型'."\n"
.' }',
],
'CancelRefund' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******002',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '22******2303',
],
],
[
'name' => 'SubLmOrderId',
'in' => 'query',
'schema' => [
'description' => '⼦订单号,通过查询订单详情接⼝获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '52******93',
],
],
[
'name' => 'DisputeId',
'in' => 'query',
'schema' => [
'description' => '纠纷ID,通过查询订单逆向申请详情接⼝获取',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '14244******33071',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值:ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '5E2D59BA-4EB0-45C4-A0D7-D98C1A4B320B',
],
'RefundApplicationData' => [
'description' => '申请的返回数据',
'type' => 'object',
'properties' => [
'DisputeType' => [
'description' => '逆向的状态',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'SubLmOrderId' => [
'description' => '当前发起逆向的子订单号',
'type' => 'string',
'example' => '37******31',
],
'DisputeStatus' => [
'description' => '任意退款类型',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"5E2D59BA-4EB0-45C4-A0D7-D98C1A4B320B\\",\\n \\"RefundApplicationData\\": {\\n \\"DisputeType\\": 0,\\n \\"SubLmOrderId\\": \\"37******31\\",\\n \\"DisputeStatus\\": 1\\n }\\n}","type":"json"}]',
'title' => '取消退款',
'summary' => '提交退款申请之后,可以通过此接口取消。',
'description' => '如果已经提交了退款申请,商家还未响应时,客户想取消退款申请,可以通过此接⼝取消。'."\n"
."\n"
.'注意:disputeId字段需要通过查询订单逆向申请详情(queryRefundApplicationDetail)接⼝获取',
'responseParamsDescription' => '申请的返回数据'."\n"
."\n"
.' {'."\n"
.' "subLmOrderId": "12131234", // 当前发起逆向的⼦订单号'."\n"
.' "disputeStatus": 1, // 逆向的状态'."\n"
.' "disputeType": 0, // 任意退款类型'."\n"
.' }',
],
'SubmitReturnGoodLogistics' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20****80001',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '250014030308185405',
],
],
[
'name' => 'LogisticsNo',
'in' => 'query',
'schema' => [
'description' => '物流单号',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => ' SF131*****7061',
],
],
[
'name' => 'CpCode',
'in' => 'query',
'schema' => [
'description' => '物流公司代码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'SF',
],
],
[
'name' => 'SubLmOrderId',
'in' => 'query',
'schema' => [
'description' => '子订单号',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '368925182',
],
],
[
'name' => 'DisputeId',
'in' => 'query',
'schema' => [
'description' => '纠纷ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '96281042016947370',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值:ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => '成功',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'C27A9456-5FC3-529D-9FDF-B21323E93B63',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"C27A9456-5FC3-529D-9FDF-B21323E93B63\\"\\n}","type":"json"}]',
'title' => '提交退货物流',
'summary' => '售后场景商家同意退货退款之后调用这个接口提交退货信息。',
'description' => '如果提交了退货申请,通过该接⼝输⼊退货的物流信息 '."\n"
."\n"
.'注意: '."\n"
.'1.只有在卖家同意退款(通过queryRefundApplicationDetail接⼝查询到disputeStatus为2时)且需要退回货物时,才能调此接⼝ '."\n"
.'2.DisputeId字段需要通过查询订单逆向申请详情(queryRefundApplicationDetail)接⼝获取',
'requestParamsDescription' => '// 常⻅物流:'."\n"
.' '."\n"
.' {'."\n"
.' "STO": "申通快递",'."\n"
.' "HTKY": "百世快递",'."\n"
.' "DBKD": "德邦快递",'."\n"
.' "POSTB": "邮政快递包裹",'."\n"
.' "EYB": "EMS经济快递",'."\n"
.' "GTO": "国通快递",'."\n"
.' "QFKD": "全峰快递",'."\n"
.' "ZJS": "宅急送",'."\n"
.' "FAST": "快捷快递",'."\n"
.' "EMS": "EMS标准",'."\n"
.' "SF": "顺丰速运",'."\n"
.' "UC": "优速快递",'."\n"
.' "100004928": "如⻛达",'."\n"
.' "5000000007756": "中国邮政国内标快",'."\n"
.' "BESTQJT": "百世快运",'."\n"
.' "ZTO": "中通快递",'."\n"
.' "TTKDEX": "天天快递",'."\n"
.' "YTO": "圆通快递",'."\n"
.' "YUNDA": "韵达快递",'."\n"
.' "OTHER": "其他",'."\n"
.' "POST": "中国邮政",'."\n"
.' "EMS": "EMS",'."\n"
.' "FEDEX": "联邦快递",'."\n"
.' "SHQ": "华强物流",'."\n"
.' "TN": "特能",'."\n"
.' "TAOBAO": "淘宝物流",'."\n"
.' "ZTKY": "中铁物流"'."\n"
.' }',
],
'QueryRefundApplicationDetail' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL2******0002',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '12******89',
],
],
[
'name' => 'SubLmOrderId',
'in' => 'query',
'schema' => [
'description' => '发起逆向申请的订单号',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '23******85',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值:ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'DAAA6391-3339-5333-9E4D-C71CD26A231F',
],
'RefundApplicationDetail' => [
'description' => '初始化逆向申请参数',
'type' => 'object',
'properties' => [
'DisputeType' => [
'description' => '逆向发生的类型',
'type' => 'integer',
'format' => 'int32',
'example' => '0: "任意退款类型"'."\n"
.'1: "售中退款"'."\n"
.'2: "售后退款"',
],
'LmOrderId' => [
'description' => '主订单号',
'type' => 'string',
'example' => '46******11',
],
'RefunderName' => [
'description' => '退货收货人,卖家同意退货后才会显示',
'type' => 'string',
'example' => '张三',
],
'SellerAgreeMsg' => [
'description' => '卖家同意退货说明,真实的退货地址会在这个字段进⾏返回',
'type' => 'string',
'example' => '同意退货',
],
'ReturnGoodLogisticsStatus' => [
'description' => '退货物流状态',
'type' => 'integer',
'format' => 'int32',
'example' => '0: "未退货"'."\n"
.'1: "等待揽收"'."\n"
.'2: "快件已揽收"'."\n"
.'3: "物流走件中"'."\n"
.'4: "派送中"'."\n"
.'5: "已签收"'."\n"
.'6: "签收失败"',
],
'DisputeDesc' => [
'description' => '申请逆向描述',
'type' => 'string',
'example' => '尺码不符',
],
'RefunderAddress' => [
'description' => '商家退货地址,卖家同意退货后才会显示',
'type' => 'string',
],
'ReturnGoodCount' => [
'description' => '退货数量',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'DisputeId' => [
'description' => '纠纷ID',
'type' => 'integer',
'format' => 'int64',
'example' => '141******33',
],
'DisputeEndTime' => [
'description' => '逆向结束时间',
'type' => 'string',
'example' => '2022-04-02 10:16:12',
],
'OrderLogisticsStatus' => [
'description' => ' 当前的订单的物流状态,1,标识未发货',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'BizClaimType' => [
'description' => '⽀持的订单退货⽅式,1, 标识仅退款,3,标识退货退款',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RealRefundFee' => [
'description' => '实际买家收到的⾦额',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'RefundFee' => [
'description' => '退款⾦额(含退平台补贴的⾦额)',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'SellerRefuseAgreementMessage' => [
'description' => '卖家拒绝的留⾔说明',
'type' => 'string',
'example' => '多拍不想要',
],
'DisputeCreateTime' => [
'description' => '逆向发起时间',
'type' => 'string',
'example' => '2022-04-02 10:16:10',
],
'RefunderTel' => [
'description' => '退货联系方式,卖家同意退货后才会显示',
'type' => 'string',
'example' => '158****1234',
],
'SellerRefuseReason' => [
'description' => '商家拒绝原因',
'type' => 'string',
'example' => '不满足退款条件',
],
'SubLmOrderId' => [
'description' => '当前发起逆向的⼦订单号',
'type' => 'string',
'example' => '44******62',
],
'ApplyDisputeDesc' => [
'description' => '当前买家申请退款说明',
'type' => 'string',
'example' => '多拍不想要',
],
'DisputeStatus' => [
'description' => '逆向退款的状态',
'type' => 'integer',
'format' => 'int32',
],
'RefunderZipCode' => [
'description' => '退货地址邮编,卖家同意退货后才会显示',
'type' => 'string',
],
'MaxRefundFeeData' => [
'description' => '本单可退金额数据',
'type' => 'object',
'properties' => [
'MaxRefundFee' => [
'description' => '本单最大可退金额',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'MinRefundFee' => [
'description' => '本单最小可退金额',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
'ApplyReasonText' => [
'description' => '买家申请逆向的原因',
'type' => 'object',
'properties' => [
'ReasonTips' => [
'description' => '买家申请逆向的原因ID',
'type' => 'string',
'example' => '多拍不想要',
],
'ReasonTextId' => [
'description' => '买家申请逆向的原因文案',
'type' => 'integer',
'format' => 'int64',
'example' => '100005',
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"DAAA6391-3339-5333-9E4D-C71CD26A231F\\",\\n \\"RefundApplicationDetail\\": {\\n \\"DisputeType\\": 0,\\n \\"LmOrderId\\": \\"46******11\\",\\n \\"RefunderName\\": \\"张三\\",\\n \\"SellerAgreeMsg\\": \\"同意退货\\",\\n \\"ReturnGoodLogisticsStatus\\": 0,\\n \\"DisputeDesc\\": \\"尺码不符\\",\\n \\"RefunderAddress\\": \\"\\",\\n \\"ReturnGoodCount\\": 1,\\n \\"DisputeId\\": 0,\\n \\"DisputeEndTime\\": \\"2022-04-02 10:16:12\\",\\n \\"OrderLogisticsStatus\\": 1,\\n \\"BizClaimType\\": 1,\\n \\"RealRefundFee\\": 10,\\n \\"RefundFee\\": 10,\\n \\"SellerRefuseAgreementMessage\\": \\"多拍不想要\\",\\n \\"DisputeCreateTime\\": \\"2022-04-02 10:16:10\\",\\n \\"RefunderTel\\": \\"158****1234\\",\\n \\"SellerRefuseReason\\": \\"不满足退款条件\\",\\n \\"SubLmOrderId\\": \\"44******62\\",\\n \\"ApplyDisputeDesc\\": \\"多拍不想要\\",\\n \\"DisputeStatus\\": 0,\\n \\"RefunderZipCode\\": \\"\\",\\n \\"MaxRefundFeeData\\": {\\n \\"MaxRefundFee\\": 10,\\n \\"MinRefundFee\\": 0\\n },\\n \\"ApplyReasonText\\": {\\n \\"ReasonTips\\": \\"多拍不想要\\",\\n \\"ReasonTextId\\": 100005\\n }\\n }\\n}","type":"json"}]',
'title' => '查询退款申请明细',
'summary' => '申请退款成功之后,可通过此接口确定逆向的状态等信息。',
'description' => '基于⼦订单号查询逆向申请的详情 '."\n"
."\n"
.'注意:⼀般申请退款成功之后通过此接⼝确认逆向的状态(disputeStatus)以及纠纷id(disputeId)等 '."\n"
.'特别说明:退货信息请优先参考sellerAgreeMsg字段,如果该字段为空、null、或者不包含退货地址、⼿机号等信息时,再参考refunderAddress、refunderName、refunderTel等字段',
'responseParamsDescription' => '逆向申请返回参数示例:'."\n"
."\n"
.' {'."\n"
.' lmOrderId: "123498124", // 对应的主订单号'."\n"
.' subLmOrderId: "12131234", // 当前发起逆向的⼦订单号'."\n"
.' bizClaimType: 1, // ⽀持的订单退货⽅式,1, 标识仅退款,3,标识退货退款'."\n"
.' orderLogisticsStatus: 1, // 当前的订单的物流状态,1,标识未发货'."\n"
.' disputeStatus: 1, // 逆向的状态'."\n"
.' returnGoodLogisticsStatus: 0, //退货物流状态'."\n"
.' disputeType: 0, // 逆向发⽣的类型'."\n"
.' maxRefundFeeData:{'."\n"
.' maxRefundFee: 100, //夲单最⼤可退款⾦额'."\n"
.' minRefundFee: 10 // 夲单最⼩可退款⾦额'."\n"
.' },'."\n"
.' sellerRefuseReason: "商品没问题,买家举证⽆效",//商家拒绝原因'."\n"
.' refundFee: 12121, // 退款⾦额(含退平台补贴的⾦额)'."\n"
.' realRefundFee: 12121, // 实际买家收到的⾦额'."\n"
.' returnGoodCount: 1, // 退货数量'."\n"
.' disputeDesc: "mmmmmm", // 申请逆向描述'."\n"
.' sellerAgreeMsg: "同意退款", // 卖家同意退货说明,真实的退货地址会在这个字段进⾏返回。'."\n"
.' sellerRefuseAgreementMessage: "不同意退款", // 卖家拒绝的留⾔说明'."\n"
.' applyReasonText: { //买家申请的逆向原因'."\n"
.' reasonTextId: 12323,'."\n"
.' reasonTips: "拍多不想要",'."\n"
.' },'."\n"
.' applyDisputeDesc: "多拍不想要", //当前买家申请退款说明'."\n"
.' disputeCreateTime: "逆向发起时间",'."\n"
.' disputeEndTime: "逆向结束时间",'."\n"
.' disputeId: 123123, // 纠纷ID,'."\n"
.' refunderAddress: "商家退货地址", //卖家同意退货后才显示,'."\n"
.' refunderName:"退货收货⼈", //卖家同意退货后才显示,'."\n"
.' refunderTel:"退货联系⽅式", //卖家同意退货后才显示,'."\n"
.' refunderZipCode:"退货地址邮编" //卖家同意退货后才显示'."\n"
.' }'."\n"
.' disputeStatus: '."\n"
.' 1: "买家已经申请退款,等待卖家同意"'."\n"
.' 2: "卖家已经同意退款,等待买家退货"'."\n"
.' 3: "买家已经退货,等待卖家确认收货"'."\n"
.' 4: "退款关闭"'."\n"
.' 5: "退款成功"'."\n"
.' 6: "卖家拒绝退款"'."\n"
.' 7: "等待买家确认重新邮寄的货物"'."\n"
.' 8: "等待卖家确认退货地址"'."\n"
.' 9: "没有申请退款"'."\n"
.' 10: "有活动的退款"'."\n"
.' 11: "退款结束"'."\n"
.' 12: "卖家确认收货,等待卖家发货"'."\n"
.' 13: "卖家已发货,等待卖家和买家确认收货"'."\n"
.' 14: "换货关闭,转退货退款"'."\n"
.' 15: "邮费单已创建,待激活"'."\n"
.' returnGoodLogisticsStatus:'."\n"
.' 0: "未退货"'."\n"
.' 1: "等待揽收"'."\n"
.' 2: "快件已揽收"'."\n"
.' 3: "物流⾛件中"'."\n"
.' 4: "派送中"'."\n"
.' 5: "已签收"'."\n"
.' 6: "签收失败"'."\n"
.' disputeType:'."\n"
.' 0: "任意退款类型"'."\n"
.' 1: "售中退款"'."\n"
.' 2: "售后退款"',
],
'InitApplyRefund' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '182******062',
],
],
[
'name' => 'SubLmOrderId',
'in' => 'query',
'schema' => [
'description' => '发起退款的⼦订单号,可在查询订单详情接⼝中获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '51******13',
],
],
[
'name' => 'BizClaimType',
'in' => 'query',
'schema' => [
'description' => '退款类型:1 仅退款,3 退货退款',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'GoodsStatus',
'in' => 'query',
'schema' => [
'description' => '货物状态:4: 未发货, 6: 已发货, 1: 未收到货, 2: 已收到货, 3:已寄回, 5: 卖家确认收货',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '6',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值:ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubLmOrderId' => [
'description' => '发起退款的⼦订单号',
'type' => 'string',
'example' => '38******75',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'B7E4EF89-DBC3-5CD0-9993-02D8C13E7177',
],
'InitApplyRefundData' => [
'description' => '初始化的逆向申请参数',
'type' => 'object',
'properties' => [
'MainOrderRefund' => [
'description' => '是否是整单退',
'type' => 'boolean',
],
'BizClaimType' => [
'description' => '⽀持的订单退货⽅式,1, 标识仅退款,3,标识退货退款',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RefundReasonList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RefundReasonList' => [
'description' => '退款信息列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReasonTextId' => [
'description' => '退款信息id',
'type' => 'integer',
'format' => 'int64',
'example' => '500003',
],
'ReasonTips' => [
'description' => '退款信息',
'type' => 'string',
'example' => '多拍不想要',
],
'ProofRequired' => [
'description' => '是否要求上传凭证',
'type' => 'boolean',
'example' => 'false',
],
'RefundDescRequired' => [
'description' => '是否要求留言',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
'MaxRefundFeeData' => [
'description' => '退款金额列表',
'type' => 'object',
'properties' => [
'MaxRefundFee' => [
'description' => '本单最大退款金额',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'MinRefundFee' => [
'description' => '本单最小退款金额',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubLmOrderId\\": \\"38******75\\",\\n \\"RequestId\\": \\"B7E4EF89-DBC3-5CD0-9993-02D8C13E7177\\",\\n \\"InitApplyRefundData\\": {\\n \\"MainOrderRefund\\": true,\\n \\"BizClaimType\\": 1,\\n \\"RefundReasonList\\": {\\n \\"RefundReasonList\\": [\\n {\\n \\"ReasonTextId\\": 500003,\\n \\"ReasonTips\\": \\"多拍不想要\\",\\n \\"ProofRequired\\": false,\\n \\"RefundDescRequired\\": true\\n }\\n ]\\n },\\n \\"MaxRefundFeeData\\": {\\n \\"MaxRefundFee\\": 100,\\n \\"MinRefundFee\\": 10\\n }\\n }\\n}","type":"json"}]',
'title' => '逆向渲染',
'summary' => '申请退款之前。',
'description' => '获取订单相关的逆向数据,必须在发起退款申请之前调⽤。'."\n"
."\n"
.'注意:订单“未发货”只能申请“仅退款(BizClaimType=1)”,订单“已发货”只能申请货物状态为“未收到货(GoodsStatus=1)”或“已收到货(GoodsStatus=2)”',
'responseParamsDescription' => '初始化逆向参数示例: '."\n"
."\n"
.' {'."\n"
.' "bizClaimType": 1, // ⽀持的订单退货⽅式,1, 标识仅退款,3,标识退货退款'."\n"
.' "mainOrderRefund": false, // 是否是整单退'."\n"
.' "maxRefundFeeData":{'."\n"
.' "maxRefundFee": 100, //本单最⼤可退款⾦额'."\n"
.' "minRefundFee": 10 // 本单最⼩可退款⾦额'."\n"
.' },'."\n"
.' "refundReasonList": ['."\n"
.' {'."\n"
.' "reasonTextId": 12323,'."\n"
.' "reasonTips": "拍多不想要",'."\n"
.' "proofRequired": true, //是否要求上传凭证'."\n"
.' "refundDescRequired": true //是否要求留⾔'."\n"
.' }'."\n"
.' ],'."\n"
.' "subLmOrderId":"⼦订单号"'."\n"
.' }',
],
'QueryMessages' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL2******001',
],
],
[
'name' => 'Topic',
'in' => 'query',
'schema' => [
'description' => '消息的 Topic',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Topic_******_api',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '扩展内容',
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '79C01D47-3C44-57D9-BC99-1B33F7ED14B8',
],
'Success' => [
'description' => '请求是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '成功',
],
'Code' => [
'description' => '返回码',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '返回信息',
'type' => 'string',
'example' => 'SUCCESS',
],
'LogsId' => [
'description' => '无效字段',
'type' => 'string',
'example' => '1',
],
'BizMessages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'BizMessage' => [
'description' => '消息列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ContentMapJson' => [
'description' => '消息内容,map转成的jsonstring。',
'type' => 'string',
],
'PubTime' => [
'description' => '消息产生时间',
'type' => 'string',
],
'DataId' => [
'description' => '消息id,需要全局唯一,不可重复。',
'type' => 'integer',
'format' => 'int64',
],
'Topic' => [
'description' => '消息的topic',
'type' => 'string',
'example' => 'Topic_******_api',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79C01D47-3C44-57D9-BC99-1B33F7ED14B8\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"成功\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"LogsId\\": \\"1\\",\\n \\"BizMessages\\": {\\n \\"BizMessage\\": [\\n {\\n \\"ContentMapJson\\": \\"\\",\\n \\"PubTime\\": \\"\\",\\n \\"DataId\\": 0,\\n \\"Topic\\": \\"Topic_******_api\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '定期获取消息事件',
'summary' => '订购电影票业务使用。',
],
'RemoveMessages' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL2******001',
],
],
[
'name' => 'MessageIds',
'in' => 'query',
'schema' => [
'description' => '消息id列表',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '212112212',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '消息扩展字段。',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '1718921E-C8D4-55E1-B8D4-114AE537C1B7',
],
'Success' => [
'description' => '调用是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '成功',
],
'Code' => [
'description' => '返回码',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '返回信息',
'type' => 'string',
'example' => 'SUCCESS',
],
'LogsId' => [
'description' => '无效字段',
'type' => 'string',
'example' => '1',
],
'ActionResult' => [
'description' => '删除结果',
'type' => 'object',
'properties' => [
'ReturnCode' => [
'description' => '返回码',
'type' => 'string',
'example' => '0',
],
'ReturnValue' => [
'description' => '返回值',
'type' => 'string',
'example' => '[{\'uuid\': \'dim-a0bf795*******8e86d4d464dc3a\', \'code\': \'itm\', \'extendName\': \'item\', \'name\': u\'\\u5541\', \'description\': u\'\\u5546\\u4e49\'}]',
],
'ReturnMessage' => [
'description' => '返回消息',
'type' => 'string',
'example' => 'Success',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1718921E-C8D4-55E1-B8D4-114AE537C1B7\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"成功\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"LogsId\\": \\"1\\",\\n \\"ActionResult\\": {\\n \\"ReturnCode\\": \\"0\\",\\n \\"ReturnValue\\": \\"[{\'uuid\': \'dim-a0bf795*******8e86d4d464dc3a\', \'code\': \'itm\', \'extendName\': \'item\', \'name\': u\'\\\\\\\\u5541\', \'description\': u\'\\\\\\\\u5546\\\\\\\\u4e49\'}]\\",\\n \\"ReturnMessage\\": \\"Success\\"\\n }\\n}","type":"json"}]',
'title' => '删除消息',
'summary' => '删除消息。',
],
'DeleteItemLimitRule' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL2021083****',
],
],
[
'name' => 'SubBizCode',
'in' => 'query',
'schema' => [
'description' => '子业务号',
'type' => 'string',
'required' => false,
'example' => '7ddaba53d5be4173808f2335eac0****',
],
],
[
'name' => 'LmActivityId',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '679',
],
],
[
'name' => 'LmItemId',
'in' => 'query',
'schema' => [
'description' => 'lm侧商品id',
'type' => 'string',
'required' => false,
'example' => '10000035-6193664*****',
],
],
[
'name' => 'ItemId',
'in' => 'query',
'schema' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '57835029****',
],
],
[
'name' => 'RuleId',
'in' => 'query',
'schema' => [
'description' => '规则id',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Model' => [
'description' => '返回结果',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'The specified parameter %s value is not valid.',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'A7BE4356-7F92-533E-A31B-2EBF2D67****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Model\\": true,\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\",\\n \\"RequestId\\": \\"A7BE4356-7F92-533E-A31B-2EBF2D67****\\"\\n}","type":"json"}]',
'title' => '删除项目限制规则',
'summary' => '删除项目限制规则。',
'description' => "\n"
.'删除项目限制规则',
],
'ModifyBasicAndBizItems' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL2***100001',
],
],
[
'name' => 'SubBizId',
'in' => 'query',
'schema' => [
'description' => '子渠道ID',
'type' => 'string',
'required' => false,
'example' => 'f4279b7cbdfc46d4b7566****',
],
],
[
'name' => 'ItemList',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '商品列表',
'type' => 'array',
'items' => [
'description' => '商品列表',
'type' => 'object',
'properties' => [
'LmItemId' => [
'description' => 'Lm侧商品ID',
'type' => 'string',
'required' => false,
'example' => '10000035-61936646****',
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '65671280****',
],
'SkuList' => [
'description' => '商品sku列表',
'type' => 'array',
'items' => [
'description' => '商品sku列表',
'type' => 'object',
'properties' => [
'StatusAction' => [
'description' => '该sku状态',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
'PriceCent' => [
'description' => '销售价格(分),priceCent表示客户端的销售价格,返回值以分为单位',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2790',
],
'SupplierPrice' => [
'description' => '供货价',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2790',
],
'SkuId' => [
'description' => '商品的SkuId',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '472461998****',
],
'Points' => [
'description' => '积分数量',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1999',
],
'PointsAmount' => [
'description' => '积分抵扣价格',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
'BenefitId' => [
'description' => '商品权益ID',
'type' => 'string',
'required' => false,
'example' => '2021090800502200000086****',
],
'Quantity' => [
'description' => 'sku库存',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2000',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
'required' => false,
],
'required' => true,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功:"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'The specified parameter %s value is not valid.',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'F957A835-87CE-5E5F-B0A9-A66B081E****',
],
'FailedItemList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Item' => [
'description' => '修改失败列表',
'type' => 'array',
'items' => [
'description' => '修改失败列表'."\n"
."\n",
'type' => 'object',
'properties' => [
'LmItemId' => [
'description' => 'lm侧商品ID',
'type' => 'string',
'example' => '10000102-65305223****',
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'example' => '65305223****',
],
'SkuIdList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Sku' => [
'description' => '商品skuId列表',
'type' => 'array',
'items' => [
'description' => 'skuId',
'type' => 'string',
'example' => '[4213879388301]',
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\",\\n \\"RequestId\\": \\"F957A835-87CE-5E5F-B0A9-A66B081E****\\",\\n \\"FailedItemList\\": {\\n \\"Item\\": [\\n {\\n \\"LmItemId\\": \\"10000102-65305223****\\",\\n \\"ItemId\\": 0,\\n \\"SkuIdList\\": {\\n \\"Sku\\": [\\n \\"[4213879388301]\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '修改基础和业务项目信息',
'summary' => '修改基础和业务项目信息。',
'description' => '修改基础和业务项目信息',
],
'GetCustomServiceUrl' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20210315****',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '220077837****',
],
],
[
'name' => 'SellerId',
'in' => 'query',
'schema' => [
'description' => '卖家ID,如果不传对接的是⼩蜜机器⼈;传sellerId后,可以直接对接商家客服',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '220680193****',
],
],
[
'name' => 'Cuid',
'in' => 'query',
'schema' => [
'description' => '客户⽅终端⽤户ID,⽤户的身份标识,不传时当做匿名⽤户',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '5512876',
],
],
[
'name' => 'Nick',
'in' => 'query',
'schema' => [
'description' => '⼩蜜界⾯上显示的⽤户昵称,可不传,默认⽣成⼀串ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '123213***1212',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户唯一标识',
'type' => 'string',
'required' => false,
'example' => '220077837****'."\n",
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值:ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '79C01D47-3C44-57D9-BC99-1B33F7ED****',
],
'UrlData' => [
'description' => '地址数据',
'type' => 'object',
'properties' => [
'ReturnUrl' => [
'description' => '客服地址',
'type' => 'string',
'example' => '客服地址(天猫超市返回的是座机号)',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"79C01D47-3C44-57D9-BC99-1B33F7ED****\\",\\n \\"UrlData\\": {\\n \\"ReturnUrl\\": \\"客服地址(天猫超市返回的是座机号)\\"\\n }\\n}","type":"json"}]',
'title' => '获取淘宝客服聊天窗口链接',
'summary' => '获取客服链接。',
'description' => '获取客服链接,⼀般有三种形式:'."\n"
."\n"
.'- ⼩蜜客服:https://h5.m.taobao.com/alicare/index.html?from=xxx ,打开后可以咨询⼩蜜客服 '."\n"
.' 客服如果询问下单的账号,可以回应客服淘宝ID位于⼩蜜咨询foreignId的第三段: '."\n"
.' foreighId形如 linkedmall_{bizId}_{taobaoId}_{cUid}'."\n"
.'- 客服电话:tel: xxx ,以 tel: 开头的电话号码'."\n"
.'- 图⽚说明:静态图⽚地址'."\n"
."\n"
.'注意:由于客户侧对商品的定价与linkedmall给到客户侧的供货价不同,需要客户⽅客服在客户⽅⽤户与淘宝商家客服之间做⼀道承接 '."\n"
.'特别说明:返回的url为免登录,打开即为与淘宝商家客服的聊天窗⼝,但是url中的token使⽤⼀次即失效,所以每次都需要重新获取,如遇打开需要登录的情况,请检查token是否被提前访问过了',
'responseParamsDescription' => 'UrlData数据结构:'."\n"
.' '."\n"
.' {'."\n"
.' "returnUrl": "客服地址(天猫超市返回的是座机号)"'."\n"
.' }',
],
'GetGuidePage' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL2***100001',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功:"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'BA157565-3358-5D80-9330-************',
],
'MiniShopInfo' => [
'description' => '返回结果列表',
'type' => 'array',
'items' => [
'description' => '返回结果列表'."\n"
."\n",
'type' => 'object',
'properties' => [
'LiteShopId' => [
'description' => '店铺id',
'type' => 'string',
'example' => '10000001',
],
'Src' => [
'type' => 'string',
],
'BizId' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'example' => 'LMALL20211012****',
],
'Name' => [
'description' => '店铺名称',
'type' => 'string',
'example' => '店铺名称',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"BA157565-3358-5D80-9330-************\\",\\n \\"MiniShopInfo\\": [\\n {\\n \\"LiteShopId\\": \\"10000001\\",\\n \\"Src\\": \\"\\",\\n \\"BizId\\": \\"LMALL20211012****\\",\\n \\"Name\\": \\"店铺名称\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取导航页',
'summary' => '获取导航页(小程序店铺)。',
'description' => '获取导航页',
],
'GetLoginPage' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20210830****',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户唯一标识',
'type' => 'string',
'required' => false,
'example' => '287381784****',
],
],
[
'name' => 'TargetUrl',
'in' => 'formData',
'schema' => [
'description' => '登录成功后的跳转地址',
'type' => 'string',
'required' => false,
'example' => 'https://********',
],
],
[
'name' => 'FailUrl',
'in' => 'formData',
'schema' => [
'description' => '登录失败后的跳转地址',
'type' => 'string',
'required' => false,
'example' => 'https://********',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '1267088B-4695-50DC-97B9-9E4F89D1****',
],
'UrlData' => [
'description' => '跳转链接',
'type' => 'object',
'properties' => [
'ReturnUrl' => [
'description' => '跳转链接',
'type' => 'string',
'example' => 'https://**********',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"1267088B-4695-50DC-97B9-9E4F89D1****\\",\\n \\"UrlData\\": {\\n \\"ReturnUrl\\": \\"https://**********\\"\\n }\\n}","type":"json"}]',
'title' => '获取登录页面',
'summary' => '获取登录页面。',
'description' => '如果客户使⽤的是淘宝的账号体系,在客户⾃⼰的系统⾥可以直接使⽤淘宝的登录⻚⾯进⾏登录。',
],
'GetSwitchUrl' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20211119****',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '221249435****',
],
],
[
'name' => 'Url',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
'example' => '221249435****'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Url' => [
'description' => '获取的链接',
'type' => 'string',
'example' => 'https://*****************',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'DAAA6391-3339-5333-9E4D-C71CD26A****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Url\\": \\"https://*****************\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"DAAA6391-3339-5333-9E4D-C71CD26A****\\"\\n}","type":"json"}]',
'title' => '获取登录态转换链接',
'summary' => '匿名账号用。传入淘宝,天猫域名的url返回包含登录态的链接。',
'description' => '获取登录态转换链接',
],
'GetUserInfo' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'UserFlag',
'in' => 'query',
'schema' => [
'description' => '用户标识',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => [
'description' => 'app名称',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'alipay',
],
],
[
'name' => 'QueryJson',
'in' => 'formData',
'schema' => [
'description' => '查询条件',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '9054694D-E3AF-5A07-9647-0537026A45E1',
],
'LoginResult' => [
'description' => '查询结果',
'type' => 'object',
'properties' => [
'ReturnUrl' => [
'description' => '返回url',
'type' => 'string',
'example' => '""',
],
'BizUserName' => [
'description' => '业务用户名称',
'type' => 'string',
'example' => '""',
],
'BizUid' => [
'description' => '业务用户ID',
'type' => 'string',
'example' => '18******60',
],
'BizId' => [
'description' => '业务ID',
'type' => 'string',
'example' => 'LMALL20******001',
],
'LmUserId' => [
'description' => 'linkedmall侧用户ID',
'type' => 'integer',
'format' => 'int64',
'example' => '10******3',
],
'ExtInfo' => [
'description' => '扩展信息',
'type' => 'object',
'example' => '{}',
],
'SubBizId' => [
'description' => '子业务ID',
'type' => 'array',
'items' => [
'description' => '子业务ID',
'type' => 'string',
'example' => 'c6ff94******f9ab468e4a29a0c',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"9054694D-E3AF-5A07-9647-0537026A45E1\\",\\n \\"LoginResult\\": {\\n \\"ReturnUrl\\": \\"\\\\\\"\\\\\\"\\",\\n \\"BizUserName\\": \\"\\\\\\"\\\\\\"\\",\\n \\"BizUid\\": \\"18******60\\",\\n \\"BizId\\": \\"LMALL20******001\\",\\n \\"LmUserId\\": 0,\\n \\"ExtInfo\\": {},\\n \\"SubBizId\\": [\\n \\"c6ff94******f9ab468e4a29a0c\\"\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取用户信息',
'summary' => '获取用户信息。',
],
'QueryAgreement' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ExternalAgreementNo',
'in' => 'formData',
'schema' => [
'description' => '外部协议号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'MerchantId',
'in' => 'formData',
'schema' => [
'description' => '商户ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'AgreementNo',
'in' => 'formData',
'schema' => [
'description' => '协议号',
'type' => 'string',
'required' => false,
'example' => '20******8006',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'DAAA6391-3339-5333-9E4D-C71CD26A231F',
],
'QueryAgreementResponse' => [
'description' => '查询结果',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '状态',
'type' => 'string',
'example' => '""',
],
'ExternalAgreementNo' => [
'description' => '外部协议号',
'type' => 'string',
'example' => '""',
],
'ValidTime' => [
'description' => '生效时间',
'type' => 'string',
'example' => '2021-08-01 00:00:00'."\n",
],
'InvalidTime' => [
'description' => '过期时间',
'type' => 'string',
'example' => '2022-08-01 00:00:00'."\n",
],
'AgreementNo' => [
'description' => '协议号',
'type' => 'string',
'example' => '20******8006'."\n",
],
'SignTime' => [
'description' => '签约时间',
'type' => 'string',
'example' => '2021-08-01 00:00:00'."\n",
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"DAAA6391-3339-5333-9E4D-C71CD26A231F\\",\\n \\"QueryAgreementResponse\\": {\\n \\"Status\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ExternalAgreementNo\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ValidTime\\": \\"2021-08-01 00:00:00\\\\n\\",\\n \\"InvalidTime\\": \\"2022-08-01 00:00:00\\\\n\\",\\n \\"AgreementNo\\": \\"20******8006\\\\n\\",\\n \\"SignTime\\": \\"2021-08-01 00:00:00\\\\n\\"\\n }\\n}","type":"json"}]',
'title' => '查询协议',
'summary' => '合作伙伴使用,查看客户的代扣协议。',
],
'QueryAllCities' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '扩展信息',
'type' => 'object',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '79C01D47-3C44-57D9-BC99-1B33F7ED14B8',
],
'Success' => [
'description' => '请求是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '1004',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '1004',
],
'LogsId' => [
'description' => '无效字段',
'type' => 'string',
'example' => '1',
],
'Cities' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'City' => [
'description' => '城市列表',
'type' => 'array',
'items' => [
'description' => ' '."\n"
.'城市列表',
'type' => 'object',
'properties' => [
'CityCode' => [
'description' => '城市编码',
'type' => 'integer',
'format' => 'int64',
'example' => '110100',
],
'ParentId' => [
'description' => '父类层级ID',
'type' => 'integer',
'format' => 'int64',
'example' => '110000',
],
'Name' => [
'description' => '城市名称',
'type' => 'string',
'example' => '北京市',
],
'PinYin' => [
'description' => '城市拼音',
'type' => 'string',
'example' => 'beijing',
],
'Id' => [
'description' => '所属实例id',
'type' => 'integer',
'format' => 'int64',
'example' => '424',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79C01D47-3C44-57D9-BC99-1B33F7ED14B8\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"1004\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"1004\\",\\n \\"LogsId\\": \\"1\\",\\n \\"Cities\\": {\\n \\"City\\": [\\n {\\n \\"CityCode\\": 110100,\\n \\"ParentId\\": 110000,\\n \\"Name\\": \\"北京市\\",\\n \\"PinYin\\": \\"beijing\\",\\n \\"Id\\": 424\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询所有的城市列表',
'summary' => '查询所有的城市列表。',
],
'QueryBestSession4Items' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20211118****',
],
],
[
'name' => 'LmItemIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'lm侧商品ID列表',
'type' => 'object',
'required' => false,
'example' => '[\\"10000791-65975997****\\"]',
],
],
[
'name' => 'ItemIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '商品ID列表',
'type' => 'object',
'required' => false,
'example' => '[63928655****,65314637****,65771454****]',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'DA2554FD-F21F-536F-A7B7-B96C3E5F****',
],
'LmItemActivitySessionModelList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmItemActivitySessionModel' => [
'description' => '返回活动场次列表',
'type' => 'array',
'items' => [
'description' => '返回活动场次列表',
'type' => 'object',
'properties' => [
'LmItemId' => [
'description' => 'lm侧商品id',
'type' => 'string',
'example' => '10000102-65875550****',
],
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '66440412****',
],
'LmActivitySessionModel' => [
'description' => '活动场次列表',
'type' => 'object',
'properties' => [
'SubBizCode' => [
'description' => '子业务号',
'type' => 'string',
'example' => 'cf5eddd467ca4d4a8105378a3ea****',
],
'EndDate' => [
'description' => '活动结束时间',
'type' => 'string',
'example' => '2022-03-09 18:59:59',
],
'DisplayDate' => [
'description' => '场次展示时间',
'type' => 'string',
'example' => '2022-03-09 18:59:59'."\n",
],
'LmSessionId' => [
'description' => '场次ID',
'type' => 'integer',
'format' => 'int64',
'example' => '679',
],
'Description' => [
'description' => '场次详情',
'type' => 'string',
'example' => '""',
],
'StartDate' => [
'description' => '场次开始时间',
'type' => 'string',
'example' => '2021-12-25 09:07:00',
],
'LmActivityId' => [
'description' => '活动ID',
'type' => 'integer',
'format' => 'int64',
'example' => '679',
],
'BizId' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'example' => 'LMALL20190325****',
],
'Name' => [
'description' => '场次名称',
'type' => 'string',
'example' => '"场次名称"',
],
'ExtInfo' => [
'description' => '拓展信息',
'type' => 'object',
'example' => '{"key":"value"}',
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"DA2554FD-F21F-536F-A7B7-B96C3E5F****\\",\\n \\"LmItemActivitySessionModelList\\": {\\n \\"LmItemActivitySessionModel\\": [\\n {\\n \\"LmItemId\\": \\"10000102-65875550****\\",\\n \\"ItemId\\": 0,\\n \\"LmActivitySessionModel\\": {\\n \\"SubBizCode\\": \\"cf5eddd467ca4d4a8105378a3ea****\\",\\n \\"EndDate\\": \\"2022-03-09 18:59:59\\",\\n \\"DisplayDate\\": \\"2022-03-09 18:59:59\\\\n\\",\\n \\"LmSessionId\\": 679,\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"StartDate\\": \\"2021-12-25 09:07:00\\",\\n \\"LmActivityId\\": 679,\\n \\"BizId\\": \\"LMALL20190325****\\",\\n \\"Name\\": \\"\\\\\\"场次名称\\\\\\"\\",\\n \\"ExtInfo\\": {\\n \\"key\\": \\"value\\"\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '根据商品查询最优场次信息',
'summary' => '根据商品查询最优场次信息。',
'description' => '根据商品查询最优场次信息'."\n",
],
'QueryStatements' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'TenantId',
'in' => 'query',
'schema' => [
'description' => '租户ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '18******263',
],
],
[
'name' => 'PayeeIds',
'in' => 'query',
'schema' => [
'description' => '收款人ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'SettleNoes',
'in' => 'query',
'schema' => [
'description' => '结算单号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '开始时间',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '2021-08-01 00:00:00',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '结束时间',
'type' => 'string',
'required' => false,
'example' => '2021-09-01 00:00:00',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页页码,从1开始',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'SettleStatus',
'in' => 'query',
'schema' => [
'description' => '结算状态',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'SettleType',
'in' => 'query',
'schema' => [
'description' => '结算类型',
'type' => 'string',
'required' => false,
'example' => '""',
],
],
[
'name' => 'ExtInfo',
'in' => 'query',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => false,
'example' => 'LMALL20******001',
],
],
[
'name' => 'Currency',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '85729953-3123-5565-B3CA-493CCF25457B',
],
'Success' => [
'description' => '调用是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '""',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '205',
],
'TotalCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '19',
],
'LogsId' => [
'description' => '无效字段',
'type' => 'string',
'example' => '1',
],
'Model' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'PageNumber' => [
'description' => '当前⻚码,从1开始',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int32',
'example' => '19',
],
'StatementList' => [
'description' => '结算单列表',
'type' => 'array',
'items' => [
'description' => '结算单列表',
'type' => 'object',
'properties' => [
'PayeeAccountName' => [
'description' => '收款账号名称',
'type' => 'string',
],
'PayeeId' => [
'description' => '收款人ID',
'type' => 'string',
],
'PayeeAccountNo' => [
'description' => '收款人账号',
'type' => 'string',
],
'CreateDate' => [
'description' => '创建时间',
'type' => 'string',
'example' => '2021-08-01 00:00:00',
],
'ExtInfo' => [
'description' => '扩展信息',
'type' => 'string',
'example' => '{}',
],
'EndTime' => [
'description' => '结束时间',
'type' => 'string',
'example' => '2021-09-01 00:00:00'."\n",
],
'StartTime' => [
'description' => '开始时间',
'type' => 'string',
'example' => '2021-08-01 00:00:00'."\n",
],
'SettleNo' => [
'description' => '结算单号',
'type' => 'string',
'example' => 'TEST000000',
],
'Attributes' => [
'type' => 'string',
],
'SettleStatus' => [
'description' => '结算状态',
'type' => 'string',
'example' => '""',
],
'PayeeName' => [
'description' => '收款人姓名',
'type' => 'string',
'example' => '""',
],
'SettleAmount' => [
'description' => '结算金额',
'type' => 'string',
'example' => '10',
],
'PayeeAccountId' => [
'description' => '收款账号ID',
'type' => 'string',
'example' => '""',
],
'ModifiedDate' => [
'description' => '修改时间',
'type' => 'string',
'example' => '2021-09-01 00:00:00'."\n",
],
'StatusMessage' => [
'description' => '状态消息',
'type' => 'string',
'example' => '""',
],
'TenantId' => [
'description' => '租户ID',
'type' => 'string',
'example' => '18******263'."\n",
],
'KpNoGenerateTime' => [
'type' => 'string',
],
'Currency' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'MissingParameter',
'errorMessage' => 'You must specify the parameter.',
],
[
'errorCode' => 'linkedmall.errorcode.InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"85729953-3123-5565-B3CA-493CCF25457B\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"205\\",\\n \\"TotalCount\\": 19,\\n \\"LogsId\\": \\"1\\",\\n \\"Model\\": {\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 19,\\n \\"StatementList\\": [\\n {\\n \\"PayeeAccountName\\": \\"\\",\\n \\"PayeeId\\": \\"\\",\\n \\"PayeeAccountNo\\": \\"\\",\\n \\"CreateDate\\": \\"2021-08-01 00:00:00\\",\\n \\"ExtInfo\\": \\"{}\\",\\n \\"EndTime\\": \\"2021-09-01 00:00:00\\\\n\\",\\n \\"StartTime\\": \\"2021-08-01 00:00:00\\\\n\\",\\n \\"SettleNo\\": \\"TEST000000\\",\\n \\"Attributes\\": \\"\\",\\n \\"SettleStatus\\": \\"\\\\\\"\\\\\\"\\",\\n \\"PayeeName\\": \\"\\\\\\"\\\\\\"\\",\\n \\"SettleAmount\\": \\"10\\",\\n \\"PayeeAccountId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ModifiedDate\\": \\"2021-09-01 00:00:00\\\\n\\",\\n \\"StatusMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"TenantId\\": \\"18******263\\\\n\\",\\n \\"KpNoGenerateTime\\": \\"\\",\\n \\"Currency\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询语句',
'summary' => '查询语句。',
],
'QueryUnfinishedSessions' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20210802****',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页页码,从1开始',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每⻚多少条记录,最⼤20条',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '20',
'minimum' => '1',
'example' => '20',
],
],
[
'name' => 'QueryTime',
'in' => 'query',
'schema' => [
'description' => '查询时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1637294220',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'BA157565-3358-5D80-9330-************',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'PageNumber' => [
'description' => '当前页码,从1开始',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'description' => '每页多少条记录,最大为20条',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'TotalCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'LmActivitySessionModelList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmActivitySessionModel' => [
'description' => '活动场次信息列表',
'type' => 'array',
'items' => [
'description' => '活动场次信息列表'."\n"
."\n",
'type' => 'object',
'properties' => [
'SubBizCode' => [
'description' => '子业务号',
'type' => 'string',
'example' => '04fe37ad2d7c42a3b215ff3a5a9*****',
],
'DisplayDate' => [
'description' => '场次展示时间',
'type' => 'string',
'example' => '2017-11-30 23:59:59'."\n",
],
'EndDate' => [
'description' => '场次结束时间',
'type' => 'string',
'example' => '2017-11-30 23:59:59',
],
'Description' => [
'description' => '场次描述',
'type' => 'string',
'example' => '""',
],
'LmSessionId' => [
'description' => '场次id',
'type' => 'integer',
'format' => 'int64',
],
'BizId' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'example' => 'LMALL20211013****',
],
'LmActivityId' => [
'description' => '活动id',
'type' => 'integer',
'format' => 'int64',
'example' => '679',
],
'StartDate' => [
'description' => '开始时间',
'type' => 'string',
'example' => '2021-05-01 00:00:00',
],
'Name' => [
'description' => '场次名称',
'type' => 'string',
'example' => '活动名称',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA157565-3358-5D80-9330-************\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 5,\\n \\"LmActivitySessionModelList\\": {\\n \\"LmActivitySessionModel\\": [\\n {\\n \\"SubBizCode\\": \\"04fe37ad2d7c42a3b215ff3a5a9*****\\",\\n \\"DisplayDate\\": \\"2017-11-30 23:59:59\\\\n\\",\\n \\"EndDate\\": \\"2017-11-30 23:59:59\\",\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"LmSessionId\\": 0,\\n \\"BizId\\": \\"LMALL20211013****\\",\\n \\"LmActivityId\\": 679,\\n \\"StartDate\\": \\"2021-05-01 00:00:00\\",\\n \\"Name\\": \\"活动名称\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询当前所有未结束的场次',
'summary' => '查询当前所有未结束的场次。',
'description' => '查询当前所有未结束的场次'."\n",
],
'QueryWithholdTrade' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'TradeNo',
'in' => 'formData',
'schema' => [
'description' => '交易流水号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'OutTradeNo',
'in' => 'formData',
'schema' => [
'description' => '外部交易流水号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'MerchantId',
'in' => 'formData',
'schema' => [
'description' => '商户ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '64******721',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '0825B1A4-0870-50BD-8AA3-9618587BEBC2',
],
'QueryWithholdTradeResponse' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'SettleStatus' => [
'description' => '结算状态',
'type' => 'string',
'example' => '""',
],
'TradeStatus' => [
'description' => '交易状态',
'type' => 'string',
'example' => '""',
],
'TotalAmount' => [
'description' => '总金额',
'type' => 'string',
'example' => '1000',
],
'TradeNo' => [
'description' => '交易流水号',
'type' => 'string',
'example' => '""',
],
'PaymentDate' => [
'description' => '支付日期',
'type' => 'string',
],
'OutTradeNo' => [
'description' => '外部交易流水号',
'type' => 'string',
'example' => '""',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"0825B1A4-0870-50BD-8AA3-9618587BEBC2\\",\\n \\"QueryWithholdTradeResponse\\": {\\n \\"SettleStatus\\": \\"\\\\\\"\\\\\\"\\",\\n \\"TradeStatus\\": \\"\\\\\\"\\\\\\"\\",\\n \\"TotalAmount\\": \\"1000\\",\\n \\"TradeNo\\": \\"\\\\\\"\\\\\\"\\",\\n \\"PaymentDate\\": \\"\\",\\n \\"OutTradeNo\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n}","type":"json"}]',
'title' => '查询代扣交易单详情',
'summary' => '查询代扣交易单详情。',
],
'ExecuteNode' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'ProcessInstanceId',
'in' => 'query',
'schema' => [
'description' => '进度实例ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'ProcessId',
'in' => 'query',
'schema' => [
'description' => '进度ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'NodeInstanceId',
'in' => 'query',
'schema' => [
'description' => '节点实例ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => [
'description' => '节点ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'RequestData',
'in' => 'query',
'schema' => [
'description' => '请求数据',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => false,
'example' => 'LMALL20******001',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '75F3A591-B1A6-5EFF-8ABF-35AB8804DFA0',
],
'Success' => [
'description' => '请求是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '1004',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '205',
],
'TotalCount' => [
'description' => '总记录数',
'type' => 'integer',
'format' => 'int64',
'example' => '19',
],
'LogsId' => [
'description' => '无效字段',
'type' => 'string',
'example' => '1',
],
'Model' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'ResponseData' => [
'description' => '响应数据',
'type' => 'object',
],
'ProcessInstanceId' => [
'description' => '进度实例ID',
'type' => 'string',
'example' => '""',
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'MissingParameter',
'errorMessage' => 'You must specify the parameter.',
],
[
'errorCode' => 'linkedmall.errorcode.InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75F3A591-B1A6-5EFF-8ABF-35AB8804DFA0\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"1004\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"205\\",\\n \\"TotalCount\\": 19,\\n \\"LogsId\\": \\"1\\",\\n \\"Model\\": {\\n \\"ResponseData\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ProcessInstanceId\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n}","type":"json"}]',
'title' => '执行节点',
'summary' => '执行节点。',
],
'RefundPoint' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20191223****',
],
],
[
'name' => 'SellerId',
'in' => 'query',
'schema' => [
'description' => '卖家ID',
'type' => 'string',
'required' => false,
'example' => '10718491****',
],
],
[
'name' => 'LmOrderId',
'in' => 'query',
'schema' => [
'description' => 'lm订单号',
'type' => 'string',
'required' => false,
'example' => '44453****',
],
],
[
'name' => 'Reason',
'in' => 'query',
'schema' => [
'description' => '退积分原因',
'type' => 'string',
'required' => false,
'example' => '小额打款-退积分',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧ID',
'type' => 'string',
'required' => false,
'example' => 'susan*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '1718921E-C8D4-55E1-B8D4-114AE537****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"1718921E-C8D4-55E1-B8D4-114AE537****\\"\\n}","type":"json"}]',
'title' => '退积分',
'summary' => '内部业务使用。',
'description' => '积分退还接口',
],
'RefuseMerchantSyncTask' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20190325****',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID',
'type' => 'string',
'required' => false,
'example' => '1***1',
],
],
[
'name' => 'SellerNick',
'in' => 'query',
'schema' => [
'description' => '卖家nick',
'type' => 'string',
'required' => false,
'example' => '宣儒商贸公司',
'default' => '',
],
],
[
'name' => 'TimeStamp',
'in' => 'query',
'schema' => [
'description' => '时间戳。单位秒。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1641708010',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'The specified parameter lmItemId or itemId value is not valid.',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'F2D3CA1E-28BE-5E1C-B55F-81C8F290****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"The specified parameter lmItemId or itemId value is not valid.\\",\\n \\"RequestId\\": \\"F2D3CA1E-28BE-5E1C-B55F-81C8F290****\\"\\n}","type":"json"}]',
'title' => '拒绝同步任务',
'summary' => '招商商品同步任务主动拒绝接口,特定客户使用。',
'description' => '拒绝同步任务',
],
'SyncMerchantInfo' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******002',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID',
'type' => 'string',
'required' => false,
'example' => '1****3',
],
],
[
'name' => 'SellerNick',
'in' => 'query',
'schema' => [
'description' => '卖家昵称',
'type' => 'string',
'required' => false,
'example' => '**食品专营店',
'default' => '',
],
],
[
'name' => 'ItemList',
'in' => 'formData',
'schema' => [
'description' => '商品列表',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'TimeStamp',
'in' => 'query',
'schema' => [
'description' => '时间戳',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1639540484044',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '79C01D47-3C44-57D9-BC99-1B33F7ED14B8',
],
'Model' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '状态',
'type' => 'string',
],
'Url' => [
'type' => 'string',
],
'TaskId' => [
'description' => '任务ID',
'type' => 'string',
'example' => '1****1',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"79C01D47-3C44-57D9-BC99-1B33F7ED14B8\\",\\n \\"Model\\": {\\n \\"Status\\": \\"\\",\\n \\"Url\\": \\"\\",\\n \\"TaskId\\": \\"1****1\\"\\n }\\n}","type":"json"}]',
'title' => '同步商户信息',
'summary' => '合作伙伴同步担保交易签约信息使用。',
],
'ListItemActivities' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******002',
],
],
[
'name' => 'LmItemIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'lm侧商品ID列表',
'type' => 'object',
'required' => false,
'example' => '[\\"10000230-60716881****\\",\\"10000021-59183191****\\"]',
],
],
[
'name' => 'ItemIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '商品ID列表',
'type' => 'object',
'required' => false,
'example' => '[664148141***,663735776***]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '1718921E-C8D4-55E1-B8D4-114AE537C1B7',
],
'LmItemActivityModelList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmItemActivityModel' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LmItemId' => [
'description' => 'lm侧商品ID',
'type' => 'string',
'example' => '10000055-599520******',
],
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '599520******',
],
'LmActivityPopModel' => [
'type' => 'object',
'properties' => [
'SubBizCode' => [
'description' => '子业务号',
'type' => 'string',
'example' => '4309074a******9d626669eaa7f7c',
],
'EndDate' => [
'description' => '活动结束时间',
'type' => 'string',
'example' => '2022-04-04 00:00:00',
],
'DisplayDate' => [
'description' => '活动展示时间',
'type' => 'string',
'example' => '2022-03-31 14:25:00 ',
],
'BizId' => [
'description' => '业务ID',
'type' => 'string',
'example' => 'LMALL20******001',
],
'StartDate' => [
'description' => '活动开始时间',
'type' => 'string',
'example' => '2022-04-01 00:00:00',
],
'Title' => [
'description' => '活动标题',
'type' => 'string',
'example' => '活动测试',
],
'ExtInfo' => [
'description' => '扩展信息',
'type' => 'object',
],
'Id' => [
'description' => '活动ID',
'type' => 'integer',
'format' => 'int64',
'example' => '666',
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"1718921E-C8D4-55E1-B8D4-114AE537C1B7\\",\\n \\"LmItemActivityModelList\\": {\\n \\"LmItemActivityModel\\": [\\n {\\n \\"LmItemId\\": \\"10000055-599520******\\",\\n \\"ItemId\\": 0,\\n \\"LmActivityPopModel\\": {\\n \\"SubBizCode\\": \\"4309074a******9d626669eaa7f7c\\",\\n \\"EndDate\\": \\"2022-04-04 00:00:00\\",\\n \\"DisplayDate\\": \\"2022-03-31 14:25:00 \\",\\n \\"BizId\\": \\"LMALL20******001\\",\\n \\"StartDate\\": \\"2022-04-01 00:00:00\\",\\n \\"Title\\": \\"活动测试\\",\\n \\"ExtInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Id\\": 666\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取商品参加活动信息',
'summary' => '获取商品参加的活动信息。',
],
'QueryUnfinishedActivities' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页页码,从1开始。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的条数。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '20',
'minimum' => '1',
'example' => '20',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'AB121F3E-607D-5EC3-A09B-7B54B86D9154',
],
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'PageSize' => [
'description' => '每页显示的条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'PageNumber' => [
'description' => '分页页码,从1开始',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TotalCount' => [
'description' => '未结束活动总数',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'LmActivityModelExtList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmActivityModelV2Ext' => [
'description' => '活动信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndDate' => [
'description' => '活动结束时间',
'type' => 'string',
'example' => '2022-01-14 23:59:59',
],
'Description' => [
'description' => '活动描述',
'type' => 'string',
'example' => '测试活动',
],
'StartDate' => [
'description' => '活动开始时间',
'type' => 'string',
'example' => '2022-03-09 11:17:38',
],
'LmActivityId' => [
'description' => '活动id',
'type' => 'integer',
'format' => 'int64',
'example' => '679',
],
'BizId' => [
'description' => '业务id',
'type' => 'string',
'example' => 'LMALL20******002',
],
'ActivityPicUrl' => [
'description' => '活动图片',
'type' => 'string',
],
'Name' => [
'description' => '活动名称',
'type' => 'string',
'example' => '活动测试',
],
'LmActivitySessionModels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmActivitySessionModel' => [
'description' => '活动场次信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SubBizCode' => [
'description' => '子业务号',
'type' => 'string',
'example' => '3a92eb6******54005be358a43bd',
],
'EndDate' => [
'description' => '场次结束时间',
'type' => 'string',
'example' => '2022-03-09 18:59:59',
],
'DisplayDate' => [
'description' => '场次展示时间',
'type' => 'string',
'example' => '2022-03-08 18:59:59',
],
'Description' => [
'description' => '场次描述',
'type' => 'string',
'example' => '活动秒杀',
],
'LmSessionId' => [
'description' => '场次id',
'type' => 'integer',
'format' => 'int64',
],
'StartDate' => [
'description' => '场次开始时间',
'type' => 'string',
'example' => '2022-03-08 00:00:00',
],
'BizId' => [
'description' => '业务id',
'type' => 'string',
'example' => 'LMALL20******001',
],
'LmActivityId' => [
'description' => '活动id',
'type' => 'integer',
'format' => 'int64',
'example' => '679',
],
'Name' => [
'description' => '场次名称',
'type' => 'string',
'example' => '场次测试',
],
'ExtInfo' => [
'description' => '拓展信息',
'type' => 'object',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AB121F3E-607D-5EC3-A09B-7B54B86D9154\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 5,\\n \\"LmActivityModelExtList\\": {\\n \\"LmActivityModelV2Ext\\": [\\n {\\n \\"EndDate\\": \\"2022-01-14 23:59:59\\",\\n \\"Description\\": \\"测试活动\\",\\n \\"StartDate\\": \\"2022-03-09 11:17:38\\",\\n \\"LmActivityId\\": 679,\\n \\"BizId\\": \\"LMALL20******002\\",\\n \\"ActivityPicUrl\\": \\"\\",\\n \\"Name\\": \\"活动测试\\",\\n \\"LmActivitySessionModels\\": {\\n \\"LmActivitySessionModel\\": [\\n {\\n \\"SubBizCode\\": \\"3a92eb6******54005be358a43bd\\",\\n \\"EndDate\\": \\"2022-03-09 18:59:59\\",\\n \\"DisplayDate\\": \\"2022-03-08 18:59:59\\",\\n \\"Description\\": \\"活动秒杀\\",\\n \\"LmSessionId\\": 0,\\n \\"StartDate\\": \\"2022-03-08 00:00:00\\",\\n \\"BizId\\": \\"LMALL20******001\\",\\n \\"LmActivityId\\": 679,\\n \\"Name\\": \\"场次测试\\",\\n \\"ExtInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询当前所有未结束的活动',
'summary' => '通过此接⼝获取未结束的活动信息。',
'description' => '客户在Linkedmall控制台创建活动并由Linkedmall运营同学审批通过之后,可通过此接⼝获取未结束的活动信息。',
'responseParamsDescription' => '返回结果示例:'."\n"
."\n"
.' {'."\n"
.' "requestId": "da6fd480-3fc6-4912-a161-995807f2d7bb",'."\n"
.' "code": "Success",'."\n"
.' "message": null,'."\n"
.' "pageNumber": 1,'."\n"
.' "totalCount": 1,'."\n"
.' "pageSize": 20,'."\n"
.' "lmActivityModelExtList": ['."\n"
.' {'."\n"
.' "lmActivitySessionModels": ['."\n"
.' {'."\n"
.' "lmActivityId": 活动id,'."\n"
.' "lmSessionId": 场次id,'."\n"
.' "name": "场次名称",'."\n"
.' "description": "场次描述",'."\n"
.' "bizId": "业务id",'."\n"
.' "subBizCode": "⼦业务号",'."\n"
.' "displayDate": "场次展示时间",'."\n"
.' "startDate": "场次开始时间",'."\n"
.' "endDate": "场次结束时间",'."\n"
.' "extInfo": "额外的信息"'."\n"
.' } ],'."\n"
.' "startDate": "活动开始时间",'."\n"
.' "name": "活动名",'."\n"
.' "lmActivityId": 活动id,'."\n"
.' "endDate": "活动结束时间",'."\n"
.' "description": "活动描述",'."\n"
.' "bizId": "业务id",'."\n"
.' "activityPicUrl": "活动图⽚"'."\n"
.' }]'."\n"
.' }',
],
'QueryBizItemsWithActivity' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL201903220001',
],
],
[
'name' => 'LmItemIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'Lm侧商品查询列表,⼀次查询Lm侧itemId最多20个',
'type' => 'object',
'required' => false,
'docRequired' => true,
'example' => '[\\"10000230-60716881****\\",\\"10000021-59183191****\\"]',
],
],
[
'name' => 'ItemIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '查询列表,⼀次查询itemId最多20个',
'type' => 'object',
'required' => false,
'docRequired' => true,
'example' => '[\\"60716881****\\",\\"59183191****\\"]'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '1A0D9B6B-EBEA-5B7C-B10D-C4455F842637',
],
'ItemList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Item' => [
'description' => '商品列表',
'type' => 'array',
'items' => [
'description' => '商品列表',
'type' => 'object',
'properties' => [
'PicUrl' => [
'description' => '商品图片',
'type' => 'string',
'example' => 'https://img.alicdn.com/******.jpg',
],
'TotalSoldQuantity' => [
'description' => '总售卖数量',
'type' => 'integer',
'format' => 'int32',
'example' => '900',
],
'ItemTitle' => [
'description' => '商品标题',
'type' => 'string',
'example' => '葡萄吐司',
],
'MaxAllowedCount' => [
'description' => '最大可购买数量(-1表示无限制)',
'type' => 'integer',
'format' => 'int32',
'example' => '-1',
],
'SellerId' => [
'description' => '卖家ID',
'type' => 'integer',
'format' => 'int64',
'example' => '284324****',
],
'LmItemId' => [
'description' => 'Lm侧商品ID',
'type' => 'string',
'example' => '10000230-60716881****',
],
'CategoryId' => [
'description' => '商品类目ID',
'type' => 'integer',
'format' => 'int64',
'example' => '50018977',
],
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '60716881****'."\n",
],
'ReservePrice' => [
'description' => '商品原价(所有sku中活动价的最⾼价)',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'Quantity' => [
'description' => '商品库存',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
'TaobaoShopName' => [
'description' => '淘宝店铺名称',
'type' => 'string',
'example' => '橘子郡',
],
'SkuList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Sku' => [
'description' => '商品sku列表',
'type' => 'array',
'items' => [
'description' => '商品sku列表',
'type' => 'object',
'properties' => [
'Status' => [
'description' => 'sku状态',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PriceCent' => [
'description' => '渠道售价',
'type' => 'integer',
'format' => 'int64',
'example' => '2790',
],
'PointsInfo' => [
'type' => 'string',
],
'MaxAllowedCount' => [
'description' => '商品可售库存',
'type' => 'integer',
'format' => 'int32',
'example' => '1000',
],
'PointsKey' => [
'type' => 'string',
],
'SkuId' => [
'description' => 'skuId',
'type' => 'integer',
'format' => 'int64',
'example' => '472266643****',
],
'Points' => [
'description' => '积分数量',
'type' => 'integer',
'format' => 'int64',
'example' => '69',
],
'PointsAmount' => [
'description' => '积分抵扣价格',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Quantity' => [
'description' => 'sku库存',
'type' => 'integer',
'format' => 'int64',
'example' => '500',
],
],
],
],
],
],
'Activities' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Activity' => [
'description' => '活动列表',
'type' => 'array',
'items' => [
'description' => '活动列表',
'type' => 'object',
'properties' => [
'StartDate' => [
'description' => '活动开始时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1632412800000',
],
'LmActivityId' => [
'description' => '活动ID',
'type' => 'integer',
'format' => 'int64',
'example' => '679',
],
'EndDate' => [
'description' => '活动结束时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1642412800000'."\n",
],
'Title' => [
'description' => '活动标题',
'type' => 'string',
'example' => '***活动测试',
],
'Description' => [
'description' => '活动详情',
'type' => 'string',
'example' => '***活动测试'."\n",
],
'ActivitySessions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ActivitySession' => [
'description' => '活动场次',
'type' => 'array',
'items' => [
'description' => '活动场次',
'type' => 'object',
'properties' => [
'SubBizCode' => [
'description' => '子业务号',
'type' => 'string',
'example' => '5fbbd94******4345f6c37166fb',
],
'EndDate' => [
'description' => '场次结束时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1639412800000',
],
'DisplayDate' => [
'description' => '场次展示时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1633412800000',
],
'LmSessionId' => [
'description' => '场次ID',
'type' => 'integer',
'format' => 'int64',
'example' => '329',
],
'Description' => [
'description' => '场次详情',
'type' => 'string',
'example' => '""',
],
'StartDate' => [
'description' => '场次开始时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1634412800000',
],
'Title' => [
'description' => '场次标题',
'type' => 'string',
'example' => '***场次测试',
],
'ActivitySessionItem' => [
'description' => '活动场次商品列表',
'type' => 'object',
'properties' => [
'SessionQuantity' => [
'description' => '场次库存',
'type' => 'integer',
'format' => 'int64',
'example' => '888',
],
'LimitQuantityForPerson' => [
'description' => '个人限购数',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'SaleableQuantity' => [
'description' => '场次可售库存',
'type' => 'integer',
'format' => 'int64',
'example' => '888',
],
'ActivitySessionItemSkuList' => [
'description' => '场次商品sku列表',
'type' => 'object',
'properties' => [
'SkuId' => [
'description' => 'skuId',
'type' => 'integer',
'format' => 'int64',
'example' => '471******57',
],
'PriceCent' => [
'description' => '渠道售价',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'Points' => [
'description' => '积分数量',
'type' => 'integer',
'format' => 'int64',
'example' => '159',
],
'PointsAmount' => [
'description' => '积分抵扣价格',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
],
],
],
],
],
],
],
'ActivityItem' => [
'description' => '活动商品列表',
'type' => 'object',
'properties' => [
'ActivityQuantity' => [
'description' => '活动库存(-1表示无限制)',
'type' => 'integer',
'format' => 'int64',
'example' => '-1',
],
'LimitQuantityForPerson' => [
'description' => '个人限购数量',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'ActivityItemSkuList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ActivityItemSku' => [
'description' => '活动商品sku列表',
'type' => 'array',
'items' => [
'description' => '活动商品sku列表',
'type' => 'object',
'properties' => [
'ActivityPrice' => [
'description' => '活动价',
'type' => 'integer',
'format' => 'int64',
'example' => '990',
],
'SkuId' => [
'description' => 'skuId',
'type' => 'integer',
'format' => 'int64',
'example' => '471******57'."\n",
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'MissingParameter',
'errorMessage' => 'You must specify the parameter.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"1A0D9B6B-EBEA-5B7C-B10D-C4455F842637\\",\\n \\"ItemList\\": {\\n \\"Item\\": [\\n {\\n \\"PicUrl\\": \\"https://img.alicdn.com/******.jpg\\",\\n \\"TotalSoldQuantity\\": 900,\\n \\"ItemTitle\\": \\"葡萄吐司\\",\\n \\"MaxAllowedCount\\": -1,\\n \\"SellerId\\": 0,\\n \\"LmItemId\\": \\"10000230-60716881****\\",\\n \\"CategoryId\\": 50018977,\\n \\"ItemId\\": 0,\\n \\"ReservePrice\\": 2990,\\n \\"Quantity\\": 1000,\\n \\"TaobaoShopName\\": \\"橘子郡\\",\\n \\"SkuList\\": {\\n \\"Sku\\": [\\n {\\n \\"Status\\": 1,\\n \\"PriceCent\\": 2790,\\n \\"PointsInfo\\": \\"\\",\\n \\"MaxAllowedCount\\": 1000,\\n \\"PointsKey\\": \\"\\",\\n \\"SkuId\\": 0,\\n \\"Points\\": 69,\\n \\"PointsAmount\\": 0,\\n \\"Quantity\\": 500\\n }\\n ]\\n },\\n \\"Activities\\": {\\n \\"Activity\\": [\\n {\\n \\"StartDate\\": 1632412800000,\\n \\"LmActivityId\\": 679,\\n \\"EndDate\\": 1642412800000,\\n \\"Title\\": \\"***活动测试\\",\\n \\"Description\\": \\"***活动测试\\\\n\\",\\n \\"ActivitySessions\\": {\\n \\"ActivitySession\\": [\\n {\\n \\"SubBizCode\\": \\"5fbbd94******4345f6c37166fb\\",\\n \\"EndDate\\": 1639412800000,\\n \\"DisplayDate\\": 1633412800000,\\n \\"LmSessionId\\": 329,\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"StartDate\\": 1634412800000,\\n \\"Title\\": \\"***场次测试\\",\\n \\"ActivitySessionItem\\": {\\n \\"SessionQuantity\\": 888,\\n \\"LimitQuantityForPerson\\": 2,\\n \\"SaleableQuantity\\": 888,\\n \\"ActivitySessionItemSkuList\\": {\\n \\"SkuId\\": 0,\\n \\"PriceCent\\": 2990,\\n \\"Points\\": 159,\\n \\"PointsAmount\\": 0\\n }\\n }\\n }\\n ]\\n },\\n \\"ActivityItem\\": {\\n \\"ActivityQuantity\\": -1,\\n \\"LimitQuantityForPerson\\": 1,\\n \\"ActivityItemSkuList\\": {\\n \\"ActivityItemSku\\": [\\n {\\n \\"ActivityPrice\\": 990,\\n \\"SkuId\\": 0\\n }\\n ]\\n }\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询商品信息',
'summary' => '通过此接⼝可以查询参加活动的商品在业务商品库中的信息。',
'description' => '通过此接⼝可以查询参加活动的商品在业务商品库中的信息',
'responseParamsDescription' => '返回结果示例:'."\n"
."\n"
.' {'."\n"
.' "code":"SUCCESS",'."\n"
.' "itemList":['."\n"
.' {'."\n"
.' "activities":[//活动'."\n"
.' {'."\n"
.' "activityItem":{//活动商品'."\n"
.' "activityItemSkuList":['."\n"
.' {'."\n"
.' "activityPrice":活动价,'."\n"
.' "skuId":skuId'."\n"
.' }],'."\n"
.' "activityQuantity":活动库存(-1表示\'⽆限制\')'."\n"
.' },'."\n"
.' "activitySessions":[//活动场次'."\n"
.' {'."\n"
.' "activitySessionItem":{'."\n"
.' "activitySessionItemSkuList":{},'."\n"
.' "limitQuantityForPerson":个⼈限购数(-1表示\'⽆限制\'),'."\n"
.' "saleableQuantity":场次可售库存,'."\n"
.' "sessionQuantity":场次库存'."\n"
.' },'."\n"
.' "displayDate":场次展示时间,'."\n"
.' "endDate":场次结束时间,'."\n"
.' "lmSessionId":场次ID,'."\n"
.' "startDate":场次开始时间'."\n"
.' "subBizCode":"⼦业务号",'."\n"
.' "title":"场次标题"'."\n"
.' }],'."\n"
.' "endDate":活动结束时间,'."\n"
.' "lmActivityId":活动ID,'."\n"
.' "startDate":活动开始时间,'."\n"
.' "title":"活动标题"'."\n"
.' }],'."\n"
.' "categoryId":商品类⽬ID,'."\n"
.' "itemId":商品ID,'."\n"
.' "itemTitle":"商品标题",'."\n"
.' "lmItemId":"LM商品ID",'."\n"
.' "maxAllowedCount":最⼤可购买数量(-1表示⽆限制),'."\n"
.' "picUrl":"商品图⽚",'."\n"
.' "quantity":商品库存,'."\n"
.' "reservePrice":商品原价(所有sku中活动价的最⾼价),'."\n"
.' "sellerId":卖家ID,'."\n"
.' "skuList":['."\n"
.' {'."\n"
.' "maxAllowedCount":商品可售库存,'."\n"
.' "points":积分数量,'."\n"
.' "pointsAmount":积分抵扣价格,'."\n"
.' "priceCent":渠道售价,'."\n"
.' "quantity":sku库存,'."\n"
.' "skuId":skuId,'."\n"
.' "status":1'."\n"
.' }],'."\n"
.' "taobaoShopName":"淘宝店铺名称",'."\n"
.' "totalSoldQuantity":总售卖数量'."\n"
.' }],'."\n"
.' "message":"SUCCESS",'."\n"
.' "requestId":"78CA33E7-C5D4-4BA2-B9BD-4BF02F98DEDF"'."\n"
.' }',
],
'QueryUnfinishedSessions4Items' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'LmItemIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'lm侧商品ID列表',
'type' => 'object',
'required' => false,
'example' => '[\\"10000230-60716881****\\",\\"10000021-59183191****\\"]',
],
],
[
'name' => 'ItemIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '商品ID列表',
'type' => 'object',
'required' => false,
'example' => '[\\"60716881****\\",\\"59183191****\\"]',
],
],
[
'name' => 'QueryTime',
'in' => 'query',
'schema' => [
'description' => '查询时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1637294220',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'A209C555-3869-5259-9880-9747CBDA2B89',
],
'LmItemActivitySessionModelListList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmItemActivitySessionModelList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LmItemId' => [
'description' => 'lm侧商品ID',
'type' => 'string',
'example' => '10000230-60716881****',
],
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '60716881****',
],
'LmActivitySessionModels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmActivitySessionModel' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SubBizCode' => [
'description' => '子业务号',
'type' => 'string',
'example' => 'cf5eddd******105378a3ea27b67',
],
'EndDate' => [
'description' => '场次结束时间',
'type' => 'string',
'example' => '2022-04-01 00:00:00',
],
'DisplayDate' => [
'description' => '场次展示时间',
'type' => 'string',
'example' => '2022-03-30 13:53:00',
],
'LmSessionId' => [
'description' => '场次ID',
'type' => 'integer',
'format' => 'int64',
],
'Description' => [
'description' => '场次描述',
'type' => 'string',
'example' => '场次测试',
],
'StartDate' => [
'description' => '场次开始时间',
'type' => 'string',
'example' => '2022-03-30 14:00:00'."\n",
],
'LmActivityId' => [
'description' => '活动ID',
'type' => 'integer',
'format' => 'int64',
'example' => '679',
],
'BizId' => [
'description' => '业务ID',
'type' => 'string',
'example' => 'LMALL20******001',
],
'Name' => [
'description' => '场次名称',
'type' => 'string',
'example' => '场次测试',
],
'ExtInfo' => [
'description' => '扩展信息',
'type' => 'object',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"A209C555-3869-5259-9880-9747CBDA2B89\\",\\n \\"LmItemActivitySessionModelListList\\": {\\n \\"LmItemActivitySessionModelList\\": [\\n {\\n \\"LmItemId\\": \\"10000230-60716881****\\",\\n \\"ItemId\\": 0,\\n \\"LmActivitySessionModels\\": {\\n \\"LmActivitySessionModel\\": [\\n {\\n \\"SubBizCode\\": \\"cf5eddd******105378a3ea27b67\\",\\n \\"EndDate\\": \\"2022-04-01 00:00:00\\",\\n \\"DisplayDate\\": \\"2022-03-30 13:53:00\\",\\n \\"LmSessionId\\": 0,\\n \\"Description\\": \\"场次测试\\",\\n \\"StartDate\\": \\"2022-03-30 14:00:00\\\\n\\",\\n \\"LmActivityId\\": 679,\\n \\"BizId\\": \\"LMALL20******001\\",\\n \\"Name\\": \\"场次测试\\",\\n \\"ExtInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '根据商品查询其参加的未完成场次',
'summary' => '根据商品查询其参加的未完成场次。',
],
'CreateWithholdTrade' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'OutRequestNo',
'in' => 'formData',
'schema' => [
'description' => '外部请求号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '94A30BED-4321-4A94-B948-EB896493B4BF',
],
],
[
'name' => 'OutTradeNo',
'in' => 'formData',
'schema' => [
'description' => '外部交易流水号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '23******274',
],
],
[
'name' => 'Subject',
'in' => 'formData',
'schema' => [
'description' => '标题',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'BuyerId',
'in' => 'formData',
'schema' => [
'description' => '买家ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '12******209',
],
],
[
'name' => 'MerchantId',
'in' => 'formData',
'schema' => [
'description' => '商户ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '64******721',
],
],
[
'name' => 'TotalAmount',
'in' => 'formData',
'schema' => [
'description' => '总金额',
'type' => 'string',
'required' => false,
'example' => '6900',
],
],
[
'name' => 'Body',
'in' => 'formData',
'schema' => [
'description' => 'body参数',
'type' => 'string',
'required' => false,
'example' => '""',
],
],
[
'name' => 'GoodsDetail',
'in' => 'formData',
'schema' => [
'description' => '商品详情',
'type' => 'string',
'required' => false,
'example' => '""',
],
],
[
'name' => 'AgreementNo',
'in' => 'formData',
'schema' => [
'description' => '协议号',
'type' => 'string',
'required' => false,
'example' => '2021******59220',
],
],
[
'name' => 'SettleMode',
'in' => 'formData',
'schema' => [
'description' => '结算模式',
'type' => 'string',
'required' => false,
'example' => '""',
],
],
[
'name' => 'ExtInfo',
'in' => 'formData',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
'example' => '{"key":"value"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '返回码',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '返回信息',
'type' => 'string',
'example' => '成功',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '6103AD7B-21C2-523B-89D0-579DA58D08E8',
],
'WithholdTradeResponse' => [
'description' => '调用成功时,返回的数据。',
'type' => 'object',
'properties' => [
'PaymentDate' => [
'description' => '订单支付时间',
'type' => 'string',
'example' => '2022-04-01 12:00:00',
],
'TradeNo' => [
'description' => '交易流水号',
'type' => 'string',
'example' => '32******372',
],
'OutRequestNo' => [
'description' => '外部请求号',
'type' => 'string',
'example' => '57E4FE52-0750-4456-AA8F-ECC9FA0F8DF0',
],
'OutTradeNo' => [
'description' => '外部交易流水号',
'type' => 'string',
'example' => ' '."\n"
.'23******274'."\n",
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"6103AD7B-21C2-523B-89D0-579DA58D08E8\\",\\n \\"WithholdTradeResponse\\": {\\n \\"PaymentDate\\": \\"2022-04-01 12:00:00\\",\\n \\"TradeNo\\": \\"32******372\\",\\n \\"OutRequestNo\\": \\"57E4FE52-0750-4456-AA8F-ECC9FA0F8DF0\\",\\n \\"OutTradeNo\\": \\"\\\\t\\\\n23******274\\\\n\\"\\n }\\n}","type":"json"}]',
'title' => '代扣支付下单',
'summary' => '代扣支付下单。',
],
'CreatePayUrl' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务方标识',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20*****0001',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9f99f38030254728***',
],
],
[
'name' => 'BuyInfo',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃,填AccountType即可',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '渠道用户ID'."\n",
'type' => 'string',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '返回信息。',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '1718921E-C8D4-55E1-B8D4-114AE537C1B7',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'True',
],
'Model' => [
'description' => '返回的信息。',
'type' => 'object',
'properties' => [
'RedirectUrl' => [
'description' => '支付url',
'type' => 'string',
'example' => '"www.taobao.com"',
],
'PayTradeIds' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
'OrderIds' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
'LmOrderList' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"1718921E-C8D4-55E1-B8D4-114AE537C1B7\\",\\n \\"Success\\": true,\\n \\"Model\\": {\\n \\"RedirectUrl\\": \\"\\\\\\"www.taobao.com\\\\\\"\\",\\n \\"PayTradeIds\\": [\\n \\"\\"\\n ],\\n \\"OrderIds\\": [\\n \\"\\"\\n ],\\n \\"LmOrderList\\": [\\n \\"\\"\\n ]\\n }\\n}","type":"json"}]',
'title' => '创单并获取支付链接',
'summary' => '创单并获取支付链接。',
],
'GetWithholdSignPageUrl' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'OutRequestNo',
'in' => 'formData',
'schema' => [
'description' => '外部请求号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '0AF7F437-C869-477D-A21A-CF402493FFFE',
],
],
[
'name' => 'ExternalAgreementNo',
'in' => 'formData',
'schema' => [
'description' => '外部协议号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '223******2637',
],
],
[
'name' => 'MerchantId',
'in' => 'formData',
'schema' => [
'description' => '商户ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '64******721',
],
],
[
'name' => 'MerchantServiceName',
'in' => 'formData',
'schema' => [
'description' => '商户服务名',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '天猫****代扣',
],
],
[
'name' => 'MerchantServiceDescription',
'in' => 'formData',
'schema' => [
'description' => '商户服务描述',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '天猫******代扣',
],
],
[
'name' => 'IdentityParameters',
'in' => 'formData',
'schema' => [
'description' => '身份参数',
'type' => 'string',
'required' => false,
'example' => '""',
],
],
[
'name' => 'ReturnUrl',
'in' => 'formData',
'schema' => [
'description' => '返回地址',
'type' => 'string',
'required' => false,
'example' => '""',
],
],
[
'name' => 'NotifyUrl',
'in' => 'formData',
'schema' => [
'description' => '通知地址',
'type' => 'string',
'required' => false,
'example' => '""',
],
],
[
'name' => 'DeviceType',
'in' => 'formData',
'schema' => [
'description' => '设备类型',
'type' => 'string',
'required' => false,
'example' => '""',
],
],
[
'name' => 'ExtInfo',
'in' => 'formData',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '返回码',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '返回信息',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '6103AD7B-21C2-523B-89D0-579DA58D08E8',
],
'WithholdSignResponse' => [
'description' => '响应结果',
'type' => 'object',
'properties' => [
'PageUrl' => [
'description' => '页面地址',
'type' => 'string',
],
'OutRequestNo' => [
'description' => '外部请求号',
'type' => 'string',
'example' => '0AF7F437-C869-477D-A21A-CF402493FFFE',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"6103AD7B-21C2-523B-89D0-579DA58D08E8\\",\\n \\"WithholdSignResponse\\": {\\n \\"PageUrl\\": \\"\\",\\n \\"OutRequestNo\\": \\"0AF7F437-C869-477D-A21A-CF402493FFFE\\"\\n }\\n}","type":"json"}]',
'title' => '获取代扣签约地址',
'summary' => '获取代扣签约地址。',
],
'RefundOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'OutRequestNo',
'in' => 'formData',
'schema' => [
'description' => '外部请求号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '4111584A-44D8-49B6-80BD-FACD0726054C',
],
],
[
'name' => 'OutTradeNo',
'in' => 'formData',
'schema' => [
'description' => '外部交易流水号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '23******32727',
],
],
[
'name' => 'TradeNo',
'in' => 'formData',
'schema' => [
'description' => '交易流水号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'WH******27',
],
],
[
'name' => 'RefundReason',
'in' => 'formData',
'schema' => [
'description' => '退款原因',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '不想要',
],
],
[
'name' => 'RefundAmount',
'in' => 'formData',
'schema' => [
'description' => '退款金额',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '100',
],
],
[
'name' => 'RefundRoyaltyParameters',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'ExtInfo',
'in' => 'formData',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
[
'name' => 'MerchantId',
'in' => 'formData',
'schema' => [
'description' => '企业分配给阿里云的ID',
'type' => 'string',
'required' => false,
'example' => '64******721',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '返回码',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '返回信息',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '1718921E-C8D4-55E1-B8D4-114AE537C1B7',
],
'RefundResponse' => [
'description' => '成功退款信息',
'type' => 'object',
'properties' => [
'FundChange' => [
'type' => 'string',
],
'GmtRefundPay' => [
'type' => 'string',
],
'TradeNo' => [
'description' => '交易流水号',
'type' => 'string',
],
'OutTradeNo' => [
'description' => '外部交易流水号',
'type' => 'string',
'example' => ' '."\n"
.'23******32727'."\n",
],
'OutRequestNo' => [
'description' => '外部请求号',
'type' => 'string',
'example' => '4111584A-44D8-49B6-80BD-FACD0726054C',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"1718921E-C8D4-55E1-B8D4-114AE537C1B7\\",\\n \\"RefundResponse\\": {\\n \\"FundChange\\": \\"\\",\\n \\"GmtRefundPay\\": \\"\\",\\n \\"TradeNo\\": \\"\\",\\n \\"OutTradeNo\\": \\"\\\\t\\\\n23******32727\\\\n\\",\\n \\"OutRequestNo\\": \\"4111584A-44D8-49B6-80BD-FACD0726054C\\"\\n }\\n}","type":"json"}]',
'title' => '订单退款',
'summary' => '订单退款。',
],
'RepayForPayUrl' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20210802****',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9f99f38030254728***',
],
],
[
'name' => 'LmOrderId',
'in' => 'query',
'schema' => [
'description' => 'lm订单号',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '449975059**',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧ID',
'type' => 'string',
'required' => false,
'example' => '9f99f38030254728***'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'The specified parameter %s value is not valid.',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '1AF23E47-D8FB-576A-B069-CA98B4DE****',
],
'Model' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'FrontUrl' => [
'description' => '返回的支付链接',
'type' => 'string',
'example' => '""',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\",\\n \\"RequestId\\": \\"1AF23E47-D8FB-576A-B069-CA98B4DE****\\",\\n \\"Model\\": {\\n \\"FrontUrl\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n}","type":"json"}]',
'title' => '获取继续支付链接',
'summary' => '获取继续支付链接。',
'description' => '获取继续支付链接',
],
'UnsignWithholdAgreement' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'OutRequestNo',
'in' => 'formData',
'schema' => [
'description' => '外部请求号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'ExternalAgreementNo',
'in' => 'formData',
'schema' => [
'description' => '外部协议号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '234******3626',
],
],
[
'name' => 'MerchantId',
'in' => 'formData',
'schema' => [
'description' => '商户ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '64******721',
],
],
[
'name' => 'AgreementNo',
'in' => 'formData',
'schema' => [
'description' => '协议号',
'type' => 'string',
'required' => false,
'example' => '20******8006',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '6103AD7B-21C2-523B-89D0-579DA58D08E8',
],
'WithholdSignResponse' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'OutRequestNo' => [
'description' => '外部请求号',
'type' => 'string',
'example' => '""',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"6103AD7B-21C2-523B-89D0-579DA58D08E8\\",\\n \\"WithholdSignResponse\\": {\\n \\"OutRequestNo\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n}","type":"json"}]',
'title' => '代扣解约',
'summary' => '代扣解约。',
],
'CreateOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20201229****',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '221249435****',
],
],
[
'name' => 'OutTradeId',
'in' => 'query',
'schema' => [
'description' => '客户系统唯一订单号,由客户提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '14684075319554*****',
],
],
[
'name' => 'ItemId',
'in' => 'query',
'schema' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'docRequired' => true,
'example' => '57835029****',
],
],
[
'name' => 'Quantity',
'in' => 'query',
'schema' => [
'description' => '购买数量',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '100',
'default' => '1',
],
],
[
'name' => 'TotalAmount',
'in' => 'query',
'schema' => [
'description' => '订单总金额',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '4990',
'default' => '0',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '扩展字段',
'type' => 'string',
'required' => false,
'example' => '{}',
'default' => '{}',
],
],
[
'name' => 'DeliveryAddress',
'in' => 'query',
'schema' => [
'description' => '详细地址不足5个字符时请补齐5个字符',
'type' => 'string',
'required' => false,
'example' => '北京市朝阳区*******************',
],
],
[
'name' => 'OrderExpireTime',
'in' => 'query',
'schema' => [
'description' => '订单失效时间,默认值为15分钟',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '900',
'example' => '900000',
'default' => '900',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '必须对应C端唯一一个用户,企业不可使用一个ID代所有用户下单',
'type' => 'string',
'required' => false,
'example' => 'susan*******',
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
[
'name' => 'LmItemId',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'string',
'required' => false,
'example' => '10000035-6193664*****',
],
],
[
'name' => 'BuyerMessageMap',
'in' => 'query',
'schema' => [
'description' => '买家信息',
'type' => 'string',
'required' => false,
'example' => '买家信息json,可不填',
],
],
[
'name' => 'ItemList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '商品列表',
'type' => 'array',
'items' => [
'description' => '商品列表',
'type' => 'object',
'properties' => [
'SkuId' => [
'description' => '商品skuId',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '456458315****',
],
'LmItemId' => [
'description' => 'LM侧商品Id',
'type' => 'string',
'required' => false,
'example' => '10000035-61936646****',
],
'ItemId' => [
'description' => '商品Id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '64750262****',
],
'Quantity' => [
'description' => '下单数量',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'DA2554FD-F21F-536F-A7B7-B96C3E5F****',
],
'Success' => [
'description' => '调用是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '1004',
],
'Code' => [
'description' => '成功:"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'RESULT_STATUS_UNKOWN',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => 'SUCCESS',
],
'TotalCount' => [
'description' => '总订单数量',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'LogsId' => [
'description' => '废弃',
'type' => 'string',
'example' => '1',
],
'Model' => [
'description' => '订单信息,从返回的model对象中取出LmOrderList字段',
'type' => 'object',
'properties' => [
'RedirectUrl' => [
'description' => '重定向地址',
'type' => 'string',
'example' => '"www.taoba**.com"',
],
'LmOrderList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LmOrderList' => [
'description' => '订单主订单列表',
'type' => 'array',
'items' => [
'description' => '订单主订单列表',
'type' => 'object',
'properties' => [
'LmOrderId' => [
'description' => '订单主订单号',
'type' => 'string',
'example' => '39435****',
],
],
],
],
],
],
'PayTradeIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PayTradeIds' => [
'description' => '交易单号',
'type' => 'array',
'items' => [
'description' => '交易单号',
'type' => 'string',
'example' => '[2324289*******,238478******]',
],
],
],
],
'OrderIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'OrderIds' => [
'description' => '淘宝订单id列表',
'type' => 'array',
'items' => [
'description' => '淘宝订单id列表',
'type' => 'string',
'example' => '2113691583*****',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA2554FD-F21F-536F-A7B7-B96C3E5F****\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"1004\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"RESULT_STATUS_UNKOWN\\",\\n \\"SubCode\\": \\"SUCCESS\\",\\n \\"TotalCount\\": 1,\\n \\"LogsId\\": \\"1\\",\\n \\"Model\\": {\\n \\"RedirectUrl\\": \\"\\\\\\"www.taoba**.com\\\\\\"\\",\\n \\"LmOrderList\\": {\\n \\"LmOrderList\\": [\\n {\\n \\"LmOrderId\\": \\"39435****\\"\\n }\\n ]\\n },\\n \\"PayTradeIds\\": {\\n \\"PayTradeIds\\": [\\n \\"[2324289*******,238478******]\\"\\n ]\\n },\\n \\"OrderIds\\": {\\n \\"OrderIds\\": [\\n \\"2113691583*****\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => '废弃',
'summary' => '已废弃,请勿使用。',
'description' => '配送方式将以后端查询到的为主。'."\n"
."\n"
.' 有免邮时,使用免邮的配送方式。'."\n"
."\n"
.'无免邮时,则使用邮费最少的配送方式。'."\n"
."\n"
.'注意:此接口目前存在已知缺陷,请使用下单、支付分离的接口。'."\n"
."\n"
.'当返回支付为决时(code=WITHHOLD_RESULT_STATUS_UNKOWN),不代表订单支付失败,同时linkedmall有重试支付15分钟的逻辑,只有订单状态为8时,才能认为订单失败,其他状态可联系linkedmall技术确认原因,不可轻易将钱退给用户',
'requestParamsDescription' => 'ItemList:'."\n"
."\n"
.' {'."\n"
.' "itemId" : "xxx",'."\n"
.' "skuId" : "xxx", '."\n"
.' "quantity": "下单数量 "'."\n"
.' }'."\n"
.'DeliveryAddress:'."\n"
."\n"
.' {'."\n"
.' "divisionCode":"区/县的4级divisionCode(街道/镇的上一级地址)" , //该字段可以通过queryAddress接口获取'."\n"
.' "townDivisionCode":"街道/镇的5级divisionCode", //该字段可以通过queryAddress接口获取'."\n"
.' "fullName":"收货人姓名",'."\n"
.' "mobile":"收货人电话"'."\n"
.' }',
'responseParamsDescription' => 'Model数据结构:'."\n"
.' '."\n"
.' {'."\n"
.' "lmOrderList":['."\n"
.' {'."\n"
.' "lmOrderId":"linkedmall主订单id"'."\n"
.' }'."\n"
.' ],'."\n"
.' "orderIds":["淘宝订单id"],'."\n"
.' "redirectUrl":"RESULT_STATUS_SUCCESS"'."\n"
.' }',
],
'QueryItemDetail' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20201228****',
],
],
[
'name' => 'ItemId',
'in' => 'query',
'schema' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '62501739****',
],
],
[
'name' => 'LmItemId',
'in' => 'query',
'schema' => [
'description' => 'lm侧商品id',
'type' => 'string',
'required' => false,
'example' => '10000035-61936646****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'E46C790E-B1F2-51EF-B6F8-B52404B5****',
],
'Success' => [
'description' => '调用是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '1004',
],
'Code' => [
'description' => '成功:"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'BizItemGroup [LMALL20210830****] has not the item [65728655****].',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '1004',
],
'Item' => [
'description' => '商品信息',
'type' => 'object',
'properties' => [
'ItemTitle' => [
'description' => '商品名称',
'type' => 'string',
'example' => '生龙888g佬米酒',
],
'MinPoints' => [
'description' => '最少积分',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'DescOption' => [
'description' => '商品详情描述',
'type' => 'string',
'example' => '"
"',
],
'VideoPicUrl' => [
'description' => '视频头图链接地址',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg'."\n",
],
'ExtJson' => [
'description' => '拓展字段',
'type' => 'string',
'example' => '{}',
],
'IsSellerPayPostfee' => [
'description' => '是否卖家包邮',
'type' => 'boolean',
'example' => 'true',
],
'LmItemCategory' => [
'description' => '商品类别',
'type' => 'string',
'example' => 'entity',
],
'SellerPayPostfee' => [
'description' => '是否卖家包邮',
'type' => 'boolean',
'example' => 'true',
],
'ReservePrice' => [
'description' => '划线价',
'type' => 'integer',
'format' => 'int64',
'example' => '4990',
],
'Quantity' => [
'description' => '库存数量',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'VideoUrl' => [
'description' => '视频链接地址',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg'."\n",
],
'CustomizedAttributeMap' => [
'description' => '买家信息',
'type' => 'object',
'example' => '{}',
],
'IforestPropsJson' => [
'description' => 'json格式的产品属性',
'type' => 'string',
'example' => '{}',
],
'PropertiesJson' => [
'description' => 'json格式的产品参数',
'type' => 'string',
'example' => '{}',
],
'IforestProps' => [
'description' => '商品详情页商品名称下面的三列属性',
'type' => 'string',
'example' => '[]',
],
'LmItemId' => [
'description' => 'lm侧商品id',
'type' => 'string',
'example' => '10000043-64818014****',
],
'SellerId' => [
'description' => '卖家id',
'type' => 'integer',
'format' => 'int64',
'example' => '424414****',
],
'TbShopName' => [
'description' => '淘宝店铺名称',
'type' => 'string',
'example' => '橘子郡',
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'example' => '64407904****',
],
'CanSell' => [
'description' => '是否可售',
'type' => 'boolean',
'example' => 'true',
],
'CenterInventory' => [
'description' => '主站是否有库存',
'type' => 'boolean',
'example' => 'true',
],
'SellerType' => [
'description' => '卖家类型:0-淘宝卖家,1-天猫卖家',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'TotalSoldQuantity' => [
'description' => '商品在tmall的销量',
'type' => 'integer',
'format' => 'int32',
'example' => '199',
],
'MainPicUrl' => [
'description' => '主图地址',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg'."\n",
],
'MinPrice' => [
'description' => '商品价格',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'IsCanSell' => [
'description' => '是否可售',
'type' => 'boolean',
'example' => 'true',
],
'CategoryId' => [
'description' => '类目的ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '5001****',
],
'DescPath' => [
'description' => '商品详情图片地址',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg'."\n",
],
'Properties' => [
'description' => '产品参数',
'type' => 'string',
'example' => '{}',
],
'Skus' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Sku' => [
'description' => '商品sku列表',
'type' => 'array',
'items' => [
'description' => '商品sku列表',
'type' => 'object',
'properties' => [
'PriceCent' => [
'description' => '客户端销售价格,目前不支持不同区域不同定价',
'type' => 'integer',
'format' => 'int64',
'example' => '4990',
],
'LmItemId' => [
'description' => 'lm侧商品id',
'type' => 'string',
'example' => '10000102-64426301****',
],
'PointPrice' => [
'description' => '积分价格',
'type' => 'integer',
'format' => 'int64',
'example' => '4990',
],
'CanSell' => [
'description' => '是否可售',
'type' => 'boolean',
'example' => 'true'."\n",
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'example' => '63894836****',
],
'SkuTitle' => [
'description' => 'sku名称,如:白色/64G。由各个属性拼成,/分割',
'type' => 'string',
'example' => '白色/64G',
],
'SkuPropertiesJson' => [
'description' => 'josn格式的商品sku参数',
'type' => 'string',
'example' => '{}',
],
'ExtJson' => [
'description' => '拓展字段',
'type' => 'string',
'example' => '{}',
],
'SkuProperties' => [
'description' => '商品sku参数',
'type' => 'string',
],
'SkuId' => [
'description' => 'skuId,虚拟商品为-1',
'type' => 'integer',
'format' => 'int64',
'example' => '456458315****',
],
'SkuPicUrl' => [
'description' => 'sku图片',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg'."\n",
],
'Points' => [
'description' => '积分',
'type' => 'integer',
'format' => 'int64',
'example' => '2499',
],
'ReservePrice' => [
'description' => '划线价',
'type' => 'integer',
'format' => 'int64',
'example' => '4490',
],
'PointsAmount' => [
'description' => '积分金额',
'type' => 'integer',
'format' => 'int64',
'example' => '4490',
],
'Quantity' => [
'description' => '库存数量,虚拟商品为-1',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CustomizedAttributeMap' => [
'description' => '买家信息',
'type' => 'object',
'example' => '{}',
],
],
],
],
],
],
'ItemImages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ItemImage' => [
'description' => '商品图片列表',
'type' => 'array',
'items' => [
'description' => '商品图片列表',
'type' => 'string',
'example' => '[https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg]',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E46C790E-B1F2-51EF-B6F8-B52404B5****\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"1004\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"BizItemGroup [LMALL20210830****] has not the item [65728655****].\\",\\n \\"SubCode\\": \\"1004\\",\\n \\"Item\\": {\\n \\"ItemTitle\\": \\"生龙888g佬米酒\\",\\n \\"MinPoints\\": 2990,\\n \\"DescOption\\": \\"\\\\\\"
\\\\\\"\\",\\n \\"VideoPicUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\\\n\\",\\n \\"ExtJson\\": \\"{}\\",\\n \\"IsSellerPayPostfee\\": true,\\n \\"LmItemCategory\\": \\"entity\\",\\n \\"SellerPayPostfee\\": true,\\n \\"ReservePrice\\": 4990,\\n \\"Quantity\\": 1,\\n \\"VideoUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\\\n\\",\\n \\"CustomizedAttributeMap\\": {},\\n \\"IforestPropsJson\\": \\"{}\\",\\n \\"PropertiesJson\\": \\"{}\\",\\n \\"IforestProps\\": \\"[]\\",\\n \\"LmItemId\\": \\"10000043-64818014****\\",\\n \\"SellerId\\": 0,\\n \\"TbShopName\\": \\"橘子郡\\",\\n \\"ItemId\\": 0,\\n \\"CanSell\\": true,\\n \\"CenterInventory\\": true,\\n \\"SellerType\\": 0,\\n \\"TotalSoldQuantity\\": 199,\\n \\"MainPicUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\\\n\\",\\n \\"MinPrice\\": 2990,\\n \\"IsCanSell\\": true,\\n \\"CategoryId\\": 0,\\n \\"DescPath\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\\\n\\",\\n \\"Properties\\": \\"{}\\",\\n \\"Skus\\": {\\n \\"Sku\\": [\\n {\\n \\"PriceCent\\": 4990,\\n \\"LmItemId\\": \\"10000102-64426301****\\",\\n \\"PointPrice\\": 4990,\\n \\"CanSell\\": true,\\n \\"ItemId\\": 0,\\n \\"SkuTitle\\": \\"白色/64G\\",\\n \\"SkuPropertiesJson\\": \\"{}\\",\\n \\"ExtJson\\": \\"{}\\",\\n \\"SkuProperties\\": \\"\\",\\n \\"SkuId\\": 0,\\n \\"SkuPicUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\\\n\\",\\n \\"Points\\": 2499,\\n \\"ReservePrice\\": 4490,\\n \\"PointsAmount\\": 4490,\\n \\"Quantity\\": 1,\\n \\"CustomizedAttributeMap\\": {}\\n }\\n ]\\n },\\n \\"ItemImages\\": {\\n \\"ItemImage\\": [\\n \\"[https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg]\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => '查询商品详情',
'summary' => '交易场景查看商品使用。',
'description' => '查询商品详情',
],
'QueryAllCinemas' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'CityCode',
'in' => 'query',
'schema' => [
'description' => '城市编码',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '330100',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前⻚码,从1开始',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '6103AD7B-21C2-523B-89D0-579DA58D08E8',
],
'Success' => [
'description' => '调用是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '1004',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '205',
],
'TotalCount' => [
'description' => '影院总数',
'type' => 'integer',
'format' => 'int64',
'example' => '19',
],
'LogsId' => [
'description' => '无效字段',
'type' => 'string',
'example' => '1',
],
'Cinemas' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Cinema' => [
'description' => '电影院列表',
'type' => 'array',
'items' => [
'description' => '电影院列表',
'type' => 'object',
'properties' => [
'StandardId' => [
'description' => '广电总局发放给影院的8位标准影院编码',
'type' => 'string',
'example' => '42112601',
],
'ScheduleCloseTime' => [
'description' => '影院场次提前关闭时间,单位分钟'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '15',
],
'CityId' => [
'description' => '影院所属城市ID',
'type' => 'integer',
'format' => 'int64',
'example' => '330100',
],
'CinemaName' => [
'description' => '影院名称',
'type' => 'string',
'example' => '""',
],
'CityName' => [
'description' => '城市名称',
'type' => 'string',
'example' => '深圳市',
],
'Address' => [
'description' => '影院地址',
'type' => 'string',
'example' => '""',
],
'Longitude' => [
'description' => '影院经度',
'type' => 'string',
'example' => '""',
],
'Latitude' => [
'description' => '影院纬度',
'type' => 'string',
'example' => '""',
],
'Phone' => [
'description' => '影院电话',
'type' => 'string',
'example' => '""',
],
'Id' => [
'description' => '影院ID',
'type' => 'integer',
'format' => 'int64',
'example' => '153',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6103AD7B-21C2-523B-89D0-579DA58D08E8\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"1004\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"205\\",\\n \\"TotalCount\\": 19,\\n \\"LogsId\\": \\"1\\",\\n \\"Cinemas\\": {\\n \\"Cinema\\": [\\n {\\n \\"StandardId\\": \\"42112601\\",\\n \\"ScheduleCloseTime\\": 15,\\n \\"CityId\\": 330100,\\n \\"CinemaName\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CityName\\": \\"深圳市\\",\\n \\"Address\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Longitude\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Latitude\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Phone\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Id\\": 153\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取城市对应的电影院',
'summary' => '开通电影服务客户使用。',
],
'QueryHotMovies' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'CityCode',
'in' => 'query',
'schema' => [
'description' => '城市编码',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '310100',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '1AF23E47-D8FB-576A-B069-CA98B4DE****',
],
'Success' => [
'description' => '调用是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => 'SUCCESS',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '205',
],
'LogsId' => [
'description' => '无效字段',
'type' => 'string',
'example' => '1',
],
'Movies' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Movie' => [
'description' => '影片列表',
'type' => 'array',
'items' => [
'description' => '影片列表',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '影片类型',
'type' => 'string',
'example' => '剧情',
],
'MovieVersion' => [
'description' => '影片版本',
'type' => 'string',
'example' => '""',
],
'BackgroundPicture' => [
'description' => '影片背景图',
'type' => 'string',
'example' => '""',
],
'Remark' => [
'description' => '评分',
'type' => 'string',
'example' => '9.7',
],
'OpenDay' => [
'description' => '上映日期,格式YYYY-MM-DD HH:MM:SS',
'type' => 'string',
'example' => '2022-04-01 12:00:00',
],
'Highlight' => [
'description' => '精彩点评',
'type' => 'string',
'example' => '""',
],
'Language' => [
'description' => '对白语言',
'type' => 'string',
'example' => '""',
],
'OpenTime' => [
'description' => '上映时间',
'type' => 'string',
'example' => '2022-04-01 12:00:00'."\n",
],
'Director' => [
'description' => '导演',
'type' => 'string',
'example' => '""',
],
'Poster' => [
'description' => '海报',
'type' => 'string',
'example' => '""',
],
'MovieName' => [
'description' => '影片名称',
'type' => 'string',
'example' => '""',
],
'Description' => [
'description' => '影片简介',
'type' => 'string',
'example' => '""',
],
'Country' => [
'description' => '国家',
'type' => 'string',
'example' => '""',
],
'Duration' => [
'description' => '影片播放时长',
'type' => 'integer',
'format' => 'int64',
'example' => '190',
],
'MovieNameEn' => [
'description' => '影片英文名',
'type' => 'string',
'example' => '""',
],
'LeadingRole' => [
'description' => '主演',
'type' => 'string',
'example' => '""',
],
'Id' => [
'description' => '影片ID',
'type' => 'integer',
'format' => 'int64',
'example' => '5790',
],
'MovieTypeList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MovieTypeList' => [
'description' => '影片类型列表,内容如:2D、IMAX3D、3D、IMAX、剧情、其他等',
'type' => 'array',
'items' => [
'description' => '影片类型',
'type' => 'string',
'example' => '剧情',
],
],
],
],
'TrailerList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TrailerList' => [
'description' => '剧照列表',
'type' => 'array',
'items' => [
'description' => '剧照',
'type' => 'string',
'example' => '""',
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AF23E47-D8FB-576A-B069-CA98B4DE****\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"SUCCESS\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"205\\",\\n \\"LogsId\\": \\"1\\",\\n \\"Movies\\": {\\n \\"Movie\\": [\\n {\\n \\"Type\\": \\"剧情\\",\\n \\"MovieVersion\\": \\"\\\\\\"\\\\\\"\\",\\n \\"BackgroundPicture\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Remark\\": \\"9.7\\",\\n \\"OpenDay\\": \\"2022-04-01 12:00:00\\",\\n \\"Highlight\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Language\\": \\"\\\\\\"\\\\\\"\\",\\n \\"OpenTime\\": \\"2022-04-01 12:00:00\\\\n\\",\\n \\"Director\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Poster\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MovieName\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Country\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Duration\\": 190,\\n \\"MovieNameEn\\": \\"\\\\\\"\\\\\\"\\",\\n \\"LeadingRole\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Id\\": 5790,\\n \\"MovieTypeList\\": {\\n \\"MovieTypeList\\": [\\n \\"剧情\\"\\n ]\\n },\\n \\"TrailerList\\": {\\n \\"TrailerList\\": [\\n \\"\\\\\\"\\\\\\"\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取某个城市的正在热映的电影',
'summary' => '获取某个城市的正在热映的电影。',
],
'QueryMovieComments' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'PrivateKey' => [],
],
[
'APP' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'MovieId',
'in' => 'query',
'schema' => [
'description' => '影片ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页页码,从1开始',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '42A19B5E-B9A0-5D41-91D0-CC316A97B92A',
],
'Success' => [
'description' => '请求是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '1004',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '205',
],
'LogsId' => [
'description' => '无效字段',
'type' => 'string',
'example' => '1',
],
'Count' => [
'description' => '符合过滤条件的记录数',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'CommentList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Comment' => [
'description' => '评论列表',
'type' => 'array',
'items' => [
'description' => '评论列表',
'type' => 'object',
'properties' => [
'Remark' => [
'description' => '评分',
'type' => 'integer',
'format' => 'int64',
'example' => '9',
],
'FavorCount' => [
'description' => '点赞数',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
'Subject' => [
'description' => '评论标题',
'type' => 'string',
'example' => '观***有感',
],
'MovieId' => [
'description' => '影片ID',
'type' => 'integer',
'format' => 'int64',
'example' => '""',
],
'NickName' => [
'description' => '用户昵称',
'type' => 'string',
'example' => '""',
],
'Content' => [
'description' => '评论内容',
'type' => 'string',
'example' => '""',
],
'Id' => [
'description' => '评论ID',
'type' => 'integer',
'format' => 'int64',
'example' => '6331',
],
'CommentTime' => [
'description' => '评论时间',
'type' => 'string',
'example' => '""',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42A19B5E-B9A0-5D41-91D0-CC316A97B92A\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"1004\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"205\\",\\n \\"LogsId\\": \\"1\\",\\n \\"Count\\": 1,\\n \\"CommentList\\": {\\n \\"Comment\\": [\\n {\\n \\"Remark\\": 9,\\n \\"FavorCount\\": 1000,\\n \\"Subject\\": \\"观***有感\\",\\n \\"MovieId\\": 0,\\n \\"NickName\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Id\\": 6331,\\n \\"CommentTime\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询电影评论',
'summary' => '开通电影服务客户使用。',
],
'QueryMovieSchedules' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'CinemaId',
'in' => 'query',
'schema' => [
'description' => '电影院ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '1718921E-C8D4-55E1-B8D4-114AE537C1B7',
],
'Success' => [
'description' => '调用是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '1004',
],
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '207',
],
'LogsId' => [
'description' => '废弃',
'type' => 'string',
'example' => '1',
],
'Schedules' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Schedule' => [
'description' => '电影排期列表',
'type' => 'array',
'items' => [
'description' => '电影排期列表'."\n"
."\n",
'type' => 'object',
'properties' => [
'MovieVersion' => [
'description' => '影片版本',
'type' => 'string',
],
'SessionEndingTime' => [
'description' => '场次结束时间',
'type' => 'string',
'example' => '2022-04-01 12:00:00',
],
'MaxCanBuy' => [
'description' => '同一个场次最多可购买的座位数',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'MovieId' => [
'description' => '影片ID',
'type' => 'integer',
'format' => 'int64',
],
'ScheduleArea' => [
'description' => '场次分区价信息',
'type' => 'string',
],
'HallName' => [
'description' => '影厅名称',
'type' => 'string',
],
'IsExpired' => [
'description' => '是否已过期',
'type' => 'boolean',
'example' => 'false',
],
'SessionStartingTime' => [
'description' => '场次开始时间',
'type' => 'string',
'example' => '2022-04-01 10:00:00'."\n",
],
'Price' => [
'description' => '价格(分)',
'type' => 'integer',
'format' => 'int64',
'example' => '5000',
],
'SectionId' => [
'description' => '如果有值,表示上下两层影厅',
'type' => 'string',
'example' => '00001:楼下',
],
'ReleaseDate' => [
'description' => '影片上映日期',
'type' => 'string',
],
'CinemaId' => [
'description' => '影院ID',
'type' => 'integer',
'format' => 'int64',
],
'ServiceFee' => [
'description' => '服务费',
'type' => 'integer',
'format' => 'int64',
],
'Id' => [
'description' => '场次ID',
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1718921E-C8D4-55E1-B8D4-114AE537C1B7\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"1004\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"207\\",\\n \\"LogsId\\": \\"1\\",\\n \\"Schedules\\": {\\n \\"Schedule\\": [\\n {\\n \\"MovieVersion\\": \\"\\",\\n \\"SessionEndingTime\\": \\"2022-04-01 12:00:00\\",\\n \\"MaxCanBuy\\": 2,\\n \\"MovieId\\": 0,\\n \\"ScheduleArea\\": \\"\\",\\n \\"HallName\\": \\"\\",\\n \\"IsExpired\\": false,\\n \\"SessionStartingTime\\": \\"2022-04-01 10:00:00\\\\n\\",\\n \\"Price\\": 5000,\\n \\"SectionId\\": \\"00001:楼下\\",\\n \\"ReleaseDate\\": \\"\\",\\n \\"CinemaId\\": 0,\\n \\"ServiceFee\\": 0,\\n \\"Id\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取影院所有上映电影的排期',
'summary' => '获取影院所有上映电影的排期。',
],
'QueryMovieSeats' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******004',
],
],
[
'name' => 'ScheduleId',
'in' => 'query',
'schema' => [
'description' => '排期ID'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '9******5',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '79C01D47-3C44-57D9-BC99-1B33F7ED14B8',
],
'Success' => [
'description' => '请求是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '成功',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '1004',
],
'LogsId' => [
'description' => '无效字段',
'type' => 'string',
'example' => '1',
],
'SeatMap' => [
'description' => '座位信息',
'type' => 'object',
'properties' => [
'MaxCanBuy' => [
'description' => '同一个场次最多可购买的座位数',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'TipMessage' => [
'description' => '影院强制弹窗须知',
'type' => 'string',
'example' => '3D眼镜需要收费',
],
'MaxRow' => [
'description' => '最大行'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'MinColumn' => [
'description' => '最小列'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '15',
],
'MinTopPx' => [
'description' => '距离顶部最小间距'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'Notice' => [
'description' => '购票须知'."\n",
'type' => 'string',
'example' => '""',
],
'MaxColumn' => [
'description' => '最大列'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'Regular' => [
'description' => 'true 使用行列,false使用坐标'."\n",
'type' => 'boolean',
'example' => 'true',
],
'MaxTopPx' => [
'description' => '距离顶部最大间距'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'MaxLeftPx' => [
'description' => '距离左边最大间距'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'SoldCount' => [
'description' => '已售座位数'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '50',
],
'MinRow' => [
'description' => '最小行'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '15',
],
'SeatCount' => [
'description' => '座位总数量'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '150',
],
'MinLeftPx' => [
'description' => '距离左边最小间距'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'Seats' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Seat' => [
'description' => '座位列表',
'type' => 'array',
'items' => [
'description' => '座位列表',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '座位状态:1:可售,0:不可售,-1:删除(非法)'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'Flag' => [
'description' => '座位标识。0:普通座位,1:情侣首座(左座),2:情侣第二座(右座)'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ExtId' => [
'description' => '座位ID',
'type' => 'string',
'example' => '""',
],
'RowName' => [
'description' => '行名称'."\n",
'type' => 'string',
'example' => '""',
],
'TopPx' => [
'description' => '座位top偏移量,绘制座位图时的css样式,为30的倍数,例:top:30px'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'Area' => [
'description' => '区域',
'type' => 'string',
'example' => '""',
],
'Name' => [
'description' => '座位名称'."\n",
'type' => 'string',
'example' => 'VIP座位',
],
'LeftPx' => [
'description' => '座位left偏移量,绘制座位图时的css样式,为30的倍数,例:left:30px'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'Column' => [
'description' => '列'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'Row' => [
'description' => '行',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79C01D47-3C44-57D9-BC99-1B33F7ED14B8\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"成功\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"1004\\",\\n \\"LogsId\\": \\"1\\",\\n \\"SeatMap\\": {\\n \\"MaxCanBuy\\": 2,\\n \\"TipMessage\\": \\"3D眼镜需要收费\\",\\n \\"MaxRow\\": 20,\\n \\"MinColumn\\": 15,\\n \\"MinTopPx\\": 30,\\n \\"Notice\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MaxColumn\\": 20,\\n \\"Regular\\": true,\\n \\"MaxTopPx\\": 30,\\n \\"MaxLeftPx\\": 30,\\n \\"SoldCount\\": 50,\\n \\"MinRow\\": 15,\\n \\"SeatCount\\": 150,\\n \\"MinLeftPx\\": 30,\\n \\"Seats\\": {\\n \\"Seat\\": [\\n {\\n \\"Status\\": 1,\\n \\"Flag\\": 0,\\n \\"ExtId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RowName\\": \\"\\\\\\"\\\\\\"\\",\\n \\"TopPx\\": 30,\\n \\"Area\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Name\\": \\"VIP座位\\",\\n \\"LeftPx\\": 30,\\n \\"Column\\": 20,\\n \\"Row\\": 20\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => '获取影院具体电影排期的座位信息',
'summary' => '获取影院具体电影排期的座位信息。',
],
'QueryMovieTickets' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******002',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '业务用户ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '221******8495',
],
],
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'description' => '订单ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '14******42',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '5E2D59BA-4EB0-45C4-A0D7-D98C1A4B320B',
],
'Success' => [
'description' => '请求是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '1004',
],
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '1004',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'LogsId' => [
'description' => '废弃',
'type' => 'string',
'example' => '1',
],
'MovieTicket' => [
'description' => '电影票信息',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '电影票状态',
'type' => 'string',
],
'TbOrderId' => [
'description' => '淘宝订单号',
'type' => 'string',
],
'TicketContents' => [
'description' => '电影票的内容',
'type' => 'string',
],
'ReturnMessage' => [
'description' => '返回消息',
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E2D59BA-4EB0-45C4-A0D7-D98C1A4B320B\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"1004\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"1004\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"LogsId\\": \\"1\\",\\n \\"MovieTicket\\": {\\n \\"Status\\": \\"\\",\\n \\"TbOrderId\\": \\"\\",\\n \\"TicketContents\\": \\"\\",\\n \\"ReturnMessage\\": \\"\\"\\n }\\n}","type":"json"}]',
'title' => '获取出票信息',
'summary' => '获取出票信息。',
],
'QueryUpcomingMovies' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'CityCode',
'in' => 'query',
'schema' => [
'description' => '城市编码',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '110100',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '扩展信息',
'type' => 'object',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '9681B75A-1BE4-57D2-8C03-5B6BEF29378D',
],
'Success' => [
'description' => '调用是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '1004',
],
'Code' => [
'description' => '成功:"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '208',
],
'TotalCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '16',
],
'LogsId' => [
'description' => '无效字段',
'type' => 'string',
'example' => '1',
],
'Movies' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Movie' => [
'description' => '影片列表',
'type' => 'array',
'items' => [
'description' => '影片列表',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '影片类型',
'type' => 'string',
'example' => '剧情',
],
'MovieVersion' => [
'description' => '影片版本',
'type' => 'string',
],
'BackgroundPicture' => [
'description' => '影片背景图',
'type' => 'string',
],
'Remark' => [
'description' => '评分',
'type' => 'string',
'example' => '9.6',
],
'OpenDay' => [
'description' => '上映日期,格式YYYY-MM-DD HH:MM:SS',
'type' => 'string',
],
'Highlight' => [
'description' => '精彩点评',
'type' => 'string',
'example' => '""',
],
'MovieTypeList' => [
'description' => '影片类型,内容如:2D、IMAX3D、3D、IMAX、剧情、其他等',
'type' => 'string',
],
'Language' => [
'description' => '对白语言',
'type' => 'string',
'example' => '""',
],
'Director' => [
'description' => '导演',
'type' => 'string',
],
'OpenTime' => [
'description' => '上映时间',
'type' => 'string',
'example' => '2022-04-01 12:00:00',
],
'Poster' => [
'description' => '海报',
'type' => 'string',
'example' => '""',
],
'MovieName' => [
'description' => '影片名称',
'type' => 'string',
'example' => '""',
],
'Description' => [
'description' => '影片简介',
'type' => 'string',
'example' => '影片简介',
],
'Country' => [
'description' => '国家',
'type' => 'string',
'example' => '""',
],
'Duration' => [
'description' => '影片播放时长',
'type' => 'integer',
'format' => 'int64',
'example' => '190',
],
'MovieNameEn' => [
'description' => '影片英文名',
'type' => 'string',
'example' => '""',
],
'LeadingRole' => [
'description' => '主演',
'type' => 'string',
'example' => '""',
],
'Id' => [
'description' => '影片ID',
'type' => 'integer',
'format' => 'int64',
'example' => '1159177',
],
'TrailerList' => [
'description' => '剧照',
'type' => 'string',
'example' => '[]',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9681B75A-1BE4-57D2-8C03-5B6BEF29378D\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"1004\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"208\\",\\n \\"TotalCount\\": 16,\\n \\"LogsId\\": \\"1\\",\\n \\"Movies\\": {\\n \\"Movie\\": [\\n {\\n \\"Type\\": \\"剧情\\",\\n \\"MovieVersion\\": \\"\\",\\n \\"BackgroundPicture\\": \\"\\",\\n \\"Remark\\": \\"9.6\\",\\n \\"OpenDay\\": \\"\\",\\n \\"Highlight\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MovieTypeList\\": \\"\\",\\n \\"Language\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Director\\": \\"\\",\\n \\"OpenTime\\": \\"2022-04-01 12:00:00\\",\\n \\"Poster\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MovieName\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"影片简介\\",\\n \\"Country\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Duration\\": 190,\\n \\"MovieNameEn\\": \\"\\\\\\"\\\\\\"\\",\\n \\"LeadingRole\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Id\\": 1159177,\\n \\"TrailerList\\": \\"[]\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取某个城市的即将上线的电影',
'summary' => '购买电影服务客户使用。',
],
'ReleaseMovieSeat' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******005',
],
],
[
'name' => 'LockSeatApplyKey',
'in' => 'query',
'schema' => [
'description' => '锁座ID'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '业务用户ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '221249435****',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '3F43129B-020F-5F8A-88B0-9CBDE2AD6F52',
],
'Success' => [
'description' => '调用是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '1004',
],
'Code' => [
'description' => '成功:"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '205',
],
'LogsId' => [
'description' => '无效字段',
'type' => 'string',
'example' => '1',
],
'ActionResult' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'ReturnCode' => [
'description' => '0代表调用接口成功',
'type' => 'string',
'example' => '0',
],
'ReturnValue' => [
'description' => 'true代表成功,false代表失败',
'type' => 'string',
'example' => 'true',
],
'ReturnMessage' => [
'description' => '返回接口调用描述',
'type' => 'string',
'example' => '""',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F43129B-020F-5F8A-88B0-9CBDE2AD6F52\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"1004\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"205\\",\\n \\"LogsId\\": \\"1\\",\\n \\"ActionResult\\": {\\n \\"ReturnCode\\": \\"0\\",\\n \\"ReturnValue\\": \\"true\\",\\n \\"ReturnMessage\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n}","type":"json"}]',
'title' => '释放前面预定的电影座椅',
'summary' => '开通电影服务客户使用。',
],
'ReserveMovieSeat' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******003',
],
],
[
'name' => 'ScheduleId',
'in' => 'query',
'schema' => [
'description' => '排期ID'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '9******15',
],
],
[
'name' => 'SeatIds',
'in' => 'query',
'schema' => [
'description' => '座位ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'SeatNames',
'in' => 'query',
'schema' => [
'description' => '座位名称',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '11排13座',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '业务用户ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '22******85759',
],
],
[
'name' => 'Mobile',
'in' => 'query',
'schema' => [
'description' => '联系方式,手机号',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '186******71',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '5E2D59BA-4EB0-45C4-A0D7-D98C1A4B320B',
],
'Success' => [
'description' => '调用是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '成功',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '207',
],
'LogsId' => [
'description' => '无效字段',
'type' => 'string',
'example' => '1',
],
'ReservedSeat' => [
'description' => '锁座结果',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '状态'."\n"
.'LOCK_SUCCESS:锁座成功'."\n"
.'LOCK_DOING:正在创建',
'type' => 'string',
'example' => 'LOCKSUCCESS',
],
'ReservedTime' => [
'description' => '锁座成功的时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1649302236658',
],
'ApplyKey' => [
'description' => '锁座冥等串。下单出票接口需要传入该字段',
'type' => 'string',
'example' => '""',
],
'DefaultLockSecond' => [
'description' => '锁座时长。绝大部分影院是900s, 部分影院是600s',
'type' => 'integer',
'format' => 'int64',
'example' => '900',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E2D59BA-4EB0-45C4-A0D7-D98C1A4B320B\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"成功\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"207\\",\\n \\"LogsId\\": \\"1\\",\\n \\"ReservedSeat\\": {\\n \\"Status\\": \\"LOCKSUCCESS\\",\\n \\"ReservedTime\\": 1649302236658,\\n \\"ApplyKey\\": \\"\\\\\\"\\\\\\"\\",\\n \\"DefaultLockSecond\\": 900\\n }\\n}","type":"json"}]',
'title' => '预订电影座位',
'summary' => '基于电影排期和座位号给用户预订电影座位。',
],
'QueryBatchRegistAnonymousTbAccountResult' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20210125****',
],
],
[
'name' => 'BatchId',
'in' => 'query',
'schema' => [
'description' => 'batchId由批量注册淘宝账号接⼝返回',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '10418*******',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Status' => [
'description' => 'submit : 已提交;success: 全部成功;fail:全部失败;partSuccess:部分成功,部分失败',
'type' => 'string',
'example' => 'SUCCESS',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '5E2D59BA-4EB0-45C4-A0D7-D98C1A4B****',
],
'BatchId' => [
'description' => '查询条件由批量注册淘宝账号接⼝返回',
'type' => 'string',
'example' => '10418*******'."\n",
],
'FailIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FailId' => [
'description' => '注册失败的id列表',
'type' => 'array',
'items' => [
'description' => '注册失败的id列表',
'type' => 'string',
'example' => '["id1","id2"]',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"5E2D59BA-4EB0-45C4-A0D7-D98C1A4B****\\",\\n \\"BatchId\\": \\"10418*******\\\\n\\",\\n \\"FailIds\\": {\\n \\"FailId\\": [\\n \\"[\\\\\\"id1\\\\\\",\\\\\\"id2\\\\\\"]\\"\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询批量注册匿名淘宝账号结果',
'summary' => '内部使用。',
'description' => '由于批量注册淘宝账号接⼝是异步接⼝,需要使⽤查询接⼝来查询注册结果。',
],
'BatchRegistAnonymousTbAccount' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20210802****',
],
],
[
'name' => 'IdJsonList',
'in' => 'query',
'schema' => [
'description' => '客户侧⽤户ID列表(最多20个)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'idJsonList": "[\\"id1\\", \\"id2\\"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '37899973-5963-5028-BA54-180A5B107****',
],
'BatchId' => [
'description' => '调⽤查询注册结果接⼝时的查询条件',
'type' => 'string',
'example' => '[\\"id1\\", \\"id2\\"]',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"37899973-5963-5028-BA54-180A5B107****\\",\\n \\"BatchId\\": \\"[\\\\\\\\\\\\\\"id1\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"id2\\\\\\\\\\\\\\"]\\"\\n}","type":"json"}]',
'title' => '批量注册匿名淘宝帐户',
'summary' => '批量注册匿名淘宝帐户。',
'description' => '如果⽤户号⽐较⼤,需要提前进⾏账号注册,可以通过此接⼝批量注册淘宝账号(最多20个)',
'requestParamsDescription' => '请求参数示例:'."\n"
."\n"
.' {'."\n"
.' "bizid" : "xxx",'."\n"
.' "idJsonList": "[\\"id1\\", \\"id2\\"]"'."\n"
.' }',
],
'ValidateTaobaoAccount' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '42******681',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
'example' => '{}',
'default' => '{}',
],
],
[
'name' => 'TbUserNick',
'in' => 'query',
'schema' => [
'description' => '淘宝用户昵称',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'MobileNo',
'in' => 'query',
'schema' => [
'description' => '手机号',
'type' => 'string',
'required' => false,
'example' => '181****0115',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'DAAA6391-3339-5333-9E4D-C71CD26A231F',
],
'Success' => [
'description' => '请求是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '调用失败时,返回的出错信息',
'type' => 'string',
'example' => '1004',
],
'Code' => [
'description' => '成功:"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '205',
],
'TotalCount' => [
'description' => '总记录数',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'LogsId' => [
'description' => '废弃',
'type' => 'string',
],
'Model' => [
'type' => 'object',
'properties' => [
'Match' => [
'type' => 'boolean',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DAAA6391-3339-5333-9E4D-C71CD26A231F\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"1004\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"205\\",\\n \\"TotalCount\\": 5,\\n \\"LogsId\\": \\"\\",\\n \\"Model\\": {\\n \\"Match\\": true\\n }\\n}","type":"json"}]',
'title' => '验证淘宝账号',
'summary' => '验证淘宝账号。',
],
'RegistAnonymousTbAccount' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20190729****',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '238837487****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'FC994CBE-F97C-5C58-ACF3-86F0292C****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"FC994CBE-F97C-5C58-ACF3-86F0292C****\\"\\n}","type":"json"}]',
'title' => '注册匿名淘宝账号',
'summary' => '内部使用,客户无须对接。',
'description' => '注册单个淘宝账号接⼝',
'requestParamsDescription' => '入参示例:'."\n"
."\n"
.' {'."\n"
.' "bizid" : "xxx",'."\n"
.' "thirdPartyUserId": "xxx"'."\n"
.' }',
],
'GetCategoryChain' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******003',
],
],
[
'name' => 'CategoryId',
'in' => 'query',
'schema' => [
'description' => '类⽬ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'docRequired' => true,
'example' => '50012478',
],
],
[
'name' => 'ItemId',
'in' => 'query',
'schema' => [
'description' => '商品ID,不可与CategoryId同时为空',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'docRequired' => true,
'example' => '637284556514',
],
],
[
'name' => 'LmItemId',
'in' => 'query',
'schema' => [
'description' => 'lm侧商品ID',
'type' => 'string',
'required' => false,
'example' => '10000055-609650881234',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
],
'CategoryList' => [
'description' => '商品所属类⽬链;⽗类⽬在前,⼦类⽬在后。',
'type' => 'array',
'items' => [
'description' => '类目列表',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '类目名称',
'type' => 'string',
'example' => '生鲜',
],
'CategoryId' => [
'description' => '类目ID',
'type' => 'integer',
'format' => 'int64',
'example' => '12123',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"\\",\\n \\"CategoryList\\": [\\n {\\n \\"Name\\": \\"生鲜\\",\\n \\"CategoryId\\": 12123\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取类目信息链',
'summary' => '根据商品ID或类⽬ID查询类⽬信息。',
'description' => '客户可以根据商品ID或类⽬ID查询类⽬信息。',
'responseParamsDescription' => '返回值解析:'."\n"
."\n"
.' ['."\n"
.' {'."\n"
.' "categoryId": "类⽬ID",'."\n"
.' "name" : "类⽬名称"'."\n"
.' }'."\n"
.' ...'."\n"
.' ]',
],
'GetCategoryList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20*****08',
],
],
[
'name' => 'CategoryId',
'in' => 'query',
'schema' => [
'description' => '类目ID,0表示查询1级类目',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '50000852',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => '成功',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '96B4141C-A3CD-5162-B435-4780A75E3D97',
],
'CategoryList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Category' => [
'description' => '类目列表',
'type' => 'array',
'items' => [
'description' => '类目列表',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '类目名称',
'type' => 'string',
'example' => '生鲜',
],
'CategoryId' => [
'description' => '类目ID',
'type' => 'integer',
'format' => 'int64',
'example' => '12312312',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"96B4141C-A3CD-5162-B435-4780A75E3D97\\",\\n \\"CategoryList\\": {\\n \\"Category\\": [\\n {\\n \\"Name\\": \\"生鲜\\",\\n \\"CategoryId\\": 12312312\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取全量类目信息(逐级查询)',
'summary' => '查询业务库全量类⽬。',
'description' => '查询业务库全量类⽬',
'responseParamsDescription' => '类目列表: '."\n"
."\n"
.' ['."\n"
.' {'."\n"
.' "categoryId": "类⽬ID",'."\n"
.' "name" : "类⽬名称"'."\n"
.' },'."\n"
.' ...'."\n"
.' ]',
],
'ConfirmDisburse' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******01',
],
],
[
'name' => 'BizUid',
'in' => 'query',
'schema' => [
'description' => '和thirdPartyUserId传一样的值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9f99f38030254728***',
],
],
[
'name' => 'LmOrderId',
'in' => 'query',
'schema' => [
'description' => 'lm订单号',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '449975059**',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
'example' => '2',
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => [
'description' => '固定值:ANONY',
'type' => 'string',
'required' => false,
'example' => 'ANONY',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => '成功',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '1718921E-C8D4-55E1-B8D4-114AE537C1B7',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"1718921E-C8D4-55E1-B8D4-114AE537C1B7\\"\\n}","type":"json"}]',
'title' => '确认收货接口',
'summary' => '来确认收货。',
'description' => '只⽀持主订单确认收货',
],
'AddAddress' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL202202100002',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => '1',
],
],
[
'name' => 'AddressInfo',
'in' => 'formData',
'schema' => [
'description' => '地址信息',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{\\"addressId\\":\\"14530893759\\",\\"province\\":\\"北京\\",\\"city\\":\\"北京市\\",\\"area\\":\\"朝阳区\\",\\"town\\":\\"东风镇\\",\\"addressDetail\\":\\"测试地址,请勿发货\\",\\"fullName\\":\\"ty测试\\",\\"mobile\\":\\"13333333333\\",\\"status\\":0}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '返回码。',
'type' => 'string',
'example' => '200',
],
'Message' => [
'description' => '返回信息。',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '1718921E-C8D4-55E1-B8D4-114AE537C1B7',
],
'AddressId' => [
'description' => '地址id。',
'type' => 'integer',
'format' => 'int64',
'example' => '560100452',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"1718921E-C8D4-55E1-B8D4-114AE537C1B7\\",\\n \\"AddressId\\": 560100452\\n}","type":"json"}]',
'title' => '添加地址',
'summary' => '添加地址。',
],
'UpdateAddress' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMMINIAPP202004140002',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => '1',
],
],
[
'name' => 'AddressInfo',
'in' => 'formData',
'schema' => [
'description' => '地址信息',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{\\"addressId\\":\\"14530893759\\",\\"province\\":\\"北京\\",\\"city\\":\\"北京市\\",\\"area\\":\\"朝阳区\\",\\"town\\":\\"东风镇\\",\\"addressDetail\\":\\"测试地址,请勿发货\\",\\"fullName\\":\\"ty测试\\",\\"mobile\\":\\"13333333333\\",\\"status\\":0}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '返回码。',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '返回消息。',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '6103AD7B-21C2-523B-89D0-579DA58D08E8',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"6103AD7B-21C2-523B-89D0-579DA58D08E8\\"\\n}","type":"json"}]',
'title' => '更新地址',
'summary' => '更新用户地址。',
],
'QueryAddress' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL202106040001',
],
],
[
'name' => 'Ip',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'string',
'required' => false,
'example' => '113.77.105.73',
],
],
[
'name' => 'DivisionCode',
'in' => 'query',
'schema' => [
'description' => '配送区域ID(默认为1)',
'type' => 'string',
'required' => false,
'example' => '510132',
'default' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '1A0D9B6B-EBEA-5B7C-B10D-C4455F842637',
],
'DivisionAddress' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DivisionAddress' => [
'description' => '区域地址信息',
'type' => 'array',
'items' => [
'description' => '查询到的地址信息。',
'type' => 'object',
'properties' => [
'ParentId' => [
'description' => '父类层级ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '30226760',
],
'DivisionCode' => [
'description' => '地址区划码',
'type' => 'integer',
'format' => 'int64',
'example' => '210211019',
],
'DivisionLevel' => [
'description' => '地址等级',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'DivisionName' => [
'description' => '地址名称',
'type' => 'string',
'example' => '某市',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"1A0D9B6B-EBEA-5B7C-B10D-C4455F842637\\",\\n \\"DivisionAddress\\": {\\n \\"DivisionAddress\\": [\\n {\\n \\"ParentId\\": 30226760,\\n \\"DivisionCode\\": 210211019,\\n \\"DivisionLevel\\": 1,\\n \\"DivisionName\\": \\"某市\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询地址列表',
'summary' => '查询C端用户地址,满足用户下单时候收货地址查看的需要。',
'description' => '1为DivisionCode的根结点,从1开始按照返回结果可依次查询出、⼆、三、四、五级地址,即依次从返回结果中取值去查询下⼀级地址'."\n"
."\n\n"
.'注意:返回的divisionCode有跨级别的情况,例如通过2级(省)地址的divisionCode(410000)查询返回的3级(市)地址中包含4级地址(410881),此种原因是由于个别市为县级市',
],
'QueryAddressDetail' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL2******01',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => '1',
],
],
[
'name' => 'AddressInfo',
'in' => 'query',
'schema' => [
'description' => '地址信息',
'type' => 'string',
'required' => false,
'example' => '{\\"addressId\\":\\"14530893759\\",\\"province\\":\\"北京\\",\\"city\\":\\"北京市\\",\\"area\\":\\"朝阳区\\",\\"town\\":\\"东风镇\\",\\"addressDetail\\":\\"测试地址,请勿发货\\",\\"fullName\\":\\"ty**测试\\",\\"mobile\\":\\"133*****333\\",\\"status\\":0}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '返回信息。',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6103AD7B-21C2-523B-89D0-579DA58D08E8',
],
'DeliveryAddress' => [
'description' => '地址信息。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '收货地址状态 0: 非默认收获地址 1: 默认收获地址',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'PostCode' => [
'description' => '邮政编码。如果不传我们会写入 000000。',
'type' => 'string',
'example' => '518055',
],
'FullName' => [
'description' => '收货人全名。',
'type' => 'string',
'example' => '金*****股份有限公司',
],
'AddressDetail' => [
'description' => '详细收货地址。(只需要街道)',
'type' => 'string',
'example' => '********************',
],
'City' => [
'description' => '所属城市',
'type' => 'string',
'example' => '北京',
],
'AddressId' => [
'description' => '地址记录ID',
'type' => 'integer',
'format' => 'int64',
'example' => '313312207',
],
'DivisionCode' => [
'description' => '省市区代码',
'type' => 'string',
'example' => '321112104',
],
'Mobile' => [
'description' => '联系方式,手机号',
'type' => 'string',
'example' => '18941288583',
],
'Country' => [
'description' => '所属国家',
'type' => 'string',
'example' => 'CN',
],
'Area' => [
'description' => '区域',
'type' => 'string',
'example' => 'fujian',
],
'TownDivisionCode' => [
'description' => '第4级地址ID 镇、街道',
'type' => 'string',
],
'Town' => [
'description' => '城镇',
'type' => 'string',
'example' => '荔湾区',
],
'Province' => [
'description' => '省份',
'type' => 'string',
'example' => '北京市',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"6103AD7B-21C2-523B-89D0-579DA58D08E8\\",\\n \\"DeliveryAddress\\": {\\n \\"Status\\": 0,\\n \\"PostCode\\": \\"518055\\",\\n \\"FullName\\": \\"金*****股份有限公司\\",\\n \\"AddressDetail\\": \\"********************\\",\\n \\"City\\": \\"北京\\",\\n \\"AddressId\\": 313312207,\\n \\"DivisionCode\\": \\"321112104\\",\\n \\"Mobile\\": \\"18941288583\\",\\n \\"Country\\": \\"CN\\",\\n \\"Area\\": \\"fujian\\",\\n \\"TownDivisionCode\\": \\"\\",\\n \\"Town\\": \\"荔湾区\\",\\n \\"Province\\": \\"北京市\\"\\n }\\n}","type":"json"}]',
'title' => '查询地址详情',
'summary' => '根据地址id,查询地址信息。',
'description' => '地址相关的POP接口涉及到敏感数据,只提供给内部用户使用,比如多端商城,不开放给外部客户的。'."\n"
.'操作的是用户的淘宝账号的地址。',
'requestParamsDescription' => '入参AddressInfo为json字符串,实际用到的参数只有addressId,根据addressId查询用户的收货地址详情。',
],
'QueryAddressList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL2***100001',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => '12312',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '返回消息。',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '阿里云为该请求生成的唯一标识符。',
'type' => 'string',
'example' => '79C01D47-3C44-57D9-BC99-1B33F7ED14B8',
],
'AddressList' => [
'description' => '地址列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '收货地址状态 0: 非默认收获地址 1: 默认收获地址'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PostCode' => [
'description' => '邮政编码。如果不传我们会写入 000000。',
'type' => 'string',
'example' => '323050',
],
'FullName' => [
'description' => '收货人全名。'."\n"
."\n",
'type' => 'string',
'example' => '海***',
],
'AddressDetail' => [
'description' => '详细收货地址。(只需要街道)'."\n"
."\n",
'type' => 'string',
'example' => '*********************',
],
'City' => [
'description' => '市。',
'type' => 'string',
'example' => '北京市',
],
'AddressId' => [
'description' => '地址id',
'type' => 'integer',
'format' => 'int64',
'example' => '314304607',
],
'DivisionCode' => [
'description' => '四级配送区域编码,查询该区域库存。该字段通过queryAddress接⼝获取',
'type' => 'string',
'example' => '230921',
],
'Mobile' => [
'description' => '手机号。',
'type' => 'string',
'example' => '18611921898',
],
'Country' => [
'description' => '国家',
'type' => 'string',
'example' => 'CN',
],
'Area' => [
'description' => '区域',
'type' => 'string',
'example' => 'xianggang',
],
'TownDivisionCode' => [
'description' => '第4级地址ID 镇、街道'."\n"
."\n",
'type' => 'string',
],
'Town' => [
'description' => '城镇',
'type' => 'string',
'example' => '洪山区',
],
'Province' => [
'description' => '省份',
'type' => 'string',
'example' => '广东省',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"79C01D47-3C44-57D9-BC99-1B33F7ED14B8\\",\\n \\"AddressList\\": [\\n {\\n \\"Status\\": 1,\\n \\"PostCode\\": \\"323050\\",\\n \\"FullName\\": \\"海***\\",\\n \\"AddressDetail\\": \\"*********************\\",\\n \\"City\\": \\"北京市\\",\\n \\"AddressId\\": 314304607,\\n \\"DivisionCode\\": \\"230921\\",\\n \\"Mobile\\": \\"18611921898\\",\\n \\"Country\\": \\"CN\\",\\n \\"Area\\": \\"xianggang\\",\\n \\"TownDivisionCode\\": \\"\\",\\n \\"Town\\": \\"洪山区\\",\\n \\"Province\\": \\"广东省\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询地址列表',
'summary' => '查询C端用户地址,满足用户下单时候收货地址查看的需要。',
],
'RemoveAddress' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL202101250001',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'query',
'schema' => [
'description' => '客户侧用户ID',
'type' => 'string',
'required' => false,
'example' => '1221',
],
],
[
'name' => 'UseAnonymousTbAccount',
'in' => 'query',
'schema' => [
'description' => '废弃',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => '1',
],
],
[
'name' => 'AddressInfo',
'in' => 'formData',
'schema' => [
'description' => '地址信息',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{\\"addressId\\":\\"14530893759\\",\\"province\\":\\"北京\\",\\"city\\":\\"北京市\\",\\"area\\":\\"朝阳区\\",\\"town\\":\\"东风镇\\",\\"addressDetail\\":\\"测试地址,请勿发货\\",\\"fullName\\":\\"ty***测试\\",\\"mobile\\":\\"133****3333\\",\\"status\\":0}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功:"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '返回消息。',
'type' => 'string',
'example' => '成功',
],
'RequestId' => [
'description' => '阿里云为该请求生成的唯一标识符。',
'type' => 'string',
'example' => '5E2D59BA-4EB0-45C4-A0D7-D98C1A4B320B',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"5E2D59BA-4EB0-45C4-A0D7-D98C1A4B320B\\"\\n}","type":"json"}]',
'title' => '删除收货地址',
'summary' => '根据AddressInfo内的addressId参数删除收货地址。',
],
'AddItemToSubBizs' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'formData',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20190325****',
],
],
[
'name' => 'ItemId',
'in' => 'formData',
'schema' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '57835029****',
],
],
[
'name' => 'LmItemId',
'in' => 'formData',
'schema' => [
'description' => 'lm侧商品id',
'type' => 'string',
'required' => false,
'example' => '10001036-66644894****',
],
],
[
'name' => 'SubBizIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '子渠道ID',
'type' => 'object',
'required' => false,
'example' => '["id1", "id2"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'A7BE4356-7F92-533E-A31B-2EBF2D67****',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'MissingParameter',
'errorMessage' => 'You must specify the parameter.',
],
[
'errorCode' => 'linkedmall.errorcode.InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"A7BE4356-7F92-533E-A31B-2EBF2D67****\\"\\n}","type":"json"}]',
'title' => '添加商品到多个子渠道商品库中',
'summary' => '添加商品到多个子渠道商品库中。',
'description' => '添加商品到多个子渠道商品库中'."\n",
],
'CreateSettleConfirm' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'OutRequestNo',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'OutTradeNo',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'docRequired' => true,
],
],
[
'name' => 'TradeNo',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'docRequired' => true,
],
],
[
'name' => 'SettleInfo',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'MerchantId',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'ExtInfo',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'BizId',
'in' => 'formData',
'schema' => [
'title' => '业务ID',
'description' => '业务ID',
'type' => 'string',
'required' => false,
'example' => 'LMALL20******05',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '错误码。',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求id。',
'type' => 'string',
'example' => '5E2D59BA-4EB0-45C4-A0D7-D98C1A4B320B',
],
'TradeSettleConfirmResponse' => [
'type' => 'object',
'properties' => [
'TradeNo' => [
'type' => 'string',
],
'OutRequestNo' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'linkedmall.errorcode.InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"5E2D59BA-4EB0-45C4-A0D7-D98C1A4B320B\\",\\n \\"TradeSettleConfirmResponse\\": {\\n \\"TradeNo\\": \\"\\",\\n \\"OutRequestNo\\": \\"\\"\\n }\\n}","type":"json"}]',
'title' => '支付单结算',
'summary' => '支付单结算。',
],
'ModifyOrderDeliveryAddress' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20190325****',
],
],
[
'name' => 'ExtJson',
'in' => 'query',
'schema' => [
'description' => '拓展字段',
'type' => 'string',
'required' => false,
'example' => '{\\"mobileNo\\":\\"123****8965\\"}',
'default' => '{}',
],
],
[
'name' => 'DeliveryAddress',
'in' => 'query',
'schema' => [
'description' => '收货地址信息,json序列化后的字符串',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{\\"divisionCode\\":\\"44****\\",\\"addressDetail\\":\\"云城\\",\\"mobile\\":\\"180****0041\\",\\"fullName\\":\\"小宇\\",\\"townDivisionCode\\":\\"440******\\"}',
],
],
[
'name' => 'LmOrderId',
'in' => 'query',
'schema' => [
'description' => 'lm订单号',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '53396****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => '5E2D59BA-4EB0-45C4-A0D7-D98C1A4B****',
],
'Success' => [
'description' => '调用是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '调用成功时,返回的信息。',
'type' => 'string',
'example' => 'SUCCESS',
],
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'The specified parameter %s value is not valid.',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '1004',
],
'TotalCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '12',
],
'LogsId' => [
'description' => '每次请求操作对应的操作日志号,由系统自动生成,返回给租户,可用于排查问题,双方日志中统一透出此标识'."\n",
'type' => 'string',
'example' => '1',
],
'Model' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'ResultInfo' => [
'description' => '返回结果',
'type' => 'object',
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'linkedmall.errorcode.InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E2D59BA-4EB0-45C4-A0D7-D98C1A4B****\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"SUCCESS\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\",\\n \\"SubCode\\": \\"1004\\",\\n \\"TotalCount\\": 12,\\n \\"LogsId\\": \\"1\\",\\n \\"Model\\": {\\n \\"ResultInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n}","type":"json"}]',
'title' => '修改匿名账号收货地址',
'summary' => '修改匿名账号收货地址。',
'description' => '客户可以调⽤本接⼝修改订单绑定的收货地址,按照淘宝规则已经发货,退款的订单不能修改;每笔单只能修改⼀次; '."\n"
."\n"
.'注意:该接⼝仅⾯向匿名账号创建的订单。',
'requestParamsDescription' => 'deliveryAddress格式:(fullName限制2~25个字符,addressDetail为60个字符之内)'."\n"
.' '."\n"
.' {'."\n"
.' "divisionCode": "省市区代码",'."\n"
.' "townDivisionCode": "第4级地址ID 镇、街道",'."\n"
.' "addressDetail": "详细收货地址。(只需要街道)",'."\n"
.' "fullName": "收货⼈",'."\n"
.' "mobile": "⼿机号"'."\n"
.' }',
],
'QueryAdvertisementSettleInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'MediaSettleDetailId',
'in' => 'query',
'schema' => [
'description' => '媒体结算详情ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'ChannelId',
'in' => 'query',
'schema' => [
'description' => '渠道ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '5781******561',
],
],
[
'name' => 'SettleNo',
'in' => 'query',
'schema' => [
'description' => '结算单号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'TEST000000',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '开始时间',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '2021-08-01 00:00:00',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '结束时间',
'type' => 'string',
'required' => false,
'example' => '2021-08-01 01:00:00'."\n",
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页多少条记录,最大为20条',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前⻚码,从1开始',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'ExtInfo',
'in' => 'query',
'schema' => [
'description' => '扩展信息。',
'type' => 'string',
'required' => false,
'example' => '{"key":"value"}',
],
],
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => false,
'example' => 'LMALL20******006',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'D94987AE-2290-5084-AA34-53C50A245AFA',
],
'Success' => [
'description' => '调用是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '成功',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '206',
],
'TotalCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '19',
],
'LogsId' => [
'description' => '无效字段',
'type' => 'string',
'example' => '1',
],
'Model' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'PageNumber' => [
'description' => '当前⻚码,从1开始',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int32',
'example' => '19',
],
'AdvertiseSettleInfoList' => [
'description' => '广告结算单信息列表',
'type' => 'array',
'items' => [
'description' => '广告结算单信息列表',
'type' => 'object',
'properties' => [
'AdvertiseSettleDetailId' => [
'description' => '广告结算单ID',
'type' => 'string',
'example' => '""',
],
'CreateDate' => [
'description' => '创建时间',
'type' => 'string',
'example' => '2021-09-11 10:00:00'."\n",
],
'MediaSettleDetailId' => [
'description' => '媒体结算详情ID',
'type' => 'string',
'example' => '""',
],
'ExtInfo' => [
'description' => '扩展信息',
'type' => 'string',
'example' => '{}',
],
'EndTime' => [
'description' => '结束时间',
'type' => 'string',
'example' => '2021-09-11 10:01:00',
],
'StartTime' => [
'description' => '开始时间',
'type' => 'string',
'example' => '2021-09-11 10:00:00'."\n",
],
'SettleNo' => [
'description' => '结算单号',
'type' => 'string',
'example' => 'TEST000000',
],
'AdvertiseSettleAmount' => [
'description' => '广告结算金额',
'type' => 'string',
'example' => '1000',
],
'SettleStatus' => [
'description' => '结算状态',
'type' => 'string',
'example' => '""',
],
'AdvertiseName' => [
'description' => '广告名',
'type' => 'string',
'example' => '""',
],
'ChannelId' => [
'description' => '渠道ID',
'type' => 'string',
'example' => '5781******561'."\n",
],
'ModifiedDate' => [
'description' => '更新时间',
'type' => 'string',
'example' => '2021-09-11 10:01:00'."\n",
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'MissingParameter',
'errorMessage' => 'You must specify the parameter.',
],
[
'errorCode' => 'linkedmall.errorcode.InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D94987AE-2290-5084-AA34-53C50A245AFA\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"成功\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"206\\",\\n \\"TotalCount\\": 19,\\n \\"LogsId\\": \\"1\\",\\n \\"Model\\": {\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 19,\\n \\"AdvertiseSettleInfoList\\": [\\n {\\n \\"AdvertiseSettleDetailId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreateDate\\": \\"2021-09-11 10:00:00\\\\n\\",\\n \\"MediaSettleDetailId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ExtInfo\\": \\"{}\\",\\n \\"EndTime\\": \\"2021-09-11 10:01:00\\",\\n \\"StartTime\\": \\"2021-09-11 10:00:00\\\\n\\",\\n \\"SettleNo\\": \\"TEST000000\\",\\n \\"AdvertiseSettleAmount\\": \\"1000\\",\\n \\"SettleStatus\\": \\"\\\\\\"\\\\\\"\\",\\n \\"AdvertiseName\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ChannelId\\": \\"5781******561\\\\n\\",\\n \\"ModifiedDate\\": \\"2021-09-11 10:01:00\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询结算单明细(广告)',
'summary' => '查询结算单明细(广告)。',
],
'QueryBizItemListWithCache' => [
'summary' => ' 获取客户专属商品库全部商品(分⻚查询业务商品库)。',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'title' => 'pageNumber',
'description' => '分页页码,从1开始。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'ItemIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => 'itemIds',
'description' => '商品ID列表',
'type' => 'array',
'items' => [
'description' => '商品ID列表',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '[664148141***,663735776***]',
],
'required' => true,
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'title' => 'pageSize',
'description' => '每⻚多少条记录,最⼤20条',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
[
'name' => 'SubBizCode',
'in' => 'query',
'schema' => [
'title' => 'subBizCode',
'description' => '子业务号',
'type' => 'string',
'required' => true,
'example' => '7ddaba53d5be4173808f2335eac0****',
],
],
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'title' => 'bizId',
'description' => '业务的唯一标识号,由阿里云提供',
'type' => 'string',
'required' => true,
'example' => 'LMALL20211119****',
],
],
[
'name' => 'LmItemIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => 'lmItemIds',
'description' => 'lm侧商品ID列表',
'type' => 'array',
'items' => [
'description' => 'lm侧商品ID列表',
'type' => 'string',
'required' => false,
'example' => '[\\"10000230-60716881****\\",\\"10000021-59183191****\\"]',
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'result',
'description' => 'result',
'type' => 'object',
'properties' => [
'TotalCount' => [
'title' => 'totalCount',
'description' => '总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '13',
],
'Message' => [
'title' => 'message',
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'The specified parameter %s value is not valid.',
],
'PageSize' => [
'title' => 'pageSize',
'description' => '每页多少条记录,最大为20条',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'RequestId' => [
'title' => 'requestId',
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'F2D3CA1E-28BE-5E1C-B55F-81C8F290****',
],
'PageNumber' => [
'title' => 'pageNumber',
'description' => '分页页码,从1开始。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'ItemList' => [
'title' => 'model',
'description' => '返回的商品信息列表。',
'type' => 'array',
'items' => [
'description' => '返回的商品信息列表。',
'type' => 'object',
'properties' => [
'LmItemId' => [
'description' => 'lm侧商品ID',
'type' => 'string',
'example' => '10000102-64373376****',
],
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '65671280****',
],
'ItemTitle' => [
'title' => '商品名称',
'description' => '商品名称',
'type' => 'string',
'example' => '张君雅小妹妹100g鸡汁味点心面',
],
'MainPicUrl' => [
'title' => '商品主图',
'description' => '商品主图',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/220660702****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg',
],
'PriceCent' => [
'title' => '渠道售价,单位:分',
'description' => '渠道售价,单位:分',
'type' => 'integer',
'format' => 'int64',
'example' => '4990',
],
'PointPrice' => [
'title' => '用户支付价格:分',
'description' => '用户支付价格:分',
'type' => 'integer',
'format' => 'int64',
'example' => '4990',
],
'Points' => [
'title' => '积分,单位:个',
'description' => '积分,单位:个',
'type' => 'integer',
'format' => 'int64',
'example' => '4990',
],
'PointsAmount' => [
'title' => '积分抵扣的金额,单位:分',
'description' => '积分抵扣的金额,单位:分',
'type' => 'integer',
'format' => 'int64',
'example' => '4990',
],
'ReservePrice' => [
'title' => '商品原价(元)',
'description' => '商品原价(元)',
'type' => 'integer',
'format' => 'int64',
'example' => '9990',
],
'CanSell' => [
'title' => '商品是否可售卖',
'description' => '商品是否可售卖',
'type' => 'boolean',
'example' => 'true',
],
'Status' => [
'title' => '商品状态。1-商品可售;2-商品下架;3-价格异常;4-商品删除',
'description' => '商品状态。1-商品可售;2-商品下架;3-价格异常;4-商品删除',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
'Code' => [
'title' => 'code',
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Success' => [
'title' => 'success',
'description' => '调用是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 13,\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\",\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"F2D3CA1E-28BE-5E1C-B55F-81C8F290****\\",\\n \\"PageNumber\\": 1,\\n \\"ItemList\\": [\\n {\\n \\"LmItemId\\": \\"10000102-64373376****\\",\\n \\"ItemId\\": 0,\\n \\"ItemTitle\\": \\"张君雅小妹妹100g鸡汁味点心面\\",\\n \\"MainPicUrl\\": \\"https://img.alicdn.com/imgextra/i3/220660702****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\",\\n \\"PriceCent\\": 4990,\\n \\"PointPrice\\": 4990,\\n \\"Points\\": 4990,\\n \\"PointsAmount\\": 4990,\\n \\"ReservePrice\\": 9990,\\n \\"CanSell\\": true,\\n \\"Status\\": 1\\n }\\n ],\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '获取客户专属商品库全部商品',
'description' => ' 获取客户专属商品库全部商品(分⻚查询业务商品库)',
],
'QueryBudgetTicketItemListByBizId' => [
'summary' => '查询预算单商品列表。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'example' => 'LMALL20******003',
],
],
[
'name' => 'BudgetTicketNo',
'in' => 'query',
'schema' => [
'description' => '预算单号',
'type' => 'string',
'required' => false,
'example' => '20******-4',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页页码,从1开始。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页多少条记录,最大为20条',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '20',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '26F4B2C7-931F-5AC5-8FCC-AE76C9B00D2F',
],
'Success' => [
'description' => '调用是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'TotalCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '16',
],
'PageNumber' => [
'description' => '当前⻚码,从1开始',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'description' => '每页多少条记录,最大为20条',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'Model' => [
'description' => '返回结果',
'type' => 'array',
'items' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '65******0310',
],
'SkuId' => [
'description' => '商品的SkuId',
'type' => 'integer',
'format' => 'int64',
'example' => '47******76529',
],
'SettlementPrice' => [
'description' => '采购单价',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'SubsidyAmount' => [
'description' => '补贴金额',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'PromotionId' => [
'description' => '优惠元数据ID',
'type' => 'string',
'example' => '68442******012',
],
'SecurityCode' => [
'description' => '安全码',
'type' => 'string',
'example' => 'c26be******86e5a61cc710cdb',
],
'RemnantAmount' => [
'description' => '商品库存',
'type' => 'integer',
'format' => 'int64',
'example' => '10000',
],
'PoCode' => [
'description' => 'PO单编号',
'type' => 'string',
'example' => '""',
],
'Invalid' => [
'description' => 'PO单是否有效',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"26F4B2C7-931F-5AC5-8FCC-AE76C9B00D2F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"TotalCount\\": 16,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Model\\": [\\n {\\n \\"ItemId\\": 0,\\n \\"SkuId\\": 0,\\n \\"SettlementPrice\\": 100,\\n \\"SubsidyAmount\\": 10,\\n \\"PromotionId\\": \\"68442******012\\",\\n \\"SecurityCode\\": \\"c26be******86e5a61cc710cdb\\",\\n \\"RemnantAmount\\": 10000,\\n \\"PoCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Invalid\\": true\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询预算单商品列表',
],
'QueryGuideItemGroupWithOutInventory' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => [
'description' => '分组 ID',
'type' => 'string',
'required' => false,
'example' => 'taojinbi-shang******',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页页码,从1开始',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => 'LMALL20211206****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'A7BE4356-7F92-533E-A31B-2EBF2D67****',
],
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'PageSize' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'PageNumber' => [
'description' => '分页页码,从1开始',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TotalCount' => [
'description' => '导购商品组数量',
'type' => 'integer',
'format' => 'int64',
'example' => '19',
],
'ItemList' => [
'description' => '商品列表',
'type' => 'array',
'items' => [
'description' => '商品列表',
'type' => 'object',
'properties' => [
'ItemTitle' => [
'description' => '商品名称',
'type' => 'string',
'example' => '乐事65g白葡萄汽水味气泡薯片',
],
'PriceCent' => [
'description' => '商品销售价格(分)',
'type' => 'integer',
'format' => 'int64',
'example' => '4990',
],
'LmItemId' => [
'description' => 'lm侧商品ID',
'type' => 'string',
'example' => '10006515-64348848****',
],
'PointPrice' => [
'description' => '积分价格(分),给⽤户显示时使⽤,以及在⽤户⾃⼰⽀付时需要真实⽀付的⾦额。等于(priceCent - pointsAmount)',
'type' => 'integer',
'format' => 'int64',
'example' => '4990',
],
'ItemId' => [
'description' => '商品ID',
'type' => 'string',
'example' => '62785263****',
],
'WhitePicUrl' => [
'description' => '白底图',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg',
],
'MainPicUrl' => [
'description' => '主图地址',
'type' => 'string',
],
'Points' => [
'description' => '积分,单位:个。如果为空或为0,表示没有积分价格,pointsAmount也不会⽣效',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ItemUrl' => [
'description' => '商品详情链接',
'type' => 'string',
'example' => 'https://detail.tmall.com/item.htm?id=670600584601&spm=a21y2.8291224.2879496.9.c6e23569FJRVmu&skuId=500049906****',
],
'PointsAmount' => [
'description' => '积分抵扣的⾦额,单位:分。⽤户真实⽀付 (points个积分) + (pointPrice 分)',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ReservePrice' => [
'description' => '商品原价(元),可⽤于显示划线价',
'type' => 'string',
'example' => '5990',
],
'CustomizedAttributeMap' => [
'description' => '客户⾃定义属性',
'type' => 'object',
'example' => 'json数据',
],
'Tags' => [
'description' => '商品tags',
'type' => 'array',
'items' => [
'description' => '商品tags',
'type' => 'string',
'example' => '[{\\"TagKey\\":\\"test\\",\\"TagValue\\":\\"test-value\\"}]',
],
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'MissingParameter',
'errorMessage' => 'You must specify the parameter.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7BE4356-7F92-533E-A31B-2EBF2D67****\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 19,\\n \\"ItemList\\": [\\n {\\n \\"ItemTitle\\": \\"乐事65g白葡萄汽水味气泡薯片\\",\\n \\"PriceCent\\": 4990,\\n \\"LmItemId\\": \\"10006515-64348848****\\",\\n \\"PointPrice\\": 4990,\\n \\"ItemId\\": \\"62785263****\\",\\n \\"WhitePicUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\",\\n \\"MainPicUrl\\": \\"\\",\\n \\"Points\\": 0,\\n \\"ItemUrl\\": \\"https://detail.tmall.com/item.htm?id=670600584601&spm=a21y2.8291224.2879496.9.c6e23569FJRVmu&skuId=500049906****\\",\\n \\"PointsAmount\\": 0,\\n \\"ReservePrice\\": \\"5990\\",\\n \\"CustomizedAttributeMap\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Tags\\": [\\n \\"[{\\\\\\\\\\\\\\"TagKey\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TagValue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test-value\\\\\\\\\\\\\\"}]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询导购商品组信息',
'summary' => '获取导购商品组商品列表,包括实物商品和虚拟商品。',
'description' => '获取导购商品组商品列表,包括实物商品和虚拟商品',
],
'QueryInventoryOfItemsInBizItemGroup' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******001',
],
],
[
'name' => 'DivisionCode',
'in' => 'query',
'schema' => [
'description' => '配送区域ID(默认为1)',
'type' => 'string',
'required' => false,
'example' => '510132',
],
],
[
'name' => 'ItemIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '商品ID列表',
'type' => 'array',
'items' => [
'description' => '商品ID列表',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '[66******3823,65******7177,66******7302]',
],
'required' => false,
],
],
[
'name' => 'LmItemIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'lm侧商品ID列表',
'type' => 'array',
'items' => [
'description' => 'lm侧商品ID列表',
'type' => 'string',
'required' => false,
],
'required' => false,
],
],
[
'name' => 'SubBizId',
'in' => 'query',
'schema' => [
'description' => '子业务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '52847******1a58205d3ce5e9328',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '0F380CB1-BE49-5DF7-B128-63CADB3A12A3',
],
'ItemList' => [
'description' => '商品列表',
'type' => 'array',
'items' => [
'description' => '商品列表',
'type' => 'object',
'properties' => [
'LmItemId' => [
'description' => 'lm侧商品ID',
'type' => 'string',
'example' => '10016572-******058233'."\n",
],
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '******058233',
],
'Quantity' => [
'title' => '剩余可售库存',
'description' => '剩余可售库存',
'type' => 'integer',
'format' => 'int32',
'example' => '10000',
],
'SkuList' => [
'description' => '商品sku列表',
'type' => 'array',
'items' => [
'description' => '商品sku列表',
'type' => 'object',
'properties' => [
'SkuId' => [
'description' => '商品的SkuId',
'type' => 'integer',
'format' => 'int64',
'example' => '467******9928',
],
'Quantity' => [
'title' => '剩余可售库存',
'description' => '剩余可售库存',
'type' => 'integer',
'format' => 'int32',
'example' => '4100',
],
],
],
],
'TotalSoldQuantity' => [
'title' => '已售库存',
'description' => '已售库存',
'type' => 'integer',
'format' => 'int64',
'example' => '900',
],
'TotalQuantity' => [
'title' => '总量库存',
'description' => '总量库存',
'type' => 'integer',
'format' => 'int64',
'example' => '5000',
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'MissingParameter',
'errorMessage' => 'You must specify the parameter.',
],
[
'errorCode' => 'linkedmall.errorcode.InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"0F380CB1-BE49-5DF7-B128-63CADB3A12A3\\",\\n \\"ItemList\\": [\\n {\\n \\"LmItemId\\": \\"10016572-******058233\\\\n\\",\\n \\"ItemId\\": 0,\\n \\"Quantity\\": 10000,\\n \\"SkuList\\": [\\n {\\n \\"SkuId\\": 0,\\n \\"Quantity\\": 4100\\n }\\n ],\\n \\"TotalSoldQuantity\\": 900,\\n \\"TotalQuantity\\": 5000\\n }\\n ]\\n}","type":"json"}]',
'title' => '批量查询业务商品库商品库存',
'summary' => '查询库存可用来判断商品是否可以售卖之用。',
],
'QueryItemInSubBizs' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务的唯一标识号,由阿里云提供'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20201229****',
],
],
[
'name' => 'ItemId',
'in' => 'query',
'schema' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '57835029****',
],
],
[
'name' => 'LmItemId',
'in' => 'query',
'schema' => [
'description' => 'lm侧商品id',
'type' => 'string',
'required' => false,
'example' => '10001036-66644894****',
],
],
[
'name' => 'SubBizIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '子渠道ID',
'type' => 'object',
'required' => false,
'example' => '["id1","id2"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'result',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '直接取入参值返回,用于日志追踪',
'type' => 'string',
'example' => 'DFBA1CD4-197E-51BB-A8CE-3A136D0B****',
],
'ItemBizList' => [
'description' => '商品详情列表',
'type' => 'array',
'items' => [
'description' => '商品详情列表'."\n"
."\n",
'type' => 'object',
'properties' => [
'ItemTitle' => [
'description' => '商品标题',
'type' => 'string',
'example' => '山楂球白巧克力',
],
'PropertiesJson' => [
'description' => 'json格式的商品参数',
'type' => 'string',
'example' => '{}',
],
'LmItemId' => [
'description' => 'lm侧商品ID',
'type' => 'string',
'example' => '10006484-64668317****',
],
'SellerId' => [
'description' => '卖家ID',
'type' => 'integer',
'format' => 'int64',
'example' => '329488****',
],
'TbShopName' => [
'description' => '淘宝店铺名称',
'type' => 'string',
'example' => '立白集团官方旗舰店',
],
'CanSell' => [
'description' => '是否可售',
'type' => 'boolean',
'example' => 'true',
],
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '62503849****',
],
'DescOption' => [
'description' => '商品详情描述',
'type' => 'string',
'example' => '""',
],
'MainPicUrl' => [
'description' => '主图地址',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg'."\n",
],
'CategoryId' => [
'description' => '最后⼀级的类⽬ID,之后会提供类⽬查询接⼝来获取商品所属类⽬信息',
'type' => 'integer',
'format' => 'int64',
'example' => '50444021',
],
'SubBizId' => [
'description' => '子渠道ID',
'type' => 'string',
'example' => '9f65e0905a544924b3cda147f28b****',
],
'ReservePrice' => [
'description' => '划线价',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'Quantity' => [
'description' => '库存数量,虚拟商品为-1',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'SkuList' => [
'description' => '商品sku列表',
'type' => 'array',
'items' => [
'description' => '商品sku列表',
'type' => 'object',
'properties' => [
'PriceCent' => [
'description' => '销售价格(分),priceCent表示客户端的销售价格,返回值以分为单位',
'type' => 'integer',
'format' => 'int64',
'example' => '1290',
],
'PointPrice' => [
'description' => '积分价格',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CanSell' => [
'description' => '是否可售',
'type' => 'boolean',
'example' => 'true',
],
'SkuTitle' => [
'description' => '商品sku名称',
'type' => 'string',
'example' => '白色/64G',
],
'SkuPropertiesJson' => [
'description' => 'json格式的商品sku参数',
'type' => 'string',
'example' => '""',
],
'SkuProperties' => [
'description' => '商品sku参数',
'type' => 'string',
'example' => '""',
],
'SkuId' => [
'description' => '商品的SkuId',
'type' => 'integer',
'format' => 'int64',
'example' => '474820025****',
],
'SkuPicUrl' => [
'description' => 'sku图片地址',
'type' => 'string',
'example' => 'https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg'."\n",
],
'Points' => [
'description' => '积分数量',
'type' => 'integer',
'format' => 'int64',
'example' => '4299',
],
'PointsAmount' => [
'description' => '积分抵扣价格',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ReservePrice' => [
'description' => '划线价',
'type' => 'integer',
'format' => 'int64',
'example' => '2990',
],
'BenefitId' => [
'description' => '商品权益ID',
'type' => 'string',
'example' => '202201050050220000000190****',
],
'CustomizedAttributeMap' => [
'description' => '买家信息',
'type' => 'object',
'example' => '{}',
],
],
],
],
'ItemImages' => [
'description' => '商品图片列表',
'type' => 'array',
'items' => [
'description' => '商品图片列表',
'type' => 'string',
'example' => '["pic1","pic2"]',
],
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'MissingParameter',
'errorMessage' => 'You must specify the parameter.',
],
[
'errorCode' => 'linkedmall.errorcode.InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"DFBA1CD4-197E-51BB-A8CE-3A136D0B****\\",\\n \\"ItemBizList\\": [\\n {\\n \\"ItemTitle\\": \\"山楂球白巧克力\\",\\n \\"PropertiesJson\\": \\"{}\\",\\n \\"LmItemId\\": \\"10006484-64668317****\\",\\n \\"SellerId\\": 0,\\n \\"TbShopName\\": \\"立白集团官方旗舰店\\",\\n \\"CanSell\\": true,\\n \\"ItemId\\": 0,\\n \\"DescOption\\": \\"\\\\\\"\\\\\\"\\",\\n \\"MainPicUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\\\n\\",\\n \\"CategoryId\\": 50444021,\\n \\"SubBizId\\": \\"9f65e0905a544924b3cda147f28b****\\",\\n \\"ReservePrice\\": 2990,\\n \\"Quantity\\": 1,\\n \\"SkuList\\": [\\n {\\n \\"PriceCent\\": 1290,\\n \\"PointPrice\\": 0,\\n \\"CanSell\\": true,\\n \\"SkuTitle\\": \\"白色/64G\\",\\n \\"SkuPropertiesJson\\": \\"\\\\\\"\\\\\\"\\",\\n \\"SkuProperties\\": \\"\\\\\\"\\\\\\"\\",\\n \\"SkuId\\": 0,\\n \\"SkuPicUrl\\": \\"https://img.alicdn.com/imgextra/i3/22066070*****/O1CN01jCtHkC1ZjO2Q8DWUk_!!0-item_pic.jpg\\\\n\\",\\n \\"Points\\": 4299,\\n \\"PointsAmount\\": 0,\\n \\"ReservePrice\\": 2990,\\n \\"BenefitId\\": \\"202201050050220000000190****\\",\\n \\"CustomizedAttributeMap\\": {}\\n }\\n ],\\n \\"ItemImages\\": [\\n \\"[\\\\\\"pic1\\\\\\",\\\\\\"pic2\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询商品',
'summary' => '查询商品子渠道商品库商品。',
'description' => '查询商品子渠道商品库商品'."\n",
],
'QueryMediaSettleInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'MediaName',
'in' => 'query',
'schema' => [
'description' => '媒体名称',
'type' => 'string',
'required' => false,
'docRequired' => true,
],
],
[
'name' => 'ChannelId',
'in' => 'query',
'schema' => [
'description' => '渠道ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
],
],
[
'name' => 'SettleNo',
'in' => 'query',
'schema' => [
'description' => '结算单号',
'type' => 'string',
'required' => false,
'docRequired' => true,
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '开始时间',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '2021-08-01 00:00:00',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '结束时间',
'type' => 'string',
'required' => false,
'example' => '2021-08-01 01:00:00'."\n",
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前⻚码,从1开始',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'ExtInfo',
'in' => 'query',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
],
],
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => false,
'example' => 'LMALL20******005',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'FAED4911-3F7D-56C0-880F-C4755D4F26D8',
],
'Success' => [
'description' => '请求是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '成功',
],
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '1004',
],
'TotalCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '19',
],
'LogsId' => [
'type' => 'string',
],
'Model' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'PageNumber' => [
'description' => '当前⻚码,从1开始',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int32',
'example' => '19',
],
'MediaSettleInfoList' => [
'description' => '媒体结算信息列表',
'type' => 'array',
'items' => [
'description' => '媒体结算信息列表',
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '结束时间',
'type' => 'string',
'example' => '2021-08-01 01:00:00',
],
'StartTime' => [
'description' => '开始时间',
'type' => 'string',
'example' => '2021-08-01 00:00:00',
],
'MediaSettleAmount' => [
'description' => '媒体结算金额',
'type' => 'string',
],
'SettleNo' => [
'description' => '结算单号',
'type' => 'string',
'example' => 'TEST000000',
],
'SettleStatus' => [
'description' => '结算状态',
'type' => 'string',
'example' => 'waitPayerConfirm',
],
'ChannelId' => [
'description' => '渠道ID',
'type' => 'string',
'example' => '63839******79044',
],
'MediaName' => [
'description' => '媒体名称',
'type' => 'string',
],
'MediaSettleDetailId' => [
'description' => '媒体结算详情',
'type' => 'string',
],
'ModifiedDate' => [
'description' => '更新时间',
'type' => 'string',
'example' => '2021-08-01 01:00:00',
],
'CreateDate' => [
'description' => '创建时间',
'type' => 'string',
'example' => '2021-08-01 00:00:00',
],
'ExtInfo' => [
'description' => '扩展信息',
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'MissingParameter',
'errorMessage' => 'You must specify the parameter.',
],
[
'errorCode' => 'linkedmall.errorcode.InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FAED4911-3F7D-56C0-880F-C4755D4F26D8\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"成功\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"1004\\",\\n \\"TotalCount\\": 19,\\n \\"LogsId\\": \\"\\",\\n \\"Model\\": {\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 19,\\n \\"MediaSettleInfoList\\": [\\n {\\n \\"EndTime\\": \\"2021-08-01 01:00:00\\",\\n \\"StartTime\\": \\"2021-08-01 00:00:00\\",\\n \\"MediaSettleAmount\\": \\"\\",\\n \\"SettleNo\\": \\"TEST000000\\",\\n \\"SettleStatus\\": \\"waitPayerConfirm\\",\\n \\"ChannelId\\": \\"63839******79044\\",\\n \\"MediaName\\": \\"\\",\\n \\"MediaSettleDetailId\\": \\"\\",\\n \\"ModifiedDate\\": \\"2021-08-01 01:00:00\\",\\n \\"CreateDate\\": \\"2021-08-01 00:00:00\\",\\n \\"ExtInfo\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询结算单明细(媒体)',
'summary' => '对账相关数据。',
],
'RegisterSettleAccount' => [
'summary' => '结算单账号注册。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'AccountNo',
'in' => 'formData',
'schema' => [
'description' => '账户号',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '15******65',
],
],
[
'name' => 'AccountName',
'in' => 'formData',
'schema' => [
'description' => '账号名称',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '***科技有限公司',
],
],
[
'name' => 'AccountType',
'in' => 'formData',
'schema' => [
'description' => '账号类型',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '""',
],
],
[
'name' => 'AccountChannel',
'in' => 'formData',
'schema' => [
'description' => '账号渠道',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'bank',
],
],
[
'name' => 'AccountPayType',
'in' => 'formData',
'schema' => [
'description' => '账号支付类型',
'type' => 'string',
'required' => false,
'example' => 'transferIn',
],
],
[
'name' => 'ExtInfo',
'in' => 'formData',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
[
'name' => 'BizId',
'in' => 'formData',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => false,
'example' => 'LMALL20******007',
],
],
[
'name' => 'IdempotentId',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'CountryOrAreaCode',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'Currency',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '26F4B2C7-931F-5AC5-8FCC-AE76C9B00D2F',
],
'Success' => [
'description' => '调用是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '1004',
],
'Code' => [
'description' => '成功时,返回"SUCCESS"。错误码见后面小节',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'SUCCESS',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '207',
],
'LogsId' => [
'description' => '无效字段',
'type' => 'string',
'example' => '1',
],
'Model' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '主键ID',
'description' => '主键ID',
'type' => 'string',
'example' => '252',
],
'AccountId' => [
'title' => '结算账号ID',
'description' => '结算账号ID',
'type' => 'string',
'example' => '180173763600****',
],
'AccountNo' => [
'title' => '入参账号no',
'description' => '入参账号no',
'type' => 'string',
'example' => '15******65',
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'MissingParameter',
'errorMessage' => 'You must specify the parameter.',
],
[
'errorCode' => 'ACL_CHECK_INVALID',
'errorMessage' => 'No Access Permission.',
],
[
'errorCode' => 'linkedmall.errorcode.InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"26F4B2C7-931F-5AC5-8FCC-AE76C9B00D2F\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"1004\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"207\\",\\n \\"LogsId\\": \\"1\\",\\n \\"Model\\": {\\n \\"Id\\": \\"252\\",\\n \\"AccountId\\": \\"180173763600****\\",\\n \\"AccountNo\\": \\"15******65\\"\\n }\\n}","type":"json"}]',
'title' => '结算单账号注册',
],
'ApplyRefundWithDesignatedTbUid' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'SubLmOrderId',
'in' => 'formData',
'schema' => [
'description' => '⼦订单ID,通过查询订单详情接⼝获取',
'type' => 'string',
'required' => true,
'example' => '702091003',
],
],
[
'name' => 'RefundCode',
'in' => 'formData',
'schema' => [
'description' => '退款状态码',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '3',
],
],
[
'name' => 'ReasonId',
'in' => 'formData',
'schema' => [
'description' => '退款申请原因ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '150013',
],
],
[
'name' => 'RefundFee',
'in' => 'formData',
'schema' => [
'description' => '本次退款金额,单位分',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '990',
],
],
[
'name' => 'GoodsStatus',
'in' => 'formData',
'schema' => [
'description' => '货物状态。当退款类型:仅退款时,货物状态:为4未发货。所有状态:4: 未发货,6:已发货, 1: 未收到货, 2: 已收到货, 3:已寄回, 5:卖家确认收货',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '2',
],
],
[
'name' => 'RefundCount',
'in' => 'formData',
'schema' => [
'description' => '退货数量',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'Message',
'in' => 'formData',
'schema' => [
'description' => '错误的时候,返回错误信息',
'type' => 'string',
'required' => false,
'example' => '款式不喜欢',
],
],
[
'name' => 'Proofs',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '凭证信息',
'type' => 'array',
'items' => [
'description' => '凭证信息',
'type' => 'object',
'properties' => [
'MessagePic' => [
'description' => '凭证图片地址(最好是阿里云的)',
'type' => 'string',
'required' => false,
'example' => 'https://aliyundoc.com',
],
'MessagePicDesc' => [
'description' => '图片说明',
'type' => 'string',
'required' => false,
'example' => '商品破损了',
],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'DisputeId',
'in' => 'formData',
'schema' => [
'description' => '纠纷ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '142***071',
],
],
[
'name' => 'BizId',
'in' => 'formData',
'schema' => [
'title' => '客户业务ID',
'description' => '客户业务ID',
'type' => 'string',
'required' => true,
'example' => 'LMALL20***001',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'formData',
'schema' => [
'title' => '企业侧用户ID',
'description' => '企业侧用户ID',
'type' => 'string',
'required' => true,
'example' => 'U333***21',
],
],
[
'name' => 'TbAccountType',
'in' => 'formData',
'schema' => [
'title' => '淘宝账号类型',
'description' => '淘宝账号类型',
'type' => 'string',
'required' => true,
'example' => 'ANONY',
],
],
[
'name' => 'TbUserId',
'in' => 'formData',
'schema' => [
'title' => '客户传递下单用户淘宝UID',
'description' => '客户传递下单用户淘宝UID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '333***21',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResponse>',
'description' => 'PopResponse
>',
'type' => 'object',
'properties' => [
'LogsId' => [
'title' => '每次请求操作对应的操作日志号,由系统自动生成,返回给租户,可用于排查问题,双方日志中统一透出此标识',
'description' => '每次请求操作对应的操作日志号,由系统自动生成,返回给租户,可用于排查问题,双方日志中统一透出此标识',
'type' => 'string',
'example' => '1',
],
'RequestId' => [
'title' => 'POP请求流水号,建议租户日志中也输出此流水号,双方排查问题方便',
'description' => 'POP请求流水号,建议租户日志中也输出此流水号,双方排查问题方便',
'type' => 'string',
'example' => '45B9EF4E-4D18-59B2-85E6-9B568F73C79D',
],
'SubCode' => [
'title' => '错误子代码。一般用于显示业务类的错误代码,一般建议关注此类错误',
'description' => '错误子代码。一般用于显示业务类的错误代码,一般建议关注此类错误',
'type' => 'string',
'example' => '206',
],
'SubMessage' => [
'title' => '业务处理相关的错误信息,一般建议关注此类错误',
'description' => '业务处理相关的错误信息,一般建议关注此类错误',
'type' => 'string',
'example' => '1004',
],
'PageSize' => [
'title' => 'pageSize',
'description' => 'pageSize',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'PageNumber' => [
'title' => '当前页',
'description' => '当前页',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TotalCount' => [
'title' => '总数量',
'description' => '总数量',
'type' => 'integer',
'format' => 'int64',
'example' => '80',
],
'Success' => [
'title' => '本次执行的结果成功与否',
'description' => '本次执行的结果成功与否',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'title' => '返回的执行结果码, 正确为字符串 0000',
'description' => '返回的执行结果码, 正确为字符串 0000',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'SUCCESS',
],
'Model' => [
'title' => '请求结果数据',
'description' => '请求结果数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemId' => [
'title' => '商品id',
'description' => '商品id',
'type' => 'string',
'example' => '65******0310',
],
'LmItemId' => [
'description' => 'LM商品ID',
'type' => 'string',
'example' => '10000102-630292778855',
],
'ItemTitle' => [
'title' => '商品名称',
'description' => '商品名称',
'type' => 'string',
'example' => '大自然酸菜(美好生鲜)',
],
'MainPicUrl' => [
'title' => '商品主图',
'description' => '商品主图',
'type' => 'string',
],
'WhitePicUrl' => [
'title' => '白底图',
'description' => '白底图',
'type' => 'string',
],
'AtmospherePicUrl' => [
'title' => '氛围图片(如:支付宝列表要求返回的主图第二张)',
'description' => '氛围图片(如:支付宝列表要求返回的主图第二张)',
'type' => 'string',
],
'ItemUrl' => [
'title' => '详情链接',
'description' => '详情链接',
'type' => 'string',
'example' => 'https://******.aliyun-inc.com/#/assistant?targetTab=TAB_GM_FAIL®ionId=9&startTime=2022-08-22%2000:00:00&endTime=2022-08-22%2018:06:01&appIds=408',
],
'PriceCent' => [
'title' => '商品销售价格(分)',
'description' => '商品销售价格(分)',
'type' => 'integer',
'format' => 'int64',
'example' => '780',
],
'Points' => [
'title' => '积分,单位:个。如果为空或为0,表示没有积分价格,pointsAmount也不会生效。',
'description' => '积分,单位:个。如果为空或为0,表示没有积分价格,pointsAmount也不会生效。',
'type' => 'integer',
'format' => 'int64',
'example' => '3980',
],
'PointsAmount' => [
'title' => '积分抵扣的金额,单位:分。用户真实支付 (points个积分) + (pointPrice 分钱)。需要打在订单标上,传给PMT',
'description' => '积分抵扣的金额,单位:分。用户真实支付 (points个积分) + (pointPrice 分钱)。需要打在订单标上,传给PMT',
'type' => 'integer',
'format' => 'int64',
'example' => '8000',
],
'PointPrice' => [
'title' => '积分价格(分),给用户显示时使用,以及在用户自己支付时需要真实支付的金额。',
'description' => '积分价格(分),给用户显示时使用,以及在用户自己支付时需要真实支付的金额。',
'type' => 'integer',
'format' => 'int64',
],
'ReservePrice' => [
'title' => '商品原价(元)',
'description' => '商品原价(元)',
'type' => 'string',
'example' => '1035',
],
'CustomizedAttributeMap' => [
'title' => '客户自定义属性',
'description' => '客户自定义属性',
'type' => 'object',
'additionalProperties' => [
'type' => 'string',
'description' => '客户自定义属性',
],
],
'Tags' => [
'title' => 'ic商品tags',
'description' => 'ic商品tags',
'type' => 'array',
'items' => [
'description' => '标签值。',
'type' => 'integer',
'format' => 'int32',
],
],
'CanSell' => [
'title' => '是否可售',
'description' => '是否可售',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidTag.Mismatch',
'errorMessage' => 'The specified Tag.n.Key and Tag.n.Value are not match.',
],
[
'errorCode' => 'InvalidTagCount',
'errorMessage' => 'The specified tags are beyond the permitted range.',
],
],
404 => [
[
'errorCode' => 'InvalidInstanceChargeType.NotFound',
'errorMessage' => 'The InstanceChargeType does not exist in our records',
],
[
'errorCode' => 'InvalidInternetChargeType.ValueNotSupported',
'errorMessage' => 'The specified InternetChargeType is not valid',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LogsId\\": \\"1\\",\\n \\"RequestId\\": \\"45B9EF4E-4D18-59B2-85E6-9B568F73C79D\\",\\n \\"SubCode\\": \\"206\\",\\n \\"SubMessage\\": \\"1004\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 80,\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Model\\": [\\n {\\n \\"ItemId\\": \\"65******0310\\",\\n \\"LmItemId\\": \\"10000102-630292778855\\",\\n \\"ItemTitle\\": \\"大自然酸菜(美好生鲜)\\",\\n \\"MainPicUrl\\": \\"\\",\\n \\"WhitePicUrl\\": \\"\\",\\n \\"AtmospherePicUrl\\": \\"\\",\\n \\"ItemUrl\\": \\"https://******.aliyun-inc.com/#/assistant?targetTab=TAB_GM_FAIL®ionId=9&startTime=2022-08-22%2000:00:00&endTime=2022-08-22%2018:06:01&appIds=408\\",\\n \\"PriceCent\\": 780,\\n \\"Points\\": 3980,\\n \\"PointsAmount\\": 8000,\\n \\"PointPrice\\": 0,\\n \\"ReservePrice\\": \\"1035\\",\\n \\"CustomizedAttributeMap\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Tags\\": [\\n 0\\n ],\\n \\"CanSell\\": true\\n }\\n ]\\n}","type":"json"}]',
'title' => '根据人群特征查询商品导购组',
'summary' => '根据人群特征查询商品导购组',
'description' => '根据人群特征查询商品导购组',
],
'QueryItemInventoryV2' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务Id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'LMALL20******01',
],
],
[
'name' => 'DivisionCode',
'in' => 'query',
'schema' => [
'description' => '四级配送区域编码,查询该区域库存。该字段通过queryAddress接⼝获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '520300',
],
],
[
'name' => 'Ip',
'in' => 'query',
'schema' => [
'description' => 'v2服务端的ip地址',
'type' => 'string',
'required' => false,
'example' => '113.77.105.73',
],
],
[
'name' => 'ItemList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '查询列表,一次查询itemId最多20个',
'type' => 'array',
'items' => [
'description' => '商品列表信息',
'type' => 'object',
'properties' => [
'LmItemId' => [
'description' => 'lm侧商品ID',
'type' => 'string',
'required' => false,
'example' => '10000035-61936646****',
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '60843842****',
],
'SkuIdList' => [
'description' => 'skuid列表,为json字符串',
'type' => 'array',
'format' => 'int64',
'items' => [
'description' => 'skuid列表,为json字符串',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '4890674122805',
],
'required' => false,
'maxItems' => 100,
],
],
'required' => false,
],
'required' => true,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '1718921E-C8D4-55E1-B8D4-114AE537C1B7',
],
'Success' => [
'description' => 'SUCCESS'."\n"
.'表示成功',
'type' => 'boolean',
'example' => 'SUCCESS',
],
'SubMessage' => [
'description' => '子错误信息',
'type' => 'string',
'example' => '成功',
],
'Code' => [
'description' => 'SUCCESS表示成功',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'description' => '失败时,返回具体原因',
'type' => 'string',
'example' => 'The bizId or lmOrderId is mandatory for this action.',
],
'SubCode' => [
'description' => '子错误码',
'type' => 'string',
'example' => '207',
],
'ItemList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Item' => [
'description' => '商品列表',
'type' => 'array',
'items' => [
'description' => '商品列表信息',
'type' => 'object',
'properties' => [
'LmItemId' => [
'description' => 'lm侧商品id',
'type' => 'string',
'example' => '10016572-654408058233'."\n",
],
'ItemId' => [
'description' => '商品id',
'type' => 'integer',
'format' => 'int64',
'example' => '65671280****',
],
'SkuList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Sku' => [
'description' => '商品sku列表',
'type' => 'array',
'items' => [
'description' => '商品sku列表',
'type' => 'object',
'properties' => [
'SkuId' => [
'description' => 'skuid',
'type' => 'integer',
'format' => 'int64',
'example' => '482694857****',
],
'Inventory' => [
'description' => '库存',
'type' => 'object',
'properties' => [
'Quantity' => [
'description' => '库存数量',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1718921E-C8D4-55E1-B8D4-114AE537C1B7\\",\\n \\"Success\\": true,\\n \\"SubMessage\\": \\"成功\\",\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"The bizId or lmOrderId is mandatory for this action.\\",\\n \\"SubCode\\": \\"207\\",\\n \\"ItemList\\": {\\n \\"Item\\": [\\n {\\n \\"LmItemId\\": \\"10016572-654408058233\\\\n\\",\\n \\"ItemId\\": 0,\\n \\"SkuList\\": {\\n \\"Sku\\": [\\n {\\n \\"SkuId\\": 0,\\n \\"Inventory\\": {\\n \\"Quantity\\": 10\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询商品库存数量(查询商品库存属性)',
],
'QueryOrderAndPaymentListWithDesignatedTbUid' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'FilterOption',
'in' => 'formData',
'schema' => [
'title' => '查询条件, 序列化com.aliyun.linkedmall.platform.service.taobaoitem.module.order.pop.FilterOption的json',
'description' => '查询条件,JSON字符串',
'type' => 'string',
'required' => true,
'example' => '{\\"enableStatus\\":0,\\"lmOrderList\\":[424***33]}',
],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'title' => '每页数量',
'description' => '每页数量',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => [
'title' => '页码',
'description' => '页码',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'BizId',
'in' => 'formData',
'schema' => [
'title' => '客户业务ID',
'description' => '客户业务ID',
'type' => 'string',
'required' => true,
'example' => 'LMALL2022***01',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'formData',
'schema' => [
'title' => '企业侧用户ID',
'description' => '企业侧用户ID',
'type' => 'string',
'required' => true,
'example' => 'R213***3121',
],
],
[
'name' => 'TbAccountType',
'in' => 'formData',
'schema' => [
'title' => '淘宝账号类型',
'description' => '淘宝账号类型',
'type' => 'string',
'required' => true,
'example' => 'REAL',
],
],
[
'name' => 'TbUserId',
'in' => 'formData',
'schema' => [
'title' => '客户传递下单用户淘宝UID',
'description' => '客户传递下单用户淘宝UID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '213***3121',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResponse
>',
'description' => 'PopResponse
>',
'type' => 'object',
'properties' => [
'LogsId' => [
'title' => '每次请求操作对应的操作日志号,由系统自动生成,返回给租户,可用于排查问题,双方日志中统一透出此标识',
'description' => '每次请求操作对应的操作日志号,由系统自动生成,返回给租户,可用于排查问题,双方日志中统一透出此标识',
'type' => 'string',
'example' => '1',
],
'RequestId' => [
'title' => 'POP请求流水号,建议租户日志中也输出此流水号,双方排查问题方便',
'description' => 'POP请求流水号,建议租户日志中也输出此流水号,双方排查问题方便',
'type' => 'string',
'example' => '6103AD7B-21***DE-A58D08E8',
],
'SubCode' => [
'title' => '错误子代码。一般用于显示业务类的错误代码,一般建议关注此类错误',
'description' => '错误子代码。一般用于显示业务类的错误代码,一般建议关注此类错误',
'type' => 'string',
'example' => '200',
],
'SubMessage' => [
'title' => '业务处理相关的错误信息,一般建议关注此类错误',
'description' => '业务处理相关的错误信息,一般建议关注此类错误',
'type' => 'string',
'example' => '成功',
],
'PageSize' => [
'title' => 'pageSize',
'description' => 'pageSize',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'PageNumber' => [
'title' => '当前页',
'description' => '当前页',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TotalCount' => [
'title' => '总数量',
'description' => '总数量',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'Success' => [
'title' => '本次执行的结果成功与否',
'description' => '本次执行的结果成功与否',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'title' => '返回的执行结果码, 正确为字符串 0000',
'description' => '返回的执行结果码, 正确为字符串 0000',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'SUCCESS',
],
'Model' => [
'title' => '请求结果数据',
'description' => '请求结果数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CreateTime' => [
'title' => '兑换时间,格式化(yyyy-MM-dd HH:mm:ss)',
'description' => '兑换时间,格式化(yyyy-MM-dd HH:mm:ss)',
'type' => 'string',
'example' => '2022-10-11 14:22:21',
],
'LmOrderId' => [
'title' => '订单号,对外统一使用此ID做主键操作',
'description' => '订单号,对外统一使用此ID做主键操作',
'type' => 'integer',
'format' => 'int64',
'example' => '45***66',
],
'TbOrderId' => [
'title' => '淘宝订单号',
'description' => '淘宝订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '12***113',
],
'OrderAmount' => [
'title' => '订单总金额',
'description' => '订单总金额',
'type' => 'integer',
'format' => 'int64',
'example' => '500',
],
'OrderStatus' => [
'title' => '订单状态 112=待支付,102=已支付,104=已退款关闭,106=交易成功,108=被淘宝关闭,其它状态请参考淘宝订单支付状态。物流状态,201 - 未发货 -> 等待卖家发货,202 - 已发货 -> *',
'description' => '12=待支付,2=已支付,4=已退款关闭,6=交易成功,8=被淘宝关闭',
'type' => 'integer',
'format' => 'int32',
'example' => '6',
],
'LogisticsStatus' => [
'description' => '1=未发货 -> 等待卖家发货 2=已发货 -> 等待买家确认收货 3=已收货 -> 交易成功 4=已经退货 -> 交易失败 5=部分收货 -> 交易成功 6=部分发货中 8=还未创建物流订单',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'ExtJson' => [
'title' => '扩展信息',
'description' => '扩展信息',
'type' => 'string',
'example' => '{}',
],
'ShopName' => [
'title' => '店铺名',
'description' => '店铺名',
'type' => 'string',
'example' => '天猫***店',
],
'FundStructureModels' => [
'title' => '支付组成',
'description' => '支付组成',
'type' => 'array',
'items' => [
'description' => '支付组成',
'type' => 'object',
'properties' => [
'FundAmount' => [
'title' => '资金金额或数量,如现金单位为分,美分,积分为个,其它再约定,建议为最小的数量单位",',
'description' => '资金金额或数量,如现金单位为分,美分,积分为个,其它再约定,建议为最小的数量单位',
'type' => 'integer',
'format' => 'int64',
'example' => '500',
],
'FundAmountMoney' => [
'title' => '"fundAmountMoney":"对应的等值金额,单位为分。比如fundType为现金时,fundAmountMoney等于fundAmount ,其它非现金类的支付,由渠道计算好相应的等值金额放在这里。",',
'description' => '对应的等值金额,单位为分。比如fundType为现金时,fundAmountMoney等于fundAmount ,其它非现金类的支付,由渠道计算好相应的等值金额放在这里。',
'type' => 'integer',
'format' => 'int64',
'example' => '500',
],
'FundType' => [
'title' => '"fundType":"资金类型,如现金,优惠券,代金券,积分等 : CASH_CNY_PAY,POINT_PAY"',
'description' => '资金类型。如现金(lmCashCnyPay),优惠券(lmCouponPay),代金券(lmVoucherPay),积分(lmPointPay)等',
'type' => 'string',
'example' => 'lmCashCnyPay',
],
],
],
],
'PostFee' => [
'title' => '邮费',
'description' => '邮费',
'type' => 'object',
'properties' => [
'FundAmount' => [
'title' => '资金金额或数量,如现金单位为分,美分,积分为个,其它再约定,建议为最小的数量单位",',
'description' => '资金金额或数量,如现金单位为分,美分,积分为个,其它再约定,建议为最小的数量单位',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'FundAmountMoney' => [
'title' => '"fundAmountMoney":"对应的等值金额,单位为分。比如fundType为现金时,fundAmountMoney等于fundAmount ,其它非现金类的支付,由渠道计算好相应的等值金额放在这里。",',
'description' => '对应的等值金额,单位为分。比如fundType为现金时,fundAmountMoney等于fundAmount ,其它非现金类的支付,由渠道计算好相应的等值金额放在这里。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'FundType' => [
'title' => '"fundType":"资金类型,如现金,优惠券,代金券,积分等 : CASH_CNY_PAY,POINT_PAY"',
'description' => '资金类型。如现金(lmCashCnyPay),优惠券(lmCouponPay),代金券(lmVoucherPay),积分(lmPointPay)等',
'type' => 'string',
'example' => 'lmCashCnyPay',
],
],
],
'SubOrderList' => [
'title' => '子订单信息',
'description' => '子订单信息',
'type' => 'array',
'items' => [
'description' => '子订单列表',
'type' => 'object',
'properties' => [
'ItemId' => [
'title' => '"itemId":"itemId",',
'description' => '淘宝侧商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '68444***5753',
],
'LmItemId' => [
'description' => 'Lm侧商品ID',
'type' => 'string',
'example' => '100***02-68***453',
],
'ItemPic' => [
'title' => '"itemPic":"商品图片",',
'description' => '商品图片',
'type' => 'string',
'example' => 'https://aliyundoc.com',
],
'ItemPriceList' => [
'title' => '子订单支付组成',
'description' => '子订单支付组成',
'type' => 'array',
'items' => [
'description' => '支付组成',
'type' => 'object',
'properties' => [
'FundAmount' => [
'title' => '资金金额或数量,如现金单位为分,美分,积分为个,其它再约定,建议为最小的数量单位",',
'description' => '资金金额或数量,如现金单位为分,美分,积分为个,其它再约定,建议为最小的数量单位',
'type' => 'integer',
'format' => 'int64',
'example' => '500',
],
'FundAmountMoney' => [
'title' => '"fundAmountMoney":"对应的等值金额,单位为分。比如fundType为现金时,fundAmountMoney等于fundAmount ,其它非现金类的支付,由渠道计算好相应的等值金额放在这里。",',
'description' => '对应的等值金额,单位为分。比如fundType为现金时,fundAmountMoney等于fundAmount ,其它非现金类的支付,由渠道计算好相应的等值金额放在这里。',
'type' => 'integer',
'format' => 'int64',
'example' => '500',
],
'FundType' => [
'title' => '"fundType":"资金类型,如现金,优惠券,代金券,积分等 : CASH_CNY_PAY,POINT_PAY"',
'description' => '资金类型。如现金(lmCashCnyPay),优惠券(lmCouponPay),代金券(lmVoucherPay),积分(lmPointPay)等',
'type' => 'string',
'example' => 'lmCashCnyPay',
],
],
],
],
'ItemTitle' => [
'title' => '"itemTitle":"商品名称",',
'description' => '商品名称',
'type' => 'string',
'example' => '芝**饼',
],
'Number' => [
'title' => '"number":"下单数量",',
'description' => '下单数量',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'SkuId' => [
'title' => '"skuId":"下单的商品SkuId",',
'description' => 'skuId',
'type' => 'string',
'example' => '477***60',
],
'SkuName' => [
'title' => '"skuName":"下单的商品SKU显示名称",',
'description' => '下单的商品SKU显示名称',
'type' => 'string',
'example' => '500g',
],
'LmOrderId' => [
'title' => '"subLmOrderId":"子订单号"',
'description' => '子订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '539***44',
],
'OrderStatus' => [
'title' => '子订单状态',
'description' => '子订单状态',
'type' => 'integer',
'format' => 'int32',
'example' => '6',
],
'EnableStatus' => [
'title' => '子订单使能状态',
'description' => '子订单使能状态',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'TbOrderId' => [
'description' => '淘宝订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '32432***324',
],
],
],
],
'EnableStatus' => [
'title' => '订单有效状态',
'description' => '订单有效状态',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'LmPaymentId' => [
'title' => '支付订单号',
'description' => '支付订单号',
'type' => 'string',
'example' => '324***333',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidTag.Mismatch',
'errorMessage' => 'The specified Tag.n.Key and Tag.n.Value are not match.',
],
[
'errorCode' => 'InvalidTagCount',
'errorMessage' => 'The specified tags are beyond the permitted range.',
],
],
404 => [
[
'errorCode' => 'InvalidInstanceChargeType.NotFound',
'errorMessage' => 'The InstanceChargeType does not exist in our records',
],
[
'errorCode' => 'InvalidInternetChargeType.ValueNotSupported',
'errorMessage' => 'The specified InternetChargeType is not valid',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LogsId\\": \\"1\\",\\n \\"RequestId\\": \\"6103AD7B-21***DE-A58D08E8\\",\\n \\"SubCode\\": \\"200\\",\\n \\"SubMessage\\": \\"成功\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Model\\": [\\n {\\n \\"CreateTime\\": \\"2022-10-11 14:22:21\\",\\n \\"LmOrderId\\": 0,\\n \\"TbOrderId\\": 0,\\n \\"OrderAmount\\": 500,\\n \\"OrderStatus\\": 6,\\n \\"LogisticsStatus\\": 3,\\n \\"ExtJson\\": \\"{}\\",\\n \\"ShopName\\": \\"天猫***店\\",\\n \\"FundStructureModels\\": [\\n {\\n \\"FundAmount\\": 500,\\n \\"FundAmountMoney\\": 500,\\n \\"FundType\\": \\"lmCashCnyPay\\"\\n }\\n ],\\n \\"PostFee\\": {\\n \\"FundAmount\\": 0,\\n \\"FundAmountMoney\\": 0,\\n \\"FundType\\": \\"lmCashCnyPay\\"\\n },\\n \\"SubOrderList\\": [\\n {\\n \\"ItemId\\": 0,\\n \\"LmItemId\\": \\"100***02-68***453\\",\\n \\"ItemPic\\": \\"https://aliyundoc.com\\",\\n \\"ItemPriceList\\": [\\n {\\n \\"FundAmount\\": 500,\\n \\"FundAmountMoney\\": 500,\\n \\"FundType\\": \\"lmCashCnyPay\\"\\n }\\n ],\\n \\"ItemTitle\\": \\"芝**饼\\",\\n \\"Number\\": 1,\\n \\"SkuId\\": \\"477***60\\",\\n \\"SkuName\\": \\"500g\\",\\n \\"LmOrderId\\": 0,\\n \\"OrderStatus\\": 6,\\n \\"EnableStatus\\": 0,\\n \\"TbOrderId\\": 0\\n }\\n ],\\n \\"EnableStatus\\": 0,\\n \\"LmPaymentId\\": \\"324***333\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '指定淘宝账号下单模式下查询订单和支付信息列表',
],
'QueryOrderListWithDesignatedTbUid' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'FilterOption',
'in' => 'formData',
'schema' => [
'title' => '查询条件, 序列化com.aliyun.linkedmall.platform.service.taobaoitem.module.order.pop.FilterOption的json',
'description' => '查询条件, JSON字符串',
'type' => 'string',
'required' => true,
'example' => '{\\"lmOrderList\\":[\\"718***37\\"]}',
],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'title' => '每页数量',
'description' => '每页数量',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => [
'title' => '页码',
'description' => '页码',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'BizId',
'in' => 'formData',
'schema' => [
'title' => '客户业务ID',
'description' => '客户业务ID',
'type' => 'string',
'required' => true,
'example' => 'LMALL2022***001',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'formData',
'schema' => [
'title' => '企业侧用户ID',
'description' => '企业侧用户ID',
'type' => 'string',
'required' => true,
'example' => 'R333***21',
],
],
[
'name' => 'TbAccountType',
'in' => 'formData',
'schema' => [
'title' => '淘宝账号类型',
'description' => '淘宝账号类型',
'type' => 'string',
'required' => true,
'example' => 'ANONY',
],
],
[
'name' => 'TbUserId',
'in' => 'formData',
'schema' => [
'title' => '客户传递下单用户淘宝UID',
'description' => '客户传递下单用户淘宝UID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '333***21',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResponse
>',
'description' => 'PopResponse
>',
'type' => 'object',
'properties' => [
'LogsId' => [
'title' => '每次请求操作对应的操作日志号,由系统自动生成,返回给租户,可用于排查问题,双方日志中统一透出此标识',
'description' => '每次请求操作对应的操作日志号,由系统自动生成,返回给租户,可用于排查问题,双方日志中统一透出此标识',
'type' => 'string',
'example' => '1',
],
'RequestId' => [
'title' => 'POP请求流水号,建议租户日志中也输出此流水号,双方排查问题方便',
'description' => 'POP请求流水号,建议租户日志中也输出此流水号,双方排查问题方便',
'type' => 'string',
'example' => '1EA70857-79***3E-9F0F777180',
],
'SubCode' => [
'title' => '错误子代码。一般用于显示业务类的错误代码,一般建议关注此类错误',
'description' => '错误子代码。一般用于显示业务类的错误代码,一般建议关注此类错误',
'type' => 'string',
'example' => '200',
],
'SubMessage' => [
'title' => '业务处理相关的错误信息,一般建议关注此类错误',
'description' => '业务处理相关的错误信息,一般建议关注此类错误',
'type' => 'string',
'example' => 'SUCCESS',
],
'PageSize' => [
'title' => 'pageSize',
'description' => 'pageSize',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'PageNumber' => [
'title' => '当前页',
'description' => '当前页',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TotalCount' => [
'title' => '总数量',
'description' => '总数量',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'Success' => [
'title' => '本次执行的结果成功与否',
'description' => '本次执行的结果成功与否',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'title' => '返回的执行结果码, 正确为字符串 0000',
'description' => '返回的执行结果码, 正确为字符串 0000',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'SUCCESS',
],
'Model' => [
'title' => '请求结果数据',
'description' => '请求结果数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CreateTime' => [
'title' => '兑换时间,格式化(yyyy-MM-dd HH:mm:ss)',
'description' => '兑换时间,格式化(yyyy-MM-dd HH:mm:ss)',
'type' => 'string',
'example' => '2022-10-11 15:21:11',
],
'LmOrderId' => [
'title' => '订单号,对外统一使用此ID做主键操作',
'description' => '订单号,对外统一使用此ID做主键操作',
'type' => 'integer',
'format' => 'int64',
'example' => '639***718',
],
'TbOrderId' => [
'title' => '淘宝订单号',
'description' => '淘宝订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '412******113',
],
'OrderAmount' => [
'title' => '订单总金额',
'description' => '订单总金额',
'type' => 'integer',
'format' => 'int64',
'example' => '5000',
],
'OrderStatus' => [
'title' => '订单状态 112=待支付,102=已支付,104=已退款关闭,106=交易成功,108=被淘宝关闭,其它状态请参考淘宝订单支付状态。物流状态,201 - 未发货 -> 等待卖家发货,202 - 已发货 -> *',
'description' => '12=待支付,2=已支付,4=已退款关闭,6=交易成功,8=被淘宝关闭',
'type' => 'integer',
'format' => 'int32',
'example' => '6',
],
'LogisticsStatus' => [
'description' => '1=未发货 -> 等待卖家发货 2=已发货 -> 等待买家确认收货 3=已收货 -> 交易成功 4=已经退货 -> 交易失败 5=部分收货 -> 交易成功 6=部分发货中 8=还未创建物流订单',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'ExtJson' => [
'title' => '扩展信息',
'description' => '扩展信息',
'type' => 'string',
'example' => '{}',
],
'ShopName' => [
'title' => '店铺名',
'description' => '店铺名',
'type' => 'string',
'example' => '天猫***店',
],
'FundStructureModels' => [
'title' => '支付组成',
'description' => '支付组成',
'type' => 'array',
'items' => [
'description' => '支付方式',
'type' => 'object',
'properties' => [
'FundAmount' => [
'title' => '资金金额或数量,如现金单位为分,美分,积分为个,其它再约定,建议为最小的数量单位",',
'description' => '资金金额或数量,如现金单位为分,美分,积分为个,其它再约定,建议为最小的数量单位',
'type' => 'integer',
'format' => 'int64',
'example' => '5000',
],
'FundAmountMoney' => [
'title' => '"fundAmountMoney":"对应的等值金额,单位为分。比如fundType为现金时,fundAmountMoney等于fundAmount ,其它非现金类的支付,由渠道计算好相应的等值金额放在这里。",',
'description' => '对应的等值金额,单位为分。比如fundType为现金时,fundAmountMoney等于fundAmount ,其它非现金类的支付,由渠道计算好相应的等值金额放在这里。',
'type' => 'integer',
'format' => 'int64',
'example' => '5000',
],
'FundType' => [
'title' => '"fundType":"资金类型,如现金,优惠券,代金券,积分等 : CASH_CNY_PAY,POINT_PAY"',
'description' => '资金类型。如现金(lmCashCnyPay),优惠券(lmCouponPay),代金券(lmVoucherPay),积分(lmPointPay)等',
'type' => 'string',
'example' => 'lmCashCnyPay',
],
],
],
],
'PostFee' => [
'title' => '邮费',
'description' => '邮费',
'type' => 'object',
'properties' => [
'FundAmount' => [
'title' => '资金金额或数量,如现金单位为分,美分,积分为个,其它再约定,建议为最小的数量单位",',
'description' => '资金金额或数量,如现金单位为分,美分,积分为个,其它再约定,建议为最小的数量单位',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'FundAmountMoney' => [
'title' => '"fundAmountMoney":"对应的等值金额,单位为分。比如fundType为现金时,fundAmountMoney等于fundAmount ,其它非现金类的支付,由渠道计算好相应的等值金额放在这里。",',
'description' => '对应的等值金额,单位为分。比如fundType为现金时,fundAmountMoney等于fundAmount ,其它非现金类的支付,由渠道计算好相应的等值金额放在这里。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'FundType' => [
'title' => '"fundType":"资金类型,如现金,优惠券,代金券,积分等 : CASH_CNY_PAY,POINT_PAY"',
'description' => '资金类型。如现金(lmCashCnyPay),优惠券(lmCouponPay),代金券(lmVoucherPay),积分(lmPointPay)等',
'type' => 'string',
'example' => 'lmCashCnyPay',
],
],
],
'SubOrderList' => [
'title' => '子订单信息',
'description' => '子订单信息',
'type' => 'array',
'items' => [
'description' => '子订单列表',
'type' => 'object',
'properties' => [
'ItemId' => [
'title' => '"itemId":"itemId",',
'description' => '淘宝侧商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '665***373',
],
'LmItemId' => [
'description' => 'Lm侧商品ID',
'type' => 'string',
'example' => '100***02-665***373',
],
'ItemPic' => [
'title' => '"itemPic":"商品图片",',
'description' => '商品图片地址',
'type' => 'string',
'example' => 'https://aliyundoc.com',
],
'ItemPriceList' => [
'title' => '子订单支付组成',
'description' => '子订单支付组成',
'type' => 'array',
'items' => [
'description' => '价格列表',
'type' => 'object',
'properties' => [
'FundAmount' => [
'title' => '资金金额或数量,如现金单位为分,美分,积分为个,其它再约定,建议为最小的数量单位",',
'description' => '资金金额或数量,如现金单位为分,美分,积分为个,其它再约定,建议为最小的数量单位',
'type' => 'integer',
'format' => 'int64',
'example' => '5000',
],
'FundAmountMoney' => [
'title' => '"fundAmountMoney":"对应的等值金额,单位为分。比如fundType为现金时,fundAmountMoney等于fundAmount ,其它非现金类的支付,由渠道计算好相应的等值金额放在这里。",',
'description' => '对应的等值金额,单位为分。比如fundType为现金时,fundAmountMoney等于fundAmount ,其它非现金类的支付,由渠道计算好相应的等值金额放在这里。',
'type' => 'integer',
'format' => 'int64',
'example' => '5000',
],
'FundType' => [
'title' => '"fundType":"资金类型,如现金,优惠券,代金券,积分等 : CASH_CNY_PAY,POINT_PAY"',
'description' => '资金类型。如现金(lmCashCnyPay),优惠券(lmCouponPay),代金券(lmVoucherPay),积分(lmPointPay)等',
'type' => 'string',
'example' => 'lmCashCnyPay',
],
],
],
],
'ItemTitle' => [
'title' => '"itemTitle":"商品名称",',
'description' => '商品名称',
'type' => 'string',
'example' => '芝麻***饼',
],
'Number' => [
'title' => '"number":"下单数量",',
'description' => '下单数量',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'SkuId' => [
'title' => '"skuId":"下单的商品SkuId",',
'description' => 'skuId',
'type' => 'string',
'example' => '496***350',
],
'SkuName' => [
'title' => '"skuName":"下单的商品SKU显示名称",',
'description' => 'SKU显示名称',
'type' => 'string',
'example' => '500g',
],
'LmOrderId' => [
'title' => '"subLmOrderId":"子订单号"',
'description' => '子订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '559***813',
],
'OrderStatus' => [
'title' => '子订单状态',
'description' => '子订单状态',
'type' => 'integer',
'format' => 'int32',
'example' => '6',
],
'EnableStatus' => [
'title' => '子订单使能状态',
'description' => '子订单使能状态',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'TbOrderId' => [
'description' => '淘宝订单号',
'type' => 'integer',
'format' => 'int64',
'example' => '323***242',
],
],
],
],
'EnableStatus' => [
'title' => '订单有效状态',
'description' => '订单有效状态',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidTag.Mismatch',
'errorMessage' => 'The specified Tag.n.Key and Tag.n.Value are not match.',
],
[
'errorCode' => 'InvalidTagCount',
'errorMessage' => 'The specified tags are beyond the permitted range.',
],
],
404 => [
[
'errorCode' => 'InvalidInstanceChargeType.NotFound',
'errorMessage' => 'The InstanceChargeType does not exist in our records',
],
[
'errorCode' => 'InvalidInternetChargeType.ValueNotSupported',
'errorMessage' => 'The specified InternetChargeType is not valid',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LogsId\\": \\"1\\",\\n \\"RequestId\\": \\"1EA70857-79***3E-9F0F777180\\",\\n \\"SubCode\\": \\"200\\",\\n \\"SubMessage\\": \\"SUCCESS\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Model\\": [\\n {\\n \\"CreateTime\\": \\"2022-10-11 15:21:11\\",\\n \\"LmOrderId\\": 0,\\n \\"TbOrderId\\": 0,\\n \\"OrderAmount\\": 5000,\\n \\"OrderStatus\\": 6,\\n \\"LogisticsStatus\\": 2,\\n \\"ExtJson\\": \\"{}\\",\\n \\"ShopName\\": \\"天猫***店\\",\\n \\"FundStructureModels\\": [\\n {\\n \\"FundAmount\\": 5000,\\n \\"FundAmountMoney\\": 5000,\\n \\"FundType\\": \\"lmCashCnyPay\\"\\n }\\n ],\\n \\"PostFee\\": {\\n \\"FundAmount\\": 0,\\n \\"FundAmountMoney\\": 0,\\n \\"FundType\\": \\"lmCashCnyPay\\"\\n },\\n \\"SubOrderList\\": [\\n {\\n \\"ItemId\\": 0,\\n \\"LmItemId\\": \\"100***02-665***373\\",\\n \\"ItemPic\\": \\"https://aliyundoc.com\\",\\n \\"ItemPriceList\\": [\\n {\\n \\"FundAmount\\": 5000,\\n \\"FundAmountMoney\\": 5000,\\n \\"FundType\\": \\"lmCashCnyPay\\"\\n }\\n ],\\n \\"ItemTitle\\": \\"芝麻***饼\\",\\n \\"Number\\": 1,\\n \\"SkuId\\": \\"496***350\\",\\n \\"SkuName\\": \\"500g\\",\\n \\"LmOrderId\\": 0,\\n \\"OrderStatus\\": 6,\\n \\"EnableStatus\\": 0,\\n \\"TbOrderId\\": 0\\n }\\n ],\\n \\"EnableStatus\\": 0\\n }\\n ]\\n}","type":"json"}]',
'title' => '指定淘宝账号下单模式下查询订单列表',
],
'QueryOrderLogisticsWithDesignatedTbUid' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'LmOrderId',
'in' => 'formData',
'schema' => [
'description' => 'lm订单号',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '737***057',
],
],
[
'name' => 'BizId',
'in' => 'formData',
'schema' => [
'title' => '客户业务ID',
'description' => '客户业务ID',
'type' => 'string',
'required' => true,
'example' => 'LMALL2022***004',
],
],
[
'name' => 'ThirdPartyUserId',
'in' => 'formData',
'schema' => [
'title' => '企业侧用户ID',
'description' => '企业侧用户ID',
'type' => 'string',
'required' => true,
'example' => 'u***001',
],
],
[
'name' => 'TbAccountType',
'in' => 'formData',
'schema' => [
'title' => '淘宝账号类型',
'description' => '淘宝账号类型',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'ANONY' => '匿名账号',
'REAL' => '实名账号',
],
'example' => 'ANONY',
],
],
[
'name' => 'TbUserId',
'in' => 'formData',
'schema' => [
'title' => '客户传递下单用户淘宝UID',
'description' => '客户传递下单用户淘宝UID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '261***126',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResponse
>',
'description' => 'PopResponse
>',
'type' => 'object',
'properties' => [
'LogsId' => [
'title' => '每次请求操作对应的操作日志号,由系统自动生成,返回给租户,可用于排查问题,双方日志中统一透出此标识',
'description' => '每次请求操作对应的操作日志号,由系统自动生成,返回给租户,可用于排查问题,双方日志中统一透出此标识',
'type' => 'string',
'example' => '1',
],
'RequestId' => [
'title' => 'POP请求流水号,建议租户日志中也输出此流水号,双方排查问题方便',
'description' => 'POP请求流水号,建议租户日志中也输出此流水号,双方排查问题方便',
'type' => 'string',
'example' => '24D184B6-9***B-AC1B8ACED261',
],
'SubCode' => [
'title' => '错误子代码。一般用于显示业务类的错误代码,一般建议关注此类错误',
'description' => '错误子代码。一般用于显示业务类的错误代码,一般建议关注此类错误',
'type' => 'string',
'example' => '200',
],
'SubMessage' => [
'title' => '业务处理相关的错误信息,一般建议关注此类错误',
'description' => '业务处理相关的错误信息,一般建议关注此类错误',
'type' => 'string',
'example' => 'SUCCESS',
],
'PageSize' => [
'title' => 'pageSize',
'description' => 'pageSize',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageNumber' => [
'title' => '当前页',
'description' => '当前页',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TotalCount' => [
'title' => '总数量',
'description' => '总数量',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'Success' => [
'title' => '本次执行的结果成功与否',
'description' => '本次执行的结果成功与否',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'title' => '返回的执行结果码, 正确为字符串 0000',
'description' => '返回的执行结果码',
'type' => 'string',
'example' => 'SUCCESS',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'SUCCESS',
],
'Model' => [
'title' => '请求结果数据',
'description' => '请求结果数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'MailNo' => [
'description' => '物流单号',
'type' => 'string',
'example' => '21321***2123',
],
'PackageGoodItems' => [
'description' => '包裹信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '商品名称',
'type' => 'string',
'example' => '小熊饼干',
],
'Quantity' => [
'description' => '购买数量',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ItemId' => [
'description' => '商品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '650***2703',
],
'LmItemId' => [
'description' => 'lm侧商品ID',
'type' => 'string',
'example' => '100***39-6046***9180',
],
],
],
],
'DataProvider' => [
'description' => '数据来源:如:菜鸟裹裹',
'type' => 'string',
'example' => '菜鸟裹裹',
],
'DataProviderTitle' => [
'description' => '数据来源说明,如:本数据由菜⻦裹裹提供',
'type' => 'string',
'example' => '本数据由菜鸟裹裹提供',
],
'Receiver' => [
'description' => '收件人信息',
'type' => 'object',
'properties' => [
'Address' => [
'description' => '收件人地址',
'type' => 'string',
'example' => '***省**市**区**街道',
],
'Name' => [
'description' => '收件人名称',
'type' => 'string',
'example' => '张**',
],
'PhoneNumber' => [
'description' => '收件人号码',
'type' => 'string',
'example' => '18***00',
],
'ZipCode' => [
'description' => '收货信息-邮编。',
'type' => 'string',
'example' => '516000',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '24D184B6-91***2AB-AC1B8ACED261',
],
],
],
'Fetcher' => [
'description' => '取件信息',
'type' => 'object',
'properties' => [
'Address' => [
'description' => '取件地址',
'type' => 'string',
'example' => '***省**市**区**街道',
],
'Name' => [
'description' => '取件人姓名',
'type' => 'string',
'example' => '张**',
],
'PhoneNumber' => [
'description' => '取件人号码',
'type' => 'string',
'example' => '189***12',
],
'ZipCode' => [
'description' => '收货信息:邮编。',
'type' => 'string',
'example' => '450000',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '24D184B6-91***B-AC1B8ACED261',
],
],
],
'LogisticsDetailList' => [
'description' => '物流信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StanderdDesc' => [
'description' => '描述信息',
'type' => 'string',
'example' => '""',
],
'OcurrTimeStr' => [
'description' => '发生时间',
'type' => 'string',
'example' => '2022-02-21 08:23:21',
],
'StatusIcon' => [
'description' => '状态图标',
'type' => 'string',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '24D184B6-913***2AB-AC1B8ACED261',
],
],
],
],
'LogisticsCompanyCode' => [
'description' => '本单物流公司code',
'type' => 'string',
'example' => 'SF',
],
'LogisticsCompanyName' => [
'description' => '本单物流公司名称',
'type' => 'string',
'example' => '顺丰',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '24D184B6-91***B-AC1B8ACED261',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidTag.Mismatch',
'errorMessage' => 'The specified Tag.n.Key and Tag.n.Value are not match.',
],
[
'errorCode' => 'InvalidTagCount',
'errorMessage' => 'The specified tags are beyond the permitted range.',
],
],
404 => [
[
'errorCode' => 'InvalidInstanceChargeType.NotFound',
'errorMessage' => 'The InstanceChargeType does not exist in our records',
],
[
'errorCode' => 'InvalidInternetChargeType.ValueNotSupported',
'errorMessage' => 'The specified InternetChargeType is not valid',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LogsId\\": \\"1\\",\\n \\"RequestId\\": \\"24D184B6-9***B-AC1B8ACED261\\",\\n \\"SubCode\\": \\"200\\",\\n \\"SubMessage\\": \\"SUCCESS\\",\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Success\\": true,\\n \\"Code\\": \\"SUCCESS\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Model\\": [\\n {\\n \\"MailNo\\": \\"21321***2123\\",\\n \\"PackageGoodItems\\": [\\n {\\n \\"Name\\": \\"小熊饼干\\",\\n \\"Quantity\\": 1,\\n \\"ItemId\\": 0,\\n \\"LmItemId\\": \\"100***39-6046***9180\\"\\n }\\n ],\\n \\"DataProvider\\": \\"菜鸟裹裹\\",\\n \\"DataProviderTitle\\": \\"本数据由菜鸟裹裹提供\\",\\n \\"Receiver\\": {\\n \\"Address\\": \\"***省**市**区**街道\\",\\n \\"Name\\": \\"张**\\",\\n \\"PhoneNumber\\": \\"18***00\\",\\n \\"ZipCode\\": \\"516000\\",\\n \\"RequestId\\": \\"24D184B6-91***2AB-AC1B8ACED261\\"\\n },\\n \\"Fetcher\\": {\\n \\"Address\\": \\"***省**市**区**街道\\",\\n \\"Name\\": \\"张**\\",\\n \\"PhoneNumber\\": \\"189***12\\",\\n \\"ZipCode\\": \\"450000\\",\\n \\"RequestId\\": \\"24D184B6-91***B-AC1B8ACED261\\"\\n },\\n \\"LogisticsDetailList\\": [\\n {\\n \\"StanderdDesc\\": \\"\\\\\\"\\\\\\"\\",\\n \\"OcurrTimeStr\\": \\"2022-02-21 08:23:21\\",\\n \\"StatusIcon\\": \\"\\",\\n \\"RequestId\\": \\"24D184B6-913***2AB-AC1B8ACED261\\"\\n }\\n ],\\n \\"LogisticsCompanyCode\\": \\"SF\\",\\n \\"LogisticsCompanyName\\": \\"顺丰\\",\\n \\"RequestId\\": \\"24D184B6-91***B-AC1B8ACED261\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '指定淘宝账号下单模式下-查询订单物流信息',
],
'QueryRealTbAccountSupport' => [
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'formData',
'schema' => [
'description' => '业务ID',
'type' => 'string',
'required' => true,
'example' => 'LMALL20***001',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResponse