产品查询

产品查询:接口描述

URL

http://<系统域名>/client/Product/

接口功能

查询产品

支持格式

JSON

开发人员

 

请求方式

GET

发布日期

 

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

curl -X GET \ https://<系统域名>/client/product \ -H 'api_key: 248ccb90dff2b99465b54c113765360c' \ -H 'company_id: 36' \ -H 'content-type: application/json'

参数描述

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

返回字段说明如下:

字段

注释

类型

字段

注释

类型

id

产品ID

INT(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

company_product-last_in_stock_time

最后入库时间

DATETIME

company_product-last_out_stock_time

最后出库时间

DATETIME

company_product-last_stock_update_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,  会返回。

请求描述

(以下为折叠内容,签署合同时以下信息无需参考,仅供第三方对接参考)

使用接口调试工具postman
HTTP请求方式:

GET /client/Product/ HTTP/1.1 Host: {{Bird_URL}} Headres: api_key: {{api_key}} company_id: {{company_id}} Cookie: PHPSESSID=3s3nejv43u9bhirsrvq9nge254 Body raw { "status":"ACTIVE", "id":"2989356" }

返回结果:

{ "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": 2989356, "client_id": 4790, "crossing_harbor_name_id": null, "customs_clear_name_id": null, "name": "大大大葡萄", "name_customs": "big big big grape", "material": "大大大葡萄", "usage": "大大大葡萄", "brand": "大大大葡萄", "url": null, "color": "大大大葡萄", "model": "大大大葡萄", "country_of_origin": null, "shape_type": "NORMAL_SHAPE", "product_risk_level": "LOW", "customs_value_level": "LOW", "customs_category_id": 1616, "commodity_code": null, "note": null, "description": null, "price_customs_import": "0.10", "price_customs_export": "0.100", "sales_price": null, "handling_fee": "0.00", "delivery_fee_adjustment": "0.00", "client_ref": "4790-2989356", "company_ref": "4790-2989356", "weight": "50.00", "length": "50.00", "width": "50.00", "depth": "50.00", "dimension_lock": "0", "live_stock": "1", "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", "is_dynamic_warehouse_unsalable_product": "0", "is_need_to_record_sn": "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": "2021-01-12 18:25:21", "create_time": "2020-11-04 17:54:51", "update_time": "2021-01-12 18:28:44", "dynamic_warehouse_stock_sequence": "DYNAMIC_WAREHOUSE_STOCK_FIRST", "return_action": null, "status": "ACTIVE", "primary_keys": [ "id" ], "sku": "4790 - 2989356", "is_expensive_product": "0", "customs_category-customs_category_full_name": "Clothing, Shoes & Accessories > Sewing accessories", "customs_category_code": "GB", "customs_category-customs_category_full_name_chinese": "服装,鞋类及配件 > 缝纫配件", "company_product-last_stock_update_time": null, "company_product-last_in_stock_time": null, "company_product-last_out_stock_time": null, "company_product-live_stock": "0", "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": "star_test", "client-telephone": null, "client-email": "112sf@sdf.as" } ], "success": true, "moduleName": "client" }