版权所有©，上海海鼎信息工程股份有限公司，2016-2025，保留所有权利。

接口

1. 接口定义

1.1. 商品服务

1.1.1. 分页查询品牌

POST /{tenant_id}/invc/itemservice/brands/query
1.1.1.1. 说明

分页查询品牌

1.1.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

倒序

boolean

Query

page
必填

页码，必须>=0

integer (int32)

Query

page_size
必填

分页大小，范围是[1,1000]

integer (int32)

Query

sort_key
可选

排序字段：modified,id,name

string

Body

filter
必填

过滤器

BrandFilter
1.1.1.3. 响应
HTTP代码 说明 类型

200

successful operation

BrandPaging
1.1.1.4. HTTP请求示例
请求 path
/string/invc/itemservice/brands/query?desc=true&page=0&page_size=0
请求 body
{
  "name_like" : "aaa",
  "key_like" : "aaa",
  "parent_id" : "aaa",
  "ids" : [ "string" ],
  "parent_ids" : [ "string" ],
  "parent_id_is_null" : false,
  "modified_start" : "2020-06-17 10:00:00",
  "modified_end" : "2020-06-17 10:00:00"
}
1.1.1.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 0,
  "brands" : [ {
    "id" : "3434343434",
    "name" : "耐克",
    "remark" : "无",
    "parentId" : "324232"
  } ],
  "page_count" : 10,
  "page_size" : 10
}

1.1.2. 批量更新品牌

POST /{tenant_id}/invc/itemservice/brands/update
1.1.2.1. 说明

批量更新品牌，不存在则创建，存在则修改。

1.1.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

brands
必填

品牌列表，每次更新不超过100条

BrandList
1.1.2.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.2.4. HTTP请求示例
请求 path
/string/invc/itemservice/brands/update?operator=string
请求 body
{
  "brands" : [ {
    "id" : "3434343434",
    "name" : "耐克",
    "remark" : "无",
    "parentId" : "324232"
  } ]
}
1.1.2.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.3. 分页查询类别

POST /{tenant_id}/invc/itemservice/categories/query
1.1.3.1. 说明

分页查询类别

1.1.3.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

string

Query

desc
可选

boolean

Query

page
可选

integer (int32)

Query

page_size
可选

integer (int32)

Query

sort_key
可选

排序字段：modified,id,name

string

Body

body
可选

CategoryFilter
1.1.3.3. 响应
HTTP代码 说明 类型

200

successful operation

CategoryPaging
1.1.3.4. HTTP请求示例
请求 path
/string/invc/itemservice/categories/query
请求 body
{
  "parentId" : "string",
  "modifiedStart" : "2020-06-17 10:00:00",
  "modifiedEnd" : "2020-06-17 10:00:00",
  "name_like" : "string",
  "key_like" : "string",
  "ids" : [ "string" ],
  "parent_ids" : [ "string" ],
  "parent_id_is_null" : true
}
1.1.3.5. HTTP响应示例
响应 200
{
  "total" : 0,
  "page" : 0,
  "categories" : [ {
    "id" : "99",
    "name" : "百货类",
    "remark" : "string",
    "parentId" : "string"
  } ],
  "page_count" : 0,
  "page_size" : 0
}

1.1.4. 批量更新类别

POST /{tenant_id}/invc/itemservice/categories/update
1.1.4.1. 说明

批量更新类别，不存在则创建，存在则修改。

1.1.4.2. 参数
类型 名称 类型

Path

tenant_id
必填

string

Query

operator
可选

string

Body

body
可选

CategoryList
1.1.4.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.4.4. HTTP请求示例
请求 path
/string/invc/itemservice/categories/update
请求 body
{
  "categories" : [ {
    "id" : "99",
    "name" : "百货类",
    "remark" : "string",
    "parentId" : "string"
  } ]
}
1.1.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.5. 批量更新产品

POST /{tenant_id}/invc/itemservice/products/update
1.1.5.1. 说明

批量更新产品，如果不存在则新增，存在则修改

1.1.5.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

products
必填

产品列表

ProductList
1.1.5.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.5.4. HTTP请求示例
请求 path
/string/invc/itemservice/products/update?operator=string
请求 body
{
  "products" : [ {
    "id" : "484844554",
    "name" : "苹果",
    "state" : "新品、季节品、赠品、淘汰品、预淘汰品、缺品、买断",
    "gid" : "2323",
    "qpcs" : [ {
      "uuid" : "string",
      "id" : "string",
      "qpc" : 0.0,
      "qpc_str" : "string",
      "unit" : "string",
      "weight" : 0.0
    } ],
    "remark" : "23223",
    "input_codes" : [ {
      "type" : "EAN",
      "code" : "232323",
      "qpc" : 1.0,
      "unit" : "包",
      "weight" : 0.0,
      "source" : "string",
      "qpc_str" : "1*1"
    } ],
    "is_unified" : false
  } ]
}
1.1.5.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.6. 批量上传商品图片

