产品的增删改查

Owned by Aileen (Unlicensed)
Last updated: 2021-02-25 by Bess (Unlicensed)
8 min read

添加产品

URLhttp://test.birdsystem.com/client/Product/

接口功能

添加产品

支持格式


开发人员


请求方式

POST

发布日期


这个接口既可用于添加产品,　也可用于查询产品的状态.

添加产品时,　需要以表单form的格式POST如下数据到接口: (注意不是json格式)

字段注释是否必填类型

name

产品中文名称

必填

VARCHAR(100)

url链接
VARCHAR(50)

name_customs

产品英文名称

必填

VARCHAR(100)

material材质
VARCHAR(50)
usage用途
VARCHAR(50)
brand品牌
VARCHAR(50)
color颜色
VARCHAR(100)
model型号
VARCHAR(100)
shape_type

形状


普通形状NORMAL_SHAPE（默认）

轴状体NORMAL_SHAPE

不规则形状RREGULAR_SHAPE

customs_category_id

海关分类编码ID


INT(10) . 参考接口:  获取海关分类 

product_product_customs_property[]产品属性

INT(10) . 参考接口:  获取产品属性 . 这些属性ID一般不常变动. 如有多个海关属性,　请传多个同名的form 字段, 例如:

product_product_customs_property[] = 1
product_product_customs_property[] = 3

note

备注


VARCHAR(100)

client_ref

客户自定义SKU编码（不能和其他SKU重复）


VARCHAR(50)

commodity_code

商品报关编码


VARCHAR(50)

weight

重量 默认单位 g


DECIMAL(10,2)

length

长度 默认单位 mm


DECIMAL(10,2)

width

宽度 默认单位 mm


DECIMAL(10,2)

depth

高度（深度）默认单位 mm


DECIMAL(10,2)

company_product-is_shared_internal

是否是共享产品


TINYINT(1)

description

产品描述


TEXT

company_product-price

产品价格 （货币每个站点不同，详询客服）


FLOAT(8,2)

company_product-cost

产品成本 （货币每个站点不同，详询客服）


FLOAT(8,2)

price_customs_import

海关进口价格 （美元）


FLOAT(8,2)

price_customs_export

海关出口价格（美元）

必填

FLOAT(8,2)

sales_price

销售价格 （美元）
FLOAT(8,2)

company_product-low_stock_level

低库存报警线


INT(5)

inventory_time

在途产品入库时间


INT(3)

attachment_url附件URL

VARCHAR(2000)

在创建或者更新产品时，同时上传一个或者多个附件, 一个URL指向一个附件，多个URL用\n换行符分隔.

ps: 附件是在后台队列中异步下载的，不会马上体现在界面上，可以通过 “查看后台运行任务” 来查看队列任务

附件可以是图片，pdf, doc,excel等文档，与产品详细页面的附件上传是同一个功能。

override_old_attachment是否覆盖旧的附件 (仅更新产品时有效)

TINYINT(1)

当当前请求是修改已有产品，且有提供附件时, 是否要覆盖掉旧的附件

status

不填写时，默认为preparing；

当值为PENDING时，添加的产品直接是待处理状态，不需要再更改状态


ENUM('PREPARING','PENDING')
is_need_to_record_sn是否需要记录产品sn唯一码
BOOL

country_of_origin

产地
国家的二字码：CN, GB 等

示例:


查询产品

URLhttp://test.birdsystem.com/client/Product/
接口功能查询产品
支持格式JSON开发人员
请求方式GET发布日期


批量获取产品的示例如下:
批量获取产品信息

curl -X GET \
https://test.birdsystem.com/client/product \
-H 'api_key: 248ccb90dff2b99465b54c113765360c' \
-H 'company_id: 36' \
-H 'content-type: application/json'


单个获取产品

单个获取产品的示例如下:

curl -X GET \
https://test.birdsystem.com/client/product/2941862 \
-H 'api_key: 248ccb90dff2b99465b54c113765360c' \
-H 'company_id: 36' \
-H 'content-type: application/json'


