forked from yoone/WEB
1
0
Fork 0
WEB/src/servers/api/typings.d.ts

3357 lines
71 KiB
TypeScript

declare namespace API {
type Address = {
address_line_1?: string;
city?: string;
region?: string;
country?: string;
postal_code?: string;
};
type ApiResponse = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 提示信息 */
message?: string;
/** 返回数据 */
data?: Record<string, any>;
};
type Area = {
/** 名称 */
name?: string;
/** 编码 */
code?: string;
};
type areacontrollerDeleteareaParams = {
id: number;
};
type areacontrollerGetareabyidParams = {
id: number;
};
type areacontrollerGetarealistParams = {
/** 当前页 */
currentPage?: number;
/** 每页数量 */
pageSize?: number;
/** 关键词(名称或编码) */
keyword?: string;
};
type areacontrollerUpdateareaParams = {
id: number;
};
type BatchCreateCustomerDTO = {
/** 客户列表 */
customers?: CreateCustomerDTO[];
};
type BatchDeleteCustomerDTO = {
/** 客户ID列表 */
ids?: number[];
};
type BatchDeleteProductDTO = {
/** 产品ID列表 */
ids: any[];
};
type BatchErrorItemDTO = {
/** 错误项标识(如ID、邮箱等) */
identifier?: string;
/** 错误信息 */
error?: string;
};
type BatchFulfillmentItemDTO = {
/** 订单ID */
order_id?: string;
/** 物流单号 */
tracking_number?: string;
/** 物流公司 */
shipping_provider?: string;
/** 发货方式 */
shipping_method?: string;
/** 发货商品项 */
items?: FulfillmentItemDTO[];
};
type BatchFulfillmentsDTO = {
/** 批量发货订单列表 */
orders?: BatchFulfillmentItemDTO[];
};
type BatchOperationDTO = {
/** 要创建的数据列表 */
create?: any[];
/** 要更新的数据列表 */
update?: any[];
/** 要删除的ID列表 */
delete?: string[];
};
type BatchOperationResultDTO = {
/** 总处理数量 */
total?: number;
/** 成功处理数量 */
processed?: number;
/** 创建数量 */
created?: number;
/** 更新数量 */
updated?: number;
/** 删除数量 */
deleted?: number;
/** 跳过的数量 */
skipped?: number;
/** 错误列表 */
errors?: BatchErrorItemDTO[];
};
type BatchSyncProductToSiteDTO = {
/** 站点ID */
siteId?: number;
/** 产品站点SKU列表 */
data?: ProductSiteSkuDTO[];
};
type BatchUpdateCustomerDTO = {
/** 客户更新列表 */
customers?: UpdateCustomerItemDTO[];
};
type BatchUpdateProductDTO = {
/** 产品ID列表 */
ids: any[];
/** 产品名称 */
name?: string;
/** 产品中文名称 */
nameCn?: string;
/** 产品描述 */
description?: string;
/** 产品简短描述 */
shortDescription?: string;
/** 产品 SKU */
sku?: string;
/** 分类ID (DictItem ID) */
categoryId?: number;
/** 站点 SKU 列表 */
siteSkus?: any[];
/** 价格 */
price?: number;
/** 促销价格 */
promotionPrice?: number;
/** 产品图片URL */
image?: string;
/** 属性列表 */
attributes?: any[];
/** 商品类型 */
type?: 'single' | 'bundle';
};
type BooleanRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: boolean;
};
type CancelFulfillmentDTO = {
/** 取消原因 */
reason?: string;
/** 发货单ID */
shipment_id?: string;
};
type categorycontrollerDeletecategoryattributeParams = {
id: number;
};
type categorycontrollerDeleteParams = {
id: number;
};
type categorycontrollerGetcategoryattributesParams = {
categoryId: number;
};
type categorycontrollerGetlistParams = {
name?: string;
pageSize?: Record<string, any>;
current?: Record<string, any>;
};
type categorycontrollerUpdateParams = {
id: number;
};
type CreateAreaDTO = {
/** 编码 */
code?: string;
};
type CreateCategoryDTO = {
/** 分类显示名称 */
title: string;
/** 分类中文名称 */
titleCN?: string;
/** 分类唯一标识 */
name: string;
/** 分类短名称,用于生成SKU */
shortName?: string;
/** 排序 */
sort?: number;
};
type CreateCustomerDTO = {
/** 站点ID */
site_id?: number;
/** 原始ID */
origin_id?: string;
/** 邮箱 */
email?: string;
/** 名字 */
first_name?: string;
/** 姓氏 */
last_name?: string;
/** 全名 */
fullname?: string;
/** 用户名 */
username?: string;
/** 电话 */
phone?: string;
/** 头像URL */
avatar?: string;
/** 账单信息 */
billing?: Record<string, any>;
/** 配送信息 */
shipping?: Record<string, any>;
/** 原始数据 */
raw?: Record<string, any>;
/** 评分 */
rate?: number;
/** 标签列表 */
tags?: string[];
/** 站点创建时间 */
site_created_at?: string;
/** 站点更新时间 */
site_updated_at?: string;
};
type CreateDictDTO = {};
type CreateDictItemDTO = {};
type CreateOrderNoteDTO = {
orderId?: number;
content?: string;
};
type CreateProductDTO = {
/** 产品名称 */
name: string;
/** 产品中文名称 */
nameCn?: string;
/** 产品描述 */
description?: string;
/** 产品简短描述 */
shortDescription?: string;
/** 产品 SKU */
sku?: string;
/** 分类ID (DictItem ID) */
categoryId?: number;
/** 分类名称 */
categoryName?: string;
/** 站点 SKU 列表 */
siteSkus?: any[];
/** 属性列表 */
attributes?: any[];
/** 价格 */
price?: number;
/** 促销价格 */
promotionPrice?: number;
/** 产品图片URL */
image?: string;
/** 商品类型 */
type?: 'single' | 'bundle';
/** 产品组成 */
components?: any[];
};
type CreatePurchaseOrderDTO = {
stockPointId?: number;
expectedArrivalTime?: string;
status?: 'draft' | 'submitted' | 'received';
note?: string;
items?: PurchaseOrderItem[];
};
type CreateReviewDTO = {
/** 产品ID */
product_id?: Record<string, any>;
/** 评论内容 */
review?: string;
/** 评论者 */
reviewer?: string;
/** 评论者邮箱 */
reviewer_email?: string;
/** 评分 */
rating?: number;
};
type CreateSiteDTO = {
/** 站点 API URL */
apiUrl?: string;
/** 站点网站 URL */
websiteUrl?: string;
/** 站点 REST Key */
consumerKey?: string;
/** 站点 REST 秘钥 */
consumerSecret?: string;
/** 访问令牌 */
token?: string;
/** 站点名称 */
name?: string;
/** 站点描述 */
description?: string;
/** 平台类型 */
type?: 'woocommerce' | 'shopyy';
/** SKU 前缀 */
skuPrefix?: string;
/** 区域 */
areas?: any;
/** 绑定仓库ID列表 */
stockPointIds?: any;
};
type CreateStockPointDTO = {
name?: string;
location?: string;
contactPerson?: string;
contactPhone?: string;
/** 区域 */
areas?: any;
/** 上游仓库点ID */
upStreamStockPointId?: number;
/** 上游名称 */
upStreamName?: string;
};
type CreateTemplateDTO = {
/** 模板名称 */
name: string;
/** 模板内容 */
value: string;
/** 测试数据JSON */
testData?: string;
};
type CreateWebhookDTO = {
/** 名称 */
name?: string;
/** 主题/事件 */
topic?: string;
/** 目标URL */
delivery_url?: string;
/** 秘密密钥 */
secret?: string;
/** 头部信息 */
headers?: Record<string, any>;
/** API版本 */
api_version?: string;
};
type Cubid = {
w?: number;
h?: number;
l?: number;
unit?: string;
};
type customercontrollerDeletecustomerParams = {
id: number;
};
type customercontrollerGetcustomerbyidParams = {
id: number;
};
type customercontrollerUpdatecustomerParams = {
id: number;
};
type CustomerTagDTO = {
/** 客户邮箱 */
email?: string;
/** 标签名称 */
tag?: string;
};
type Date = {
year?: string;
month?: string;
day?: string;
};
type Destination = {
name?: string;
address?: Address;
phone_number?: PhoneNumber;
email_addresses?: any;
ready_at?: Time;
ready_until?: Time;
SignatureRequirementEnum?: any;
};
type dictcontrollerDeletedictitemParams = {
id: number;
};
type dictcontrollerDeletedictParams = {
id: number;
};
type dictcontrollerExportdictitemsParams = {
dictId?: number;
};
type dictcontrollerGetdictitemsbydictnameParams = {
name?: string;
};
type dictcontrollerGetdictitemsParams = {
title?: string;
name?: string;
dictId?: number;
};
type dictcontrollerGetdictParams = {
id: number;
};
type dictcontrollerGetdictsParams = {
name?: string;
title?: string;
};
type dictcontrollerUpdatedictitemParams = {
id: number;
};
type dictcontrollerUpdatedictParams = {
id: number;
};
type DisableSiteDTO = {
/** 是否禁用 */
disabled?: boolean;
};
type FulfillmentDTO = {
/** 物流id */
tracking_id?: string;
/** 物流单号 */
tracking_number?: string;
/** 物流公司 */
shipping_provider?: string;
/** 发货方式 */
shipping_method?: string;
/** 状态 */
status?: string;
/** 创建时间 */
date_created?: string;
/** 发货商品项 */
items?: FulfillmentItemDTO[];
};
type FulfillmentItemDTO = {
/** 订单项ID */
order_item_id?: number;
/** 数量 */
quantity?: number;
};
type GetCustomerDTO = {
/** 客户ID */
id?: number;
/** 站点ID */
site_id?: number;
/** 原始ID */
origin_id?: string;
/** 站点创建时间 */
site_created_at?: string;
/** 站点更新时间 */
site_updated_at?: string;
/** 邮箱 */
email?: string;
/** 名字 */
first_name?: string;
/** 姓氏 */
last_name?: string;
/** 全名 */
fullname?: string;
/** 用户名 */
username?: string;
/** 电话 */
phone?: string;
/** 头像URL */
avatar?: string;
/** 账单信息 */
billing?: Record<string, any>;
/** 配送信息 */
shipping?: Record<string, any>;
/** 原始数据 */
raw?: Record<string, any>;
/** 创建时间 */
created_at?: string;
/** 更新时间 */
updated_at?: string;
/** 评分 */
rate?: number;
/** 标签列表 */
tags?: string[];
};
type localecontrollerGetlocaleParams = {
lang: string;
};
type Location = {
name?: string;
address?: Address;
phone_number?: PhoneNumber;
email_addresses?: any;
};
type LoginRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: LoginResDTO;
};
type LoginResDTO = {
token?: string;
userId?: number;
username?: string;
permissions?: string[];
};
type logisticscontrollerCreateshipmentParams = {
orderId: number;
};
type logisticscontrollerDeleteshipmentParams = {
id: number;
};
type logisticscontrollerDelshipmentParams = {
id: number;
};
type logisticscontrollerDelshippingaddressParams = {
id: number;
};
type logisticscontrollerGetlistbyorderidParams = {
id?: number;
};
type logisticscontrollerGetorderlistParams = {
number?: string;
};
type logisticscontrollerGetservicelistParams = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
carrier_name?: string;
isActive?: boolean;
};
type logisticscontrollerGetshipmentlabelParams = {
shipmentId: number;
};
type logisticscontrollerUpdateshipmentstateParams = {
shipmentId: number;
};
type logisticscontrollerUpdateshippingaddressParams = {
id: number;
};
type Measurements = {
cuboid?: Cubid;
weight?: Cubid;
};
type Money = {
currency?: string;
value?: string;
};
type Order = {
id?: number;
siteId?: number;
externalOrderId?: string;
status?: any;
orderStatus?: any;
shipmentId?: number;
currency?: string;
currency_symbol?: string;
prices_include_tax?: boolean;
date_created?: string;
date_modified?: string;
discount_total?: number;
discount_tax?: number;
shipping_total?: number;
shipping_tax?: number;
cart_tax?: number;
total?: number;
total_tax?: number;
customer_id?: number;
customer_email?: string;
order_key?: string;
billing?: OrderAddress;
shipping?: OrderAddress;
payment_method?: string;
payment_method_title?: string;
transaction_id?: string;
customer_ip_address?: string;
customer_user_agent?: string;
created_via?: string;
customer_note?: string;
date_completed?: string;
date_paid?: string;
cart_hash?: string;
number?: string;
meta_data?: any;
payment_url?: string;
is_editable?: boolean;
needs_payment?: boolean;
needs_processing?: boolean;
device_type?: string;
source_type?: string;
utm_source?: string;
is_exchange?: boolean;
exchange_frequency?: number;
/** 创建时间 */
createdAt: string;
/** 更新时间 */
updatedAt: string;
/** 订单项列表 */
orderItems?: any;
/** 销售项列表 */
orderSales?: any;
};
type OrderAddress = {
first_name?: string;
last_name?: string;
company?: string;
address_1?: string;
address_2?: string;
city?: string;
state?: string;
postcode?: string;
country?: string;
email?: string;
phone?: string;
};
type ordercontrollerCancelorderParams = {
id: number;
};
type ordercontrollerChangestatusParams = {
id: number;
};
type ordercontrollerCompletedorderParams = {
id: number;
};
type ordercontrollerDelorderParams = {
id: number;
};
type ordercontrollerGetorderdetailParams = {
orderId: number;
};
type ordercontrollerGetorderitemlistParams = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
siteId?: number;
name?: string;
externalProductId?: string;
externalVariationId?: string;
startDate?: string;
endDate?: string;
};
type ordercontrollerGetorderitemsParams = {
/** 是否为原产品还是库存产品 */
isSource?: boolean;
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
/** 排序对象,格式如 { productName: "asc", sku: "desc" } */
orderBy?: any;
/** 是否排除套餐 */
exceptPackage?: boolean;
/** 站点ID */
siteId?: number;
/** 名称 */
name?: string;
/** SKU */
sku?: string;
/** 开始日期 */
startDate?: string;
/** 结束日期 */
endDate?: string;
};
type ordercontrollerGetordersalesParams = {
/** 是否为原产品还是库存产品 */
isSource?: boolean;
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
/** 排序对象,格式如 { productName: "asc", sku: "desc" } */
orderBy?: any;
/** 是否排除套餐 */
exceptPackage?: boolean;
/** 站点ID */
siteId?: number;
/** 名称 */
name?: string;
/** SKU */
sku?: string;
/** 开始日期 */
startDate?: string;
/** 结束日期 */
endDate?: string;
};
type ordercontrollerGetordersParams = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
externalOrderId?: string;
siteId?: number;
customer_email?: string;
billing_phone?: string;
keyword?: string;
startDate?: string;
endDate?: string;
status?:
| 'pending'
| 'processing'
| 'completed'
| 'cancelled'
| 'refunded'
| 'failed'
| 'after_sale_pending'
| 'pending_reshipment'
| 'pending_refund'
| 'return-requested'
| 'return-approved'
| 'return-cancelled';
payment_method?: string;
/** 仅订阅订单(父订阅订单或包含订阅商品) */
isSubscriptionOnly?: boolean;
};
type ordercontrollerGetrelatedbyorderParams = {
orderId: number;
};
type ordercontrollerRefundorderParams = {
id: number;
};
type ordercontrollerSyncorderbyidParams = {
orderId: string;
siteId: number;
};
type ordercontrollerSyncordersParams = {
siteId: number;
};
type ordercontrollerUpdateorderitemsParams = {
orderId: number;
};
type OrderDetail = {
id?: number;
siteId?: number;
externalOrderId?: string;
status?: any;
orderStatus?: any;
shipmentId?: number;
currency?: string;
currency_symbol?: string;
prices_include_tax?: boolean;
date_created?: string;
date_modified?: string;
discount_total?: number;
discount_tax?: number;
shipping_total?: number;
shipping_tax?: number;
cart_tax?: number;
total?: number;
total_tax?: number;
customer_id?: number;
customer_email?: string;
order_key?: string;
billing?: OrderAddress;
shipping?: OrderAddress;
payment_method?: string;
payment_method_title?: string;
transaction_id?: string;
customer_ip_address?: string;
customer_user_agent?: string;
created_via?: string;
customer_note?: string;
date_completed?: string;
date_paid?: string;
cart_hash?: string;
number?: string;
meta_data?: any;
payment_url?: string;
is_editable?: boolean;
needs_payment?: boolean;
needs_processing?: boolean;
device_type?: string;
source_type?: string;
utm_source?: string;
is_exchange?: boolean;
exchange_frequency?: number;
/** 创建时间 */
createdAt: string;
/** 更新时间 */
updatedAt: string;
/** 订单项列表 */
orderItems?: any;
/** 销售项列表 */
orderSales?: any;
items?: OrderItem[];
sales?: OrderSale[];
refundItems?: OrderRefundItem[];
notes?: OrderNote[];
};
type OrderDetailRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: OrderDetail;
};
type OrderItem = {
id?: number;
name?: string;
siteId?: number;
orderId?: number;
externalOrderId?: string;
externalOrderItemId?: string;
externalProductId?: string;
externalVariationId?: string;
quantity?: number;
subtotal?: number;
subtotal_tax?: number;
total?: number;
total_tax?: number;
tax_class?: string;
taxes?: any;
meta_data?: any;
sku?: string;
global_unique_id?: string;
price?: number;
image?: Record<string, any>;
parent_name?: string;
bundled_by?: string;
bundled_item_title?: string;
bundled_items?: any;
/** 创建时间 */
createdAt: string;
/** 更新时间 */
updatedAt: string;
};
type OrderListRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: OrderPaginatedRespone;
};
type OrderNote = {
userId?: number;
orderId?: number;
content?: string;
/** 创建时间 */
createdAt: string;
/** 更新时间 */
updatedAt: string;
};
type OrderPaginatedRespone = {
/** 当前页码 */
page?: number;
/** 每页大小 */
pageSize?: number;
/** 总记录数 */
total?: number;
/** 数据列表 */
items?: Order[];
count?: OrderStatusCountDTO[];
};
type OrderRefundItem = {
id?: number;
refundId?: number;
siteId?: number;
externalRefundId?: string;
externalRefundItemId?: string;
externalProductId?: string;
externalVariationId?: string;
name?: string;
quantity?: number;
tax_class?: string;
subtotal?: number;
subtotal_tax?: number;
total?: number;
total_tax?: number;
sku?: string;
price?: number;
/** 创建时间 */
createdAt: string;
/** 更新时间 */
updatedAt: string;
};
type OrderSale = {
id?: number;
orderId?: number;
siteId?: number;
externalOrderItemId?: string;
parentProductId?: number;
productId?: number;
name?: string;
/** sku */
sku?: string;
quantity?: number;
isPackage?: boolean;
/** 商品品类 */
category?: string;
/** 品牌 */
brand?: string;
/** 口味 */
flavor?: string;
/** 湿度 */
humidity?: string;
/** 尺寸 */
size?: string;
strength?: string;
/** 版本 */
version?: string;
/** 创建时间 */
createdAt?: string;
/** 更新时间 */
updatedAt?: string;
};
type OrderSaleDTO = {
id?: number;
orderId?: number;
siteId?: number;
externalOrderItemId?: string;
parentProductId?: number;
productId?: number;
name?: string;
/** sku */
sku?: string;
quantity?: number;
isPackage?: boolean;
/** 商品品类 */
category?: string;
/** 品牌 */
brand?: string;
/** 口味 */
flavor?: string;
/** 湿度 */
humidity?: string;
/** 尺寸 */
size?: string;
strength?: string;
/** 版本 */
version?: string;
/** 创建时间 */
createdAt?: string;
/** 更新时间 */
updatedAt?: string;
totalQuantity?: number;
};
type OrderSaleListRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: OrderSalePaginatedRespone;
};
type OrderSalePaginatedRespone = {
/** 当前页码 */
page?: number;
/** 每页大小 */
pageSize?: number;
/** 总记录数 */
total?: number;
/** 数据列表 */
items?: OrderSaleDTO[];
};
type OrderStatisticsParams = {
startDate?: string;
endDate?: string;
keyword?: string;
siteId?: number;
country?: any;
purchaseType?: 'all' | 'first_purchase' | 'repeat_purchase';
orderType?: 'all' | 'cpc' | 'non_cpc';
brand?: 'all' | 'zyn' | 'yoone' | 'zolt';
grouping?: 'day' | 'week' | 'month';
};
type OrderStatusCountDTO = {
status?: string;
count?: number;
};
type Package = {
measurements?: Measurements;
description?: string;
};
type PackagingPackage = {
packages?: Package[];
};
type PhoneNumber = {
number?: string;
extension?: string;
};
type Product = {
/** ID */
id: number;
/** sku */
sku?: string;
/** 类型 */
type?: string;
/** 产品名称 */
name: string;
/** 产品中文名称 */
nameCn?: string;
/** 产品简短描述 */
shortDescription?: string;
/** 产品描述 */
description?: string;
/** 产品图片URL */
image?: string;
/** 价格 */
price?: number;
/** 促销价格 */
promotionPrice?: number;
/** 分类 ID */
categoryId?: number;
/** 库存组成 */
components?: ProductStockComponent[];
/** 站点 SKU 列表 */
siteSkus?: string[];
/** 来源 */
source?: number;
/** 创建时间 */
createdAt: string;
/** 更新时间 */
updatedAt: string;
};
type productcontrollerAutobindcomponentsParams = {
id: number;
};
type productcontrollerBindproductsiteskusParams = {
id: number;
};
type productcontrollerCompatbrandsParams = {
name?: string;
pageSize?: Record<string, any>;
current?: Record<string, any>;
};
type productcontrollerCompatdeletebrandParams = {
id: number;
};
type productcontrollerCompatdeleteflavorsParams = {
id: number;
};
type productcontrollerCompatdeletesizeParams = {
id: number;
};
type productcontrollerCompatdeletestrengthParams = {
id: number;
};
type productcontrollerCompatflavorsParams = {
name?: string;
pageSize?: Record<string, any>;
current?: Record<string, any>;
};
type productcontrollerCompatsizeParams = {
name?: string;
pageSize?: Record<string, any>;
current?: Record<string, any>;
};
type productcontrollerCompatstrengthParams = {
name?: string;
pageSize?: Record<string, any>;
current?: Record<string, any>;
};
type productcontrollerCompatupdatebrandParams = {
id: number;
};
type productcontrollerCompatupdateflavorsParams = {
id: number;
};
type productcontrollerCompatupdatesizeParams = {
id: number;
};
type productcontrollerCompatupdatestrengthParams = {
id: number;
};
type productcontrollerCreateattributeParams = {
dictName?: string;
};
type productcontrollerDeleteattributeParams = {
id: number;
};
type productcontrollerDeletecategoryattributeParams = {
id: number;
};
type productcontrollerDeletecategoryParams = {
id: number;
};
type productcontrollerDeleteproductParams = {
id: number;
};
type productcontrollerGetallproductsParams = {
brand?: string;
};
type productcontrollerGetattributeallParams = {
dictName?: string;
};
type productcontrollerGetattributelistParams = {
name?: string;
pageSize?: Record<string, any>;
current?: Record<string, any>;
dictName?: string;
};
type productcontrollerGetcategoryattributesParams = {
id: number;
};
type productcontrollerGetgroupedproductsParams = {
attribute?: string;
brand?: string;
};
type productcontrollerGetproductbyidParams = {
id: number;
};
type productcontrollerGetproductbysiteskuParams = {
siteSku: string;
};
type productcontrollerGetproductcomponentsParams = {
id: number;
};
type productcontrollerGetproductlistgroupedParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
};
type productcontrollerGetproductlistParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
};
type productcontrollerGetproductsiteskusParams = {
id: number;
};
type productcontrollerProductbyskuParams = {
sku: string;
};
type productcontrollerSearchproductsParams = {
name?: string;
};
type productcontrollerUpdateattributeParams = {
dictName?: string;
id: number;
};
type productcontrollerUpdatecategoryParams = {
id: number;
};
type productcontrollerUpdatenamecnParams = {
nameCn: string;
id: number;
};
type productcontrollerUpdateproductParams = {
id: number;
};
type ProductListRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: ProductPaginatedResponse;
};
type ProductPaginatedResponse = {
/** 当前页码 */
page?: number;
/** 每页大小 */
pageSize?: number;
/** 总记录数 */
total?: number;
/** 数据列表 */
items?: Product[];
};
type ProductRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: Product;
};
type ProductSiteSkuDTO = {
/** 产品ID */
productId?: number;
/** 站点SKU */
siteSku?: string;
};
type ProductsRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: Product[];
};
type ProductStockComponent = {
id?: number;
productId?: number;
/** 组件所关联的 SKU */
sku?: string;
/** 组成数量 */
quantity?: number;
/** 创建时间 */
createdAt?: string;
/** 更新时间 */
updatedAt?: string;
};
type PurchaseOrderDTO = {
id?: number;
stockPointId?: number;
orderNumber?: string;
status?: any;
note?: string;
/** 预计时间 */
expectedArrivalTime: string;
/** 创建时间 */
createdAt: string;
/** 更新时间 */
updatedAt: string;
items?: PurchaseOrderItem[];
};
type PurchaseOrderItem = {
id?: number;
sku?: string;
name?: string;
quantity?: number;
price?: number;
purchaseOrderId?: number;
};
type PurchaseOrderListRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: PurchaseOrderPaginatedRespone;
};
type PurchaseOrderPaginatedRespone = {
/** 当前页码 */
page?: number;
/** 每页大小 */
pageSize?: number;
/** 总记录数 */
total?: number;
/** 数据列表 */
items?: PurchaseOrderDTO[];
};
type QueryAreaDTO = {
/** 当前页 */
currentPage?: number;
/** 每页数量 */
pageSize?: number;
/** 关键词(名称或编码) */
keyword?: string;
};
type QueryOrderDTO = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
externalOrderId?: string;
siteId?: number;
customer_email?: string;
billing_phone?: string;
keyword?: string;
startDate?: string;
endDate?: string;
status?:
| 'pending'
| 'processing'
| 'completed'
| 'cancelled'
| 'refunded'
| 'failed'
| 'after_sale_pending'
| 'pending_reshipment'
| 'pending_refund'
| 'return-requested'
| 'return-approved'
| 'return-cancelled';
payment_method?: string;
/** 仅订阅订单(父订阅订单或包含订阅商品) */
isSubscriptionOnly?: boolean;
};
type QueryOrderItemDTO = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
siteId?: number;
name?: string;
externalProductId?: string;
externalVariationId?: string;
startDate?: string;
endDate?: string;
};
type QueryOrderSalesDTO = {
/** 是否为原产品还是库存产品 */
isSource?: boolean;
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
/** 排序对象,格式如 { productName: "asc", sku: "desc" } */
orderBy?: any;
/** 是否排除套餐 */
exceptPackage?: boolean;
/** 站点ID */
siteId?: number;
/** 名称 */
name?: string;
/** SKU */
sku?: string;
/** 开始日期 */
startDate?: string;
/** 结束日期 */
endDate?: string;
};
type QueryPointDTO = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
};
type QueryPurchaseOrderDTO = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
orderNumber?: string;
stockPointId?: number;
};
type QueryServiceDTO = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
carrier_name?: string;
isActive?: boolean;
};
type QuerySiteDTO = {
/** 当前页码 */
current?: number;
/** 每页数量 */
pageSize?: number;
/** 搜索关键词 */
keyword?: string;
/** 是否禁用 */
isDisabled?: boolean;
/** 站点ID列表(逗号分隔) */
ids?: string;
};
type QueryStockDTO = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
name?: string;
sku?: string;
/** 按库存点ID排序 */
sortPointId?: number;
/** 排序对象,格式如 { productName: "asc", sku: "desc" } */
order?: Record<string, any>;
};
type QueryStockRecordDTO = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
stockPointId?: number;
sku?: string;
name?: string;
operationType?: string;
startDate?: string;
endDate?: string;
};
type QuerySubscriptionDTO = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
/** 站点ID */
siteId?: string;
/** 订阅状态 */
status?:
| 'active'
| 'pending'
| 'on-hold'
| 'cancelled'
| 'expired'
| 'pending-cancel';
/** 客户邮箱 */
customer_email?: string;
/** 关键字(订阅ID,邮箱等) */
keyword?: string;
};
type RateDTO = {
carrier_name?: string;
service_name?: string;
service_id?: string;
valid_until?: Date;
total?: Money;
base?: Money;
surcharges?: Surcharges[];
taxes?: Money[];
transit_time_days?: number;
transit_time_not_available?: boolean;
};
type RateLitRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: RateDTO[];
};
type RenderTemplateDTO = {
/** 模板内容 */
template: string;
/** 渲染数据 */
data: Record<string, any>;
};
type Service = {
id?: string;
carrier_name?: string;
service_name?: string;
isActive?: boolean;
/** 创建时间 */
createdAt: string;
/** 更新时间 */
updatedAt: string;
};
type ServiceListRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: Service[];
};
type ShipmentBookDTO = {
sales?: OrderSale[];
details?: ShippingDetailsDTO;
stockPointId?: number;
orderIds?: number[];
shipmentPlatform?: string;
};
type ShipmentFeeBookDTO = {
shipmentPlatform?: string;
stockPointId?: number;
sender?: string;
startPhone?: string;
startPostalCode?: string;
pickupAddress?: string;
shipperCountryCode?: string;
receiver?: string;
city?: string;
province?: string;
country?: string;
postalCode?: string;
deliveryAddress?: string;
receiverPhone?: string;
receiverEmail?: string;
length?: number;
width?: number;
height?: number;
dimensionUom?: string;
weight?: number;
weightUom?: string;
address_id?: number;
};
type ShippingAddress = {
id?: number;
name?: string;
stockPointId?: number;
address?: Address;
phone_number?: string;
phone_number_extension?: string;
phone_number_country?: string;
/** 创建时间 */
createdAt: string;
/** 更新时间 */
updatedAt: string;
};
type ShippingAddressListRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: ShippingAddress[];
};
type ShippingDetailsDTO = {
shipmentFee?: number;
origin?: Location;
destination?: Destination;
expected_ship_date?: Date;
packaging_type?: 'pallet' | 'package' | 'courier-pak' | 'envelope';
packaging_properties?: PackagingPackage[];
reference_codes?: any;
};
type siteapicontrollerBatchcustomersParams = {
siteId: number;
};
type siteapicontrollerBatchfulfillordersParams = {
siteId: number;
};
type siteapicontrollerBatchmediaParams = {
siteId: number;
};
type siteapicontrollerBatchordersParams = {
siteId: number;
};
type siteapicontrollerBatchproductsParams = {
siteId: number;
};
type siteapicontrollerBatchupsertproductParams = {
siteId: number;
};
type siteapicontrollerCancelfulfillmentParams = {
id: string;
siteId: number;
};
type siteapicontrollerConvertmediatowebpParams = {
siteId: number;
};
type siteapicontrollerCountordersParams = {
siteId: number;
};
type siteapicontrollerCreatecustomerParams = {
siteId: number;
};
type siteapicontrollerCreatemediaParams = {
siteId: number;
};
type siteapicontrollerCreateorderfulfillmentParams = {
orderId: string;
siteId: number;
};
type siteapicontrollerCreateordernoteParams = {
id: string;
siteId: number;
};
type siteapicontrollerCreateorderParams = {
siteId: number;
};
type siteapicontrollerCreateproductParams = {
siteId: number;
};
type siteapicontrollerCreatereviewParams = {
siteId: number;
};
type siteapicontrollerCreatewebhookParams = {
siteId: number;
};
type siteapicontrollerDeletecustomerParams = {
id: string;
siteId: number;
};
type siteapicontrollerDeletemediaParams = {
id: string;
siteId: number;
};
type siteapicontrollerDeleteorderfulfillmentParams = {
fulfillmentId: string;
orderId: string;
siteId: number;
};
type siteapicontrollerDeleteorderParams = {
id: string;
siteId: number;
};
type siteapicontrollerDeleteproductParams = {
id: string;
siteId: number;
};
type siteapicontrollerDeletereviewParams = {
id: number;
siteId: number;
};
type siteapicontrollerDeletewebhookParams = {
id: string;
siteId: number;
};
type siteapicontrollerExportcustomersParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
siteId: number;
};
type siteapicontrollerExportmediaParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
siteId: number;
};
type siteapicontrollerExportordersParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
siteId: number;
};
type siteapicontrollerExportproductsParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
siteId: number;
};
type siteapicontrollerExportproductsspecialParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
siteId: number;
};
type siteapicontrollerExportsubscriptionsParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
siteId: number;
};
type siteapicontrollerGetcustomerordersParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
customerId: number;
siteId: number;
};
type siteapicontrollerGetcustomerParams = {
id: string;
siteId: number;
};
type siteapicontrollerGetcustomersParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
siteId: number;
};
type siteapicontrollerGetlinksParams = {
siteId: number;
};
type siteapicontrollerGetmediaParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
siteId: number;
};
type siteapicontrollerGetorderfulfillmentsParams = {
orderId: string;
siteId: number;
};
type siteapicontrollerGetordernotesParams = {
id: string;
siteId: number;
};
type siteapicontrollerGetorderParams = {
id: string;
siteId: number;
};
type siteapicontrollerGetordersParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
siteId: number;
};
type siteapicontrollerGetproductParams = {
id: string;
siteId: number;
};
type siteapicontrollerGetproductsParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
siteId: number;
};
type siteapicontrollerGetreviewsParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
siteId: number;
};
type siteapicontrollerGetsubscriptionsParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
siteId: number;
};
type siteapicontrollerGetwebhookParams = {
id: string;
siteId: number;
};
type siteapicontrollerGetwebhooksParams = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
siteId: number;
};
type siteapicontrollerImportcustomersParams = {
siteId: number;
};
type siteapicontrollerImportordersParams = {
siteId: number;
};
type siteapicontrollerImportproductsParams = {
siteId: number;
};
type siteapicontrollerImportproductsspecialParams = {
siteId: number;
};
type siteapicontrollerUpdatecustomerParams = {
id: string;
siteId: number;
};
type siteapicontrollerUpdatemediaParams = {
id: string;
siteId: number;
};
type siteapicontrollerUpdateorderfulfillmentParams = {
fulfillmentId: string;
orderId: string;
siteId: number;
};
type siteapicontrollerUpdateorderParams = {
id: string;
siteId: number;
};
type siteapicontrollerUpdateproductParams = {
id: string;
siteId: number;
};
type siteapicontrollerUpdatereviewParams = {
id: number;
siteId: number;
};
type siteapicontrollerUpdatevariationParams = {
variationId: string;
productId: string;
siteId: number;
};
type siteapicontrollerUpdatewebhookParams = {
id: string;
siteId: number;
};
type siteapicontrollerUpsertproductParams = {
siteId: number;
};
type SiteConfig = {
/** 站点 ID */
id?: string;
/** 站点 URL */
apiUrl?: string;
/** 站点 rest key */
consumerKey?: string;
/** 站点 rest 秘钥 */
consumerSecret?: string;
/** 站点名 */
name?: string;
/** 描述 */
description?: string;
/** 平台类型 */
type?: 'woocommerce' | 'shopyy';
/** SKU 前缀 */
skuPrefix?: string;
};
type sitecontrollerDisableParams = {
id: string;
};
type sitecontrollerGetParams = {
id: string;
};
type sitecontrollerListParams = {
/** 当前页码 */
current?: number;
/** 每页数量 */
pageSize?: number;
/** 搜索关键词 */
keyword?: string;
/** 是否禁用 */
isDisabled?: boolean;
/** 站点ID列表(逗号分隔) */
ids?: string;
};
type sitecontrollerUpdateParams = {
id: string;
};
type SitesResponse = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: SiteConfig[];
};
type statisticscontrollerGetinativeusersbymonthParams = {
month?: string;
};
type stockcontrollerCanceltransferParams = {
id: number;
};
type stockcontrollerDelpurchaseorderParams = {
id: number;
};
type stockcontrollerDelstockpointsParams = {
id: number;
};
type stockcontrollerGetpurchaseorderParams = {
orderNumber: string;
};
type stockcontrollerGetpurchaseordersParams = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
orderNumber?: string;
stockPointId?: number;
};
type stockcontrollerGetstockpointsParams = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
};
type stockcontrollerGetstockrecordsParams = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
stockPointId?: number;
sku?: string;
name?: string;
operationType?: string;
startDate?: string;
endDate?: string;
};
type stockcontrollerGetstocksParams = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
name?: string;
sku?: string;
/** 按库存点ID排序 */
sortPointId?: number;
/** 排序对象,格式如 { productName: "asc", sku: "desc" } */
order?: Record<string, any>;
};
type stockcontrollerHasstockParams = {
sku: string;
};
type stockcontrollerLosttransferParams = {
id: number;
};
type stockcontrollerReceivepurchaseorderParams = {
id: number;
};
type stockcontrollerReceivetransferParams = {
id: number;
};
type stockcontrollerUpdatepurchaseorderParams = {
id: number;
};
type stockcontrollerUpdatestockpointParams = {
id: number;
};
type stockcontrollerUpdatetransferParams = {
id: number;
};
type StockDTO = {
id?: number;
stockPointId?: number;
sku?: string;
quantity?: number;
/** 创建时间 */
createdAt: string;
/** 更新时间 */
updatedAt: string;
name?: string;
stockPoint?: Record<string, any>[];
};
type StockListRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: StockPaginatedRespone;
};
type StockPaginatedRespone = {
/** 当前页码 */
page?: number;
/** 每页大小 */
pageSize?: number;
/** 总记录数 */
total?: number;
/** 数据列表 */
items?: StockDTO[];
};
type StockPoint = {
id?: number;
name?: string;
location?: string;
contactPerson?: string;
contactPhone?: string;
ignore?: boolean;
inCanada?: boolean;
isB?: boolean;
/** 创建时间 */
createdAt: string;
/** 更新时间 */
updatedAt: string;
};
type StockPointAllRespone = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: StockPoint[];
};
type StockPointListRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: StockPointPaginatedRespone;
};
type StockPointPaginatedRespone = {
/** 当前页码 */
page?: number;
/** 每页大小 */
pageSize?: number;
/** 总记录数 */
total?: number;
/** 数据列表 */
items?: StockPoint[];
};
type StockRecordDTO = {
id?: number;
stockPointId?: number;
sku?: string;
operationType?: any;
quantityChange?: number;
operatorId?: number;
/** 创建时间 */
createdAt: string;
note?: string;
productName?: string;
};
type StockRecordListRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: StockRecordPaginatedRespone;
};
type StockRecordPaginatedRespone = {
/** 当前页码 */
page?: number;
/** 每页大小 */
pageSize?: number;
/** 总记录数 */
total?: number;
/** 数据列表 */
items?: StockRecordDTO[];
};
type Subscription = {
id?: number;
/** 来源站点唯一标识 */
siteId?: number;
/** WooCommerce 订阅 ID */
externalSubscriptionId?: string;
status?: any;
currency?: string;
total?: number;
/** 计费周期 e.g. day/week/month/year */
billing_period?: string;
/** 计费周期间隔 e.g. 1/3/12 */
billing_interval?: number;
customer_id?: number;
customer_email?: string;
/** 父订单/父订阅ID(如有) */
parent_id?: number;
start_date?: string;
trial_end?: string;
next_payment_date?: string;
end_date?: string;
line_items?: any;
meta_data?: any;
/** 创建时间 */
createdAt: string;
/** 更新时间 */
updatedAt: string;
};
type subscriptioncontrollerListParams = {
/** 页码 */
current?: number;
/** 每页大小 */
pageSize?: number;
/** 站点ID */
siteId?: string;
/** 订阅状态 */
status?:
| 'active'
| 'pending'
| 'on-hold'
| 'cancelled'
| 'expired'
| 'pending-cancel';
/** 客户邮箱 */
customer_email?: string;
/** 关键字(订阅ID,邮箱等) */
keyword?: string;
};
type subscriptioncontrollerSyncParams = {
siteId: number;
};
type SubscriptionListRes = {
/** 状态码 */
code?: number;
/** 是否成功 */
success?: boolean;
/** 消息内容 */
message?: string;
/** 响应数据 */
data?: SubscriptionPaginatedResponse;
};
type SubscriptionPaginatedResponse = {
/** 当前页码 */
page?: number;
/** 每页大小 */
pageSize?: number;
/** 总记录数 */
total?: number;
/** 数据列表 */
items?: Subscription[];
};
type Surcharges = {
type?: string;
amount?: Money;
};
type SyncCustomersDTO = {
/** 站点ID */
siteId?: number;
/** 查询参数(支持where和orderBy) */
params?: UnifiedSearchParamsDTO;
};
type SyncOperationResult = {};
type SyncOperationResultDTO = {
/** 总处理数量 */
total?: number;
/** 成功处理数量 */
processed?: number;
/** 创建数量 */
created?: number;
/** 更新数量 */
updated?: number;
/** 删除数量 */
deleted?: number;
/** 跳过的数量 */
skipped?: number;
/** 错误列表 */
errors?: BatchErrorItemDTO[];
/** 同步成功数量 */
synced?: number;
};
type SyncProductToSiteDTO = {
/** 产品ID */
productId?: number;
/** 站点SKU */
siteSku?: string;
/** 站点ID */
siteId?: number;
};
type SyncProductToSiteResultDTO = {
/** 同步状态 */
success?: boolean;
/** 远程产品ID */
remoteId?: string;
/** 错误信息 */
error?: string;
};
type Template = {
id?: number;
name?: string;
value?: string;
description?: string;
/** 测试数据JSON */
testData?: string;
/** 是否可删除 */
deletable: boolean;
/** 创建时间 */
createdAt: string;
/** 更新时间 */
updatedAt: string;
};
type templatecontrollerDeletetemplateParams = {
id: number;
};
type templatecontrollerGettemplatebynameParams = {
name: string;
};
type templatecontrollerRendertemplateParams = {
name: string;
};
type templatecontrollerUpdatetemplateParams = {
id: number;
};
type Time = {
hour?: string;
minute?: string;
};
type UnifiedAddressDTO = {
/** 名 */
first_name?: string;
/** 姓 */
last_name?: string;
/** 全名 */
fullname?: string;
/** 公司 */
company?: string;
/** 地址1 */
address_1?: string;
/** 地址2 */
address_2?: string;
/** 城市 */
city?: string;
/** 省/州 */
state?: string;
/** 邮政编码 */
postcode?: string;
/** 国家 */
country?: string;
/** 邮箱 */
email?: string;
/** 电话 */
phone?: string;
/** 配送方式 */
method_title?: string;
};
type UnifiedCategoryDTO = {
/** 分类ID */
id?: Record<string, any>;
/** 分类名称 */
name?: string;
};
type UnifiedCouponLineDTO = {
/** 优惠券项ID */
id?: Record<string, any>;
/** 优惠券项代码 */
code?: string;
/** 优惠券项折扣 */
discount?: string;
/** 优惠券项税额 */
discount_tax?: string;
/** 优惠券项元数据 */
meta_data?: any;
};
type UnifiedCustomerDTO = {
/** 客户ID */
id?: Record<string, any>;
/** 头像URL */
avatar?: string;
/** 邮箱 */
email?: string;
/** 订单总数 */
orders?: number;
/** 总花费 */
total_spend?: number;
/** 创建时间 */
date_created?: string;
/** 更新时间 */
date_modified?: string;
/** 名 */
first_name?: string;
/** 姓 */
last_name?: string;
/** 名字 */
fullname?: string;
/** 用户名 */
username?: string;
/** 电话 */
phone?: string;
/** 账单地址 */
billing?: UnifiedAddressDTO;
/** 收货地址 */
shipping?: UnifiedAddressDTO;
/** 原始数据 */
raw?: Record<string, any>;
};
type UnifiedCustomerPaginationDTO = {
/** 列表数据 */
items?: UnifiedCustomerDTO[];
/** 总数 */
total?: number;
/** 当前页 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 总页数 */
totalPages?: number;
};
type UnifiedFeeLineDTO = {
/** 费用项ID */
id?: Record<string, any>;
/** 费用项名称 */
name?: string;
/** 税率类 */
tax_class?: string;
/** 税率状态 */
tax_status?: string;
/** 总金额 */
total?: string;
/** 总税额 */
total_tax?: string;
/** 税额详情 */
taxes?: any;
/** 元数据 */
meta_data?: any;
};
type UnifiedImageDTO = {
/** 图片ID */
id?: Record<string, any>;
/** 图片URL */
src?: string;
/** 图片名称 */
name?: string;
/** 替代文本 */
alt?: string;
};
type UnifiedMediaDTO = {
/** 媒体ID */
id?: number;
/** 标题 */
title?: string;
/** 媒体类型 */
media_type?: string;
/** MIME类型 */
mime_type?: string;
/** 源URL */
source_url?: string;
/** 创建时间 */
date_created?: string;
/** 更新时间 */
date_modified?: string;
};
type UnifiedMediaPaginationDTO = {
/** 列表数据 */
items?: UnifiedMediaDTO[];
/** 总数 */
total?: number;
/** 当前页 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 总页数 */
totalPages?: number;
};
type UnifiedOrderDTO = {
/** 订单ID */
id?: Record<string, any>;
/** 订单号 */
number?: string;
/** 订单状态 */
status?: string;
/** 财务状态 */
financial_status?: string;
/** 货币 */
currency?: string;
/** 货币符号 */
currency_symbol?: string;
/** 总金额 */
total?: string;
/** 客户ID */
customer_id?: number;
/** 客户姓名 */
customer_name?: string;
/** 客户邮箱 */
email?: string;
/** 客户邮箱 */
customer_email?: string;
/** 订单项(具体的商品) */
line_items?: UnifiedOrderLineItemDTO[];
/** 销售项(兼容前端) */
sales?: UnifiedOrderLineItemDTO[];
/** 账单地址 */
billing?: UnifiedAddressDTO;
/** 收货地址 */
shipping?: UnifiedAddressDTO;
/** 账单地址全称 */
billing_full_address?: string;
/** 收货地址全称 */
shipping_full_address?: string;
/** 支付方式 */
payment_method?: string;
/** 退款列表 */
refunds?: UnifiedOrderRefundDTO[];
/** 创建时间 */
date_created?: string;
/** 更新时间 */
date_modified?: string;
/** 原始数据 */
raw?: Record<string, any>;
/** 配送方式 */
shipping_lines?: UnifiedShippingLineDTO[];
/** 费用项 */
fee_lines?: UnifiedFeeLineDTO[];
/** 优惠券项 */
coupon_lines?: UnifiedCouponLineDTO[];
/** 支付时间 */
date_paid?: string;
/** 客户IP地址 */
customer_ip_address?: string;
/** UTM来源 */
utm_source?: string;
/** 设备类型 */
device_type?: string;
/** 来源类型 */
source_type?: string;
/** 订单状态 */
fulfillment_status?: number;
/** 物流信息 */
fulfillments?: FulfillmentDTO[];
};
type UnifiedOrderLineItemDTO = {
/** 订单项ID */
id?: Record<string, any>;
/** 产品名称 */
name?: string;
/** 产品ID */
product_id?: Record<string, any>;
/** 变体ID */
variation_id?: Record<string, any>;
/** 数量 */
quantity?: number;
/** 总计 */
total?: string;
/** SKU */
sku?: string;
};
type UnifiedOrderPaginationDTO = {
/** 列表数据 */
items?: UnifiedOrderDTO[];
/** 总数 */
total?: number;
/** 当前页 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 总页数 */
totalPages?: number;
};
type UnifiedOrderRefundDTO = {
/** 退款ID */
id?: Record<string, any>;
/** 退款原因 */
reason?: string;
/** 退款金额 */
total?: string;
};
type UnifiedOrderTrackingDTO = {
/** 订单ID */
order_id?: string;
/** 物流单号 */
tracking_number?: string;
/** 物流公司 */
shipping_provider?: string;
/** 发货方式 */
shipping_method?: string;
/** 状态 */
status?: string;
/** 创建时间 */
date_created?: string;
};
type UnifiedPaginationDTO = {
/** 列表数据 */
items?: any;
/** 总数 */
total?: number;
/** 当前页 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 总页数 */
totalPages?: number;
};
type UnifiedProductAttributeDTO = {
/** 属性ID */
id?: Record<string, any>;
/** 属性名称 */
name?: string;
/** 属性位置 */
position?: number;
/** 对变体是否可见 */
visible?: boolean;
/** 是否为变体属性 */
variation?: boolean;
/** 属性选项 */
options?: string[];
/** 变体属性值(单个值) */
option?: string;
};
type UnifiedProductDTO = {
/** 产品ID */
id?: Record<string, any>;
/** 产品名称 */
name?: string;
/** 产品类型 */
type?: string;
/** 产品状态 */
status?: string;
/** 产品SKU */
sku?: string;
/** 常规价格 */
regular_price?: string;
/** 销售价格 */
sale_price?: string;
/** 当前价格 */
price?: string;
/** 库存状态 */
stock_status?: string;
/** 库存数量 */
stock_quantity?: number;
/** 产品图片 */
images?: UnifiedImageDTO[];
/** 产品标签 */
tags?: UnifiedTagDTO[];
/** 产品分类 */
categories?: UnifiedCategoryDTO[];
/** 产品属性 */
attributes?: UnifiedProductAttributeDTO[];
/** 产品变体 */
variations?: UnifiedProductVariationDTO[];
/** 创建时间 */
date_created?: string;
/** 更新时间 */
date_modified?: string;
/** 产品链接 */
permalink?: string;
/** 原始数据(保留备用) */
raw?: Record<string, any>;
/** ERP产品信息 */
erpProduct?: Record<string, any>;
};
type UnifiedProductPaginationDTO = {
/** 列表数据 */
items?: UnifiedProductDTO[];
/** 总数 */
total?: number;
/** 当前页 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 总页数 */
totalPages?: number;
};
type UnifiedProductVariationDTO = {
/** 变体ID */
id?: Record<string, any>;
/** 变体名称 */
name?: string;
/** 变体SKU */
sku?: string;
/** 常规价格 */
regular_price?: string;
/** 销售价格 */
sale_price?: string;
/** 当前价格 */
price?: string;
/** 库存状态 */
stock_status?: string;
/** 库存数量 */
stock_quantity?: number;
/** 变体属性 */
attributes?: UnifiedProductAttributeDTO[];
/** 变体图片 */
image?: UnifiedImageDTO;
/** 变体描述 */
description?: string;
/** 是否启用 */
enabled?: boolean;
/** 是否可下载 */
downloadable?: boolean;
/** 是否为虚拟商品 */
virtual?: boolean;
/** 管理库存 */
manage_stock?: boolean;
/** 重量 */
weight?: string;
/** 长度 */
length?: string;
/** 宽度 */
width?: string;
/** 高度 */
height?: string;
/** 运输类别 */
shipping_class?: string;
/** 税类别 */
tax_class?: string;
/** 菜单顺序 */
menu_order?: number;
};
type UnifiedReviewDTO = {
/** 评论ID */
id?: Record<string, any>;
/** 产品ID */
product_id?: Record<string, any>;
/** 评论者 */
author?: string;
/** 评论者邮箱 */
email?: string;
/** 评论内容 */
content?: string;
/** 评分 */
rating?: number;
/** 状态 */
status?: string;
/** 创建时间 */
date_created?: string;
/** 更新时间 */
date_modified?: string;
/** 原始数据 */
raw?: Record<string, any>;
};
type UnifiedReviewPaginationDTO = {
/** 列表数据 */
items?: UnifiedReviewDTO[];
/** 总数 */
total?: number;
/** 当前页 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 总页数 */
totalPages?: number;
};
type UnifiedSearchParamsDTO = {
/** 页码 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 查询时间范围开始 */
after?: string;
/** 查询时间范围结束 */
before?: string;
/** 搜索关键词 */
search?: string;
/** 过滤条件对象 */
where?: any;
/** 排序对象,例如 { "sku": "desc" } */
orderBy?: any;
/** 分组字段,例如 "categoryId" */
groupBy?: string;
};
type UnifiedShippingLineDTO = {
/** 配送方式ID */
id?: Record<string, any>;
/** 配送方式名称 */
method_title?: string;
/** 配送方式实例ID */
method_id?: string;
/** 配送方式金额 */
total?: string;
/** 配送方式税额 */
total_tax?: string;
/** 配送方式税额详情 */
taxes?: any;
/** 配送方式元数据 */
meta_data?: any;
};
type UnifiedSubscriptionDTO = {
/** 订阅ID */
id?: Record<string, any>;
/** 订阅状态 */
status?: string;
/** 客户ID */
customer_id?: number;
/** 计费周期 */
billing_period?: string;
/** 计费间隔 */
billing_interval?: number;
/** 创建时间 */
date_created?: string;
/** 更新时间 */
date_modified?: string;
/** 开始时间 */
start_date?: string;
/** 下次支付时间 */
next_payment_date?: string;
/** 订单项 */
line_items?: UnifiedOrderLineItemDTO[];
/** 原始数据 */
raw?: Record<string, any>;
};
type UnifiedSubscriptionPaginationDTO = {
/** 列表数据 */
items?: UnifiedSubscriptionDTO[];
/** 总数 */
total?: number;
/** 当前页 */
page?: number;
/** 每页数量 */
per_page?: number;
/** 总页数 */
totalPages?: number;
};
type UnifiedTagDTO = {
/** 标签ID */
id?: Record<string, any>;
/** 标签名称 */
name?: string;
};
type UnifiedWebhookDTO = {
/** Webhook ID */
id?: Record<string, any>;
/** 名称 */
name?: string;
/** 状态 */
status?: string;
/** 主题/事件 */
topic?: string;
/** 目标URL */
delivery_url?: string;
/** 秘密密钥 */
secret?: string;
/** 创建时间 */
date_created?: string;
/** 更新时间 */
date_modified?: string;
/** 头部信息 */
headers?: Record<string, any>;
/** API版本 */
api_version?: string;
};
type UpdateAreaDTO = {
/** 编码 */
code?: string;
};
type UpdateCategoryDTO = {
/** 分类显示名称 */
title?: string;
/** 分类中文名称 */
titleCN?: string;
/** 分类唯一标识 */
name?: string;
/** 分类短名称,用于生成SKU */
shortName?: string;
/** 排序 */
sort?: number;
};
type UpdateCustomerDTO = {
/** 站点ID */
site_id?: number;
/** 原始ID */
origin_id?: string;
/** 邮箱 */
email?: string;
/** 名字 */
first_name?: string;
/** 姓氏 */
last_name?: string;
/** 全名 */
fullname?: string;
/** 用户名 */
username?: string;
/** 电话 */
phone?: string;
/** 头像URL */
avatar?: string;
/** 账单信息 */
billing?: Record<string, any>;
/** 配送信息 */
shipping?: Record<string, any>;
/** 原始数据 */
raw?: Record<string, any>;
/** 评分 */
rate?: number;
/** 标签列表 */
tags?: string[];
};
type UpdateCustomerItemDTO = {
/** 客户ID */
id?: number;
/** 更新字段 */
update_data?: UpdateCustomerDTO;
};
type UpdateDictDTO = {};
type UpdateDictItemDTO = {};
type UpdateProductDTO = {
/** 产品名称 */
name?: string;
/** 产品中文名称 */
nameCn?: string;
/** 产品描述 */
description?: string;
/** 产品简短描述 */
shortDescription?: string;
/** 产品 SKU */
sku?: string;
/** 分类ID (DictItem ID) */
categoryId?: number;
/** 分类名称 */
categoryName?: string;
/** 站点 SKU 列表 */
siteSkus?: any[];
/** 价格 */
price?: number;
/** 促销价格 */
promotionPrice?: number;
/** 产品图片URL */
image?: string;
/** 属性列表 */
attributes?: any[];
/** 商品类型 */
type?: 'single' | 'bundle';
/** 产品组成 */
components?: any[];
};
type UpdatePurchaseOrderDTO = {
stockPointId?: number;
expectedArrivalTime?: string;
status?: 'draft' | 'submitted' | 'received';
note?: string;
items?: PurchaseOrderItem[];
};
type UpdateReviewDTO = {
/** 评论内容 */
review?: string;
/** 评分 */
rating?: number;
/** 状态 */
status?: string;
};
type UpdateSiteDTO = {
/** 站点 API URL */
apiUrl?: string;
/** 站点 REST Key */
consumerKey?: string;
/** 站点 REST 秘钥 */
consumerSecret?: string;
/** 访问令牌 */
token?: string;
/** 站点名称 */
name?: string;
/** 站点描述 */
description?: string;
/** 是否禁用 */
isDisabled?: boolean;
/** 平台类型 */
type?: 'woocommerce' | 'shopyy';
/** SKU 前缀 */
skuPrefix?: string;
/** 区域 */
areas?: any;
/** 绑定仓库ID列表 */
stockPointIds?: any;
/** 站点网站URL */
websiteUrl?: string;
/** Webhook URL */
webhookUrl?: string;
};
type UpdateStockDTO = {
stockPointId?: number;
sku?: string;
quantityChange?: number;
operationType?: 'in' | 'out';
operatorId?: number;
note?: string;
};
type UpdateStockPointDTO = {
name?: string;
location?: string;
contactPerson?: string;
contactPhone?: string;
/** 区域 */
areas?: any;
/** 上游仓库点ID */
upStreamStockPointId?: number;
/** 上游名称 */
upStreamName?: string;
};
type UpdateTemplateDTO = {
/** 模板名称 */
name: string;
/** 模板内容 */
value: string;
/** 测试数据JSON */
testData?: string;
};
type UpdateWebhookDTO = {
/** 名称 */
name?: string;
/** 状态 */
status?: string;
/** 主题/事件 */
topic?: string;
/** 目标URL */
delivery_url?: string;
/** 秘密密钥 */
secret?: string;
/** 头部信息 */
headers?: Record<string, any>;
/** API版本 */
api_version?: string;
};
type UploadMediaDTO = {
/** Base64 编码的文件内容 */
file?: string;
/** 文件名 */
filename?: string;
};
type usercontrollerUpdateuserParams = {
id?: number;
};
type webhookcontrollerHandleshoppywebhookParams = {
signature?: string;
siteId?: string;
};
type webhookcontrollerHandlewoowebhookParams = {
siteId?: string;
};
}