POST /{tenant_id}/invc/itemservice/sku/images/update
1.1.6.1. 说明

批量上传商品图片。

1.1.6.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

sku_images
必填

商品图片列表，每次更新不超过100条

SkuImageList
1.1.6.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.6.4. HTTP请求示例
请求 path
/string/invc/itemservice/sku/images/update?operator=string
请求 body
{
  "sku_images" : [ {
    "sku_id" : "string",
    "image" : {
      "name" : "a.jpg",
      "url" : "http://aa.png",
      "sort" : 1,
      "image_base64" : "xxxx"
    },
    "sub_images" : [ {
      "name" : "a.jpg",
      "url" : "http://aa.png",
      "sort" : 1,
      "image_base64" : "xxxx"
    } ],
    "detail_images" : [ {
      "name" : "a.jpg",
      "url" : "http://aa.png",
      "sort" : 1,
      "image_base64" : "xxxx"
    } ]
  } ],
  "upload_type" : "string"
}
1.1.6.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.7. 指定货号查询商品

GET /{tenant_id}/invc/itemservice/sku/{id}
1.1.7.1. 说明

指定货号查询商品

1.1.7.2. 参数
类型 名称 说明 类型

Path

id
必填

商品ID

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分:desc(商品详情)

string
1.1.7.3. 响应
HTTP代码 说明 类型

200

successful operation

Sku
1.1.7.4. HTTP请求示例
请求 path
/string/invc/itemservice/sku/string
1.1.7.5. HTTP响应示例
响应 200
{
  "id" : "484844554",
  "barcode" : "484844554",
  "upc" : "69...",
  "name" : "矿泉水",
  "remark" : "无",
  "disp" : false,
  "size" : {
    "unit" : "mm",
    "height" : 12.0,
    "width" : 15.0,
    "length" : 12.0
  },
  "weight" : {
    "unit" : "g",
    "value" : 12.0
  },
  "packing" : {
    "spec" : "1*1",
    "quantity" : 1.0,
    "spec2" : "200ml",
    "unit" : "瓶"
  },
  "title" : "矿泉水",
  "desc" : "好喝",
  "gid" : "145555",
  "capacity" : 0.001,
  "created" : "2018-11-11 21:12:55",
  "creator" : "123",
  "modifier" : "123",
  "product_id" : "1515151",
  "product_type" : "fresh",
  "brand_id" : "1515444444",
  "category_id" : "44848444484",
  "retail_price" : 15.15,
  "member_price" : 53.22,
  "image_url" : "http://aa.png",
  "sub_image_urls" : [ "string" ],
  "detail_image_urls" : [ "string" ],
  "tax_rate" : 0.13,
  "tax_sort_code" : "string",
  "invoice_name" : "string",
  "combined_items" : [ {
    "id" : "string",
    "title" : "string",
    "price" : 0.0,
    "quantity" : 0.0,
    "product_type" : "normal",
    "package_group_id" : "string",
    "add_price" : 0.0,
    "default_selected" : true,
    "required_selected" : true,
    "line_no" : 0
  } ],
  "package_groups" : [ {
    "id" : "string",
    "name" : "string",
    "type" : "string",
    "min_item_number" : 0.0,
    "max_item_number" : 0.0,
    "multiple_select_allowed" : true,
    "line_no" : 0
  } ],
  "customs_fields" : [ {
    "id" : "1212",
    "name" : "143434",
    "value" : "1212"
  } ],
  "input_codes" : [ {
    "type" : "EAN",
    "code" : "232323",
    "qpc" : 1.0,
    "unit" : "包",
    "weight" : 0.0,
    "source" : "string",
    "qpc_str" : "1*1"
  } ],
  "is_inv_unit" : true,
  "sku_combined_tag" : {
    "enabled" : false,
    "code" : "20-2-10",
    "qty" : 2.0,
    "price" : 19.9999
  },
  "kind_types" : [ "string" ],
  "capacity_unit" : "string",
  "invc_unit" : "string",
  "state" : "string",
  "modified" : "2018-11-11 21:12:55",
  "first_arriving_time" : "2018-11-11 21:12:55",
  "source" : "ERP",
  "label_printing" : false,
  "is_light_catering" : true,
  "trace_source_code_type" : "string",
  "online_type" : "string",
  "heavy_type" : "string",
  "sale_point" : "string",
  "shelf_life" : "string",
  "combo_mode_type" : "string",
  "process_during_sale" : true,
  "use_valid_date" : true,
  "valid_period_over_days" : 0,
  "sale_valid_period_over_hours" : 0
}

