Product

商品结构

名称 类型 示例值 描述
product_id number 78879 产品id
name string 产品中文名称
name_en string 产品英文名称
is_sensitive bool false 是否为敏感品
sku_ids number[] [2234,5345,363] 产品skuid
is_onsale bool fasle 是否在售
create_date string 2015-03-22 12:34:54 创建时间的时间戳
images string[] 商品图片url
videos Video[] 商品主图视频
description string 商品描述
cid number 类目id
spec map 自定义商品规格
sku_prop_image SkuPropertyImage[] 商品sku属性展示图
delivery_method number 派送方式 派送方式
parcel_split number 包裹拆分方式 商品包裹拆分方式

Product Detail

商品详情

名称 类型 示例值 描述
product_id number 78879 产品id
name string 产品中文名称
name_en string 产品英文名称
is_sensitive bool false 是否为敏感品
sku_ids number[] [2234,5345,363] 产品skuid
is_onsale bool fasle 是否在售
create_date string 2015-03-22 12:34:54 创建时间的时间戳
images string[] 商品图片url
videos Video[] 商品主图视频
description string 商品描述
cid number 类目id
spec map <string,string> 商品描述属性,支持自定义
sku_prop_image SkuPropertyImage[] 商品sku属性展示图
skus Sku[] 商品sku详情

Sku

sku结构

名称 类型 示例值 描述
sku_id number 783783 ezbuy的SKUID
name string 蓝色x sku名称
product_id number 78879 产品id
seller_sku_id string uue939-1 卖家货号
retail_price float 88.99 sku原价
selling_price float 55.88 sku售卖价
stock number 88 sku库存
weight float 2.55 sku重量
is_onsale bool true 是否在售
length number 体积-长 (单位cm)
width number 体积-宽
height number 体积-高
sku_image string sku图片

New Sku Info

用于商品发布时的sku结构

名称 类型 示例值 描述
props SkuPropery[] sku销售属性
custom_props CustomSkuProperty[] 自定义sku销售属性值
seller_sku_id string uue939-1 卖家货号
retail_price float 88.99 sku原价
selling_price float 55.88 sku售卖价
stock number 88 sku库存
weight float 2.55 sku重量
is_onsale bool true 是否在售
length number 体积-长 (单位cm)
width number 体积-宽
height number 体积-高

Sku Property

sku属性

名称 类型 示例值 描述
pid number 类目属性id
vid number 类目属性值id

Custom Sku Property

sku属性

名称 类型 示例值 描述
pid number 类目属性id
value string 类目属性值
image string 类目属性图片

Sku Property Image

sku属性图片

名称 类型 示例值 描述
pid number 类目属性id
vid number 类目属性值id
vcontent string 类目属性值,仅供更新商品时使用(vid为0时,根据vcontent查询属性,更改image),新增商品时该字段不生效
image string 属性图片地址

Order

新订单系统的订单结构

名称 类型 示例值 描述
order_number string 订单编号
product_id number 商品id
product_name string 商品名
seller_sku_id string 货号
sku_id number 783783 sku id
sku_name string sku名称
sku_attr_image string sku属性图片
unit_price float 单价
quantity number 数量
status number 订单状态
dispatch_date string 2015-01-01 12:00:00 发货截止时间, 格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8
paid_date string 2015-01-01 12:00:00 订单付款时间, 格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8
warehouse number 1 仓库代码
remark string 蓝色XL 订单备注
cancel_date string 2015-01-01 12:00:00 取消时间,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8
cancel_reason number 取消原因
region number 国家代码
paid_amount float 实付金额

Sku Stock Out

订单sku缺货信息

名称 类型 示例值 描述
sku_id number 10032 订单下的ezbuy sku id
quantity number 4 sku缺货数量
reason string 缺货原因(200字符内)

Response Code

接口响应状态

名称 类型 描述
code string 响应状态码
message string 响应错误概述
detail string 响应错误详细描述

Category

类目信息

名称 类型 描述
cid number 类目id
name string 类目名称

Category Prop

类目属性

名称 类型 描述
pid number 属性id
name string 属性名
values CategoryPropValue[] 属性值
type number 属性类型(1:销售属性,2:描述属性)

Category Prop Value

类目属性值

名称 类型 描述
vid number 属性值id
name string 属性值

Issue