获取产品返回信息解析

批量获取产品与单个获取产品的信息格式相同.　如下:

{
    "total": 1,
    "data": [
        {
            "price_internal": null,
            "product_volume_level_code": null,
            "product_stock_volume_level_code": null,
            "product_sales_level_code": null,
            "directional_share_total": null,
            "total": null,
            "price": null,
            "cost": null,
            "is_shared_internal": null,
            "is_shared_external": null,
            "client_dispatch_product_id": null,
            "product_stock_level_code": null,
            "company_id": null,
            "warehouse_id": null,
            "live_volume": null,
            "sales_quantity": null,
            "sales_volume": null,
            "volume": null,
            "id": 2941862,
            "client_id": 47,
            "crossing_harbor_name_id": 1490,
            "customs_clear_name_id": null,
            "name": "YOYO",
            "name_customs": "YOYO",
            "material": "plastic",
            "usage": "test",
            "brand": "test",
            "url": "http://www.test.com/aaa",
            "color": "red",
            "model": "test",
			"country_of_origin":"CN",
            "shape_type": "NORMAL_SHAPE",
            "product_risk_level": "LOW",
            "customs_value_level": "LOW",
            "customs_category_id": 1519,
            "commodity_code": null,
            "note": "YOYO",
            "description": "6d4b8bd54ea754c1,6d4b8bd54ea754c1",
            "price_customs_import": "5.00",
            "price_customs_export": "5.000",
			"sales_price": "5.00",
            "handling_fee": "0.00",
            "delivery_fee_adjustment": "0.00",
            "client_ref": "YOYO-1",
            "company_ref": "47-2941862",
            "weight": "29.00",
            "length": "350.00",
            "width": "245.00",
            "depth": "29.00",
            "dimension_lock": "0",
            "live_stock": "91",
            "frozen_stock": "0",
            "pending_stock": "0",
            "low_stock_level": "0",
            "inventory_time": "0",
            "is_use_delivery_cost": "0",
            "is_no_handling_fee": "0",
            "is_vip": "0",
            "last_info_check_time": null,
            "last_stock_update_time": null,
            "last_in_stock_time": null,
            "last_out_stock_time": null,
            "last_update_status_time": "2020-05-29 15:26:15",
            "create_time": "2020-05-29 15:24:30",
            "update_time": "2020-05-29 15:26:39",
            "dynamic_warehouse_stock_sequence": "DYNAMIC_WAREHOUSE_STOCK_FIRST",
            "return_action": null,
            "status": "ACTIVE",
            "is_dynamic_warehouse_unsalable_product": "0",
            "primary_keys": [
                "id"
            ],
            "sku": "47 - 2941862",
            "is_expensive_product": "0",
            "customs_category-customs_category_full_name": "Toys 0026 Hobbies 003E Models 0026 Kits 003E Plastic Models 0026 Kits",
            "customs_category_code": "GB9503009990",
            "customs_category-customs_category_full_name_chinese": "73a95177/52a86f2b/6a21578b/6bdb7ed2 003E 6a21578b4e0e59574ef6 003E 585165996a21578b4e0e59574ef6",
            "company_product-last_stock_update_time": "2020-05-29 17:48:52",
            "company_product-last_in_stock_time": "2020-05-29 15:31:45",
            "company_product-last_out_stock_time": "2020-05-29 17:48:52",
            "company_product-live_stock": "91",
            "company_product-low_stock_level": "0",
            "company_product-price": "0.00",
            "company_product-cost": "0.00",
            "company_product-is_shared_internal": "0",
            "company_product-is_shared_external": "0",
            "client-name": "98de9e1ftest",
            "client-telephone": "4ed37ba1ff1a123     603b8d1f8d234ebaff1a126    603b8d1f8d234ebaff1a126    603b8d1f8d234ebaff1a126  ",
            "client-email": "eva@birdsystem.co.uk"
        }
    ],
    "success": true,
    "moduleName": "client"
}