1.1.8. 批量取指定商品信息

POST /{tenant_id}/invc/itemservice/skus
1.1.8.1. 说明

批量取指定商品信息

1.1.8.2. 参数
类型 名称 类型

Path

tenant_id
必填

string

Body

body
可选

IdsWrapper
1.1.8.3. 响应
HTTP代码 说明 类型

200

successful operation

SkuList
1.1.8.4. HTTP请求示例
请求 path
/string/invc/itemservice/skus
请求 body
{
  "ids" : [ "string" ]
}
1.1.8.5. HTTP响应示例
响应 200
{
  "skus" : [ {
    "id" : "484844554",
    "barcode" : "484844554",
    "upc" : "69...",
    "name" : "矿泉水",
    "remark" : "无",
    "disp" : false,
    "size" : {
      "unit" : "mm",
      "height" : 12.0,
      "width" : 15.0,
      "length" : 12.0
    },
    "weight" : {
      "unit" : "g",
      "value" : 12.0
    },
    "packing" : {
      "spec" : "1*1",
      "quantity" : 1.0,
      "spec2" : "200ml",
      "unit" : "瓶"
    },
    "title" : "矿泉水",
    "desc" : "好喝",
    "gid" : "145555",
    "capacity" : 0.001,
    "created" : "2018-11-11 21:12:55",
    "creator" : "123",
    "modifier" : "123",
    "product_id" : "1515151",
    "product_type" : "fresh",
    "brand_id" : "1515444444",
    "category_id" : "44848444484",
    "retail_price" : 15.15,
    "member_price" : 53.22,
    "image_url" : "http://aa.png",
    "sub_image_urls" : [ "string" ],
    "detail_image_urls" : [ "string" ],
    "tax_rate" : 0.13,
    "tax_sort_code" : "string",
    "invoice_name" : "string",
    "combined_items" : [ {
      "id" : "string",
      "title" : "string",
      "price" : 0.0,
      "quantity" : 0.0,
      "product_type" : "normal",
      "package_group_id" : "string",
      "add_price" : 0.0,
      "default_selected" : true,
      "required_selected" : true,
      "line_no" : 0
    } ],
    "package_groups" : [ {
      "id" : "string",
      "name" : "string",
      "type" : "string",
      "min_item_number" : 0.0,
      "max_item_number" : 0.0,
      "multiple_select_allowed" : true,
      "line_no" : 0
    } ],
    "customs_fields" : [ {
      "id" : "1212",
      "name" : "143434",
      "value" : "1212"
    } ],
    "input_codes" : [ {
      "type" : "EAN",
      "code" : "232323",
      "qpc" : 1.0,
      "unit" : "包",
      "weight" : 0.0,
      "source" : "string",
      "qpc_str" : "1*1"
    } ],
    "is_inv_unit" : true,
    "sku_combined_tag" : {
      "enabled" : false,
      "code" : "20-2-10",
      "qty" : 2.0,
      "price" : 19.9999
    },
    "kind_types" : [ "string" ],
    "capacity_unit" : "string",
    "invc_unit" : "string",
    "state" : "string",
    "modified" : "2018-11-11 21:12:55",
    "first_arriving_time" : "2018-11-11 21:12:55",
    "source" : "ERP",
    "label_printing" : false,
    "is_light_catering" : true,
    "trace_source_code_type" : "string",
    "online_type" : "string",
    "heavy_type" : "string",
    "sale_point" : "string",
    "shelf_life" : "string",
    "combo_mode_type" : "string",
    "process_during_sale" : true,
    "use_valid_date" : true,
    "valid_period_over_days" : 0,
    "sale_valid_period_over_hours" : 0
  } ],
  "needSaveCombinedItems" : true
}

1.1.9. 分页查询商品，使用es索引

POST /{tenant_id}/invc/itemservice/skus/es_query
1.1.9.1. 说明

分页查询商品，使用es索引，推荐使用

1.1.9.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码，从0开始，必须>=0

integer (int32)

Query

page_size
必填

分页大小，范围是[1,1000]

integer (int32)

Query

sort_key
可选

排序字段，取值范围:title(名称)、barcode(条码)、skuId(货号)、modified(最后修改时间)

string

Body

filter
必填

查询过滤器

SkuFilter
1.1.9.3. 响应
HTTP代码 说明 类型

200

successful operation

