/* tslint:disable */ /* eslint-disable */ /** * Swagger Petstore - OpenAPI 3.0 - version 1.0.27 * * This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at [https://swagger.io](https://swagger.io). In the third iteration of the pet store, we've switched to the design first approach! You can now help us improve the API whether it's by making changes to the definition itself or to the code. That way, with time, we can improve the API in general, and expose some of the new features in OAS3. Some useful links: - [The Pet Store repository](https://github.com/swagger-api/swagger-petstore) - [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml) * * OpenAPI version: 3.0.4 * * Contact: * * NOTE: This file is auto generated by the alova's vscode plugin. * * https://alova.js.org/devtools/vscode * * **Do not edit the file manually.** */ import type { Alova, AlovaMethodCreateConfig, AlovaGenerics, Method } from 'alova'; import type { $$userConfigMap, alovaInstance } from './index'; import type apiDefinitions from './apiDefinitions'; type CollapsedAlova = typeof alovaInstance; type UserMethodConfigMap = typeof $$userConfigMap; type Alova2MethodConfig = CollapsedAlova extends Alova< AlovaGenerics< any, any, infer RequestConfig, infer Response, infer ResponseHeader, infer L1Cache, infer L2Cache, infer SE > > ? Omit< AlovaMethodCreateConfig< AlovaGenerics, any, Responded >, 'params' > : never; // Extract the return type of transform function that define in $$userConfigMap, if it not exists, use the default type. type ExtractUserDefinedTransformed< DefinitionKey extends keyof typeof apiDefinitions, Default > = DefinitionKey extends keyof UserMethodConfigMap ? UserMethodConfigMap[DefinitionKey]['transform'] extends (...args: any[]) => any ? Awaited> : Default : Default; type Alova2Method< Responded, DefinitionKey extends keyof typeof apiDefinitions, CurrentConfig extends Alova2MethodConfig > = CollapsedAlova extends Alova< AlovaGenerics< any, any, infer RequestConfig, infer Response, infer ResponseHeader, infer L1Cache, infer L2Cache, infer SE > > ? Method< AlovaGenerics< CurrentConfig extends undefined ? ExtractUserDefinedTransformed : CurrentConfig['transform'] extends (...args: any[]) => any ? Awaited> : ExtractUserDefinedTransformed, any, RequestConfig, Response, ResponseHeader, L1Cache, L2Cache, SE > > : never; export interface ApiResponse { code?: number; type?: string; msg?: string; data: any } interface listData { data?: { list: T[] } } interface apiResData { data: T; code: string msg: string } declare global { interface Apis { sys: { appAccess< Config extends Alova2MethodConfig> & { pathParams: { accessId: string }; } >( config: Config ): Alova2Method, 'sys.appAccess', Config>; auth< Config extends Alova2MethodConfig> & { params: loginModel; } >( config: Config ): Alova2Method, 'sys.auth', Config>; userInfo< Config extends Alova2MethodConfig> >( config: Config ): Alova2Method, 'sys.userInfo', Config>; updateUserInfo< Config extends Alova2MethodConfig & { pathParams: { memberId: number }; data: Api.userInfo; } >( config: Config ): Alova2Method; uploadFile< Config extends Alova2MethodConfig<{ url: string }> & { data: { name: string; filePath: string; }; } >( config: Config ): Alova2Method<{ url: string }, 'sys.uploadFile', Config>; addresses< Config extends Alova2MethodConfig> & { } >( config: Config ): Alova2Method, 'sys.addresses', Config>; Addaddresses< Config extends Alova2MethodConfig & { data: Api.addressList; } >( config: Config ): Alova2Method; deleteAddresses< Config extends Alova2MethodConfig & { pathParams: { ids: string }; } >( config: Config ): Alova2Method; updateAddresses< Config extends Alova2MethodConfig & { data: Api.addressList; } >( config: Config ): Alova2Method; addressesDetail< Config extends Alova2MethodConfig> & { pathParams: { addressId: number }; } >( config: Config ): Alova2Method, 'sys.addressesDetail', Config>; selectZhUser< Config extends Alova2MethodConfig> & {} >( config: Config ): Alova2Method, 'sys.selectZhUser', Config>; zhUserReceived< Config extends Alova2MethodConfig> & {} >( config: Config ): Alova2Method, 'sys.zhUserReceived', Config>; dictPage< Config extends Alova2MethodConfig> & { data: { typeCode: string; }; } >( config: Config ): Alova2Method, 'sys.dictPage', Config>; } xsb: { orderCoupons< Config extends Alova2MethodConfig> & { data: { channelId: number; num: number; shopId: number; skuId: number; }; } >( config: Config ): Alova2Method, 'xsb.orderCoupons', Config>; newCouponPopup< Config extends Alova2MethodConfig> & {} >( config: Config ): Alova2Method, 'xsb.newCouponPopup', Config>; popupConfig< Config extends Alova2MethodConfig> & {} >( config: Config ): Alova2Method, 'xsb.popupConfig', Config>; refundDetails< Config extends Alova2MethodConfig> & { data: { refundNumber: string; }; } >( config: Config ): Alova2Method, 'xsb.refundList', Config>; refundCancel< Config extends Alova2MethodConfig & { data: { refundNumber: string; }; } >( config: Config ): Alova2Method; refundList< Config extends Alova2MethodConfig> & { data: { pageNum: number; pageSize: number }; } >( config: Config ): Alova2Method, 'xsb.refundList', Config>; getWaybillToken< Config extends Alova2MethodConfig> & { data: { orderNumber: string; }; } >( config: Config ): Alova2Method, 'xsb.getWaybillToken', Config>; findByOrderNumber< Config extends Alova2MethodConfig> & { data: { orderNumber: string; }; } >( config: Config ): Alova2Method, 'xsb.findByOrderNumber', Config>; deliveryNode< Config extends Alova2MethodConfig> & { data: { orderNumber: string; }; } >( config: Config ): Alova2Method, 'xsb.deliveryNode', Config>; riderInfo< Config extends Alova2MethodConfig> & { data: { orderNumber: string }; } >( config: Config ): Alova2Method, 'xsb.riderInfo', Config>; calculateMoney< Config extends Alova2MethodConfig> & { data: { orderRefundSkuList: { orderItemId: number, productCount: number }[]; orderNumber: string }; } >( config: Config ): Alova2Method, 'xsb.applyRefund', Config>; applyRefund< Config extends Alova2MethodConfig> & { data: { /** * 退款类型 1,仅退款,2退款退货,5差价退款 */ applyType?: number; /** * 退款订单业务类型 1-星闪豹 */ businessType?: number; /** * 备注说明 */ buyerDesc?: string; /** * 手机号码(默认当前订单手机号码) */ buyerMobile?: string; /** * 仅退款-未收到货申请原因 * 11(质量问题) * 12(拍错/多拍/不喜欢) * 3(商品描述不符) * 14(假货), 15(商家发错货) * 16(商品破损/少件) * 17(其他) * 仅退款-已收到货申请原因 * 51(多买/买错/不想要) * 52(快递无记录) * 53(少货/空包裹) * 54(未按约定时间发货) * 55(快递一直未送达) * 56(其他) * 退货退款-申请原因 * 101(商品破损/少件) * 102(商家发错货) * 103(商品描述不符) * 104(拍错/多拍/不喜欢) * 105(质量问题) * 107(其他) */ buyerReason?: string; /** * 订单编号 */ orderNumber?: string; /** * 退款商品详情 */ orderRefundSkuList?: AppOrderRefundSkuVo[]; /** * 凭证图片列表使用,分割 */ photoFiles?: string; /** * 退款金额 */ refundAmount?: number; /** * 退款单类型(1:整单退款,2:单个物品退款) */ refundType?: number; [property: string]: any; }; } >( config: Config ): Alova2Method, 'xsb.applyRefund', Config>; nearestShop< Config extends Alova2MethodConfig> & { data: { latitude: number; longitude: number }; } >( config: Config ): Alova2Method, 'xsb.nearestShop', Config>; categories< Config extends Alova2MethodConfig> & { data: { channelId: number; shopId: number }; } >( config: Config ): Alova2Method, 'xsb.categories', Config>; getCategoryProductList< Config extends Alova2MethodConfig> & { data: { categoryId: number; shopId: number channelId: number }; } >( config: Config ): Alova2Method, 'xsb.getCategoryProductList', Config>; getProductDetail< Config extends Alova2MethodConfig> & { data: { id: number; shopId: number channelId: number }; } >( config: Config ): Alova2Method, 'xsb.getProductDetail', Config>; findUserPoints< Config extends Alova2MethodConfig> & { } >( config: Config ): Alova2Method, 'xsb.findUserPoints', Config>; findUserPointsPage< Config extends Alova2MethodConfig> & { data: { pageNum: number; pageSize: number; }; } >( config: Config ): Alova2Method, 'xsb.findUserPointsPage', Config>; getSearchProductList< Config extends Alova2MethodConfig> & { data: { /** * 暂定为商品名称,后面可能会加其他条件 */ keywords?: string; /** * 页码 */ pageNum?: number; /** * 每页记录数 */ pageSize?: number; /** * 价格排序不传时为空,默认不排 ASC:价格升序,DESC:价格倒序 */ priceSort?: string; /** * 销量排序不传时为空,默认不排 ASC:价格升序,DESC:价格倒序 */ salesNum?: string; shopId: number channelId: number }; } >( config: Config ): Alova2Method, 'xsb.getSearchProductList', Config>; appAdvertInfo< Config extends Alova2MethodConfig> & { } >( config: Config ): Alova2Method, 'xsb.appAdvertInfo', Config>; SearchTerm< Config extends Alova2MethodConfig> & { data: { type: number } } >( config: Config ): Alova2Method, 'xsb.SearchTerm', Config>; shopList< Config extends Alova2MethodConfig> & { } >( config: Config ): Alova2Method, 'xsb.shopList', Config>; orderList< Config extends Alova2MethodConfig> & { data: { businessType?: string; orderStatus?: string | number; pageNum?: number; pageSize?: number; dvyType?: number | string; } } >( config: Config ): Alova2Method, 'xsb.orderList', Config>; orderInfo< Config extends Alova2MethodConfig> & { data: { orderNo: string; } } >( config: Config ): Alova2Method, 'xsb.orderInfo', Config>; cancelOrder< Config extends Alova2MethodConfig & { data: { orderNo: string; } } >( config: Config ): Alova2Method; deleteOrder< Config extends Alova2MethodConfig & { pathParams: { ids: string; } } >( config: Config ): Alova2Method; skuOrderConfirm< Config extends Alova2MethodConfig> & { data: { channelId?: number; num?: number; shopId?: number; skuId?: number; } } >( config: Config ): Alova2Method, 'xsb.skuOrderConfirm', Config>; myShoppingCartCategory< Config extends Alova2MethodConfig> & { data: { channelId?: number; shopId?: number; businessType?: string; } } >( config: Config ): Alova2Method, 'xsb.myShoppingCartCategory', Config>; delivery< Config extends Alova2MethodConfig> & { data: { memberId?: number; shopId?: number; addressId?: number; } } >( config: Config ): Alova2Method, 'xsb.delivery', Config>; confirmReceipt< Config extends Alova2MethodConfig & { data: { orderNumber: string; } } >( config: Config ): Alova2Method; memberCouponPage< Config extends Alova2MethodConfig> & { data: { pageNum?: number; pageSize?: number; useStatus?: number; lockStatus?: number; } } >( config: Config ): Alova2Method, 'xsb.memberCouponPage', Config>; } common: { myShoppingCart< Config extends Alova2MethodConfig> & { data: { businessType: string; channelId: number; } } >( config: Config ): Alova2Method, 'common.myShoppingCart', Config>; addShoppingCart< Config extends Alova2MethodConfig> & { data: { /** * 业务类型 */ businessType: string; /** * 渠道 */ channelId: number; /** * 数量 */ num: number; /** * 门店 */ shopId: number; /** * sku_id */ skuId: number; } } >( config: Config ): Alova2Method, 'common.addShoppingCart', Config>; deleteShoppingCart< Config extends Alova2MethodConfig> & { pathParams: { ids: string }; } >( config: Config ): Alova2Method, 'common.deleteShoppingCart', Config>; shoppingCartOrderConfirm< Config extends Alova2MethodConfig> & { pathParams: { ids: string }; } >( config: Config ): Alova2Method, 'common.shoppingCartOrderConfirm', Config>; addOrder< Config extends Alova2MethodConfig & { data: { /** * 收货人地址id */ addressId: number; /** * 业务类型 */ businessType: string; /** * 企业ID */ channelId: number; /** * 配送类型 1:快递 2:自提 3:及时配送 */ dvyType: number; /** * 订单运费 */ freightAmount: number; /** * 商品信息 */ orderItemList: { /** * 数量 */ prodCount?: number; /** * 产品SkuID */ skuId?: number; [property: string]: any; }[]; /** * 买家备注 */ remarks?: string; /** * 店铺id */ shopId: number; [property: string]: any; } } >( config: Config ): Alova2Method; hybridPayment< Config extends Alova2MethodConfig> & { data: { orderNumber: string; } } >( config: Config ): Alova2Method, 'common.hybridPayment', Config>; } smqjh: { getCategoryList< Config extends Alova2MethodConfig> & { data: { /** * 分类名称 */ name?: string; /** * 父级id */ parentId?: number; /** * 分类状态 */ visible?: number; } } >( config: Config ): Alova2Method, 'smqjh.getCategoryList', Config>; }, film: { getCityList< Config extends Alova2MethodConfig> & { } >( config: Config ): Alova2Method, 'film.getCityList', Config>; getMovieList< Config extends Alova2MethodConfig> & { data: { showSt?: number; pageNum?: number; pageSize?: number; } } >( config: Config ): Alova2Method, 'film.getMovieList', Config>; getMovieDetail< Config extends Alova2MethodConfig> & { data: { id?: number | string; } } >( config: Config ): Alova2Method, 'film.getMovieDetail', Config>; getFilmList< Config extends Alova2MethodConfig> & { data: { cityId?: number | string; cinemaId?: number | string; movieId?: number | string; districtId?: number | string; showDates?: number | string; hall?: number | string; lat?: number | null; lng?: number | null; } } >( config: Config ): Alova2Method, 'film.getFilmList', Config>; getFilmDateList< Config extends Alova2MethodConfig> & { data: { movieId?: string } } >( config: Config ): Alova2Method, 'film.getFilmDateList', Config>; getFilmBrandList< Config extends Alova2MethodConfig> & { } >( config: Config ): Alova2Method, 'film.getFilmBrandList', Config>; getFilmMovieList< Config extends Alova2MethodConfig> & { data: { cinemaId: string movieId: string } } >( config: Config ): Alova2Method, 'film.getFilmMovieList', Config>; getFilmMovieSeat< Config extends Alova2MethodConfig> & { data: { sessionId: string movieId: string cinemaId: string } } >( config: Config ): Alova2Method, 'film.getFilmMovieSeat', Config>; addFilmOrder< Config extends Alova2MethodConfig> & { data: { cinemaCode: string hallName: string orderPayMode: string originPrice: number seatNames: string sessionBeginTime: string switchSeat: boolean } } >( config: Config ): Alova2Method, 'film.addFilmOrder', Config>; filmOrderDetail< Config extends Alova2MethodConfig> & { data: { id: string } } >( config: Config ): Alova2Method, 'film.filmOrderDetail', Config>; } charge: { getStationInfoPage< Config extends Alova2MethodConfig> & { data: { pageNum?: number; pageSize?: number; sortType?: number; longitude?: number; latitude?: number; userId?: number; } } >( config: Config ): Alova2Method, 'charge.getStationInfoPage', Config>; getMemberInfo< Config extends Alova2MethodConfig> & {} >( config: Config ): Alova2Method, 'charge.getMemberInfo', Config>; detail< Config extends Alova2MethodConfig> & { data: { stationId?: number; longitude?: number | null; latitude?: number | null; } } >( config: Config ): Alova2Method, 'charge.detail', Config>; prices< Config extends Alova2MethodConfig> & { data: { stationId?: number; } } >( config: Config ): Alova2Method, 'charge.prices', Config>; connectors< Config extends Alova2MethodConfig> & { data: { stationId?: number; } } >( config: Config ): Alova2Method, 'charge.connectors', Config>; connectorDetail< Config extends Alova2MethodConfig> & { data: { connectorCode?: string; } } >( config: Config ): Alova2Method, 'charge.detail', Config>; invokeCharge< Config extends Alova2MethodConfig & { data: Api.invokeChargeList; } >( config: Config ): Alova2Method; search< Config extends Alova2MethodConfig> & { data: { keyword?: string; longitude?: number | null latitude?: number | null } } >( config: Config ): Alova2Method, 'charge.search', Config>; chargeingCost< Config extends Alova2MethodConfig> & { data: { orderNo?: string; } } >( config: Config ): Alova2Method, 'charge.search', Config>; stopCharge< Config extends Alova2MethodConfig> & { data: { chargeOrderNo?: string; } } >( config: Config ): Alova2Method, 'charge.stopCharge', Config>; stationInfoMapList< Config extends Alova2MethodConfig> & { data: { longitude?: number | null; latitude?: number | null; } } >( config: Config ): Alova2Method, 'charge.stationInfoMapList', Config>; orderDetail< Config extends Alova2MethodConfig> & { data: { orderNumber?: string | null; } } >( config: Config ): Alova2Method, 'charge.orderDetail', Config>; getReChargeLevel< Config extends Alova2MethodConfig> & {} >( config: Config ): Alova2Method, 'charge.getReChargeLevel', Config>; addPurchaseRecord< Config extends Alova2MethodConfig> & { data: { couponAmount?: number; consigneeName?: string; consigneeMobile?: string; } } >( config: Config ): Alova2Method, 'charge.addPurchaseRecord', Config>; wxJsApiPay< Config extends Alova2MethodConfig> & { data: { orderNumber?: string; } } >( config: Config ): Alova2Method, 'charge.wxJsApiPay', Config>; getPurchaseRecordPage< Config extends Alova2MethodConfig> & { data: { /** * 页码 */ pageNum?: number; /** * 每页记录数 */ pageSize?: number; } } >( config: Config ): Alova2Method, 'charge.getPurchaseRecordPage', Config>; userCouponRefund< Config extends Alova2MethodConfig> & {} >( config: Config ): Alova2Method, 'charge.userCouponRefund', Config>; default< Config extends Alova2MethodConfig> & {} >( config: Config ): Alova2Method, 'charge.default', Config>; vehicleList< Config extends Alova2MethodConfig> & {} >( config: Config ): Alova2Method, 'charge.vehicleList', Config>; addVehicle< Config extends Alova2MethodConfig> & { data: { /** * 车牌号 */ licensePlate: string; /** * 用户ID */ userId: number; } } >( config: Config ): Alova2Method, 'charge.addVehicle', Config>; setDefault< Config extends Alova2MethodConfig> & { pathParams: { id: string }; } >( config: Config ): Alova2Method, 'charge.setDefault', Config>; deleteVehicle< Config extends Alova2MethodConfig> & { pathParams: { id: string }; } >( config: Config ): Alova2Method, 'charge.deleteVehicle', Config>; } videoRight: { findAppByPage< Config extends Alova2MethodConfig> & { data: { pageNum?: number; pageSize?: number; productName?: string; } } >( config: Config ): Alova2Method, 'videoRight.findAppByPage', Config>; goodsDetail< Config extends Alova2MethodConfig> & { data: { id: string } } >( config: Config ): Alova2Method, 'videoRight.goodsDetail', Config>; goodsPreview< Config extends Alova2MethodConfig> & { data: { id: string } } >( config: Config ): Alova2Method, 'videoRight.goodsPreview', Config>; orderCreate< Config extends Alova2MethodConfig & { data: Api.videoRightsubmitOrder; } >( config: Config ): Alova2Method; orderDetail< Config extends Alova2MethodConfig> & { data: { orderNumber: string } } >( config: Config ): Alova2Method, 'videoRight.goodsPreview', Config>; orderList< Config extends Alova2MethodConfig> & { data: { rechargeStatus?: string pageNum?: number pageSize?: number } } >( config: Config ): Alova2Method, 'videoRight.orderList', Config>; } djk: { appletGoodsList< Config extends Alova2MethodConfig> & { data: { pageNum?: number; pageSize?: number; } } >( config: Config ): Alova2Method, 'djk.appletGoodsList', Config>; appletShopInfo< Config extends Alova2MethodConfig> & { data: { shopId: number } } >( config: Config ): Alova2Method, 'djk.appletShopInfo', Config>; goodsInfo< Config extends Alova2MethodConfig> & { data: { goodsId: number } } >( config: Config ): Alova2Method, 'djk.goodsInfo', Config>; djkAppletOrderConfirm< Config extends Alova2MethodConfig> & { data: { goodsId: number channelId: number } } >( config: Config ): Alova2Method, 'djk.djkAppletOrderConfirm', Config>; addDJKOrder< Config extends Alova2MethodConfig> & { data: { channelId?: number; /** * 客户授权 */ customerAuthorization?: number; /** * 商品id */ goodsId?: number; /** * 商品数量 */ goodsNum?: number; /** * phone */ phone?: string; /** * 买家备注 */ remarks?: string; /** * 店铺id */ shopId?: number; } } >( config: Config ): Alova2Method, 'djk.djkAppletOrderConfirm', Config>; welfareList< Config extends Alova2MethodConfig> & { } >( config: Config ): Alova2Method, 'djk.welfareList', Config>; welfareInfo< Config extends Alova2MethodConfig> & { data: { id: number } } >( config: Config ): Alova2Method, 'djk.welfareList', Config>; welfareClaimInfo< Config extends Alova2MethodConfig> & { data: { /** * 领取时间 */ claimTime?: string; createTime?: string; /** * 领取商品ID */ goodsId?: number; /** * 用户ID */ memberId?: number; updateTime?: string; /** * 福利活动ID */ welfareId?: number; } } >( config: Config ): Alova2Method, 'djk.welfareClaimInfo', Config>; welfareClaimInfoDetaile< Config extends Alova2MethodConfig> & { pathParams: { memberId: number }; } >( config: Config ): Alova2Method, 'djk.welfareClaimInfoDetaile', Config>; welfareClaimInfoPopup< Config extends Alova2MethodConfig> & { pathParams: { memberId: number }; } >( config: Config ): Alova2Method, 'djk.welfareClaimInfoPopup', Config>; addWelfareOrder< Config extends Alova2MethodConfig> & { data: {/** * 企业ID */ channelId?: number; /** * 客户授权 */ customerAuthorization?: number; /** * 商品id */ goodsId?: number; /** * 商品数量 */ goodsNum?: number; /** * phone */ phone?: string; /** * 买家备注 */ remarks?: string; /** * 店铺id */ shopId?: number; /** * 福利活动Id */ welfareId?: number; }; } >( config: Config ): Alova2Method, 'djk.addWelfareOrder', Config>; submitRefund< Config extends Alova2MethodConfig> & { data: { /** * 订单号 */ orderNumber?: string; /** * 退款描述 */ refundDesc?: string; /** * 退款图片 */ refundImg?: string; /** * 退款原因 */ refundReason?: string; }; } >( config: Config ): Alova2Method, 'djk.submitRefund', Config>; } refueling: { /** * 加油支付码 */ getPayCode< Config extends Alova2MethodConfig> & { data: { /** * 二维码内容 */ content?: string; }; } >( config: Config ): Alova2Method, 'refueling.getPayCode', Config>; cancelOrder< Config extends Alova2MethodConfig> & { params: { /** * 订单ID */ orderId: string; }; } >( config: Config ): Alova2Method, 'refueling.cancelOrder', Config>; } attractions: { findAppByPage< Config extends Alova2MethodConfig> & { data: { /** * 页码 */ pageNum?: number; /** * 每页记录数 */ pageSize?: number; /** * 产品名称(模糊查询) */ productName?: string; } } >( config: Config ): Alova2Method, 'attractions.findAppByPage', Config>; detail< Config extends Alova2MethodConfig> & { data: { /** * 产品id */ productNo?: number; } } >( config: Config ): Alova2Method, 'attractions.detail', Config>; price< Config extends Alova2MethodConfig> & { data: { /** * 产品ID */ productNo?: number; /** * 开始日期 */ travelDate?: string; /** * 结束日期,不传默认只查本月的价格 */ endTravelDate?: string; } } >( config: Config ): Alova2Method, 'attractions.price', Config>; createOrder< Config extends Alova2MethodConfig> & { data: Api.CreateOrderRequest; } >( config: Config ): Alova2Method, 'attractions.createOrder', Config>; payPreview< Config extends Alova2MethodConfig> & { data: { /** * 订单号 */ orderNumber: string; } } >( config: Config ): Alova2Method, 'attractions.payPreview', Config>; orderList< Config extends Alova2MethodConfig> & { data: { pageNum: number; pageSize: number; /** * 订单状态:0-全部 1-待支付 2-已支付 3-已取消 4-已完成 */ status: number; } } >( config: Config ): Alova2Method, 'attractions.orderList', Config>; orderDetail< Config extends Alova2MethodConfig> & { data: { orderNumber: string; } } >( config: Config ): Alova2Method, 'attractions.orderDetail', Config>; cancelOrder< Config extends Alova2MethodConfig> & { data: { cancelMemo?: string; cancelNum?: number; orderNumber: string; } } >( config: Config ): Alova2Method, 'attractions.cancelOrder', Config>; } app: { /** * --- * * [GET] 优惠券活动列表查询 * * **path:** /smqjh-system/app-api/memberCoupon/page * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // 页码 * pageNum?: number * // 每页记录数 * pageSize?: number * // 优惠券状态 * useStatus?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // [items] start * // [items] end * list?: Array<{ * // id * id?: string * // 第三方id * allowanceId?: string * // 门槛(单位(元)) 满减时的需要达到什么金额 * amountMoney?: number * // 面额(单位(元)) 优惠的金额 * discountMoney?: number * // 使用状态:0-未使用 1-已使用 2-已过期 * useStatus?: number * // 锁定状态:0-未锁定/已释放 1-已锁定 * lockStatus?: number * // 锁定的订单ID * lockOrderId?: string * // 过期时间 * expirationTime?: string * // 订单使用时间 * orderCreateTime?: string * }> * total?: number * } * // 返回处理消息 * msg?: string * } * ``` */ get_smqjh_system_app_api_membercoupon_page< Config extends Alova2MethodConfig & { params: { /** * 页码 */ pageNum?: number; /** * 每页记录数 */ pageSize?: number; /** * 优惠券状态 */ useStatus?: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 优惠券详情查询 * * **path:** /smqjh-system/app-api/memberCoupon/findById * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * id: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // id * id?: string * // 门槛(单位(元)) 满减时的需要达到什么金额 * amountMoney?: number * // 第三方的津贴/券id * allowanceId?: string * // 批次id * batchId?: string * // 面额(单位(元)) 优惠的金额 * discountMoney?: number * // 使用状态:0-未使用 1-已使用 2-已过期 * useStatus?: number * // 锁定状态:0-未锁定/已释放 1-已锁定 * lockStatus?: number * // 领取时间 * getTime?: string * // 过期时间 * expirationTime?: string * // 订单使用时间 * orderPayTime?: string * // 锁定的订单ID * orderNumber?: string * // 门店名称 * storeName?: string * // 枪号 * gunNo?: string * // 商品名称(油品名称) * itemName?: string * // 订单金额(单位:分) * totalMoney?: number * // 实付金额(单位:分) * realMoney?: number * // 优惠减免金额 * promotionAmount?: number * // 下单时间 * orderCreateTime?: string * } * msg?: string * } * ``` */ get_smqjh_system_app_api_membercoupon_findbyid< Config extends Alova2MethodConfig & { params: { id: string; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 优惠券活动列表查询 * * **path:** /app-api/memberCoupon/page * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // 页码 * pageNum?: number * // 每页记录数 * pageSize?: number * // 优惠券状态 * useStatus?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // [items] start * // [items] end * list?: Array<{ * // id * id?: string * // 第三方id * allowanceId?: string * // 门槛(单位(元)) 满减时的需要达到什么金额 * amountMoney?: number * // 面额(单位(元)) 优惠的金额 * discountMoney?: number * // 使用状态:0-未使用 1-已使用 2-已过期 * useStatus?: number * // 锁定状态:0-未锁定/已释放 1-已锁定 * lockStatus?: number * // 锁定的订单ID * lockOrderId?: string * // 过期时间 * expirationTime?: string * // 订单使用时间 * orderCreateTime?: string * }> * total?: number * } * // 返回处理消息 * msg?: string * } * ``` */ get_app_api_membercoupon_page< Config extends Alova2MethodConfig & { params: { /** * 页码 */ pageNum?: number; /** * 每页记录数 */ pageSize?: number; /** * 优惠券状态 */ useStatus?: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 优惠券详情查询 * * **path:** /app-api/memberCoupon/findById * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * id: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // id * id?: string * // 门槛(单位(元)) 满减时的需要达到什么金额 * amountMoney?: number * // 第三方的津贴/券id * allowanceId?: string * // 批次id * batchId?: string * // 面额(单位(元)) 优惠的金额 * discountMoney?: number * // 使用状态:0-未使用 1-已使用 2-已过期 * useStatus?: number * // 锁定状态:0-未锁定/已释放 1-已锁定 * lockStatus?: number * // 领取时间 * getTime?: string * // 过期时间 * expirationTime?: string * // 订单使用时间 * orderPayTime?: string * // 锁定的订单ID * orderNumber?: string * // 门店名称 * storeName?: string * // 枪号 * gunNo?: string * // 商品名称(油品名称) * itemName?: string * // 订单金额(单位:分) * totalMoney?: number * // 实付金额(单位:分) * realMoney?: number * // 优惠减免金额 * promotionAmount?: number * // 下单时间 * orderCreateTime?: string * } * msg?: string * } * ``` */ get_app_api_membercoupon_findbyid< Config extends Alova2MethodConfig & { params: { id: string; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 查询用户下单时使用优惠劵 * * **path:** /smqjh-system/app-api/memberCoupon/findPlaceOrderList * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // 门店id * // 用于判断是否满足门店使用限制条件 * storeId?: string * // 订单金额 * // 用于判断是否满足满减的条件。 单位:分 * orderAmount?: number * // 津贴类型 * // 2.枪价券 * allowanceType?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * appCouponOrderOptimalVO?: { * // id * id?: string * // 券Id * allowanceId?: string * // 订单金额,单位:元 * amountMoney?: number * // 优惠金额,单位:元 * discountMoney?: number * // 优惠类型 1-满减,2-立减 * promotionType?: number * // 状态 1-可用;其他不可用 * status?: number * // 状态描述 * statusDesc?: string * // 限制使用优惠券,true:被限制 * restrict?: boolean * // 结束时间 * expirationTime?: string * } * // 可以用优惠劵 * // [items] start * // [items] end * appCouponOrderVOList?: Array<{ * // id * id?: string * // 券Id * allowanceId?: string * // 订单金额,单位:元 * amountMoney?: number * // 优惠金额,单位:元 * discountMoney?: number * // 优惠类型 1-满减,2-立减 * promotionType?: number * // 状态 1-可用;其他不可用 * status?: number * // 状态描述 * statusDesc?: string * // 限制使用优惠券,true:被限制 * restrict?: boolean * // 结束时间 * expirationTime?: string * }> * // 不可用优惠劵 * // [items] start * // [items] end * appCouponNoOrderVOList?: Array<{ * // id * id?: string * // 券Id * allowanceId?: string * // 订单金额,单位:元 * amountMoney?: number * // 优惠金额,单位:元 * discountMoney?: number * // 优惠类型 1-满减,2-立减 * promotionType?: number * // 状态 1-可用;其他不可用 * status?: number * // 状态描述 * statusDesc?: string * // 限制使用优惠券,true:被限制 * restrict?: boolean * // 结束时间 * expirationTime?: string * }> * } * msg?: string * } * ``` */ get_smqjh_system_app_api_membercoupon_findplaceorderlist< Config extends Alova2MethodConfig & { params: { /** * 门店id * 用于判断是否满足门店使用限制条件 */ storeId?: string; /** * 订单金额 * 用于判断是否满足满减的条件。 单位:分 */ orderAmount?: number; /** * 津贴类型 * 2.枪价券 */ allowanceType?: number; }; } >( config: Config ): Alova2Method< ResultAppMemberCouponOrderVO, 'app.get_smqjh_system_app_api_membercoupon_findplaceorderlist', Config >; /** * --- * * [GET] 查询用户下单时使用优惠劵 * * **path:** /app-api/memberCoupon/findPlaceOrderList * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // 门店id * // 用于判断是否满足门店使用限制条件 * storeId?: string * // 订单金额 * // 用于判断是否满足满减的条件。 单位:分 * orderAmount?: number * // 津贴类型 * // 2.枪价券 * allowanceType?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * appCouponOrderOptimalVO?: { * // id * id?: string * // 券Id * allowanceId?: string * // 订单金额,单位:元 * amountMoney?: number * // 优惠金额,单位:元 * discountMoney?: number * // 优惠类型 1-满减,2-立减 * promotionType?: number * // 状态 1-可用;其他不可用 * status?: number * // 状态描述 * statusDesc?: string * // 限制使用优惠券,true:被限制 * restrict?: boolean * // 结束时间 * expirationTime?: string * } * // 可以用优惠劵 * // [items] start * // [items] end * appCouponOrderVOList?: Array<{ * // id * id?: string * // 券Id * allowanceId?: string * // 订单金额,单位:元 * amountMoney?: number * // 优惠金额,单位:元 * discountMoney?: number * // 优惠类型 1-满减,2-立减 * promotionType?: number * // 状态 1-可用;其他不可用 * status?: number * // 状态描述 * statusDesc?: string * // 限制使用优惠券,true:被限制 * restrict?: boolean * // 结束时间 * expirationTime?: string * }> * // 不可用优惠劵 * // [items] start * // [items] end * appCouponNoOrderVOList?: Array<{ * // id * id?: string * // 券Id * allowanceId?: string * // 订单金额,单位:元 * amountMoney?: number * // 优惠金额,单位:元 * discountMoney?: number * // 优惠类型 1-满减,2-立减 * promotionType?: number * // 状态 1-可用;其他不可用 * status?: number * // 状态描述 * statusDesc?: string * // 限制使用优惠券,true:被限制 * restrict?: boolean * // 结束时间 * expirationTime?: string * }> * } * msg?: string * } * ``` */ get_app_api_membercoupon_findplaceorderlist< Config extends Alova2MethodConfig & { params: { /** * 门店id * 用于判断是否满足门店使用限制条件 */ storeId?: string; /** * 订单金额 * 用于判断是否满足满减的条件。 单位:分 */ orderAmount?: number; /** * 津贴类型 * 2.枪价券 */ allowanceType?: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 优惠券活动列表查询 * * **path:** /smqjh-system/app-api/coupon/page * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // 页码 * pageNum?: number * // 每页记录数 * pageSize?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // [items] start * // [items] end * list?: Array<{ * // id * id?: string * // 活动id * activityId?: string * // 活动名称 * activityName?: string * // 优惠类型 1.满减、2.立减 * promotionType?: number * // 门槛(单位(分)) 满减时的需要达到什么金额 * amountMoney?: number * // 面额(单位(分)) 优惠的金额 * discountMoney?: number * // 库存 * inventoryTotal?: number * // 实际库存 * inventoryActual?: number * // 含税采购价(元) * purchasePrice?: number * // 优惠券开始时间 * couponStartTime?: string * // 优惠券结束时间 * couponEndTime?: string * // 有效期,领取后多少天内有效(单位天) * expirationDate?: number * // 创建时间 * createTime?: string * // 更新时间 * updateTime?: string * // 标识是否有领取数 * receiveSign?: boolean * // 过期时间 * expirationTime?: string * }> * total?: number * } * // 返回处理消息 * msg?: string * } * ``` */ get_smqjh_system_app_api_coupon_page< Config extends Alova2MethodConfig & { params: { /** * 页码 */ pageNum?: number; /** * 每页记录数 */ pageSize?: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 查询优惠券详情信息 * * **path:** /smqjh-system/app-api/coupon/findById * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * couponId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // id * id?: string * // 活动id * activityId?: string * // 活动名称 * activityName?: string * // 优惠类型 1.满减、2.立减 * promotionType?: number * // 门槛(单位(分)) 满减时的需要达到什么金额 * amountMoney?: number * // 面额(单位(分)) 优惠的金额 * discountMoney?: number * // 库存 * inventoryTotal?: number * // 实际库存 * inventoryActual?: number * // 含税采购价(元) * purchasePrice?: number * // 优惠券开始时间 * couponStartTime?: string * // 优惠券结束时间 * couponEndTime?: string * // 有效期,领取后多少天内有效(单位天) * expirationDate?: number * // 创建时间 * createTime?: string * // 更新时间 * updateTime?: string * // 标识是否有领取数 * receiveSign?: boolean * // 过期时间 * expirationTime?: string * } * msg?: string * } * ``` */ get_smqjh_system_app_api_coupon_findbyid< Config extends Alova2MethodConfig & { params: { couponId: string; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 兑换明细 * * **path:** /smqjh-system/app-api/coupon/exchangeInfo * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * couponId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // id * id?: string * // 活动id * activityId?: string * // 活动名称 * activityName?: string * // 优惠类型 1.满减、2.立减 * promotionType?: number * // 门槛(单位(分)) 满减时的需要达到什么金额 * amountMoney?: number * // 面额(单位(分)) 优惠的金额 * discountMoney?: number * // 积分金额 * pointsMoney?: number * // 总库存 * inventoryTotal?: number * // 实际库存 * inventoryActual?: number * // 优惠券开始时间 * couponStartTime?: string * // 优惠券结束时间 * couponEndTime?: string * // 有效期,领取后多少天内有效(单位天) * expirationDate?: number * } * msg?: string * } * ``` */ get_smqjh_system_app_api_coupon_exchangeinfo< Config extends Alova2MethodConfig & { params: { couponId: string; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 使用积分进行兑换 * * **path:** /smqjh-system/app-api/coupon/exchangePoints * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * couponId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 抵扣券id * id?: string * // 活动id * activityId?: string * // 活动名称 * activityName?: string * // 门槛(单位(分)) 满减时的需要达到什么金额 * amountMoney?: number * // 面额(单位(分)) 优惠的金额 * discountMoney?: number * // 第三方的津贴/券id * allowanceId?: string * // 批次id * batchId?: string * // 有效期,领取后多少天内有效(单位天) * expirationDate?: number * } * msg?: string * } * ``` */ get_smqjh_system_app_api_coupon_exchangepoints< Config extends Alova2MethodConfig & { params: { couponId: string; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 优惠券活动列表查询 * * **path:** /app-api/coupon/page * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // 页码 * pageNum?: number * // 每页记录数 * pageSize?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // [items] start * // [items] end * list?: Array<{ * // id * id?: string * // 活动id * activityId?: string * // 活动名称 * activityName?: string * // 优惠类型 1.满减、2.立减 * promotionType?: number * // 门槛(单位(分)) 满减时的需要达到什么金额 * amountMoney?: number * // 面额(单位(分)) 优惠的金额 * discountMoney?: number * // 库存 * inventoryTotal?: number * // 实际库存 * inventoryActual?: number * // 含税采购价(元) * purchasePrice?: number * // 优惠券开始时间 * couponStartTime?: string * // 优惠券结束时间 * couponEndTime?: string * // 有效期,领取后多少天内有效(单位天) * expirationDate?: number * // 创建时间 * createTime?: string * // 更新时间 * updateTime?: string * // 标识是否有领取数 * receiveSign?: boolean * // 过期时间 * expirationTime?: string * }> * total?: number * } * // 返回处理消息 * msg?: string * } * ``` */ get_app_api_coupon_page< Config extends Alova2MethodConfig & { params: { /** * 页码 */ pageNum?: number; /** * 每页记录数 */ pageSize?: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 查询优惠券详情信息 * * **path:** /app-api/coupon/findById * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * couponId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // id * id?: string * // 活动id * activityId?: string * // 活动名称 * activityName?: string * // 优惠类型 1.满减、2.立减 * promotionType?: number * // 门槛(单位(分)) 满减时的需要达到什么金额 * amountMoney?: number * // 面额(单位(分)) 优惠的金额 * discountMoney?: number * // 库存 * inventoryTotal?: number * // 实际库存 * inventoryActual?: number * // 含税采购价(元) * purchasePrice?: number * // 优惠券开始时间 * couponStartTime?: string * // 优惠券结束时间 * couponEndTime?: string * // 有效期,领取后多少天内有效(单位天) * expirationDate?: number * // 创建时间 * createTime?: string * // 更新时间 * updateTime?: string * // 标识是否有领取数 * receiveSign?: boolean * // 过期时间 * expirationTime?: string * } * msg?: string * } * ``` */ get_app_api_coupon_findbyid< Config extends Alova2MethodConfig & { params: { couponId: string; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 兑换明细 * * **path:** /app-api/coupon/exchangeInfo * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * couponId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // id * id?: string * // 活动id * activityId?: string * // 活动名称 * activityName?: string * // 优惠类型 1.满减、2.立减 * promotionType?: number * // 门槛(单位(分)) 满减时的需要达到什么金额 * amountMoney?: number * // 面额(单位(分)) 优惠的金额 * discountMoney?: number * // 积分金额 * pointsMoney?: number * // 总库存 * inventoryTotal?: number * // 实际库存 * inventoryActual?: number * // 优惠券开始时间 * couponStartTime?: string * // 优惠券结束时间 * couponEndTime?: string * // 有效期,领取后多少天内有效(单位天) * expirationDate?: number * } * msg?: string * } * ``` */ get_app_api_coupon_exchangeinfo< Config extends Alova2MethodConfig & { params: { couponId: string; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 使用积分进行兑换 * * **path:** /app-api/coupon/exchangePoints * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * couponId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 抵扣券id * id?: string * // 活动id * activityId?: string * // 活动名称 * activityName?: string * // 门槛(单位(分)) 满减时的需要达到什么金额 * amountMoney?: number * // 面额(单位(分)) 优惠的金额 * discountMoney?: number * // 第三方的津贴/券id * allowanceId?: string * // 批次id * batchId?: string * // 有效期,领取后多少天内有效(单位天) * expirationDate?: number * } * msg?: string * } * ``` */ get_app_api_coupon_exchangepoints< Config extends Alova2MethodConfig & { params: { couponId: string; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 优惠券活动列表查询 * * **path:** /smqjh-system/app-api/coupon/findList * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * // [items] start * // [items] end * data?: Array<{ * // id * id?: string * // 活动id * activityId?: string * // 活动名称 * activityName?: string * // 优惠类型 1.满减、2.立减 * promotionType?: number * // 门槛(单位(分)) 满减时的需要达到什么金额 * amountMoney?: number * // 面额(单位(分)) 优惠的金额 * discountMoney?: number * // 库存 * inventoryTotal?: number * // 实际库存 * inventoryActual?: number * // 含税采购价(元) * purchasePrice?: number * // 优惠券开始时间 * couponStartTime?: string * // 优惠券结束时间 * couponEndTime?: string * // 有效期,领取后多少天内有效(单位天) * expirationDate?: number * // 创建时间 * createTime?: string * // 更新时间 * updateTime?: string * // 标识是否有领取数 * receiveSign?: boolean * // 过期时间 * expirationTime?: string * }> * msg?: string * } * ``` */ get_smqjh_system_app_api_coupon_findlist>( config?: Config ): Alova2Method; /** * --- * * [GET] 优惠券活动列表查询 * * **path:** /app-api/coupon/findList * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * // [items] start * // [items] end * data?: Array<{ * // id * id?: string * // 活动id * activityId?: string * // 活动名称 * activityName?: string * // 优惠类型 1.满减、2.立减 * promotionType?: number * // 门槛(单位(分)) 满减时的需要达到什么金额 * amountMoney?: number * // 面额(单位(分)) 优惠的金额 * discountMoney?: number * // 库存 * inventoryTotal?: number * // 实际库存 * inventoryActual?: number * // 含税采购价(元) * purchasePrice?: number * // 优惠券开始时间 * couponStartTime?: string * // 优惠券结束时间 * couponEndTime?: string * // 有效期,领取后多少天内有效(单位天) * expirationDate?: number * // 创建时间 * createTime?: string * // 更新时间 * updateTime?: string * // 标识是否有领取数 * receiveSign?: boolean * // 过期时间 * expirationTime?: string * }> * msg?: string * } * ``` */ get_app_api_coupon_findlist>( config?: Config ): Alova2Method; }; general: { /** * --- * * [POST] 手机号短信验证码登录 * * **path:** /smqjh-auth/oauth2/token * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * grant_type?: string * mobile?: string * code?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * code: string * data: { * access_token: string * refresh_token: string * code: string * mobile: string * token_type: string * expires_in: number * } * msg: string * } * ``` */ post_smqjh_auth_oauth2_token< Config extends Alova2MethodConfig<{ code: string; data: { access_token: string; refresh_token: string; code: string; mobile: string; token_type: string; expires_in: number; }; msg: string; }> & { params: { grant_type?: string; mobile?: string; code?: string; }; } >( config: Config ): Alova2Method< { code: string; data: { access_token: string; refresh_token: string; code: string; mobile: string; token_type: string; expires_in: number; }; msg: string; }, 'general.post_smqjh_auth_oauth2_token', Config >; /** * --- * * [POST] 发送手机短信验证码 * * **path:** /smqjh-auth/api/v1/auth/sms_code * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // 手机号 * mobile: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: object * msg?: string * } * ``` */ post_smqjh_auth_api_v1_auth_sms_code< Config extends Alova2MethodConfig & { params: { /** * 手机号 */ mobile: string; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 获取验证码 * * **path:** /api/v1/auth/captcha * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 验证码唯一标识(用于从Redis获取验证码Code) * captchaId?: string * // 验证码图片Base64字符串 * captchaBase64?: string * } * msg?: string * } * ``` */ get_api_v1_auth_captcha>( config?: Config ): Alova2Method; /** * --- * * [POST] 发送手机短信验证码 * * **path:** /api/v1/auth/sms_code * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // 手机号 * mobile: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: object * msg?: string * } * ``` */ post_api_v1_auth_sms_code< Config extends Alova2MethodConfig & { params: { /** * 手机号 */ mobile: string; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 获取登录会员信息 * * **path:** /smqjh-system/app-api/v1/members/me * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 会员ID * id?: number * // 会员昵称 * nickName?: string * // 会员头像地址 * avatarUrl?: string * // 会员手机号 * mobile?: string * // 会员余额(单位:分) * balance?: number * // 所属企业ID * channelId?: number * // 所属企业名称 * channelName?: string * // 配送费 * freightFee?: number * // 所属企业顶级ID * channelTopId?: number * } * msg?: string * } * ``` */ get_smqjh_system_app_api_v1_members_me>( config?: Config ): Alova2Method; /** * --- * * [POST] A1-查询Token * * **path:** /smqjh-pms/api/v1/refueling/queryToken * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // token,有效期内可复用 * accessToken?: string * // 有效期,单位秒 * availableTime?: number * } * msg?: string * } * ``` */ post_smqjh_pms_api_v1_refueling_querytoken>( config?: Config ): Alova2Method; /** * --- * * [POST] A2-查询门店价格 * * **path:** /smqjh-pms/api/v1/refueling/queryStorePrice * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 门店id列表,最多10个 * // [items] start * // [items] end * storeIds: string[] * // 手机号 * mobile: string * // 用户标识 * outUserId: string * // 开放渠道,固定1即可 * openChannel: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * // [items] start * // [items] end * data?: Array<{ * // 门店id * storeId?: string * // 油站禁止使用优惠券,0:禁止使用 * allowanceClientScheme?: number * // 油号信息列表 * // [items] start * // [items] end * itemInfoList?: Array<{ * // 油品名称,例如92# * itemName?: string * // 油品id * itemId?: string * // 发改委价格、国标价,单位分 * cityPrice?: number * // 门店价、油枪价、油机价,单位分 * storePrice?: number * // 小桔价、折扣价、优惠价,单位分 * vipPrice?: number * // 枪号列表 * // [items] start * // [items] end * gunNos?: string[] * // 优惠活动标签详情列表 * // [items] start * // [items] end * tagList?: Array<{ * // 标签类型,目前默认为0 * type?: number * // 标签位置,目前默认为0 * location?: number * // 图形类型,目前默认为0 * iconType?: number * // 标签名称 * title?: string * }> * // 小桔价、折扣价、优惠价,小程序显示的价格 * vipPriceShow?: number * // 发改委价格、国标价,小程序显示的价格 * cityPriceShow?: number * // 门店价、油枪价、油机价,小程序显示的价格 * storePriceShow?: number * }> * }> * msg?: string * } * ``` */ post_smqjh_pms_api_v1_refueling_querystoreprice< Config extends Alova2MethodConfig & { data: QueryStorePriceRequest; } >( config: Config ): Alova2Method< ResultListQueryStorePriceResponse, 'general.post_smqjh_pms_api_v1_refueling_querystoreprice', Config >; /** * --- * * [POST] A3-查询站点详情 * * **path:** /smqjh-pms/api/v1/refueling/queryStoreDetail * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 门店id * storeId: string * // 纬度 * lat: number * // 经度 * lon: number * // 外部用户id * outUserId?: string * // 手机号 * mobile?: string * // 开放渠道,固定1即可 * openChannel?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 门店id * storeId?: string * // 门店名称 * storeName?: string * // 门店logo * storeLogo?: string * // 门店图片列表 * // [items] start * // [items] end * storePicList?: string[] * // 城市 * cityName?: string * // 地址 * address?: string * // 经度 * lon?: number * // 纬度 * lat?: number * // 品牌 * brandName?: string * // 用户是否有未支付订单,0-否,1-是 * orderInPay?: number * // 油号信息列表 * // [items] start * // [items] end * itemInfoList?: Array<{ * // 油品名称,例如92# * itemName?: string * // 油品id * itemId?: string * // 发改委价格、国标价,单位分 * cityPrice?: number * // 门店价、油枪价、油机价,单位分 * storePrice?: number * // 小桔价、折扣价、优惠价,单位分 * vipPrice?: number * // 枪号列表 * // [items] start * // [items] end * gunNos?: string[] * // 优惠活动标签详情列表 * // [items] start * // [items] end * tagList?: Array<{ * // 标签类型,目前默认为0 * type?: number * // 标签位置,目前默认为0 * location?: number * // 图形类型,目前默认为0 * iconType?: number * // 标签名称 * title?: string * }> * // 小桔价、折扣价、优惠价,小程序显示的价格 * vipPriceShow?: number * // 发改委价格、国标价,小程序显示的价格 * cityPriceShow?: number * // 门店价、油枪价、油机价,小程序显示的价格 * storePriceShow?: number * }> * } * msg?: string * } * ``` */ post_smqjh_pms_api_v1_refueling_querystoredetail< Config extends Alova2MethodConfig & { data: QueryStoreDetailRequest; } >( config: Config ): Alova2Method< ResultQueryStoreDetailResponse, 'general.post_smqjh_pms_api_v1_refueling_querystoredetail', Config >; /** * --- * * [POST] A4-优惠价格计算 * * **path:** /smqjh-pms/api/v1/refueling/queryCalPrice * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 门店id * storeId: string * // 用户设备号,标识用户终端设备,可为空 * deviceId?: string * // 开放渠道,固定1即可 * openChannel: number * // 外部用户id,唯一标识用户,接入方需保证用户粒度唯一性 * outUserId: string * // 手机号 * mobile: string * // 油品名称,如:92# * itemName: string * // 订单总金额、机显金额,单位分 * amount: number * // 优惠营销信息,非必填,目前只允许单次使用一张优惠券 * // [items] start * // [items] end * promotionInfo?: Array<{ * // 小桔定义的津贴id * allowanceId?: string * // 津贴类型,2-枪价券 * allowanceType?: number * }> * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 门店id * storeId?: string * // 实付金额,单位分 * realPrice?: number * // 订单总金额、机显金额,单位分 * totalPrice?: number * // 服务费,单位分 * serviceFee?: number * // 优惠减免金额,单位分 * promotionAmount?: number * // 加油容量,单位毫升 * litre?: number * // 油品名称,例如92# * itemName?: string * } * msg?: string * } * ``` */ post_smqjh_pms_api_v1_refueling_querycalprice< Config extends Alova2MethodConfig & { data: QueryCalPriceRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] A5-批量优惠价格计算 * * **path:** /smqjh-pms/api/v1/refueling/queryCalPrices * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 门店id * storeId: string * // 用户设备号,标识用户终端设备,可为空 * deviceId?: string * // 开放渠道,固定1即可 * openChannel: number * // 外部用户id,唯一标识用户,接入方需保证用户粒度唯一性 * outUserId: string * // 手机号 * mobile: string * // 油品、容量信息 * // [items] start * // [items] end * itemList: Array<{ * // 油品名称,如:92# * itemName: string * // 订单总金额、机显金额,单位分 * amount: number * }> * // 优惠营销信息,非必填,目前只允许单次使用一张优惠券 * // [items] start * // [items] end * promotionInfo?: Array<{ * // 小桔定义的津贴id * allowanceId?: string * // 津贴类型,2-枪价券 * allowanceType?: number * }> * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 门店id * storeId?: string * // 价格信息列表 * // [items] start * // [items] end * itemList?: Array<{ * // 实付金额,单位分 * realPrice?: number * // 订单总金额、机显金额,单位分 * totalPrice?: number * // 服务费,单位分 * serviceFee?: number * // 优惠减免金额,单位分 * promotionAmount?: number * // 加油容量,单位毫升 * litre?: number * // 油品名称,例如92# * itemName?: string * }> * } * msg?: string * } * ``` */ post_smqjh_pms_api_v1_refueling_querycalprices< Config extends Alova2MethodConfig & { data: QueryCalPricesRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] A6-创建订单 * * **path:** /smqjh-pms/api/v1/refueling/queryNewOrder * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 外部用户id,唯一标识用户 * outUserId: string * // 手机号 * mobile: string * // 模糊后手机号,例如135****9872 * vagueMobile?: string * // 外部订单号 * outOrderId: string * // 用户实时纬度 * lat: number * // 用户实时经度 * lon: number * // 门店id * storeId: string * // 油号id * itemId: number * // 枪号 * gunNo: string * // 订单总金额,单位分,价格查询接口返回的totalPrice * originalAmount: number * // 订单支付金额,单位分,价格查询接口返回的realPrice * paymentAmount: number * // 服务费,单位分,价格查询接口返回的serviceFee * serviceFee: number * // 加油升数,单位毫升 * litre: number * // 小桔价、折扣价、优惠价,单位分 * vipPrice: number * // 门店价、油枪价、油机价,单位分 * storePrice: number * // 开放渠道,固定1即可 * openChannel: number * // 扩展参数,选填,接入方自定义,订单回调及查询会原样返回 * openExtra?: string * // 优惠营销信息,非必填 * // [items] start * // [items] end * promotionInfo?: Array<{ * // 小桔定义的津贴id * allowanceId?: string * // 津贴类型,2-枪价券 * allowanceType?: number * }> * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 待支付单号,客户端页面又称tradeId * tradeNo?: string * // 小桔订单号,客户端页面又称orderId * orderId?: string * // 小桔H5支付地址 * payUrl?: string * } * msg?: string * } * ``` */ post_smqjh_pms_api_v1_refueling_queryneworder< Config extends Alova2MethodConfig & { data: QueryNewOrderRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] A7-取消订单 * * **path:** /smqjh-pms/api/v1/refueling/cancelOrder * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 外部订单号 * outOrderId: string * // 小桔订单号 * orderId: string * // 外部用户号 * outUserId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 取消订单结果:取消订单成功:null;取消订单失败:3001(订单已支付)、3002(订单已支付)、 * opStatus?: number * // 状态 * success?: boolean * // 消息 * message?: string * } * msg?: string * } * ``` */ post_smqjh_pms_api_v1_refueling_cancelorder< Config extends Alova2MethodConfig & { data: CancelOrderRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] A8-获取优惠券 * * **path:** /smqjh-pms/api/v1/refueling/getPromotion * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 手机号 * mobile?: string * // 外部用户id * outUserId?: string * // 活动id * activityId?: string * // 外部交易号 * tradeNo?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * // [items] start * // [items] end * data?: Array<{ * // 津贴类型 2.枪价券 * allowanceType?: number * // 优惠类型 1.满减、2.立减 * promotionType?: number * // 优惠描述 * promotionDesc?: string * // 订单金额 * amount?: number * // 优惠金额 单位:分 * discount?: number * // 优惠券信息列表 * // [items] start * // [items] end * promotionInfo?: Array<{ * // 津贴/券id * allowanceId?: string * // 批次id * batchId?: string * // 状态 1-已使用 2-可使用 5-已过期 * status?: number * }> * }> * msg?: string * } * ``` */ post_smqjh_pms_api_v1_refueling_getpromotion< Config extends Alova2MethodConfig & { data: GetPromotionRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] A9-查询最优可用券 * * **path:** /smqjh-pms/api/v1/refueling/queryOrderPromotionList * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 手机号 * mobile?: string * // 外部用户id,唯一标识用户 * outUserId?: string * // 门店id,用于判断是否满足门店使用限制条件 * storeId?: string * // 订单金额,用于判断是否满足满减的条件,单位:分 * orderAmount?: number * // 津贴类型 2.枪价券 * allowanceType?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * // [items] start * // [items] end * data?: Array<{ * // 券Id * allowanceId?: string * // 优惠描述 * promotionDesc?: string * // 订单金额,单位:分 * amount?: number * // 优惠金额,单位:分 * discount?: number * // 优惠类型 1-满减,2-立减 * promotionType?: number * // 状态 1-可用;其他不可用 * status?: number * // 状态描述 * statusDesc?: string * // 限制使用优惠券,true:被限制 * restrict?: boolean * // 可用时间-开始,秒级时间戳 * startTimestamp?: string * // 可用时间-结束,秒级时间戳 * endTimestamp?: string * }> * msg?: string * } * ``` */ post_smqjh_pms_api_v1_refueling_queryorderpromotionlist< Config extends Alova2MethodConfig & { data: QueryOrderPromotionListRequest; } >( config: Config ): Alova2Method< ResultListQueryOrderPromotionListResponse, 'general.post_smqjh_pms_api_v1_refueling_queryorderpromotionlist', Config >; /** * --- * * [POST] A10-查询用户所有券列表 * * **path:** /smqjh-pms/api/v1/refueling/queryUserPromotionList * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 手机号 * mobile?: string * // 外部用户id,唯一标识用户 * outUserId?: string * // 津贴类型 2.枪价券 * allowanceType?: number * // 津贴状态 3.已使用、4.已过期、5.未使用 * status?: number * // 页码,从1开始 * pageIndex?: number * // 分页大小 * pageSize?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 页码 * pageIndex?: number * // 分页大小 * pageSize?: number * // 总记录数 * totalSize?: number * // 总页数 * totalPage?: number * // 优惠券信息列表 * // [items] start * // [items] end * data?: Array<{ * // 小桔定义的津贴id * allowanceId?: string * // 优惠描述 * promotionDesc?: string * // 订单金额,单位:分 * amount?: number * // 优惠金额,单位:分 * discount?: number * // 优惠类型 1.满减、2.立减 * promotionType?: number * // 可用时间-开始,秒级时间戳 * startTimestamp?: string * // 可用时间-结束,秒级时间戳 * endTimestamp?: string * // 状态 1.可用;其他不可用 * status?: number * // 状态描述 * statusDesc?: string * }> * } * msg?: string * } * ``` */ post_smqjh_pms_api_v1_refueling_queryuserpromotionlist< Config extends Alova2MethodConfig & { data: QueryUserPromotionListRequest; } >( config: Config ): Alova2Method< ResultQueryUserPromotionListResponse, 'general.post_smqjh_pms_api_v1_refueling_queryuserpromotionlist', Config >; /** * --- * * [POST] 生成二维码 * * **path:** /smqjh-pms/api/v1/refueling/generateQrCode * * --- * * **RequestBody** * ```ts * type RequestBody = { * key?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: string * msg?: string * } * ``` */ post_smqjh_pms_api_v1_refueling_generateqrcode< Config extends Alova2MethodConfig & { data: MapString; } >( config: Config ): Alova2Method; /** * --- * * [POST] B1-接收站点信息 * * **path:** /smqjh-pms/api/v1/refueling/receivingGasStation * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 应用标识 * appKey?: string * // 加密后的业务数据(AES-128-CBC加密) * data?: string * // 请求唯一标识 * requestId?: string * // 签名(HMac-MD5,大写) * sig?: string * // 时间戳(格式:yyyyMMddHHmmss) * timeStamp?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 接收是否成功 * success?: boolean * // 信息提示 * msg?: string * } * msg?: string * } * ``` */ post_smqjh_pms_api_v1_refueling_receivinggasstation< Config extends Alova2MethodConfig & { data: XiaojuEncryptedRequest; } >( config: Config ): Alova2Method< ResultReceiveGasStationResponse, 'general.post_smqjh_pms_api_v1_refueling_receivinggasstation', Config >; /** * --- * * [POST] B2-接收订单信息 * * **path:** /smqjh-pms/api/v1/refueling/notifyOrderInfo * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 应用标识 * appKey?: string * // 加密后的业务数据(AES-128-CBC加密) * data?: string * // 请求唯一标识 * requestId?: string * // 签名(HMac-MD5,大写) * sig?: string * // 时间戳(格式:yyyyMMddHHmmss) * timeStamp?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 接收是否成功:0-不成功,1-成功 * state?: number * // 信息提示 * message?: string * } * msg?: string * } * ``` */ post_smqjh_pms_api_v1_refueling_notifyorderinfo< Config extends Alova2MethodConfig & { data: XiaojuEncryptedRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] A1-查询Token * * **path:** /api/v1/refueling/queryToken * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // token,有效期内可复用 * accessToken?: string * // 有效期,单位秒 * availableTime?: number * } * msg?: string * } * ``` */ post_api_v1_refueling_querytoken>( config?: Config ): Alova2Method; /** * --- * * [POST] A2-查询门店价格 * * **path:** /api/v1/refueling/queryStorePrice * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 门店id列表,最多10个 * // [items] start * // [items] end * storeIds: string[] * // 手机号 * mobile: string * // 用户标识 * outUserId: string * // 开放渠道,固定1即可 * openChannel: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * // [items] start * // [items] end * data?: Array<{ * // 门店id * storeId?: string * // 油站禁止使用优惠券,0:禁止使用 * allowanceClientScheme?: number * // 油号信息列表 * // [items] start * // [items] end * itemInfoList?: Array<{ * // 油品名称,例如92# * itemName?: string * // 油品id * itemId?: string * // 发改委价格、国标价,单位分 * cityPrice?: number * // 门店价、油枪价、油机价,单位分 * storePrice?: number * // 小桔价、折扣价、优惠价,单位分 * vipPrice?: number * // 枪号列表 * // [items] start * // [items] end * gunNos?: string[] * // 优惠活动标签详情列表 * // [items] start * // [items] end * tagList?: Array<{ * // 标签类型,目前默认为0 * type?: number * // 标签位置,目前默认为0 * location?: number * // 图形类型,目前默认为0 * iconType?: number * // 标签名称 * title?: string * }> * // 小桔价、折扣价、优惠价,小程序显示的价格 * vipPriceShow?: number * // 发改委价格、国标价,小程序显示的价格 * cityPriceShow?: number * // 门店价、油枪价、油机价,小程序显示的价格 * storePriceShow?: number * }> * }> * msg?: string * } * ``` */ post_api_v1_refueling_querystoreprice< Config extends Alova2MethodConfig & { data: QueryStorePriceRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] A3-查询站点详情 * * **path:** /api/v1/refueling/queryStoreDetail * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 门店id * storeId: string * // 纬度 * lat: number * // 经度 * lon: number * // 外部用户id * outUserId?: string * // 手机号 * mobile?: string * // 开放渠道,固定1即可 * openChannel?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 门店id * storeId?: string * // 门店名称 * storeName?: string * // 门店logo * storeLogo?: string * // 门店图片列表 * // [items] start * // [items] end * storePicList?: string[] * // 城市 * cityName?: string * // 地址 * address?: string * // 经度 * lon?: number * // 纬度 * lat?: number * // 品牌 * brandName?: string * // 用户是否有未支付订单,0-否,1-是 * orderInPay?: number * // 油号信息列表 * // [items] start * // [items] end * itemInfoList?: Array<{ * // 油品名称,例如92# * itemName?: string * // 油品id * itemId?: string * // 发改委价格、国标价,单位分 * cityPrice?: number * // 门店价、油枪价、油机价,单位分 * storePrice?: number * // 小桔价、折扣价、优惠价,单位分 * vipPrice?: number * // 枪号列表 * // [items] start * // [items] end * gunNos?: string[] * // 优惠活动标签详情列表 * // [items] start * // [items] end * tagList?: Array<{ * // 标签类型,目前默认为0 * type?: number * // 标签位置,目前默认为0 * location?: number * // 图形类型,目前默认为0 * iconType?: number * // 标签名称 * title?: string * }> * // 小桔价、折扣价、优惠价,小程序显示的价格 * vipPriceShow?: number * // 发改委价格、国标价,小程序显示的价格 * cityPriceShow?: number * // 门店价、油枪价、油机价,小程序显示的价格 * storePriceShow?: number * }> * } * msg?: string * } * ``` */ post_api_v1_refueling_querystoredetail< Config extends Alova2MethodConfig & { data: QueryStoreDetailRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] A4-优惠价格计算 * * **path:** /api/v1/refueling/queryCalPrice * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 门店id * storeId: string * // 用户设备号,标识用户终端设备,可为空 * deviceId?: string * // 开放渠道,固定1即可 * openChannel: number * // 外部用户id,唯一标识用户,接入方需保证用户粒度唯一性 * outUserId: string * // 手机号 * mobile: string * // 油品名称,如:92# * itemName: string * // 订单总金额、机显金额,单位分 * amount: number * // 优惠营销信息,非必填,目前只允许单次使用一张优惠券 * // [items] start * // [items] end * promotionInfo?: Array<{ * // 小桔定义的津贴id * allowanceId?: string * // 津贴类型,2-枪价券 * allowanceType?: number * }> * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 门店id * storeId?: string * // 实付金额,单位分 * realPrice?: number * // 订单总金额、机显金额,单位分 * totalPrice?: number * // 服务费,单位分 * serviceFee?: number * // 优惠减免金额,单位分 * promotionAmount?: number * // 加油容量,单位毫升 * litre?: number * // 油品名称,例如92# * itemName?: string * } * msg?: string * } * ``` */ post_api_v1_refueling_querycalprice< Config extends Alova2MethodConfig & { data: QueryCalPriceRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] A5-批量优惠价格计算 * * **path:** /api/v1/refueling/queryCalPrices * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 门店id * storeId: string * // 用户设备号,标识用户终端设备,可为空 * deviceId?: string * // 开放渠道,固定1即可 * openChannel: number * // 外部用户id,唯一标识用户,接入方需保证用户粒度唯一性 * outUserId: string * // 手机号 * mobile: string * // 油品、容量信息 * // [items] start * // [items] end * itemList: Array<{ * // 油品名称,如:92# * itemName: string * // 订单总金额、机显金额,单位分 * amount: number * }> * // 优惠营销信息,非必填,目前只允许单次使用一张优惠券 * // [items] start * // [items] end * promotionInfo?: Array<{ * // 小桔定义的津贴id * allowanceId?: string * // 津贴类型,2-枪价券 * allowanceType?: number * }> * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 门店id * storeId?: string * // 价格信息列表 * // [items] start * // [items] end * itemList?: Array<{ * // 实付金额,单位分 * realPrice?: number * // 订单总金额、机显金额,单位分 * totalPrice?: number * // 服务费,单位分 * serviceFee?: number * // 优惠减免金额,单位分 * promotionAmount?: number * // 加油容量,单位毫升 * litre?: number * // 油品名称,例如92# * itemName?: string * }> * } * msg?: string * } * ``` */ post_api_v1_refueling_querycalprices< Config extends Alova2MethodConfig & { data: QueryCalPricesRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] A6-创建订单 * * **path:** /api/v1/refueling/queryNewOrder * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 外部用户id,唯一标识用户 * outUserId: string * // 手机号 * mobile: string * // 模糊后手机号,例如135****9872 * vagueMobile?: string * // 外部订单号 * outOrderId: string * // 用户实时纬度 * lat: number * // 用户实时经度 * lon: number * // 门店id * storeId: string * // 油号id * itemId: number * // 枪号 * gunNo: string * // 订单总金额,单位分,价格查询接口返回的totalPrice * originalAmount: number * // 订单支付金额,单位分,价格查询接口返回的realPrice * paymentAmount: number * // 服务费,单位分,价格查询接口返回的serviceFee * serviceFee: number * // 加油升数,单位毫升 * litre: number * // 小桔价、折扣价、优惠价,单位分 * vipPrice: number * // 门店价、油枪价、油机价,单位分 * storePrice: number * // 开放渠道,固定1即可 * openChannel: number * // 扩展参数,选填,接入方自定义,订单回调及查询会原样返回 * openExtra?: string * // 优惠营销信息,非必填 * // [items] start * // [items] end * promotionInfo?: Array<{ * // 小桔定义的津贴id * allowanceId?: string * // 津贴类型,2-枪价券 * allowanceType?: number * }> * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 待支付单号,客户端页面又称tradeId * tradeNo?: string * // 小桔订单号,客户端页面又称orderId * orderId?: string * // 小桔H5支付地址 * payUrl?: string * } * msg?: string * } * ``` */ post_api_v1_refueling_queryneworder< Config extends Alova2MethodConfig & { data: QueryNewOrderRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] A7-取消订单 * * **path:** /api/v1/refueling/cancelOrder * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 外部订单号 * outOrderId: string * // 小桔订单号 * orderId: string * // 外部用户号 * outUserId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 取消订单结果:取消订单成功:null;取消订单失败:3001(订单已支付)、3002(订单已支付)、 * opStatus?: number * // 状态 * success?: boolean * // 消息 * message?: string * } * msg?: string * } * ``` */ post_api_v1_refueling_cancelorder< Config extends Alova2MethodConfig & { data: CancelOrderRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] A8-获取优惠券 * * **path:** /api/v1/refueling/getPromotion * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 手机号 * mobile?: string * // 外部用户id * outUserId?: string * // 活动id * activityId?: string * // 外部交易号 * tradeNo?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * // [items] start * // [items] end * data?: Array<{ * // 津贴类型 2.枪价券 * allowanceType?: number * // 优惠类型 1.满减、2.立减 * promotionType?: number * // 优惠描述 * promotionDesc?: string * // 订单金额 * amount?: number * // 优惠金额 单位:分 * discount?: number * // 优惠券信息列表 * // [items] start * // [items] end * promotionInfo?: Array<{ * // 津贴/券id * allowanceId?: string * // 批次id * batchId?: string * // 状态 1-已使用 2-可使用 5-已过期 * status?: number * }> * }> * msg?: string * } * ``` */ post_api_v1_refueling_getpromotion< Config extends Alova2MethodConfig & { data: GetPromotionRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] A9-查询最优可用券 * * **path:** /api/v1/refueling/queryOrderPromotionList * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 手机号 * mobile?: string * // 外部用户id,唯一标识用户 * outUserId?: string * // 门店id,用于判断是否满足门店使用限制条件 * storeId?: string * // 订单金额,用于判断是否满足满减的条件,单位:分 * orderAmount?: number * // 津贴类型 2.枪价券 * allowanceType?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * // [items] start * // [items] end * data?: Array<{ * // 券Id * allowanceId?: string * // 优惠描述 * promotionDesc?: string * // 订单金额,单位:分 * amount?: number * // 优惠金额,单位:分 * discount?: number * // 优惠类型 1-满减,2-立减 * promotionType?: number * // 状态 1-可用;其他不可用 * status?: number * // 状态描述 * statusDesc?: string * // 限制使用优惠券,true:被限制 * restrict?: boolean * // 可用时间-开始,秒级时间戳 * startTimestamp?: string * // 可用时间-结束,秒级时间戳 * endTimestamp?: string * }> * msg?: string * } * ``` */ post_api_v1_refueling_queryorderpromotionlist< Config extends Alova2MethodConfig & { data: QueryOrderPromotionListRequest; } >( config: Config ): Alova2Method< ResultListQueryOrderPromotionListResponse, 'general.post_api_v1_refueling_queryorderpromotionlist', Config >; /** * --- * * [POST] A10-查询用户所有券列表 * * **path:** /api/v1/refueling/queryUserPromotionList * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 手机号 * mobile?: string * // 外部用户id,唯一标识用户 * outUserId?: string * // 津贴类型 2.枪价券 * allowanceType?: number * // 津贴状态 3.已使用、4.已过期、5.未使用 * status?: number * // 页码,从1开始 * pageIndex?: number * // 分页大小 * pageSize?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 页码 * pageIndex?: number * // 分页大小 * pageSize?: number * // 总记录数 * totalSize?: number * // 总页数 * totalPage?: number * // 优惠券信息列表 * // [items] start * // [items] end * data?: Array<{ * // 小桔定义的津贴id * allowanceId?: string * // 优惠描述 * promotionDesc?: string * // 订单金额,单位:分 * amount?: number * // 优惠金额,单位:分 * discount?: number * // 优惠类型 1.满减、2.立减 * promotionType?: number * // 可用时间-开始,秒级时间戳 * startTimestamp?: string * // 可用时间-结束,秒级时间戳 * endTimestamp?: string * // 状态 1.可用;其他不可用 * status?: number * // 状态描述 * statusDesc?: string * }> * } * msg?: string * } * ``` */ post_api_v1_refueling_queryuserpromotionlist< Config extends Alova2MethodConfig & { data: QueryUserPromotionListRequest; } >( config: Config ): Alova2Method< ResultQueryUserPromotionListResponse, 'general.post_api_v1_refueling_queryuserpromotionlist', Config >; /** * --- * * [POST] 生成二维码 * * **path:** /api/v1/refueling/generateQrCode * * --- * * **RequestBody** * ```ts * type RequestBody = { * key?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: string * msg?: string * } * ``` */ post_api_v1_refueling_generateqrcode< Config extends Alova2MethodConfig & { data: MapString; } >( config: Config ): Alova2Method; /** * --- * * [POST] B1-接收站点信息 * * **path:** /api/v1/refueling/receivingGasStation * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 应用标识 * appKey?: string * // 加密后的业务数据(AES-128-CBC加密) * data?: string * // 请求唯一标识 * requestId?: string * // 签名(HMac-MD5,大写) * sig?: string * // 时间戳(格式:yyyyMMddHHmmss) * timeStamp?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 接收是否成功 * success?: boolean * // 信息提示 * msg?: string * } * msg?: string * } * ``` */ post_api_v1_refueling_receivinggasstation< Config extends Alova2MethodConfig & { data: XiaojuEncryptedRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] B2-接收订单信息 * * **path:** /api/v1/refueling/notifyOrderInfo * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 应用标识 * appKey?: string * // 加密后的业务数据(AES-128-CBC加密) * data?: string * // 请求唯一标识 * requestId?: string * // 签名(HMac-MD5,大写) * sig?: string * // 时间戳(格式:yyyyMMddHHmmss) * timeStamp?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 接收是否成功:0-不成功,1-成功 * state?: number * // 信息提示 * message?: string * } * msg?: string * } * ``` */ post_api_v1_refueling_notifyorderinfo< Config extends Alova2MethodConfig & { data: XiaojuEncryptedRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] 保存加油商品 * * **path:** /api/v1/refueling/savePushProductOil * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * id?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: object * msg?: string * } * ``` */ post_api_v1_refueling_savepushproductoil< Config extends Alova2MethodConfig & { params: { id?: string; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] 保存加油商品 * * **path:** /smqjh-pms/app-api/v1/product_oil/savePushProductOil * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * id?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: object * msg?: string * } * ``` */ post_smqjh_pms_app_api_v1_product_oil_savepushproductoil< Config extends Alova2MethodConfig & { params: { id?: string; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] A3-查询站点详情 * * **path:** /smqjh-pms/app-api/v1/product_oil/queryStoreDetail * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 门店id * storeId: string * // 纬度 * lat: number * // 经度 * lon: number * // 外部用户id * outUserId?: string * // 手机号 * mobile?: string * // 开放渠道,固定1即可 * openChannel?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 门店id * storeId?: string * // 门店名称 * storeName?: string * // 门店logo * storeLogo?: string * // 门店图片列表 * // [items] start * // [items] end * storePicList?: string[] * // 城市 * cityName?: string * // 地址 * address?: string * // 经度 * lon?: number * // 纬度 * lat?: number * // 品牌 * brandName?: string * // 用户是否有未支付订单,0-否,1-是 * orderInPay?: number * // 油号信息列表 * // [items] start * // [items] end * itemInfoList?: Array<{ * // 油品名称,例如92# * itemName?: string * // 油品id * itemId?: string * // 发改委价格、国标价,单位分 * cityPrice?: number * // 门店价、油枪价、油机价,单位分 * storePrice?: number * // 小桔价、折扣价、优惠价,单位分 * vipPrice?: number * // 枪号列表 * // [items] start * // [items] end * gunNos?: string[] * // 优惠活动标签详情列表 * // [items] start * // [items] end * tagList?: Array<{ * // 标签类型,目前默认为0 * type?: number * // 标签位置,目前默认为0 * location?: number * // 图形类型,目前默认为0 * iconType?: number * // 标签名称 * title?: string * }> * // 小桔价、折扣价、优惠价,小程序显示的价格 * vipPriceShow?: number * // 发改委价格、国标价,小程序显示的价格 * cityPriceShow?: number * // 门店价、油枪价、油机价,小程序显示的价格 * storePriceShow?: number * }> * // 前端距离显示千米 * distanceShow?: number * // 油站禁止使用优惠券 * allowanceClientScheme?: boolean * } * msg?: string * } * ``` */ post_smqjh_pms_app_api_v1_product_oil_querystoredetail< Config extends Alova2MethodConfig & { data: QueryStoreDetailRequest; } >( config: Config ): Alova2Method< ResultGasStationDetailVO, 'general.post_smqjh_pms_app_api_v1_product_oil_querystoredetail', Config >; /** * --- * * [POST] 分页查询渠道商品 * * **path:** /smqjh-pms/app-api/v1/product_oil/page * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 页码 * pageNum?: number * // 每页记录数 * pageSize?: number * // 纬度(GCJ-02火星坐标系) * // 用户当前纬度 * lat?: number * // 经度(GCJ-02火星坐标系) * // 用户当前经度 * lon?: number * // 排序方式:0:价格排序,1:距离优先 * sort?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // [items] start * // [items] end * list?: Array<{ * // 门店id * storeId?: string * // 门店名称 * storeName?: string * // 地址 * address?: string * // 品牌 * brandName?: string * // 小桔价、折扣价、优惠价,单位分 * vipPrice?: number * // 油品名称,例如92# * itemName?: string * // 距离 * distance?: number * // 前端距离显示千米 * distanceShow?: number * // 纬度(GCJ-02火星坐标系) * lat?: number * // 经度(GCJ-02火星坐标系) * lon?: number * // 差值 * maxPriceDiff?: number * // 油站禁止使用优惠券 * allowanceClientScheme?: boolean * }> * total?: number * } * // 返回处理消息 * msg?: string * } * ``` */ post_smqjh_pms_app_api_v1_product_oil_page< Config extends Alova2MethodConfig & { data: GasStationQuery; } >( config: Config ): Alova2Method; /** * --- * * [POST] 电子围栏接口 * * **path:** /smqjh-pms/app-api/v1/product_oil/queryDistanceFence * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 用户当前纬度 * lat?: number * // 用户当前经度 * lon?: number * // 下单门店id * storeId?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 是否有更近的油站标识,true弹框提示,false继续下一步 * isClosest?: boolean * // 有更近标识时次集合有两条数据,第一条最近油站,当前下单油站 * // [items] start * // [items] end * storeVOS?: Array<{ * // 门店id * storeId?: string * // 门店名称 * storeName?: string * // 品牌 * brandName?: string * // 距离 * distance?: number * // 前端距离显示千米 * distanceShow?: number * // 纬度(GCJ-02火星坐标系) * lat?: number * // 经度(GCJ-02火星坐标系) * lon?: number * }> * } * msg?: string * } * ``` */ post_smqjh_pms_app_api_v1_product_oil_querydistancefence< Config extends Alova2MethodConfig & { data: DistanceFenceQuery; } >( config: Config ): Alova2Method< ResultDistanceFenceVO, 'general.post_smqjh_pms_app_api_v1_product_oil_querydistancefence', Config >; /** * --- * * [POST] 保存加油商品 * * **path:** /app-api/v1/product_oil/savePushProductOil * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * id?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: object * msg?: string * } * ``` */ post_app_api_v1_product_oil_savepushproductoil< Config extends Alova2MethodConfig & { params: { id?: string; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] 分页查询渠道商品 * * **path:** /app-api/v1/product_oil/page * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 页码 * pageNum?: number * // 每页记录数 * pageSize?: number * // 纬度(GCJ-02火星坐标系) * // 用户当前纬度 * lat?: number * // 经度(GCJ-02火星坐标系) * // 用户当前经度 * lon?: number * // 排序方式:0:价格排序,1:距离优先 * sort?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // [items] start * // [items] end * list?: Array<{ * // 门店id * storeId?: string * // 门店名称 * storeName?: string * // 地址 * address?: string * // 品牌 * brandName?: string * // 小桔价、折扣价、优惠价,单位分 * vipPrice?: number * // 油品名称,例如92# * itemName?: string * // 距离 * distance?: number * // 前端距离显示千米 * distanceShow?: number * // 纬度(GCJ-02火星坐标系) * lat?: number * // 经度(GCJ-02火星坐标系) * lon?: number * // 差值 * maxPriceDiff?: number * // 油站禁止使用优惠券 * allowanceClientScheme?: boolean * }> * total?: number * } * // 返回处理消息 * msg?: string * } * ``` */ post_app_api_v1_product_oil_page< Config extends Alova2MethodConfig & { data: GasStationQuery; } >( config: Config ): Alova2Method; /** * --- * * [POST] A3-查询站点详情 * * **path:** /app-api/v1/product_oil/queryStoreDetail * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 门店id * storeId: string * // 纬度 * lat: number * // 经度 * lon: number * // 外部用户id * outUserId?: string * // 手机号 * mobile?: string * // 开放渠道,固定1即可 * openChannel?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 门店id * storeId?: string * // 门店名称 * storeName?: string * // 门店logo * storeLogo?: string * // 门店图片列表 * // [items] start * // [items] end * storePicList?: string[] * // 城市 * cityName?: string * // 地址 * address?: string * // 经度 * lon?: number * // 纬度 * lat?: number * // 品牌 * brandName?: string * // 用户是否有未支付订单,0-否,1-是 * orderInPay?: number * // 油号信息列表 * // [items] start * // [items] end * itemInfoList?: Array<{ * // 油品名称,例如92# * itemName?: string * // 油品id * itemId?: string * // 发改委价格、国标价,单位分 * cityPrice?: number * // 门店价、油枪价、油机价,单位分 * storePrice?: number * // 小桔价、折扣价、优惠价,单位分 * vipPrice?: number * // 枪号列表 * // [items] start * // [items] end * gunNos?: string[] * // 优惠活动标签详情列表 * // [items] start * // [items] end * tagList?: Array<{ * // 标签类型,目前默认为0 * type?: number * // 标签位置,目前默认为0 * location?: number * // 图形类型,目前默认为0 * iconType?: number * // 标签名称 * title?: string * }> * // 小桔价、折扣价、优惠价,小程序显示的价格 * vipPriceShow?: number * // 发改委价格、国标价,小程序显示的价格 * cityPriceShow?: number * // 门店价、油枪价、油机价,小程序显示的价格 * storePriceShow?: number * }> * // 前端距离显示千米 * distanceShow?: number * // 油站禁止使用优惠券 * allowanceClientScheme?: boolean * } * msg?: string * } * ``` */ post_app_api_v1_product_oil_querystoredetail< Config extends Alova2MethodConfig & { data: QueryStoreDetailRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] 优惠价格计算接口 * * **path:** /smqjh-pms/app-api/v1/product_oil/queryCalPrice * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 门店id * storeId: string * // 用户设备号,标识用户终端设备,可为空 * deviceId?: string * // 开放渠道,固定1即可 * openChannel: number * // 外部用户id,唯一标识用户,接入方需保证用户粒度唯一性 * outUserId: string * // 手机号 * mobile: string * // 油品名称,如:92# * itemName: string * // 订单总金额、机显金额,单位分 * amount: number * // 优惠营销信息,非必填,目前只允许单次使用一张优惠券 * // [items] start * // [items] end * promotionInfo?: Array<{ * // 小桔定义的津贴id * allowanceId?: string * // 津贴类型,2-枪价券 * allowanceType?: number * }> * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 门店id * storeId?: string * // 实付金额,单位分 * realPrice?: number * // 订单总金额、机显金额,单位分 * totalPrice?: number * // 服务费,单位分 * serviceFee?: number * // 优惠减免金额,单位分 * promotionAmount?: number * // 加油容量,单位毫升 * litre?: number * // 油品名称,例如92# * itemName?: string * // 实付金额,前端显示 * realPriceShow?: number * // 订单总金额、机显金额,前端显示 * totalPriceShow?: number * // 服务费,前端显示 * serviceFeeShow?: number * // 优惠减免金额,前端显示 * promotionAmountShow?: number * // 加油容量,前端显示 * litreShow?: number * } * msg?: string * } * ``` */ post_smqjh_pms_app_api_v1_product_oil_querycalprice< Config extends Alova2MethodConfig & { data: QueryCalPriceRequest; } >( config: Config ): Alova2Method; /** * --- * * [POST] 电子围栏接口 * * **path:** /app-api/v1/product_oil/queryDistanceFence * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 用户当前纬度 * lat?: number * // 用户当前经度 * lon?: number * // 下单门店id * storeId?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 是否有更近的油站标识,true弹框提示,false继续下一步 * isClosest?: boolean * // 有更近标识时次集合有两条数据,第一条最近油站,当前下单油站 * // [items] start * // [items] end * storeVOS?: Array<{ * // 门店id * storeId?: string * // 门店名称 * storeName?: string * // 品牌 * brandName?: string * // 距离 * distance?: number * // 前端距离显示千米 * distanceShow?: number * // 纬度(GCJ-02火星坐标系) * lat?: number * // 经度(GCJ-02火星坐标系) * lon?: number * }> * } * msg?: string * } * ``` */ post_app_api_v1_product_oil_querydistancefence< Config extends Alova2MethodConfig & { data: DistanceFenceQuery; } >( config: Config ): Alova2Method; /** * --- * * [POST] 下单 * * **path:** /smqjh-oms/api/v1/oil/order/createOrder * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 用户实时纬度 * lat?: number * // 用户实时经度 * lon?: number * // 门店id * storeId?: string * // 油号id * itemId?: number * // 枪号 * gunNo?: string * // 订单总金额,单位分,价格查询接口返回的totalPrice * originalAmount: number * // 订单支付金额,单位分,价格查询接口返回的realPrice * paymentAmount: number * // 服务费,单位分,价格查询接口返回的serviceFee * serviceFee?: number * // 加油升数,单位毫升 价格查询接口返回的promotionAmount * litre?: number * // 小桔价、折扣价、优惠价,单位分 * vipPrice?: number * // 门店价、油枪价、油机价,单位分 * storePrice?: number * // 发改委价格、国标价,单位分,查询油站站点详细信息接口返回cityPrice * cityPrice?: number * // 优惠减免金额 价格查询接口返回的promotionAmount * promotionAmount?: number * // 门店名称 查询油站站点详细信息storeName * storeName?: string * // 城市 查询油站站点详细信息cityName * cityName?: string * // 油品名称 查询门店价格itemName * itemName?: string * // 优惠营销信息,非必填 * // [items] start * // [items] end * promotionInfo?: Array<{ * // 小桔定义的津贴id * allowanceId?: string * // 津贴类型,2-枪价券 * allowanceType?: number * }> * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: string * msg?: string * } * ``` */ post_smqjh_oms_api_v1_oil_order_createorder< Config extends Alova2MethodConfig & { data: OilOrderPo; } >( config: Config ): Alova2Method; /** * --- * * [POST] 加油订单列表 * * **path:** /smqjh-oms/api/v1/oil/order/findOilOrderPage * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 页码 * pageNum?: number * // 每页记录数 * pageSize?: number * // 订单状态:0全部,1-待支付,2-已支付,6-已退款,9-已取消 * status?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // [items] start * // [items] end * list?: Array<{ * // 订购流水号 * orderNumber?: string * // 门店名称 * storeName?: string * // 枪号 * gunNo?: string * // 商品名称(油品名称) * itemName?: string * // 品牌 * brandName?: string * // 实付金额 * realMoney?: number * // 订单金额 * totalMoney?: number * // 订单状态:1-待支付,2-已支付,6-已退款,9-已取消 * oilOrderStatus?: number * // 合作方订单号 * thirdOrderId?: string * // 付款时间 * payTime?: string * // 退款时间 * refundTime?: string * // 下单时间 * createTime?: string * // 取消时间 * cancelTime?: string * // 订单过期时间 * expireTime?: string * // 小桔H5支付地址 * payUrl?: string * // 微信交易号 * transactionId?: string * }> * total?: number * } * // 返回处理消息 * msg?: string * } * ``` */ post_smqjh_oms_api_v1_oil_order_findoilorderpage< Config extends Alova2MethodConfig & { data: OmsOrderOilPageQuery; } >( config: Config ): Alova2Method; /** * --- * * [POST] 加油订单列表 * * **path:** /api/v1/oil/order/findOilOrderPage * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 页码 * pageNum?: number * // 每页记录数 * pageSize?: number * // 订单状态:0全部,1-待支付,2-已支付,6-已退款,9-已取消 * status?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // [items] start * // [items] end * list?: Array<{ * // 订购流水号 * orderNumber?: string * // 门店名称 * storeName?: string * // 枪号 * gunNo?: string * // 商品名称(油品名称) * itemName?: string * // 品牌 * brandName?: string * // 实付金额 * realMoney?: number * // 订单金额 * totalMoney?: number * // 订单状态:1-待支付,2-已支付,6-已退款,9-已取消 * oilOrderStatus?: number * // 合作方订单号 * thirdOrderId?: string * // 付款时间 * payTime?: string * // 退款时间 * refundTime?: string * // 下单时间 * createTime?: string * // 取消时间 * cancelTime?: string * // 订单过期时间 * expireTime?: string * // 小桔H5支付地址 * payUrl?: string * // 微信交易号 * transactionId?: string * }> * total?: number * } * // 返回处理消息 * msg?: string * } * ``` */ post_api_v1_oil_order_findoilorderpage< Config extends Alova2MethodConfig & { data: OmsOrderOilPageQuery; } >( config: Config ): Alova2Method; /** * --- * * [POST] 下单 * * **path:** /api/v1/oil/order/createOrder * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 用户实时纬度 * lat?: number * // 用户实时经度 * lon?: number * // 门店id * storeId?: string * // 油号id * itemId?: number * // 枪号 * gunNo?: string * // 订单总金额,单位分,价格查询接口返回的totalPrice * originalAmount: number * // 订单支付金额,单位分,价格查询接口返回的realPrice * paymentAmount: number * // 服务费,单位分,价格查询接口返回的serviceFee * serviceFee?: number * // 加油升数,单位毫升 价格查询接口返回的promotionAmount * litre?: number * // 小桔价、折扣价、优惠价,单位分 * vipPrice?: number * // 门店价、油枪价、油机价,单位分 * storePrice?: number * // 发改委价格、国标价,单位分,查询油站站点详细信息接口返回cityPrice * cityPrice?: number * // 优惠减免金额 价格查询接口返回的promotionAmount * promotionAmount?: number * // 门店名称 查询油站站点详细信息storeName * storeName?: string * // 城市 查询油站站点详细信息cityName * cityName?: string * // 油品名称 查询门店价格itemName * itemName?: string * // 优惠营销信息,非必填 * // [items] start * // [items] end * promotionInfo?: Array<{ * // 小桔定义的津贴id * allowanceId?: string * // 津贴类型,2-枪价券 * allowanceType?: number * }> * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: string * msg?: string * } * ``` */ post_api_v1_oil_order_createorder< Config extends Alova2MethodConfig & { data: OilOrderPo; } >( config: Config ): Alova2Method; /** * --- * * [GET] 检查是否还有未支付订单 * * **path:** /api/v1/oil/order/checkOnPayOrder * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 小桔H5支付地址 * payUrl?: string * orderId?: string * } * msg?: string * } * ``` */ get_api_v1_oil_order_checkonpayorder>( config?: Config ): Alova2Method; /** * --- * * [POST] 取消订单并释放优惠券 * * **path:** /smqjh-oms/api/v1/oil/order/cancel * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // 订单ID * orderId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: boolean * msg?: string * } * ``` */ post_smqjh_oms_api_v1_oil_order_cancel< Config extends Alova2MethodConfig & { params: { /** * 订单ID */ orderId: string; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 支付成功后订单回写信息 * * **path:** /api/v1/oil/order/payResultInfo * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // 订单ID * orderId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 订单金额 * totalMoney?: number * // 平台订单号 * orderNumber?: string * // 三方订单号 * thirdOrderId?: string * // 枪号 * gunNo?: string * // 加油量 * quantity?: number * // 品牌名称 * brandName?: string * // 门店名称 * storeName?: string * // 油品 * itemName?: string * } * msg?: string * } * ``` */ get_api_v1_oil_order_payresultinfo< Config extends Alova2MethodConfig & { params: { /** * 订单ID */ orderId: string; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] 支付订单+标记优惠券使用 * * **path:** /smqjh-oms/api/v1/oil/order/pay * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * orderId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: boolean * msg?: string * } * ``` */ post_smqjh_oms_api_v1_oil_order_pay< Config extends Alova2MethodConfig & { params: { orderId: string; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] 取消订单并释放优惠券 * * **path:** /api/v1/oil/order/cancel * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // 订单ID * orderId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: boolean * msg?: string * } * ``` */ post_api_v1_oil_order_cancel< Config extends Alova2MethodConfig & { params: { /** * 订单ID */ orderId: string; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] 获取订单开票 * * **path:** /smqjh-oms/api/v1/oil/order/invoiceOrder * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // 订单ID * orderId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: string * msg?: string * } * ``` */ post_smqjh_oms_api_v1_oil_order_invoiceorder< Config extends Alova2MethodConfig & { params: { /** * 订单ID */ orderId: string; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 支付成功后订单回写信息 * * **path:** /smqjh-oms/api/v1/oil/order/payResultInfo * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // 订单ID * orderId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // 订单金额 * totalMoney?: number * // 平台订单号 * orderNumber?: string * // 三方订单号 * thirdOrderId?: string * // 枪号 * gunNo?: string * // 加油量 * quantity?: number * // 品牌名称 * brandName?: string * // 门店名称 * storeName?: string * // 油品 * itemName?: string * } * msg?: string * } * ``` */ get_smqjh_oms_api_v1_oil_order_payresultinfo< Config extends Alova2MethodConfig & { params: { /** * 订单ID */ orderId: string; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] 支付订单+标记优惠券使用 * * **path:** /api/v1/oil/order/pay * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * orderId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: boolean * msg?: string * } * ``` */ post_api_v1_oil_order_pay< Config extends Alova2MethodConfig & { params: { orderId: string; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] 支付订单+标记优惠券使用 * * **path:** /api/v1/oil/order/scanTimeoutCancelOrder * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: boolean * msg?: string * } * ``` */ post_api_v1_oil_order_scantimeoutcancelorder>( config?: Config ): Alova2Method; /** * --- * * [POST] 退款 * * **path:** /api/v1/oil/order/refundOrder * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * orderId: string * refundTime: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: boolean * msg?: string * } * ``` */ post_api_v1_oil_order_refundorder< Config extends Alova2MethodConfig & { params: { orderId: string; refundTime: string; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] 退款 * * **path:** /smqjh-oms/api/v1/oil/order/refundOrder * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * orderId: string * refundTime: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: boolean * msg?: string * } * ``` */ post_smqjh_oms_api_v1_oil_order_refundorder< Config extends Alova2MethodConfig & { params: { orderId: string; refundTime: string; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] 获取订单开票 * * **path:** /api/v1/oil/order/invoiceOrder * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // 订单ID * orderId: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: string * msg?: string * } * ``` */ post_api_v1_oil_order_invoiceorder< Config extends Alova2MethodConfig & { params: { /** * 订单ID */ orderId: string; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] 根据订单编号查询支付地址 * * **path:** /smqjh-oms/api/v1/oil/order/findByPayUrl * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * // 订单ID * orderNumber: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: string * msg?: string * } * ``` */ post_smqjh_oms_api_v1_oil_order_findbypayurl< Config extends Alova2MethodConfig & { params: { /** * 订单ID */ orderNumber: string; }; } >( config: Config ): Alova2Method; /** * --- * * [POST] 加油订单支付回调 * * **path:** /api/v1/oil/callback/third-party * * --- * * **RequestBody** * ```ts * type RequestBody = { * // 外部用户号(第三方平台UserId) * outUserId?: string * // 订单号 * orderId?: string * // 门店id * storeId?: string * // 门店名称 * storeName?: string * // 城市名称 * cityName?: string * // 枪号 * gunNo?: string * // 商品名称(油品名称) * itemName?: string * // 商品升数 * quantity?: string * // 订单金额(单位:分) * totalMoney?: number * // 实付金额(单位:分) * realMoney?: number * // 订单状态:1-待支付,2-已支付,6-已退款,9-已取消 * orderStatus?: number * // 支付时间 * payTime?: string * // 退款时间(未退款时无退款时间) * refundTime?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * // 返回数据对象 * data?: object * msg?: string * } * ``` */ post_api_v1_oil_callback_third_party< Config extends Alova2MethodConfig & { data: NotifyOrderInfoRequestDto; } >( config: Config ): Alova2Method; /** * --- * * [GET] 小程序-我的订单 all-全部 paddingPay-待支付 ing-进行中 completed-已完成 cancel-已取消 * * **path:** /api/v1/order/orderList * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * pageNum?: number * pageSize?: number * businessType?: string * orderStatus?: string * dvyType?: number * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * // [items] start * // [items] end * list?: Array<{ * createTime?: string * updateTime?: string * // 第三方订单ID * thirdOrderId?: string * // 用户ID * memberId?: number * // 店铺id * shopId?: number * // 企业ID * channelId?: number * // 企业名称 * channelName?: string * // 订购流水号 * orderNumber?: string * // 订单总额 * orderMoney?: number * // 商品总值 * total?: number * // 实际总值(用户实付) * actualTotal?: number * // 订单运费 * freightAmount?: number * // 企业用户用积分抵扣,后台充值积分 * offsetPoints?: number * // 支付方式 0-微信 1-积分 2-混合 * payType?: number * // 买家备注 * remarks?: string * // 卖家备注 * shopRemarks?: string * // 配送类型 1:快递 2:自提 3:及时配送 * dvyType?: number * // 配送方式ID * dvyId?: number * // 物流单号 * dvyFlowId?: string * // 物流公司编号 * dvyNo?: string * // 物流公司名称 * dvyName?: string * // 付款时间 * payTime?: string * // 发货时间 * dvyTime?: string * // 取消原因 * cancelReason?: string * // 取消时间 * cancelTime?: string * // 用户订单删除状态 * deleteStatus?: number * // 订单类型 0-微信订单 1-积分订单 2-混合订单 * orderType?: number * // 订单关闭原因 1-超时未支付 2-退款关闭 4-买家取消 15-已通过货到付款交易 * closeType?: number * // 海博订单状态:0-待支付,1-待发货(快递使用),20-订单已接单(待拣货),30-订单待配送(拣货完成/自提类订单为待自提),40-订单配送中 ,50-订单取消待审核,60-订单已取消,70-订单已送达,80-订单已完成 * hbOrderStatus?: number * // 海博物流状态(20:已抢单,30:配送员到店,40:取货完成,50:配送单取消,100:已送达) * hbLogisticStatus?: number * // 业务类型 * businessType?: string * // 收货人姓名 * consigneeName?: string * // 收货人电话 * consigneeMobile: string * // 收货人地址 * consigneeAddress?: string * // 是否已经支付,1:已经支付过,0:,没有支付过 * isPayed?: number * // 微信订单号 * outTradeNo?: string * // 微信交易号 * transactionId?: string * // 纬度 * latitude?: number * // 经度 * longitude?: number * // 订单售后状态(0-无售后订单,1-部分商品退款,2-退款完成) * refundStatus?: number * // 影院名称 * cinemaName?: string * // 影院编码 * cinemaCode?: string * // 计影片类型 * planType?: string * // 影厅名称 * hallName?: string * // 场次 * session?: string * // 电影名称 * movieName?: string * // 订单图片 * orderImage?: string * // 门店名称 * shopName?: string * // 门店地址 * shopAddress?: string * // 门店电话 * tel?: string * djkOrderAttachInfo?: { * createTime?: string * updateTime?: string * // 订单号 * orderNumber?: string * // 大健康订单类型 0-正常订单 1-福利订单 * djkOrderType?: number * // 商品id * goodsId?: number * // 商品图 * goodsImg?: string * // 商品名 * goodsName?: string * // 商品编码 * goodsCode?: string * // 价格 * price?: number * // 商品数量 * goodsNum?: number * // 有效时间(天) * effectiveTime?: number * // 提前预约时间(天) * advanceBookingTime?: number * // 活动名称 * activityName?: string * // 客户授权 * customerAuthorization?: number * // 过期时间 * expiredTime?: string * // 核销时间 * verificationTime?: string * // 核销人 * verificationPerson?: string * // 核销门店 * verificationShop?: string * // 退款单号 * refundNo?: string * // 退款原因 * refundReason?: string * // 退款描述 * refundDesc?: string * // 退款图片 * refundImg?: string * // 提交退款时间 * submitRefundTime?: string * // 退款到账时间 * refundTime?: string * // 订单备注 * remark?: string * } * // 商品总额 * goodsTotal?: number * // 是否存在退款单 0不存在 1存在 * hasRefund?: number * // 子订单 * // [items] start * // [items] end * orderItemList?: Array<{ * // 用户Id * memberId?: number * // 店铺id * shopId?: number * // 订单order_number * orderNumber?: string * // 产品ID * prodId?: number * // 产品SkuID * skuId?: number * // 购物车产品个数 * prodCount?: number * // 产品名称 * prodName?: string * // sku名称 * skuName?: string * // 产品主图片路径 * pic?: string * // spec * spec?: string * // 产品价格 * price?: number * // 商品小计 * productTotalAmount?: number * // 购物时间 * recTime?: string * // 使用积分 * useScore?: number * // 获得积分 * gainScore?: number * }> * // 电影院子订单 * // [items] start * // [items] end * orderMovieItems?: Array<{ * // 订单order_number * orderNumber?: string * // 座位名称 * name?: string * // 票码 * ticketCode?: string * // 二维码 * pic?: string * // 区域类型(1-普通区域, 2-特殊区域 3-贵宾区) * areaType?: string * // 使用状态(未使用, :已使用, :已过期) * status?: number * // 产品价格 * price?: number * // 购物时间 * recTime?: string * }> * // 影院电话号码 * cinemaPhone?: string * chargeOrder?: { * // 用户ID * memberId?: number * // 订购流水号 * orderNumber?: string * // 充电订单状态: * status?: number * // 备注 * remarks?: string * // 充电订单号 * chargeOrderNo?: string * // 开始充电时间 * startTime?: string * // 结束充电时间 * endTime?: string * // 第三方充电站ID * stationId?: string * // 充电时间:秒 * chargeTime?: number * // 实际充电度数(单位:0.001 kw/h) * totalCharge?: number * // 平台实际收取金额 * realCost?: number * // 平台总服务费 * realServiceCost?: number * // 预充值金额 * preAmt?: number * // 充电设备接口编码 * connectorId?: string * chargeOrderId?: string * // 电站名称 * powerStationName?: string * // 三方电费 * totalMoney?: number * // 充电度数 * totalPower?: number * // 0:用户手动停止充电;1:客户归属地运营商平台停止充电;2:BMS停止充电;3:充电机设备故障;4:连接器断开;其它:自定义 * stopMethod?: number * } * yppDetail?: { * key?: object * } * // 会员昵称 * memberNickName?: string * // 会员真实姓名 * memberRealName?: string * // 会员电话 * memberMobile?: string * // 记录 * // [items] start * // [items] end * djkOrderLogList?: Array<{ * createTime?: string * updateTime?: string * // 订单号 * orderNumber?: string * // 操作 * operation?: string * // 操作员 * operator?: string * // 订单备注 * remark?: string * }> * virtualOrderItem?: { * createTime?: string * updateTime?: string * // 订购流水号,关联主订单 * orderNumber?: string * // 用户ID * memberId?: number * // 渠道ID * channelId?: number * // 商品编号(本地pms_video_product.product_number) * productNumber?: string * // 第三方商品编码(pms_video_product.product_id) * productId?: string * // 商品名称 * productName?: string * // 商品类型:卡密/直充 * productType?: string * // 面值 * faceValue?: number * // 采购价(成本) * purchasePrice?: number * // 销售价(从pms_video_channel_price获取) * sellPrice?: number * // 充值账号(直充类) * rechargeAccount?: string * // 账号类型:1手机号 2QQ号 0其他 * accountType?: number * // 充值状态:0待处理 1处理中 2成功 3失败 * rechargeStatus?: number * // 第三方平台订单号 * thirdOrderNo?: string * // 卡密信息JSON(卡密类商品,需解密) * cardInfo?: string * // 第三方接口原始返回JSON * thirdResponse?: string * } * // 优惠券ID * couponId?: string * // 1-待支付,2-已支付,6-已退款,9-已取消 * oilOrderStatus?: number * // 订单平台类型(0-小程序 1-TV) * orderPlatformType?: number * // 订单过期时间 * expireTime?: string * // 是否可核销,0:不可核销操作,1:可进行核销操作 * isWriteOff?: number * shopInfo?: { * // 门店id * shopId?: number * // shop_logo * shopLogo?: string * // 门店名称 * shopName?: string * // shop_lat * shopLat?: number * // shop_lng * shopLng?: number * // tel * tel?: string * } * omsOrderOilVO?: { * // 小桔订单号 * xjOrderId?: string * // 门店ID * storeId?: string * // 门店名称 * storeName?: string * // 城市名称 * cityName?: string * // 枪号 * gunNo?: string * // 商品名称(油品名称) * itemName?: string * // 油号id * itemId?: number * // 商品升数 * quantity?: number * // 订单金额(单位:分) * totalMoney?: number * // 实付金额(单位:分) * realMoney?: number * // 订单状态:1-待支付,2-已支付,6-已退款,9-已取消 * orderStatus?: number * // 支付时间 * payTime?: string * // 退款时间 * refundTime?: string * // 服务费 * serviceFee?: number * // 优惠减免金额 * promotionAmount?: number * // 发改委价格、国标价 * cityPrice?: number * // 门店价、油枪价、油机价 * storePrice?: number * // 品牌名称 * brandName?: string * // 油站地址 * address?: string * // 优惠卷名称 * activityName?: string * // 优惠卷id * allowanceId?: string * // 小桔H5支付地址 * payUrl?: string * // 小桔价、折扣价、优惠价 * vipPrice?: number * } * }> * total?: number * } * // 返回处理消息 * msg?: string * } * ``` */ get_api_v1_order_orderlist< Config extends Alova2MethodConfig & { params: { pageNum?: number; pageSize?: number; businessType?: string; orderStatus?: string; dvyType?: number; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 小程序-订单详情 * * **path:** /smqjh-oms/api/v1/order/orderInfo * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * orderNo?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * createTime?: string * updateTime?: string * // 第三方订单ID * thirdOrderId?: string * // 用户ID * memberId?: number * // 店铺id * shopId?: number * // 企业ID * channelId?: number * // 企业名称 * channelName?: string * // 订购流水号 * orderNumber?: string * // 订单总额 * orderMoney?: number * // 商品总值 * total?: number * // 实际总值(用户实付) * actualTotal?: number * // 订单运费 * freightAmount?: number * // 企业用户用积分抵扣,后台充值积分 * offsetPoints?: number * // 支付方式 0-微信 1-积分 2-混合 * payType?: number * // 买家备注 * remarks?: string * // 卖家备注 * shopRemarks?: string * // 配送类型 1:快递 2:自提 3:及时配送 * dvyType?: number * // 配送方式ID * dvyId?: number * // 物流单号 * dvyFlowId?: string * // 物流公司编号 * dvyNo?: string * // 物流公司名称 * dvyName?: string * // 付款时间 * payTime?: string * // 发货时间 * dvyTime?: string * // 取消原因 * cancelReason?: string * // 取消时间 * cancelTime?: string * // 用户订单删除状态 * deleteStatus?: number * // 订单类型 0-微信订单 1-积分订单 2-混合订单 * orderType?: number * // 订单关闭原因 1-超时未支付 2-退款关闭 4-买家取消 15-已通过货到付款交易 * closeType?: number * // 海博订单状态:0-待支付,1-待发货(快递使用),20-订单已接单(待拣货),30-订单待配送(拣货完成/自提类订单为待自提),40-订单配送中 ,50-订单取消待审核,60-订单已取消,70-订单已送达,80-订单已完成 * hbOrderStatus?: number * // 海博物流状态(20:已抢单,30:配送员到店,40:取货完成,50:配送单取消,100:已送达) * hbLogisticStatus?: number * // 业务类型 * businessType?: string * // 收货人姓名 * consigneeName?: string * // 收货人电话 * consigneeMobile: string * // 收货人地址 * consigneeAddress?: string * // 是否已经支付,1:已经支付过,0:,没有支付过 * isPayed?: number * // 微信订单号 * outTradeNo?: string * // 微信交易号 * transactionId?: string * // 纬度 * latitude?: number * // 经度 * longitude?: number * // 订单售后状态(0-无售后订单,1-部分商品退款,2-退款完成) * refundStatus?: number * // 影院名称 * cinemaName?: string * // 影院编码 * cinemaCode?: string * // 计影片类型 * planType?: string * // 影厅名称 * hallName?: string * // 场次 * session?: string * // 电影名称 * movieName?: string * // 订单图片 * orderImage?: string * // 门店名称 * shopName?: string * // 门店地址 * shopAddress?: string * // 门店电话 * tel?: string * djkOrderAttachInfo?: { * createTime?: string * updateTime?: string * // 订单号 * orderNumber?: string * // 大健康订单类型 0-正常订单 1-福利订单 * djkOrderType?: number * // 商品id * goodsId?: number * // 商品图 * goodsImg?: string * // 商品名 * goodsName?: string * // 商品编码 * goodsCode?: string * // 价格 * price?: number * // 商品数量 * goodsNum?: number * // 有效时间(天) * effectiveTime?: number * // 提前预约时间(天) * advanceBookingTime?: number * // 活动名称 * activityName?: string * // 客户授权 * customerAuthorization?: number * // 过期时间 * expiredTime?: string * // 核销时间 * verificationTime?: string * // 核销人 * verificationPerson?: string * // 核销门店 * verificationShop?: string * // 退款单号 * refundNo?: string * // 退款原因 * refundReason?: string * // 退款描述 * refundDesc?: string * // 退款图片 * refundImg?: string * // 提交退款时间 * submitRefundTime?: string * // 退款到账时间 * refundTime?: string * // 订单备注 * remark?: string * } * // 商品总额 * goodsTotal?: number * // 是否存在退款单 0不存在 1存在 * hasRefund?: number * // 子订单 * // [items] start * // [items] end * orderItemList?: Array<{ * // 用户Id * memberId?: number * // 店铺id * shopId?: number * // 订单order_number * orderNumber?: string * // 产品ID * prodId?: number * // 产品SkuID * skuId?: number * // 购物车产品个数 * prodCount?: number * // 产品名称 * prodName?: string * // sku名称 * skuName?: string * // 产品主图片路径 * pic?: string * // spec * spec?: string * // 产品价格 * price?: number * // 商品小计 * productTotalAmount?: number * // 购物时间 * recTime?: string * // 使用积分 * useScore?: number * // 获得积分 * gainScore?: number * }> * // 电影院子订单 * // [items] start * // [items] end * orderMovieItems?: Array<{ * // 订单order_number * orderNumber?: string * // 座位名称 * name?: string * // 票码 * ticketCode?: string * // 二维码 * pic?: string * // 区域类型(1-普通区域, 2-特殊区域 3-贵宾区) * areaType?: string * // 使用状态(未使用, :已使用, :已过期) * status?: number * // 产品价格 * price?: number * // 购物时间 * recTime?: string * }> * // 影院电话号码 * cinemaPhone?: string * chargeOrder?: { * // 用户ID * memberId?: number * // 订购流水号 * orderNumber?: string * // 充电订单状态: * status?: number * // 备注 * remarks?: string * // 充电订单号 * chargeOrderNo?: string * // 开始充电时间 * startTime?: string * // 结束充电时间 * endTime?: string * // 第三方充电站ID * stationId?: string * // 充电时间:秒 * chargeTime?: number * // 实际充电度数(单位:0.001 kw/h) * totalCharge?: number * // 平台实际收取金额 * realCost?: number * // 平台总服务费 * realServiceCost?: number * // 预充值金额 * preAmt?: number * // 充电设备接口编码 * connectorId?: string * chargeOrderId?: string * // 电站名称 * powerStationName?: string * // 三方电费 * totalMoney?: number * // 充电度数 * totalPower?: number * // 0:用户手动停止充电;1:客户归属地运营商平台停止充电;2:BMS停止充电;3:充电机设备故障;4:连接器断开;其它:自定义 * stopMethod?: number * } * yppDetail?: { * key?: object * } * // 会员昵称 * memberNickName?: string * // 会员真实姓名 * memberRealName?: string * // 会员电话 * memberMobile?: string * // 记录 * // [items] start * // [items] end * djkOrderLogList?: Array<{ * createTime?: string * updateTime?: string * // 订单号 * orderNumber?: string * // 操作 * operation?: string * // 操作员 * operator?: string * // 订单备注 * remark?: string * }> * virtualOrderItem?: { * createTime?: string * updateTime?: string * // 订购流水号,关联主订单 * orderNumber?: string * // 用户ID * memberId?: number * // 渠道ID * channelId?: number * // 商品编号(本地pms_video_product.product_number) * productNumber?: string * // 第三方商品编码(pms_video_product.product_id) * productId?: string * // 商品名称 * productName?: string * // 商品类型:卡密/直充 * productType?: string * // 面值 * faceValue?: number * // 采购价(成本) * purchasePrice?: number * // 销售价(从pms_video_channel_price获取) * sellPrice?: number * // 充值账号(直充类) * rechargeAccount?: string * // 账号类型:1手机号 2QQ号 0其他 * accountType?: number * // 充值状态:0待处理 1处理中 2成功 3失败 * rechargeStatus?: number * // 第三方平台订单号 * thirdOrderNo?: string * // 卡密信息JSON(卡密类商品,需解密) * cardInfo?: string * // 第三方接口原始返回JSON * thirdResponse?: string * } * // 优惠券ID * couponId?: string * // 1-待支付,2-已支付,6-已退款,9-已取消 * oilOrderStatus?: number * // 订单平台类型(0-小程序 1-TV) * orderPlatformType?: number * // 订单过期时间 * expireTime?: string * // 是否可核销,0:不可核销操作,1:可进行核销操作 * isWriteOff?: number * shopInfo?: { * // 门店id * shopId?: number * // shop_logo * shopLogo?: string * // 门店名称 * shopName?: string * // shop_lat * shopLat?: number * // shop_lng * shopLng?: number * // tel * tel?: string * } * omsOrderOilVO?: { * // 小桔订单号 * xjOrderId?: string * // 门店ID * storeId?: string * // 门店名称 * storeName?: string * // 城市名称 * cityName?: string * // 枪号 * gunNo?: string * // 商品名称(油品名称) * itemName?: string * // 油号id * itemId?: number * // 商品升数 * quantity?: number * // 订单金额(单位:分) * totalMoney?: number * // 实付金额(单位:分) * realMoney?: number * // 订单状态:1-待支付,2-已支付,6-已退款,9-已取消 * orderStatus?: number * // 支付时间 * payTime?: string * // 退款时间 * refundTime?: string * // 服务费 * serviceFee?: number * // 优惠减免金额 * promotionAmount?: number * // 发改委价格、国标价 * cityPrice?: number * // 门店价、油枪价、油机价 * storePrice?: number * // 品牌名称 * brandName?: string * // 油站地址 * address?: string * // 优惠卷名称 * activityName?: string * // 优惠卷id * allowanceId?: string * // 小桔H5支付地址 * payUrl?: string * // 小桔价、折扣价、优惠价 * vipPrice?: number * } * } * msg?: string * } * ``` */ get_smqjh_oms_api_v1_order_orderinfo< Config extends Alova2MethodConfig & { params: { orderNo?: string; }; } >( config: Config ): Alova2Method; /** * --- * * [GET] 小程序-订单详情 * * **path:** /api/v1/order/orderInfo * * --- * * **Query Parameters** * ```ts * type QueryParameters = { * orderNo?: string * } * ``` * * --- * * **Response** * ```ts * type Response = { * // 返回状态码 * code?: string * data?: { * createTime?: string * updateTime?: string * // 第三方订单ID * thirdOrderId?: string * // 用户ID * memberId?: number * // 店铺id * shopId?: number * // 企业ID * channelId?: number * // 企业名称 * channelName?: string * // 订购流水号 * orderNumber?: string * // 订单总额 * orderMoney?: number * // 商品总值 * total?: number * // 实际总值(用户实付) * actualTotal?: number * // 订单运费 * freightAmount?: number * // 企业用户用积分抵扣,后台充值积分 * offsetPoints?: number * // 支付方式 0-微信 1-积分 2-混合 * payType?: number * // 买家备注 * remarks?: string * // 卖家备注 * shopRemarks?: string * // 配送类型 1:快递 2:自提 3:及时配送 * dvyType?: number * // 配送方式ID * dvyId?: number * // 物流单号 * dvyFlowId?: string * // 物流公司编号 * dvyNo?: string * // 物流公司名称 * dvyName?: string * // 付款时间 * payTime?: string * // 发货时间 * dvyTime?: string * // 取消原因 * cancelReason?: string * // 取消时间 * cancelTime?: string * // 用户订单删除状态 * deleteStatus?: number * // 订单类型 0-微信订单 1-积分订单 2-混合订单 * orderType?: number * // 订单关闭原因 1-超时未支付 2-退款关闭 4-买家取消 15-已通过货到付款交易 * closeType?: number * // 海博订单状态:0-待支付,1-待发货(快递使用),20-订单已接单(待拣货),30-订单待配送(拣货完成/自提类订单为待自提),40-订单配送中 ,50-订单取消待审核,60-订单已取消,70-订单已送达,80-订单已完成 * hbOrderStatus?: number * // 海博物流状态(20:已抢单,30:配送员到店,40:取货完成,50:配送单取消,100:已送达) * hbLogisticStatus?: number * // 业务类型 * businessType?: string * // 收货人姓名 * consigneeName?: string * // 收货人电话 * consigneeMobile: string * // 收货人地址 * consigneeAddress?: string * // 是否已经支付,1:已经支付过,0:,没有支付过 * isPayed?: number * // 微信订单号 * outTradeNo?: string * // 微信交易号 * transactionId?: string * // 纬度 * latitude?: number * // 经度 * longitude?: number * // 订单售后状态(0-无售后订单,1-部分商品退款,2-退款完成) * refundStatus?: number * // 影院名称 * cinemaName?: string * // 影院编码 * cinemaCode?: string * // 计影片类型 * planType?: string * // 影厅名称 * hallName?: string * // 场次 * session?: string * // 电影名称 * movieName?: string * // 订单图片 * orderImage?: string * // 门店名称 * shopName?: string * // 门店地址 * shopAddress?: string * // 门店电话 * tel?: string * djkOrderAttachInfo?: { * createTime?: string * updateTime?: string * // 订单号 * orderNumber?: string * // 大健康订单类型 0-正常订单 1-福利订单 * djkOrderType?: number * // 商品id * goodsId?: number * // 商品图 * goodsImg?: string * // 商品名 * goodsName?: string * // 商品编码 * goodsCode?: string * // 价格 * price?: number * // 商品数量 * goodsNum?: number * // 有效时间(天) * effectiveTime?: number * // 提前预约时间(天) * advanceBookingTime?: number * // 活动名称 * activityName?: string * // 客户授权 * customerAuthorization?: number * // 过期时间 * expiredTime?: string * // 核销时间 * verificationTime?: string * // 核销人 * verificationPerson?: string * // 核销门店 * verificationShop?: string * // 退款单号 * refundNo?: string * // 退款原因 * refundReason?: string * // 退款描述 * refundDesc?: string * // 退款图片 * refundImg?: string * // 提交退款时间 * submitRefundTime?: string * // 退款到账时间 * refundTime?: string * // 订单备注 * remark?: string * } * // 商品总额 * goodsTotal?: number * // 是否存在退款单 0不存在 1存在 * hasRefund?: number * // 子订单 * // [items] start * // [items] end * orderItemList?: Array<{ * // 用户Id * memberId?: number * // 店铺id * shopId?: number * // 订单order_number * orderNumber?: string * // 产品ID * prodId?: number * // 产品SkuID * skuId?: number * // 购物车产品个数 * prodCount?: number * // 产品名称 * prodName?: string * // sku名称 * skuName?: string * // 产品主图片路径 * pic?: string * // spec * spec?: string * // 产品价格 * price?: number * // 商品小计 * productTotalAmount?: number * // 购物时间 * recTime?: string * // 使用积分 * useScore?: number * // 获得积分 * gainScore?: number * }> * // 电影院子订单 * // [items] start * // [items] end * orderMovieItems?: Array<{ * // 订单order_number * orderNumber?: string * // 座位名称 * name?: string * // 票码 * ticketCode?: string * // 二维码 * pic?: string * // 区域类型(1-普通区域, 2-特殊区域 3-贵宾区) * areaType?: string * // 使用状态(未使用, :已使用, :已过期) * status?: number * // 产品价格 * price?: number * // 购物时间 * recTime?: string * }> * // 影院电话号码 * cinemaPhone?: string * chargeOrder?: { * // 用户ID * memberId?: number * // 订购流水号 * orderNumber?: string * // 充电订单状态: * status?: number * // 备注 * remarks?: string * // 充电订单号 * chargeOrderNo?: string * // 开始充电时间 * startTime?: string * // 结束充电时间 * endTime?: string * // 第三方充电站ID * stationId?: string * // 充电时间:秒 * chargeTime?: number * // 实际充电度数(单位:0.001 kw/h) * totalCharge?: number * // 平台实际收取金额 * realCost?: number * // 平台总服务费 * realServiceCost?: number * // 预充值金额 * preAmt?: number * // 充电设备接口编码 * connectorId?: string * chargeOrderId?: string * // 电站名称 * powerStationName?: string * // 三方电费 * totalMoney?: number * // 充电度数 * totalPower?: number * // 0:用户手动停止充电;1:客户归属地运营商平台停止充电;2:BMS停止充电;3:充电机设备故障;4:连接器断开;其它:自定义 * stopMethod?: number * } * yppDetail?: { * key?: object * } * // 会员昵称 * memberNickName?: string * // 会员真实姓名 * memberRealName?: string * // 会员电话 * memberMobile?: string * // 记录 * // [items] start * // [items] end * djkOrderLogList?: Array<{ * createTime?: string * updateTime?: string * // 订单号 * orderNumber?: string * // 操作 * operation?: string * // 操作员 * operator?: string * // 订单备注 * remark?: string * }> * virtualOrderItem?: { * createTime?: string * updateTime?: string * // 订购流水号,关联主订单 * orderNumber?: string * // 用户ID * memberId?: number * // 渠道ID * channelId?: number * // 商品编号(本地pms_video_product.product_number) * productNumber?: string * // 第三方商品编码(pms_video_product.product_id) * productId?: string * // 商品名称 * productName?: string * // 商品类型:卡密/直充 * productType?: string * // 面值 * faceValue?: number * // 采购价(成本) * purchasePrice?: number * // 销售价(从pms_video_channel_price获取) * sellPrice?: number * // 充值账号(直充类) * rechargeAccount?: string * // 账号类型:1手机号 2QQ号 0其他 * accountType?: number * // 充值状态:0待处理 1处理中 2成功 3失败 * rechargeStatus?: number * // 第三方平台订单号 * thirdOrderNo?: string * // 卡密信息JSON(卡密类商品,需解密) * cardInfo?: string * // 第三方接口原始返回JSON * thirdResponse?: string * } * // 优惠券ID * couponId?: string * // 1-待支付,2-已支付,6-已退款,9-已取消 * oilOrderStatus?: number * // 订单平台类型(0-小程序 1-TV) * orderPlatformType?: number * // 订单过期时间 * expireTime?: string * // 是否可核销,0:不可核销操作,1:可进行核销操作 * isWriteOff?: number * shopInfo?: { * // 门店id * shopId?: number * // shop_logo * shopLogo?: string * // 门店名称 * shopName?: string * // shop_lat * shopLat?: number * // shop_lng * shopLng?: number * // tel * tel?: string * } * omsOrderOilVO?: { * // 小桔订单号 * xjOrderId?: string * // 门店ID * storeId?: string * // 门店名称 * storeName?: string * // 城市名称 * cityName?: string * // 枪号 * gunNo?: string * // 商品名称(油品名称) * itemName?: string * // 油号id * itemId?: number * // 商品升数 * quantity?: number * // 订单金额(单位:分) * totalMoney?: number * // 实付金额(单位:分) * realMoney?: number * // 订单状态:1-待支付,2-已支付,6-已退款,9-已取消 * orderStatus?: number * // 支付时间 * payTime?: string * // 退款时间 * refundTime?: string * // 服务费 * serviceFee?: number * // 优惠减免金额 * promotionAmount?: number * // 发改委价格、国标价 * cityPrice?: number * // 门店价、油枪价、油机价 * storePrice?: number * // 品牌名称 * brandName?: string * // 油站地址 * address?: string * // 优惠卷名称 * activityName?: string * // 优惠卷id * allowanceId?: string * // 小桔H5支付地址 * payUrl?: string * // 小桔价、折扣价、优惠价 * vipPrice?: number * } * } * msg?: string * } * ``` */ get_api_v1_order_orderinfo< Config extends Alova2MethodConfig & { params: { orderNo?: string; }; } >( config: Config ): Alova2Method; }; } } var Apis: Apis; export interface loginModel { captchaCode?: string; code?: string; grant_type?: string; mobile?: string; password?: string; [property: string]: any; } export interface logoinToken { access_token: string code: string expires_in: number phoneCode: string refresh_token: string token_type: string } export interface wxpay { appId: string nonceStr: string package: string paySign: string signType: string timeStamp: string /** * 支付方式 0-微信 1-积分 2-混合 */ payType: number price: number }