名称 类型 示例值 描述
issue_number string 2018041900542 工单编号
order_number string 25352806709854208-1 订单编号
issue_type string 退货申请 工单类型
issue_status number 1 工单状态:未分配、待回复、已回复、处理完成
create_date string 2015/01/01 12:00:00 发起时间时间戳, 格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8
message_date string 2015/01/01 12:00:00 留言更新时间戳, 格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8
complete_date string 2015/01/01 12:00:00 处理完成时间戳, 格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8
issue_sku issue-sku 包括:sku_id,问题数量
replies reply[]

Issue SKU

名称 类型 示例值 描述
sku_id number 783783 工单描述
quantity number 2 商品数量

Issue Reply

名称 类型 示例值 描述
username string 回复人
reply_message string 回复内容,包括图片链接
reply_date string 2015-01-01 12:00:00 回复留言的时间戳,格式为yyyy-MM-dd HH:mm:ss

Size Guide

名称 类型 示例值 描述
unit string Inches、Centimeters 尺码单位
table SizeTable[] 尺码表

Size Table

名称 类型 示例值 描述
column_name string size 列名
column_value string[] s、m、xl 列对应的值

Video

名称 类型 示例值 描述
url string https://www.youtube.com/embed/LlNlwY5yWmY 视频链接,目前只支持七牛与YouTube链接
show_status bool false 是否前台展示,默认值false

Parcel Order Data

包裹数据结构

名称 类型 示例值 描述
shop_id number 1000 店铺ID
ezorder_id string 327608829566969600 订单ID
parcel_num string 包裹号
parcel_status number 1 包裹状态
splited bool false 是否拆分
delivery_method number 派送方式
order_items ParcelOrderItem[] 订单行
sub_parcel_items SubParcelOrderItem[] 子包裹行
consignee ConsigneeInfo 收件人信息

Sub Parcel Order Item

名称 类型 示例值 描述
sub_parcel_num string 子包裹号
sub_parcel_status number 子包裹状态
order_items ParcelOrderItem[] 订单行
create_date number 创建时间-时间戳
update_date number 更新时间-时间戳

Parcel Order Item

名称 类型 示例值 描述
order_item_id string 327608829566969600 订单ID
order_num string 327608829566969600-1 订单号
product_id number 502232 商品ID
product_name string 蓝色牛仔裤 商品名
sku_id number 502233 SKU ID
seller_sku_id number 蓝色牛仔裤-S码 卖家SKU商品编码
sku_name string 蓝色-S码 SKU名称
unit_price number 商品单价(实际价格*100)
quantity number 数量
sku_img string SKU图片
order_status OrderItemTrackStatus 订单状态
warehouse OrderItemWarehouse 仓库代码
paid_amount number 实际支付(实际价格*100)
paid_date number 付款时间
dispatch_date number 发货时间
remark string 用户备注
cancel_date number 订单取消时间
cancel_reason number 订单取消原因
cus_region Region 订单国家

Consignee Info

名称 类型 示例值 描述
username string 收件人姓名
mobile string 收件人手机号
zip_code string 邮编
address string 详细地址
address_type number 收货地址类型

Split Parcel Data

名称 类型 是否必须 示例值 描述
sub_parcel_num string n 子包裹号,请求时可以为空,包裹被拆分则,返回数据不为空,否则为空
items SplitParcelItem[] y 子包裹列表

Split Parcel Item

名称 类型 示例值 描述
order_item_id string 订单ID
quantity number 数量

Dispatch Parcel Data

名称 类型 是否必须 示例值 描述
parcel_num string y 包裹号
provider string n 快递运营商
tracking_num string n 快递单号

Dispatch Address Data

名称 类型 示例值 描述
id number 地址ID
contact string 联系人
admim_area string[] 所在地区
admim_area_code string[] 所在地区编号
street string 街道
contact_method string 联系方式
remark string 备注
is_ship boolean 是否默认发货地址
is_receipt boolean 是否默认退货地址
email string 电子邮件
post_code string 邮编

Search Pickup Data

名称 类型 示例值 描述
task_no string 取货任务编号
address_id number 地址ID
pickup_date number 预约时间
remark string 备注
recipient string 取件人
recipient_phone string 取件人联系方式
timeslots PeriodModel 取件时间段
status PickupStatus 取件状态

Pickup Period Model

名称 类型 示例值 描述
date number 日期
pickup_periods PeriodModel[] 取货时间段

Period Model

名称 类型 示例值 描述
id number 日期
pickup_start string 开始时间段
pickup_end string 结束时间段