SkuPaging
1.1.9.4. HTTP请求示例
请求 path
/string/invc/itemservice/skus/es_query?desc=true&page=0&page_size=0
请求 body
{
  "barcode" : "43454",
  "codes" : [ "string" ],
  "barcodes" : [ "string" ],
  "name_like" : "aaa",
  "key_like" : "aaa",
  "brand_id" : "54564",
  "category_id" : "32434",
  "code_type" : "string",
  "product_ids" : [ "string" ],
  "exclude_sku_ids" : "aaa",
  "title_like" : "aaa",
  "barcode_like" : "123",
  "sku_id_from" : "12",
  "sku_id_like" : "233",
  "sku_id_gt" : "233",
  "barcode_from" : "aaa",
  "sku_id_in" : [ "string" ],
  "product_types" : [ "normal" ],
  "modified_start" : "2018-11-11 21:12:55",
  "modified_end" : "2018-11-11 21:12:55",
  "created_start" : "2018-11-11 21:12:55",
  "created_end" : "2018-11-11 21:12:55",
  "fetch_parts" : "combinedItems",
  "kinds_in" : [ "string" ],
  "pre_page" : 1
}
1.1.9.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 0,
  "skus" : [ {
    "id" : "484844554",
    "barcode" : "484844554",
    "upc" : "69...",
    "name" : "矿泉水",
    "remark" : "无",
    "disp" : false,
    "size" : {
      "unit" : "mm",
      "height" : 12.0,
      "width" : 15.0,
      "length" : 12.0
    },
    "weight" : {
      "unit" : "g",
      "value" : 12.0
    },
    "packing" : {
      "spec" : "1*1",
      "quantity" : 1.0,
      "spec2" : "200ml",
      "unit" : "瓶"
    },
    "title" : "矿泉水",
    "desc" : "好喝",
    "gid" : "145555",
    "capacity" : 0.001,
    "created" : "2018-11-11 21:12:55",
    "creator" : "123",
    "modifier" : "123",
    "product_id" : "1515151",
    "product_type" : "fresh",
    "brand_id" : "1515444444",
    "category_id" : "44848444484",
    "retail_price" : 15.15,
    "member_price" : 53.22,
    "image_url" : "http://aa.png",
    "sub_image_urls" : [ "string" ],
    "detail_image_urls" : [ "string" ],
    "tax_rate" : 0.13,
    "tax_sort_code" : "string",
    "invoice_name" : "string",
    "combined_items" : [ {
      "id" : "string",
      "title" : "string",
      "price" : 0.0,
      "quantity" : 0.0,
      "product_type" : "normal",
      "package_group_id" : "string",
      "add_price" : 0.0,
      "default_selected" : true,
      "required_selected" : true,
      "line_no" : 0
    } ],
    "package_groups" : [ {
      "id" : "string",
      "name" : "string",
      "type" : "string",
      "min_item_number" : 0.0,
      "max_item_number" : 0.0,
      "multiple_select_allowed" : true,
      "line_no" : 0
    } ],
    "customs_fields" : [ {
      "id" : "1212",
      "name" : "143434",
      "value" : "1212"
    } ],
    "input_codes" : [ {
      "type" : "EAN",
      "code" : "232323",
      "qpc" : 1.0,
      "unit" : "包",
      "weight" : 0.0,
      "source" : "string",
      "qpc_str" : "1*1"
    } ],
    "is_inv_unit" : true,
    "sku_combined_tag" : {
      "enabled" : false,
      "code" : "20-2-10",
      "qty" : 2.0,
      "price" : 19.9999
    },
    "kind_types" : [ "string" ],
    "capacity_unit" : "string",
    "invc_unit" : "string",
    "state" : "string",
    "modified" : "2018-11-11 21:12:55",
    "first_arriving_time" : "2018-11-11 21:12:55",
    "source" : "ERP",
    "label_printing" : false,
    "is_light_catering" : true,
    "trace_source_code_type" : "string",
    "online_type" : "string",
    "heavy_type" : "string",
    "sale_point" : "string",
    "shelf_life" : "string",
    "combo_mode_type" : "string",
    "process_during_sale" : true,
    "use_valid_date" : true,
    "valid_period_over_days" : 0,
    "sale_valid_period_over_hours" : 0
  } ],
  "page_count" : 10,
  "page_size" : 10
}

1.1.10. 批量更新商品

POST /{tenant_id}/invc/itemservice/skus/update
1.1.10.1. 说明

批量更新商品，不存在则创建，存在则修改。

1.1.10.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

group_by_product
必填

如果是true，表示上传的商品是所属产品的全部商品，如果为false，则只上传部分商品

boolean

Query

operator
必填

操作人

string

Body

skus
必填

商品列表，每次更新不超过100条

SkuList
1.1.10.3. 响应
HTTP代码 说明 类型

200

successful operation