返回字段说明如下:

字段注释类型
id产品IDINT(10)

name

产品中文名称

VARCHAR(100)

name_customs

产品英文名称

VARCHAR(100)

customs_category_id

海关分类编码ID

INT(10)

material材料VARCHAR(100)
usage用途VARCHAR(100)
brand品牌VARCHAR(100)
color颜色VARCHAR(100)
model型号VARCHAR(100)
url链接VARCHAR(500)

note

备注

VARCHAR(100)

shape_type形状

普通形状NORMAL_SHAPE（默认）

轴状体NORMAL_SHAPE

不规则形状RREGULAR_SHAPE

client_ref

客户自定义SKU编码

VARCHAR(50)

weight

重量 默认单位 g

DECIMAL(10,2)

length

长度 默认单位 mm

DECIMAL(10,2)

width

宽度 默认单位 mm

DECIMAL(10,2)

depth

高度(深度） 默认单位 mm

DECIMAL(10,2)

is_shared_internal

是否是共享产品

TINYINT(1)

description

产品描述

TEXT

price

产品价格（货币每个站点不同，详询客服）

FLOAT(8,2)

cost

产品成本（货币每个站点不同，详询客服）

FLOAT(8,2)

price_customs_import

海关进口价格 （美元）

FLOAT(8,2)

price_customs_export

海关出口价格 （美元）

FLOAT(8,2)

low_stock_level

低库存报警线

INT(5)

inventory_time

在途产品入库天数

INT(3)

company_product-live_stock当前站的产品库存INT(10)
live_stock所的站的产品库存之和INT(10)
last_update_status_time最后更新时间DATETIME
create_time创建时间DATETIME
update_time更新时间DATETIME
dynamic_warehouse_stock_sequence动态仓库存出库顺序

DYNAMIC_WAREHOUSE_STOCK_FIRST

(动态仓库存优先)

ORIGIN_WAREHOUSE_STOCK_FIRST

（起始仓库存优先）

status产品状态VARCHAR(50)
is_dynamic_warehouse_unsalable_product是否动态仓滞销货TINYINT(1)

country_of_origin

产地国家的二字码：CN, GB 等
sales_price平台销售价格FLOAT(8,2)

查询产品列表时可直接使用的过滤字段: 

字段注释类型
status产品状态

字符串，只能是 'PREPARING','PENDING','ACTIVE','PROBLEM','RECHECK','DELETED','OUT_OF_STOCK','DEPRECATED','REVIEWING',

'HOLD_INBOUND','HOLD_OUTBOUND'　这些值中的任意一个. 状态解释如下:

PREPARING:   准备中状态, 客户还在完善产品的各种信息, 新创建的产品默认是此状态.

PENDING: 待处理状态, 客户已经将产品信息完善好, 转交给仓库核查处理

PROBLEM: 仓库审核有问题, 需要客户再检查和完善

RECHECK: 客户修改好了, 待仓库重新审核

REVIEWING: 仓库审核中

ACTIVE: 产品经过仓库审核, 已是正常状态, 可下订单和下头程发货单

DELETED: 已删除此产品

OUT_OF_STOCK: 售罄状态, 待补充库存

DEPRECATED: 已下架, 不会继续销售

HOLD_INBOUND:只出不进, 只允许下订单, 不允许下头程发货单进行备货
HOLD_OUTBOUND:只进不出, 只允许下头程发货单备货, 不允许下订单


客户端可以操作的产品状态流: 

当前状态  → 允许跳转的状态

PREPARING → PENDING, PROBLEM, DELETED
PENDING → PREPARING,PROBLEM,DELETED
PROBLEM →  RECHECK,DELETED
ACTIVE → PROBLEM,DELETED

产品标准的状态流: 

PREPARING → PENDING → REVIEWING → ACTIVE

client_ref客户SKU字符串
company_ref系统SKU字符串（admin端存在）
name产品名称字符串
company_product-is_shared_internal是否内部共享数字，0或者1
company_product-is_shared_external是否外部共享数字，0或者1（admin端存在）
commodity_code报关编码字符串
with_parent_client_product当前账号有父账号时，是否返回当前账号的父账号下的产品数字，0或者1, 默认是1，会返回。
with_child_client_product当前账号有子账号时，是否返回当前账号的子账号下的产品数字，0或者1, 默认是1,  会返回。

修改产品信息

类型：POST

id=xxxx，xxxx为产品ID，为必填项。多个产品用下划线链接，例如：212236_96653

返回信息如下：

{
    "data": {
        "product_volume_level_code": null,
        "product_stock_volume_level_code": null,
        "product_sales_level_code": null,
        "directional_share_total": null,
        "total": null,
        "price": null,
        "cost": null,
        "is_shared_internal": null,
        "is_shared_external": null,
        "client_dispatch_product_id": null,
        "product_stock_level_code": null,
        "company_id": null,
        "warehouse_id": null,
        "live_volume": null,
        "sales_quantity": null,
        "sales_volume": null,
        "volume": null,
        "id": 96635,
        "client_id": 983,
        "crossing_harbor_name_id": null,
        "customs_clear_name_id": null,
        "name": "然",
        "name_customs": "ranran",
        "material": "年\b",
        "usage": "月",
        "brand": "日",
        "url": null,
        "color": null,
        "model": null,
        "shape_type": "NORMAL_SHAPE",
        "product_risk_level": "LOW",
        "customs_value_level": "LOW",
        "customs_category_id": 305,
        "commodity_code": null,
        "note": "hw-b593s-82 brand new in original box seales",
        "description": "",
        "price_customs_import": null,
        "price_customs_export": "90.000",
        "price_customs_export_internal": "8.000",
        "handling_fee": "0.00",
        "delivery_fee_adjustment": "0.00",
        "client_ref": "hw-b593s-82",
        "company_ref": "669-96635",
        "weight": "879.00",
        "length": "295.00",
        "width": "185.00",
        "depth": "75.00",
        "dimension_lock": "0",
        "live_stock": "0",
        "frozen_stock": "0",
        "pending_stock": "0",
        "low_stock_level": "0",
        "inventory_time": "0",
        "is_use_delivery_cost": "0",
        "is_no_handling_fee": "0",
        "is_vip": "0",
        "last_info_check_time": null,
		"is_dynamic_warehouse_unsalable_product": "0",
        "is_need_to_record_sn": "0",
        "last_stock_update_time": "2015-01-03 23:00:10",
        "last_in_stock_time": "2015-01-03 23:00:10",
        "last_out_stock_time": "2015-01-03 23:00:10",
        "last_update_status_time": "2015-11-03 19:35:46",
        "update_time": "2019-05-24 23:44:46",
        "note_internal": "",
        "return_action": null,
        "status": "PROBLEM",
        "primary_keys": [
            "id"
        ]
    },
    "success": true,
    "moduleName": "client"
}

删除产品（修改产品状态）

URLhttp://test.birdsystem.com/client/Product/Batch-Update-Status/

接口功能

修改产品状态

支持格式

JSON

开发人员


请求方式

POST

发布日期


参数说明类型
ids产品id(多个产品id用下划线隔开，例如：212236_96653)INT(10)
status产品状态，只能是：

PREPARING:   准备中状态, 客户还在完善产品的各种信息, 新创建的产品默认是此状态.

PENDING: 待处理状态, 客户已经将产品信息完善好, 转交给仓库核查处理

PROBLEM: 仓库审核有问题, 需要客户再检查和完善

RECHECK: 客户修改好了, 待仓库重新审核

DELETED: 已删除此产品

VARCHAR(100)

请求示例：

https://test.birdsystem.com/client/Product/Batch-Update-Status?ids=2990310&status=DELETED

返回示例：

{"success":true,"refresh":false,"moduleName":"client"}

返回错误示例：

{"success":false,"message":"You can not delete active product(s) ."}

要删除的产品有库存。