版权所有©,上海海鼎信息工程股份有限公司,2016-2025,保留所有权利。
1. 接口定义
1.1. 仓库库存服务
1.1.1. ERP更新仓库库存到鼎力云
POST /{tenant_id}/invc/wrhinvservice/wrh/{wrh_id}/invs
1.1.1.1. 说明
ERP更新仓库库存到鼎力云
1.1.1.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Path |
wrh_id |
仓库代码 |
string |
Query |
operator |
操作人 |
string |
Body |
skus |
当前可用库存集合 |
1.1.1.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.1.4. HTTP请求示例
请求 path
/string/invc/wrhinvservice/wrh/string/invs?operator=string
请求 body
{
"operator" : "string",
"skus" : [ {
"available" : 155.0,
"sku_id" : "54654",
"fixed_qty" : 10.0,
"stock_qty" : 12.0,
"change_time" : "2019-07-30 00:00:00",
"task_id" : "54654"
} ],
"business_type" : "order",
"business_key" : "4089440170477411908"
}
1.1.1.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.2. 商品服务
1.2.1. 分页查询品牌
POST /{tenant_id}/invc/itemservice/brands/query
1.2.1.1. 说明
分页查询品牌
1.2.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 |
过滤器 |
1.2.1.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.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.2.1.5. HTTP响应示例
响应 200
{
"total" : 100,
"page" : 0,
"brands" : [ {
"id" : "3434343434",
"name" : "耐克",
"remark" : "无",
"parentId" : "324232"
} ],
"page_count" : 10,
"page_size" : 10
}
1.2.2. 批量更新品牌
POST /{tenant_id}/invc/itemservice/brands/update
1.2.2.1. 说明
批量更新品牌,不存在则创建,存在则修改。
1.2.2.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
brands |
品牌列表,每次更新不超过100条 |
1.2.2.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.2.4. HTTP请求示例
请求 path
/string/invc/itemservice/brands/update?operator=string
请求 body
{
"brands" : [ {
"id" : "3434343434",
"name" : "耐克",
"remark" : "无",
"parentId" : "324232"
} ]
}
1.2.2.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.2.3. 分页查询类别
POST /{tenant_id}/invc/itemservice/categories/query
1.2.3.1. 说明
分页查询类别
1.2.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 |
1.2.3.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.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.2.3.5. HTTP响应示例
响应 200
{
"total" : 0,
"page" : 0,
"categories" : [ {
"id" : "99",
"name" : "百货类",
"remark" : "string",
"parentId" : "string"
} ],
"page_count" : 0,
"page_size" : 0
}
1.2.4. 批量更新类别
POST /{tenant_id}/invc/itemservice/categories/update
1.2.4.1. 说明
批量更新类别,不存在则创建,存在则修改。
1.2.4.2. 参数
类型 | 名称 | 类型 |
---|---|---|
Path |
tenant_id |
string |
Query |
operator |
string |
Body |
body |
1.2.4.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.4.4. HTTP请求示例
请求 path
/string/invc/itemservice/categories/update
请求 body
{
"categories" : [ {
"id" : "99",
"name" : "百货类",
"remark" : "string",
"parentId" : "string"
} ]
}
1.2.4.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.2.5. 批量更新产品
POST /{tenant_id}/invc/itemservice/products/update
1.2.5.1. 说明
批量更新产品,如果不存在则新增,存在则修改
1.2.5.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
products |
产品列表 |
1.2.5.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.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.2.5.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.2.6. 批量上传商品图片
POST /{tenant_id}/invc/itemservice/sku/images/update
1.2.6.1. 说明
批量上传商品图片。
1.2.6.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
sku_images |
商品图片列表,每次更新不超过100条 |
1.2.6.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.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.2.6.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.2.7. 指定货号查询商品
GET /{tenant_id}/invc/itemservice/sku/{id}
1.2.7.1. 说明
指定货号查询商品
1.2.7.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
商品ID |
string |
Path |
tenant_id |
租户ID |
string |
Query |
parts |
需要返回的部分:desc(商品详情) |
string |
1.2.7.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.7.4. HTTP请求示例
请求 path
/string/invc/itemservice/sku/string
1.2.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"
} ],
"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"
}
1.2.8. 批量取指定商品信息
POST /{tenant_id}/invc/itemservice/skus
1.2.8.1. 说明
批量取指定商品信息
1.2.8.2. 参数
类型 | 名称 | 类型 |
---|---|---|
Path |
tenant_id |
string |
Body |
body |
1.2.8.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.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"
} ],
"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"
} ]
}
1.2.9. 分页查询商品,使用es索引
POST /{tenant_id}/invc/itemservice/skus/es_query
1.2.9.1. 说明
分页查询商品,使用es索引,推荐使用
1.2.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 |
查询过滤器 |
1.2.9.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.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.2.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"
} ],
"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"
} ],
"page_count" : 10,
"page_size" : 10
}
1.2.10. 批量更新商品
POST /{tenant_id}/invc/itemservice/skus/update
1.2.10.1. 说明
批量更新商品,不存在则创建,存在则修改。
1.2.10.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
group_by_product |
如果是true,表示上传的商品是所属产品的全部商品,如果为false,则只上传部分商品 |
boolean |
Query |
operator |
操作人 |
string |
Body |
skus |
商品列表,每次更新不超过100条 |
1.2.10.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.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"
} ],
"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"
} ]
}
1.2.10.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string",
"errors" : [ {
"id" : "string",
"code" : "string",
"message" : "string"
} ]
}
1.2.11. 批量更新标签
POST /{tenant_id}/invc/itemservice/tags/update
1.2.11.1. 说明
批量更新标签,不存在则创建,存在则修改。
1.2.11.2. 参数
类型 | 名称 | 类型 |
---|---|---|
Path |
tenant_id |
string |
Query |
operator |
string |
Body |
body |
1.2.11.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.2.11.4. HTTP请求示例
请求 path
/string/invc/itemservice/tags/update
请求 body
{
"tags" : [ {
"code" : "string",
"name" : "string"
} ]
}
1.2.11.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.3. 门店库存服务
1.3.1. POS更新门店库存到鼎力云
POST /{tenant_id}/invc/storeinvservice/store/{store_id}/invs
1.3.1.1. 说明
POS更新门店库存到鼎力云
1.3.1.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Body |
skus |
当前可用库存集合 |
1.3.1.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.3.1.4. HTTP请求示例
请求 path
/string/invc/storeinvservice/store/string/invs
请求 body
{
"operator" : "string",
"skus" : [ {
"available" : 155.0,
"sku_id" : "54654",
"fixed_qty" : 10.0,
"stock_qty" : 12.0,
"change_time" : "2019-07-30 00:00:00",
"task_id" : "54654"
} ],
"business_type" : "order",
"business_key" : "4089440170477411908"
}
1.3.1.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.4. 门店商品服务
1.4.1. 批量更新门店商品货架位
POST /{tenant_id}/invc/storeskuservice/store/{store_id}/skus/shelfPositionCode
1.4.1.1. 说明
批量更新门店商品货架位,覆盖更新,空数组则清空。
1.4.1.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店id |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
storeSkuShelfPositionCodeList |
门店商品货架位列表,每次更新不超过100条 |
1.4.1.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.4.1.4. HTTP请求示例
请求 path
/string/invc/storeskuservice/store/string/skus/shelfPositionCode?operator=string
请求 body
{
"store_sku_shelf_position_codes" : [ {
"sku_id" : "12002",
"shelf_position_codes" : [ "string" ]
} ]
}
1.4.1.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string",
"errors" : [ {
"code" : "string",
"message" : "string",
"store_id" : "string",
"sku_id" : "string"
} ]
}
1.4.2. 批量更新门店商品
POST /{tenant_id}/invc/storeskuservice/store/{store_id}/skus/updates
1.4.2.1. 说明
批量更新门店商品,不存在则创建,存在则修改。
1.4.2.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店id |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
storeSkus |
门店商品列表,每次更新不超过100条 |
1.4.2.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.4.2.4. HTTP请求示例
请求 path
/string/invc/storeskuservice/store/string/skus/updates?operator=string
请求 body
{
"store_skus" : [ {
"state" : "待售:forSale,可售:sale,禁售: notForSale",
"modified" : "2016-03-02 12:00:02",
"store_id" : "001",
"store_name" : "测试店",
"sku_id" : "12002",
"business_type" : "string",
"erp_state" : "string",
"is_active_sales" : true,
"sku_shelf_position_code" : "string",
"use_state" : "string"
} ]
}
1.4.2.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string",
"errors" : [ {
"code" : "string",
"message" : "string",
"store_id" : "string",
"sku_id" : "string"
} ]
}
1.5. 门店价格服务
1.5.1. POS更新门店商品价格到鼎力云
POST /{tenant_id}/invc/storepriceservice/store/{store_id}/prices
1.5.1.1. 说明
POS更新门店商品价格到鼎力云
1.5.1.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
store_id |
门店ID |
string |
Path |
tenant_id |
租户ID |
string |
Body |
prices |
商品价格集合 |
1.5.1.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.5.1.4. HTTP请求示例
请求 path
/string/invc/storepriceservice/store/string/prices
请求 body
{
"skus" : [ {
"price" : 12.25,
"modified" : "2019-07-30 00:00:00",
"modifier" : "张三",
"sku_id" : "54654",
"min_price" : 12.25,
"max_price" : 12.25,
"unit_price" : 12.35,
"mbr_price" : 15.25,
"task_id" : "32323232",
"price_mode" : "price",
"change_time" : "2019-07-30 00:00:00",
"cost_price" : 5.67
} ]
}
1.5.1.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.6. 订单占货服务
1.6.1. 订单占货
POST /{tenant_id}/invc/orderstockservice/lock
1.6.1.1. 说明
订单占货
1.6.1.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Body |
param |
占货参数 |
1.6.1.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.6.1.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/lock?operator=string
请求 body
{
"items" : [ {
"sku_id" : "12",
"qty" : 32.0
} ],
"order_id" : "4545454545454542",
"platform_id" : "jdo2o",
"shop_id" : "12121212",
"shop_name" : "百度外卖",
"store_id" : "43435545",
"store_name" : "aaa",
"request_id" : "3232323",
"lock_type" : "3232323"
}
1.6.1.5. HTTP响应示例
响应 200
{
"success" : true,
"message" : "占货失败",
"stock_state" : "locked",
"lock_result" : "none",
"lock_id" : "string",
"store_id" : "string"
}
1.6.2. 查询订单占货
GET /{tenant_id}/invc/orderstockservice/order/lockresult
1.6.2.1. 说明
查询订单占货
1.6.2.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
order_id |
订单号 |
string |
1.6.2.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.6.2.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/order/lockresult?order_id=string
1.6.2.5. HTTP响应示例
响应 200
{
"success" : true,
"message" : "占货失败",
"stock_state" : "locked",
"lock_result" : "none",
"lock_id" : "string",
"store_id" : "string"
}
1.6.3. 获取指定货号平台商家占用门店库存记录
GET /{tenant_id}/invc/orderstockservice/orderstocks
1.6.3.1. 说明
获取指定货号平台商家占用门店库存记录
1.6.3.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
platform_id |
平台id |
string |
Query |
shop_id |
商家id |
string |
Query |
shop_id |
门店id |
string |
Query |
sku_ids |
货号集合 |
< string > array(multi) |
1.6.3.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.6.3.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/orderstocks?platform_id=string&shop_id=string&sku_ids=string
1.6.3.5. HTTP响应示例
响应 200
{
"operator" : "string",
"skus" : [ {
"available" : 155.0,
"sku_id" : "54654",
"fixed_qty" : 10.0,
"stock_qty" : 12.0,
"change_time" : "2019-07-30 00:00:00",
"task_id" : "54654"
} ],
"business_type" : "order",
"business_key" : "4089440170477411908"
}
1.6.4. 订单占货发货|出库
PUT /{tenant_id}/invc/orderstockservice/ship/{order_id}
1.6.4.1. 说明
订单占货发货|出库
1.6.4.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
order_id |
订单号 |
string |
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
1.6.4.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.6.4.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/ship/string?operator=string
1.6.4.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
1.6.5. 取消占货
POST /{tenant_id}/invc/orderstockservice/unlock
1.6.5.1. 说明
取消订单占货,释放占用库存
1.6.5.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户ID |
string |
Query |
operator |
操作人 |
string |
Query |
order_id |
订单号 |
string |
Query |
request_id |
标识一次占货请求,如果不为空表示释放某一次请求的占货结果,如果为空表示释放订单的占货结果 |
string |
1.6.5.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.6.5.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/unlock?operator=string&order_id=string
1.6.5.5. HTTP响应示例
响应 200
{
"success" : true,
"code" : "string",
"message" : "string"
}
2. 定义
2.1. ActionResult
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
message |
样例 : |
string |
success |
默认值 : |
boolean |
2.2. Brand
品牌资料
名称 | 说明 | 类型 |
---|---|---|
id |
品牌标识 |
string |
name |
名称 |
string |
parentId |
父品牌ID |
string |
remark |
备注 |
string |
2.3. BrandFilter
品牌查询过滤器
名称 | 说明 | 类型 |
---|---|---|
ids |
品牌ID集合 |
< string > array |
key_like |
主键(id,name)类似于,常用于模糊搜索 |
string |
modified_end |
样例 : |
string (date-time) |
modified_start |
样例 : |
string (date-time) |
name_like |
名称类似于 |
string |
parent_id |
父品牌ID等于 |
string |
parent_id_is_null |
父节点是否空 |
boolean |
parent_ids |
父品牌ID集合 |
< string > array |
2.5. BrandPaging
品牌查询过滤器
名称 | 说明 | 类型 |
---|---|---|
brands |
品牌列表 |
< Brand > array |
page |
页码 |
integer (int32) |
page_count |
页数 |
integer (int32) |
page_size |
分页大小 |
integer (int32) |
total |
总记录数 |
integer (int64) |
2.6. Category
名称 | 说明 | 类型 |
---|---|---|
id |
类目ID |
string |
name |
类目名称 |
string |
parentId |
上一级类目ID |
string |
remark |
类目说明 |
string |
2.7. CategoryFilter
名称 | 说明 | 类型 |
---|---|---|
ids |
样例 : |
< string > array |
key_like |
样例 : |
string |
modifiedEnd |
样例 : |
string (date-time) |
modifiedStart |
样例 : |
string (date-time) |
name_like |
样例 : |
string |
parentId |
样例 : |
string |
parent_id_is_null |
默认值 : |
boolean |
parent_ids |
样例 : |
< string > array |
2.8. CategoryList
名称 | 说明 | 类型 |
---|---|---|
categories |
样例 : |
< Category > array |
2.9. CategoryPaging
名称 | 说明 | 类型 |
---|---|---|
categories |
样例 : |
< Category > array |
page |
样例 : |
integer (int32) |
page_count |
样例 : |
integer (int32) |
page_size |
样例 : |
integer (int32) |
total |
样例 : |
integer (int64) |
2.10. CustomField
自定义属性值
名称 | 说明 | 类型 |
---|---|---|
id |
自定义id |
string |
name |
自定义名称 |
string |
value |
自定义值 |
string |
2.11. IdsWrapper
名称 | 说明 | 类型 |
---|---|---|
ids |
样例 : |
< string > array |
2.12. ImageDetail
名称 | 说明 | 类型 |
---|---|---|
image_base64 |
上传的图片base64编码字符串数据 |
string |
name |
图片名称,长度不能超过64 |
string |
sort |
图片的序号,序号越小排在越前面,默认值为1 |
integer (int32) |
url |
图片url |
string |
2.13. InputCode
输入码
名称 | 说明 | 类型 |
---|---|---|
code |
条码 |
string |
qpc |
规格 |
number |
qpc_str |
规格说明 |
string |
source |
来源 |
string |
type |
输入码类型 |
string |
unit |
单位 |
string |
weight |
重量,默认单位是g |
number |
2.14. ItemError
资料错误对象
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
id |
样例 : |
string |
message |
样例 : |
string |
2.15. ItemUpdateResponse
商品更新响应对象
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
errors |
样例 : |
< ItemError > array |
message |
样例 : |
string |
success |
默认值 : |
boolean |
2.16. LockStockResult
占货结果
名称 | 说明 | 类型 |
---|---|---|
lock_id |
占货ID |
string |
lock_result |
占货结果,取值:none(未占货), lock_all(全部占货), lock_part(部分占货) |
string |
message |
消息 |
string |
stock_state |
占货状态,取值:initial(未占货), locked(已占货), shipped(已发货), aborted(已作废) |
enum (initial, locked, shipped, aborted) |
store_id |
门店ID |
string |
success |
是否成功,取值:true(成功), false(失败) |
boolean |
2.17. Measure
重量对象
名称 | 说明 | 类型 |
---|---|---|
unit |
单位:g(克),kg(千克),为空默认是g |
string |
value |
值 |
number |
2.19. OrderDataParam
占货参数
名称 | 说明 | 类型 |
---|---|---|
items |
明细 |
< OrderDataItem > array |
lock_type |
占货类型:(pre_lock)预占、(lock)在单库存 |
string |
order_id |
订单号 |
string |
platform_id |
平台id |
string |
request_id |
请求标识ID,识别一次占货请求 |
string |
shop_id |
平台商家id |
string |
shop_name |
平台商家名称 |
string |
store_id |
门店id |
string |
store_name |
门店名称 |
string |
2.20. Packing
包装规格
名称 | 说明 | 类型 |
---|---|---|
quantity |
包装数量,默认1 |
number |
spec |
包装规格说明,比如1*8,默认1*1 |
string |
spec2 |
销售规格|含量 |
string |
unit |
单位 |
string |
2.21. Product
商品主档
名称 | 说明 | 类型 |
---|---|---|
gid |
内码 |
string |
id |
商品主档id |
string |
input_codes |
输入码 |
< InputCode > array |
is_unified |
是否统一编码(大类编码):true为是,false为不是,修改时传null不修改 |
boolean |
name |
名称 |
string |
qpcs |
输入码 |
< ProductQpc > array |
remark |
说明 |
string |
state |
状态 |
string |
2.23. ProductQpc
名称 | 说明 | 类型 |
---|---|---|
id |
规格ID |
string |
qpc |
规格 |
number |
qpc_str |
规格文字 |
string |
unit |
规格单位 |
string |
uuid |
样例 : |
string |
weight |
重量 |
number |
2.24. Size
尺寸对象
名称 | 说明 | 类型 |
---|---|---|
height |
高 |
number |
length |
长 |
number |
unit |
单位 |
string |
width |
宽 |
number |
2.25. Sku
商品对象
名称 | 说明 | 类型 |
---|---|---|
barcode |
条码:已经弃用,传值跟id保持一致,国标码传upc字段 |
string |
brand_id |
品牌ID |
string |
capacity |
容量 |
number |
capacity_unit |
容量单位 |
string |
category_id |
类别ID |
string |
combined_items |
商品组合详情 |
< SkuCombinedItem > array |
created |
创建时间 |
string (date-time) |
creator |
创建人 |
string |
customs_fields |
样例 : |
< CustomField > array |
desc |
商品描述 |
string |
detail_image_urls |
详情图片url列表 |
< string > array |
disp |
商品是否散装,默认false |
boolean |
first_arriving_time |
首次到店时间 |
string (date-time) |
gid |
商品GID属性 |
string |
heavy_type |
重物类型,取值(普通、重物) |
string |
id |
货号 |
string |
image_url |
主图url |
string |
input_codes |
输入码(识别码) |
< InputCode > array |
invc_unit |
计重单位 |
string |
invoice_name |
开票商品名称 |
string |
is_inv_unit |
是否为最小库存管理单位 |
boolean |
is_light_catering |
是否轻餐饮 |
boolean |
kind_types |
商品种类 |
< string > array |
label_printing |
是否打印标签 |
boolean |
member_price |
标准会员价 |
number |
modified |
最后修改时间 |
string (date-time) |
modifier |
最后修改人 |
string |
name |
名称 |
string |
online_type |
商品线上类型,取值(自营商品、供应商商品) |
string |
packing |
包装规格 |
|
product_id |
产品ID |
string |
product_type |
产品类型:取值范围:normal(普通商品),fresh(生鲜商品);combined(组合商品) |
enum (normal, fresh, combined) |
remark |
说明 |
string |
retail_price |
标准零售价 |
number |
sale_point |
卖点 |
string |
shelf_life |
保质期 |
string |
size |
尺寸 |
|
sku_combined_tag |
组合标签信息 |
|
source |
商品来源:DLY、ERP |
string |
state |
状态 |
string |
sub_image_urls |
子图(幅图)url列表 |
< string > array |
tax_rate |
税率,如果是13%,传0.13 |
number |
tax_sort_code |
税率分类码 |
string |
title |
在前台展示的名称 |
string |
trace_source_code_type |
溯源码类型,取值(一物一码、标准、酒类溯源码) |
string |
upc |
国标码 |
string |
weight |
重量 |
2.26. SkuCombinedItem
名称 | 说明 | 类型 |
---|---|---|
id |
样例 : |
string |
price |
样例 : |
number |
product_type |
样例 : |
enum (normal, fresh, combined) |
quantity |
样例 : |
number |
title |
样例 : |
string |
2.27. SkuCombinedTag
组合标签信息
名称 | 说明 | 类型 |
---|---|---|
code |
标签,举例20-2-10,20所属商品大类代码,2商品数量,10价格 |
string |
enabled |
是否启用组合标签,默认false(不启用) |
boolean |
price |
价格 |
number |
qty |
数量 |
number |
2.28. SkuFilter
查询条件对象
名称 | 说明 | 类型 |
---|---|---|
barcode |
条码 |
string |
barcode_from |
条码起始于 |
string |
barcode_like |
条码类似于 |
string |
barcodes |
条码列表 |
< string > array |
brand_id |
品牌ID |
string |
category_id |
类别ID |
string |
code_type |
样例 : |
string |
codes |
样例 : |
< string > array |
created_end |
创建结束时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
created_start |
创建起始时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
exclude_sku_ids |
样例 : |
< string > array |
fetch_parts |
需要返回的部分 |
string |
key_like |
(id,name)类似于,常用于模糊搜索 |
string |
kinds_in |
样例 : |
< string > array |
modified_end |
修改结束时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
modified_start |
修改起始时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
name_like |
名称类似于 |
string |
pre_page |
上一次页数 |
integer (int32) |
product_ids |
商品ID |
< string > array |
product_types |
取值范围:normal(普通商品),fresh(生鲜商品),combined(组合商品); |
< enum (normal, fresh, combined) > array |
sku_id_from |
货号起始于 |
string |
sku_id_gt |
货号大于,字典序,es有效 |
string |
sku_id_in |
货号范围 |
< string > array |
sku_id_like |
货号类似于 |
string |
title_like |
展示名称类似于 |
string |
2.29. SkuImage
商品图片对象
名称 | 说明 | 类型 |
---|---|---|
detail_images |
详情图片 |
< ImageDetail > array |
image |
主图 |
|
sku_id |
样例 : |
string |
sub_images |
子图 |
< ImageDetail > array |
2.30. SkuImageList
商品图片列表对象
名称 | 说明 | 类型 |
---|---|---|
sku_images |
上传的商品图片列表 |
< SkuImage > array |
upload_type |
上传方式 url 或 base64 ,默认url |
string |
2.32. SkuPaging
商品分页结果
名称 | 说明 | 类型 |
---|---|---|
page |
页号,从0开始,必须>=0 |
integer (int32) |
page_count |
总页数 |
integer (int32) |
page_size |
分页大小 |
integer (int32) |
skus |
商品集合 |
< Sku > array |
total |
总记录 |
integer (int64) |
2.33. SkuPrice
库存
名称 | 说明 | 类型 |
---|---|---|
change_time |
业务变化时间 |
string (date-time) |
cost_price |
成本价 |
number |
max_price |
最大商品零售价 |
number |
mbr_price |
会员价 |
number |
min_price |
最小商品零售价 |
number |
modified |
最后修改时间 |
string (date-time) |
modifier |
修改人 |
string |
price |
商品零售价 |
number |
price_mode |
取价方式:unit_price(标准售价),price(固定价) |
enum (unit_price, price) |
sku_id |
商品ID |
string |
task_id |
任务ID |
string |
unit_price |
标准售价 |
number |
2.35. SkuQuantity
库存
名称 | 说明 | 类型 |
---|---|---|
available |
可用库存数 |
number |
change_time |
库存变化时间 |
string (date-time) |
fixed_qty |
期初库存数 |
number |
sku_id |
商品ID |
string |
stock_qty |
占用库存 |
number |
task_id |
任务ID |
string |
2.36. SkuQuantityList
当前可用库存集合
名称 | 说明 | 类型 |
---|---|---|
business_key |
业务关键字 |
string |
business_type |
业务类型 |
string |
operator |
操作人 |
string |
skus |
当前可用库存集合 |
< SkuQuantity > array |
2.37. StoreSku
门店商品对象
名称 | 说明 | 类型 |
---|---|---|
business_type |
经营方式:经销、联营、代销 |
string |
erp_state |
erp商品状态 |
string |
is_active_sales |
是否动销 |
boolean |
modified |
修改时间,格式为:yyyy-MM-dd HH:mm:ss |
string (date-time) |
sku_id |
货号 |
string |
sku_shelf_position_code |
货位代码 |
string |
state |
门店商品售卖状态 |
string |
store_id |
门店代码 |
string |
store_name |
门店名称 |
string |
use_state |
启用状态:启用、不启用 |
string |
2.38. StoreSkuError
门店商品对象
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
message |
样例 : |
string |
sku_id |
样例 : |
string |
store_id |
样例 : |
string |
2.40. StoreSkuShelfPositionCode
门店商品货架位对象
名称 | 说明 | 类型 |
---|---|---|
shelf_position_codes |
货架位列表 |
< string > array |
sku_id |
货号 |
string |
2.41. StoreSkuShelfPositionCodeList
门店商品货架位列表
名称 | 说明 | 类型 |
---|---|---|
store_sku_shelf_position_codes |
门店商品货架位列表 |
< StoreSkuShelfPositionCode > array |
2.42. StoreSkuUpdateResponse
门店商品对象
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
errors |
样例 : |
< StoreSkuError > array |
message |
样例 : |
string |
success |
默认值 : |
boolean |
2.43. Tag
名称 | 说明 | 类型 |
---|---|---|
code |
样例 : |
string |
name |
样例 : |
string |
2.44. TagList
名称 | 说明 | 类型 |
---|---|---|
tags |
样例 : |
< Tag > array |