ItemUpdateResponse
1.1.10.4. HTTP请求示例
请求 path
/string/invc/itemservice/skus/update?group_by_product=true&operator=string
请求 body
{
  "skus" : [ {
    "id" : "484844554",
    "barcode" : "484844554",
    "upc" : "69...",
    "name" : "矿泉水",
    "remark" : "无",
    "disp" : false,
    "size" : {
      "unit" : "mm",
      "height" : 12.0,
      "width" : 15.0,
      "length" : 12.0
    },
    "weight" : {
      "unit" : "g",
      "value" : 12.0
    },
    "packing" : {
      "spec" : "1*1",
      "quantity" : 1.0,
      "spec2" : "200ml",
      "unit" : "瓶"
    },
    "title" : "矿泉水",
    "desc" : "好喝",
    "gid" : "145555",
    "capacity" : 0.001,
    "created" : "2018-11-11 21:12:55",
    "creator" : "123",
    "modifier" : "123",
    "product_id" : "1515151",
    "product_type" : "fresh",
    "brand_id" : "1515444444",
    "category_id" : "44848444484",
    "retail_price" : 15.15,
    "member_price" : 53.22,
    "image_url" : "http://aa.png",
    "sub_image_urls" : [ "string" ],
    "detail_image_urls" : [ "string" ],
    "tax_rate" : 0.13,
    "tax_sort_code" : "string",
    "invoice_name" : "string",
    "combined_items" : [ {
      "id" : "string",
      "title" : "string",
      "price" : 0.0,
      "quantity" : 0.0,
      "product_type" : "normal",
      "package_group_id" : "string",
      "add_price" : 0.0,
      "default_selected" : true,
      "required_selected" : true,
      "line_no" : 0
    } ],
    "package_groups" : [ {
      "id" : "string",
      "name" : "string",
      "type" : "string",
      "min_item_number" : 0.0,
      "max_item_number" : 0.0,
      "multiple_select_allowed" : true,
      "line_no" : 0
    } ],
    "customs_fields" : [ {
      "id" : "1212",
      "name" : "143434",
      "value" : "1212"
    } ],
    "input_codes" : [ {
      "type" : "EAN",
      "code" : "232323",
      "qpc" : 1.0,
      "unit" : "包",
      "weight" : 0.0,
      "source" : "string",
      "qpc_str" : "1*1"
    } ],
    "is_inv_unit" : true,
    "sku_combined_tag" : {
      "enabled" : false,
      "code" : "20-2-10",
      "qty" : 2.0,
      "price" : 19.9999
    },
    "kind_types" : [ "string" ],
    "capacity_unit" : "string",
    "invc_unit" : "string",
    "state" : "string",
    "modified" : "2018-11-11 21:12:55",
    "first_arriving_time" : "2018-11-11 21:12:55",
    "source" : "ERP",
    "label_printing" : false,
    "is_light_catering" : true,
    "trace_source_code_type" : "string",
    "online_type" : "string",
    "heavy_type" : "string",
    "sale_point" : "string",
    "shelf_life" : "string",
    "combo_mode_type" : "string",
    "process_during_sale" : true,
    "use_valid_date" : true,
    "valid_period_over_days" : 0,
    "sale_valid_period_over_hours" : 0
  } ],
  "needSaveCombinedItems" : true
}
1.1.10.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "errors" : [ {
    "id" : "string",
    "code" : "string",
    "message" : "string"
  } ]
}

1.1.11. 批量更新标签

POST /{tenant_id}/invc/itemservice/tags/update
1.1.11.1. 说明

批量更新标签，不存在则创建，存在则修改。

1.1.11.2. 参数
类型 名称 类型

Path

tenant_id
必填

string

Query

operator
可选

string

Body

body
可选

TagList
1.1.11.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.11.4. HTTP请求示例
请求 path
/string/invc/itemservice/tags/update
请求 body
{
  "tags" : [ {
    "code" : "string",
    "name" : "string"
  } ]
}
1.1.11.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

2. 定义

2.1. ActionResult

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.2. Brand

品牌资料

名称 说明 类型

id
必填

品牌标识
样例 : "3434343434"

string

name
必填

名称
样例 : "耐克"

string

parentId
可选

父品牌ID
样例 : "324232"

string

remark
可选

备注
样例 : "无"

string

2.3. BrandFilter

品牌查询过滤器

名称 说明 类型

ids
可选

品牌ID集合
样例 : [ "string" ]

< string > array

key_like
可选

主键(id,name)类似于，常用于模糊搜索
样例 : "aaa"

string

modified_end
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modified_start
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

name_like
可选

名称类似于
样例 : "aaa"

string

parent_id
可选

父品牌ID等于
样例 : "aaa"

string

parent_id_is_null
可选

父节点是否空
默认值 : false
样例 : false

boolean

parent_ids
可选

父品牌ID集合
样例 : [ "string" ]

< string > array

2.4. BrandList

品牌列表

名称 说明 类型

brands
可选

品牌列表集合
样例 : [ "Brand" ]

< Brand > array

2.5. BrandPaging

品牌查询过滤器

名称 说明 类型

brands
可选

品牌列表
样例 : [ "Brand" ]

< Brand > array

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

total
可选

总记录数
样例 : 100

integer (int64)

2.6. Category

名称 说明 类型

id
必填

类目ID
样例 : "99"

string

name
必填

类目名称
样例 : "百货类"

string

parentId
可选

上一级类目ID
样例 : "string"

string

remark
可选

类目说明
样例 : "string"

string

2.7. CategoryFilter

名称 说明 类型

ids
可选

样例 : [ "string" ]

< string > array

key_like
可选

样例 : "string"

string

modifiedEnd
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifiedStart
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

name_like
可选

样例 : "string"

string

parentId
可选

样例 : "string"

string

parent_id_is_null
可选

默认值 : false
样例 : true

boolean

parent_ids
可选

样例 : [ "string" ]

< string > array

2.8. CategoryList

名称 说明 类型

categories
可选

样例 : [ "Category" ]

< Category > array

2.9. CategoryPaging

名称 说明 类型

categories
可选

样例 : [ "Category" ]

< Category > array

page
可选

样例 : 0

integer (int32)

page_count
可选

样例 : 0

integer (int32)

page_size
可选

样例 : 0

integer (int32)

total
可选

样例 : 0

integer (int64)

2.10. CustomField

自定义属性值

名称 说明 类型

id
可选

自定义id
样例 : "1212"

string

name
可选

自定义名称
样例 : "143434"

string

value
可选

自定义值
样例 : "1212"

string

2.11. IdsWrapper

名称 说明 类型

ids
可选

样例 : [ "string" ]

< string > array

2.12. ImageDetail

名称 说明 类型

image_base64
可选

上传的图片base64编码字符串数据
样例 : "xxxx"

string

name
必填

图片名称，长度不能超过64
样例 : "a.jpg"

string

sort
可选

图片的序号，序号越小排在越前面，默认值为1
样例 : 1

integer (int32)

url
可选

图片url
样例 : "http://aa.png"

string

2.13. InputCode

输入码

名称 说明 类型

code
可选

条码
样例 : "232323"

string

qpc
可选

规格
样例 : 1.0

number

qpc_str
可选

规格说明
样例 : "1*1"

string

source
可选

来源
样例 : "string"

string

type
可选

输入码类型
样例 : "EAN"

string

unit
可选

单位
样例 : "包"

string

weight
可选

重量,默认单位是g
样例 : 0.0

number

2.14. ItemError

资料错误对象

名称 说明 类型

code
可选

样例 : "string"

string

id
可选

样例 : "string"

string

message
可选

样例 : "string"

string

2.15. ItemUpdateResponse

商品更新响应对象

名称 说明 类型

code
可选

样例 : "string"

string

errors
可选

样例 : [ "ItemError" ]

< ItemError > array

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.16. Measure

重量对象

名称 说明 类型

unit
可选

单位：g（克）,kg（千克），为空默认是g
样例 : "g"

string

value
可选

值
样例 : 12.0

number

2.17. Packing

包装规格

名称 说明 类型

quantity
必填

包装数量，默认1
样例 : 1.0

number

spec
可选

包装规格说明，比如1*8，默认1*1
样例 : "1*1"

string

spec2
可选

销售规格|含量
样例 : "200ml"

string

unit
可选

单位
样例 : "瓶"

string

2.18. Product

商品主档

名称 说明 类型

gid
可选

内码
样例 : "2323"

string

id
必填

商品主档id
样例 : "484844554"

string

input_codes
可选

输入码
样例 : [ "InputCode" ]

< InputCode > array

is_unified
可选

是否统一编码(大类编码):true为是,false为不是，修改时传null不修改
默认值 : false
样例 : false

boolean

name
必填

名称
样例 : "苹果"

string

qpcs
可选

输入码
样例 : [ "ProductQpc" ]

< ProductQpc > array

remark
可选

说明
样例 : "23223"

string

state
可选

状态
样例 : "新品、季节品、赠品、淘汰品、预淘汰品、缺品、买断"

string

2.19. ProductList

商品主档列表对象

名称 说明 类型

products
可选

商品主档列表
样例 : [ "Product" ]

< Product > array

2.20. ProductQpc

名称 说明 类型

id
可选

规格ID
样例 : "string"

string

qpc
可选

规格
样例 : 0.0

number

qpc_str
可选

规格文字
样例 : "string"

string

unit
可选

规格单位
样例 : "string"

string

uuid
可选

样例 : "string"

string

weight
可选

重量
样例 : 0.0

number

2.21. Size

尺寸对象

名称 说明 类型

height
可选

高
样例 : 12.0

number

length
可选

长
样例 : 12.0

number

unit
可选

单位
样例 : "mm"

string

width
可选

宽
样例 : 15.0

number

2.22. Sku

商品对象

名称 说明 类型

barcode
可选

条码：已经弃用，传值跟id保持一致，国标码传upc字段
样例 : "484844554"

string

brand_id
可选

品牌ID
样例 : "1515444444"

string

capacity
可选

容量
样例 : 0.001

number

capacity_unit
可选

容量单位
样例 : "string"

string

category_id
可选

类别ID
样例 : "44848444484"

string

combined_items
可选

商品组合详情
样例 : [ "SkuCombinedItem" ]

< SkuCombinedItem > array

combo_mode_type
可选

分组类型
样例 : "string"

string

created
可选

创建时间
样例 : "2018-11-11 21:12:55"

string (date-time)

creator
可选

创建人
样例 : "123"

string

customs_fields
可选

样例 : [ "CustomField" ]

< CustomField > array

desc
可选

商品描述
样例 : "好喝"

string

detail_image_urls
可选

详情图片url列表
样例 : [ "string" ]

< string > array

disp
可选

商品是否散装,默认false
默认值 : false
样例 : false

boolean

first_arriving_time
可选

首次到店时间
样例 : "2018-11-11 21:12:55"

string (date-time)

gid
可选

商品GID属性
样例 : "145555"

string

heavy_type
可选

重物类型，取值（普通、重物）
样例 : "string"

string

id
必填

货号
样例 : "484844554"

string

image_url
可选

主图url
样例 : "http://aa.png"

string

input_codes
可选

输入码（识别码）
样例 : [ "InputCode" ]

< InputCode > array

invc_unit
可选

计重单位
样例 : "string"

string

invoice_name
可选

开票商品名称
样例 : "string"

string

is_inv_unit
可选

是否为最小库存管理单位
默认值 : false
样例 : true

boolean

is_light_catering
可选

是否轻餐饮
默认值 : false
样例 : true

boolean

kind_types
可选

商品种类
样例 : [ "string" ]

< string > array

label_printing
可选

是否打印标签
默认值 : false
样例 : false

boolean

member_price
可选

标准会员价
样例 : 53.22

number

modified
可选

最后修改时间
样例 : "2018-11-11 21:12:55"

string (date-time)

modifier
可选

最后修改人
样例 : "123"

string

name
必填

名称
样例 : "矿泉水"

string

online_type
可选

商品线上类型，取值（自营商品、供应商商品）
样例 : "string"

string

package_groups
可选

套餐商品分组明细
样例 : [ "SkuPackageGroup" ]

< SkuPackageGroup > array

packing
可选

包装规格
样例 : Packing

Packing

process_during_sale
可选

是否售前加工
默认值 : false
样例 : true

boolean

product_id
必填

产品ID
样例 : "1515151"

string

product_type
可选

产品类型：取值范围：normal(普通商品),fresh(生鲜商品);combined(组合商品)
样例 : "fresh"

enum (normal, fresh, combined)

remark
可选

说明
样例 : "无"

string

retail_price
必填

标准零售价
样例 : 15.15

number

sale_point
可选

卖点
样例 : "string"

string

sale_valid_period_over_hours
可选

销售保质期超期提醒小时
样例 : 0

integer (int32)

shelf_life
可选

保质期
样例 : "string"

string

size
可选

尺寸
样例 : Size

Size

sku_combined_tag
可选

组合标签信息
样例 : SkuCombinedTag

SkuCombinedTag

source
可选

商品来源：DLY、ERP
样例 : "ERP"

string

state
可选

状态
样例 : "string"

string

sub_image_urls
可选

子图（幅图）url列表
样例 : [ "string" ]

< string > array

tax_rate
可选

税率,如果是13%，传0.13
样例 : 0.13

number

tax_sort_code
可选

税率分类码
样例 : "string"

string

title
可选

在前台展示的名称
样例 : "矿泉水"

string

trace_source_code_type
可选

溯源码类型，取值（一物一码、标准、酒类溯源码）
样例 : "string"

string

upc
可选

国标码
样例 : "69…​"

string

use_valid_date
可选

启用保质期
默认值 : false
样例 : true

boolean

valid_period_over_days
可选

保质期超期提醒天数
样例 : 0

integer (int32)

weight
可选

重量
样例 : Measure

Measure

2.23. SkuCombinedItem

名称 说明 类型

add_price
可选

加价
样例 : 0.0

number

default_selected
可选

是否默认选中
默认值 : false
样例 : true

boolean

id
可选

原料商品货号
样例 : "string"

string

line_no
可选

序号
样例 : 0

integer (int32)

package_group_id
可选

分组Id
样例 : "string"

string

price
可选

原料商品价格
样例 : 0.0

number

product_type
必填

产品类型
样例 : "normal"

enum (normal, fresh, combined)

quantity
可选

原料商品数量
样例 : 0.0

number

required_selected
可选

是否必选
默认值 : false
样例 : true

boolean

title
可选

名称
样例 : "string"

string

2.24. SkuCombinedTag

组合标签信息

名称 说明 类型

code
可选

标签，举例20-2-10，20所属商品大类代码，2商品数量，10价格
样例 : "20-2-10"

string

enabled
可选

是否启用组合标签，默认false（不启用）
默认值 : false
样例 : false

boolean

price
可选

价格
样例 : 19.9999

number

qty
可选

数量
样例 : 2.0

number

2.25. SkuFilter

查询条件对象

名称 说明 类型

barcode
可选

条码
样例 : "43454"

string

barcode_from
可选

条码起始于
样例 : "aaa"

string

barcode_like
可选

条码类似于
样例 : "123"

string

barcodes
可选

条码列表
样例 : [ "string" ]

< string > array

brand_id
可选

品牌ID
样例 : "54564"

string

category_id
可选

类别ID
样例 : "32434"

string

code_type
可选

样例 : "string"

string

codes
可选

样例 : [ "string" ]

< string > array

created_end
可选

创建结束时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2018-11-11 21:12:55"

string (date-time)

created_start
可选

创建起始时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2018-11-11 21:12:55"

string (date-time)

exclude_sku_ids
可选

样例 : "aaa"

< string > array

fetch_parts
可选

需要返回的部分
样例 : "combinedItems"

string

key_like
可选

(id,name)类似于，常用于模糊搜索
样例 : "aaa"

string

kinds_in
可选

样例 : [ "string" ]

< string > array

modified_end
可选

修改结束时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2018-11-11 21:12:55"

string (date-time)

modified_start
可选

修改起始时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2018-11-11 21:12:55"

string (date-time)

name_like
可选

名称类似于
样例 : "aaa"

string

pre_page
可选

上一次页数
样例 : 1

integer (int32)

product_ids
可选

商品ID
样例 : [ "string" ]

< string > array

product_types
可选

取值范围：normal(普通商品),fresh(生鲜商品),combined(组合商品);
样例 : [ "normal" ]

< enum (normal, fresh, combined) > array

sku_id_from
可选

货号起始于
样例 : "12"

string

sku_id_gt
可选

货号大于，字典序，es有效
样例 : "233"

string

sku_id_in
可选

货号范围
样例 : [ "string" ]

< string > array

sku_id_like
可选

货号类似于
样例 : "233"

string

title_like
可选

展示名称类似于
样例 : "aaa"

string

2.26. SkuImage

商品图片对象

名称 说明 类型

detail_images
可选

详情图片
样例 : [ "ImageDetail" ]

< ImageDetail > array

image
可选

主图
样例 : ImageDetail

ImageDetail

sku_id
可选

样例 : "string"

string

sub_images
可选

子图
样例 : [ "ImageDetail" ]

< ImageDetail > array

2.27. SkuImageList

商品图片列表对象

名称 说明 类型

sku_images
可选

上传的商品图片列表
样例 : [ "SkuImage" ]

< SkuImage > array

upload_type
可选

上传方式 url 或 base64 ,默认url
样例 : "string"

string

2.28. SkuList

商品列表对象

名称 说明 类型

needSaveCombinedItems
可选

是否保存组合原料商品
默认值 : false
样例 : true

boolean

skus
可选

商品列表
样例 : [ "Sku" ]

< Sku > array

2.29. SkuPackageGroup

名称 说明 类型

id
可选

分组Id
样例 : "string"

string

line_no
可选

序号
样例 : 0

integer (int32)

max_item_number
可选

最大选项数
样例 : 0.0

number

min_item_number
可选

最小选项数
样例 : 0.0

number

multiple_select_allowed
可选

是否允许多选
默认值 : false
样例 : true

boolean

name
可选

名称
样例 : "string"

string

type
可选

分组类型:fixed(固定)，optional(可选)
样例 : "string"

string

2.30. SkuPaging

商品分页结果

名称 说明 类型

page
可选

页号，从0开始，必须>=0
样例 : 0

integer (int32)

page_count
可选

总页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

skus
可选

商品集合
样例 : [ "Sku" ]

< Sku > array

total
可选

总记录
样例 : 100

integer (int64)

2.31. Tag

名称 说明 类型

code
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.32. TagList

名称 说明 类型

tags
可选

样例 : [ "Tag" ]

< Tag > array