产品 - Help for ShipSage

端点

方法	端点	描述
GET	/api/v202105/products	获取产品列表
POST	/api/v202105/products	创建产品
PUT	/api/v202105/products/{productId}	更新产品

头部

键	值
Authorization	Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi ...

GET /api/v202105/products

请求

类型	名称	描述	必填/选填	数据结构
query	api	API 类型可用值: index.by-default	必填	enum
query	product_id	产品 id	选填	integer
query	sku	sku 编码	选填	integer
query	customer_sku	客户的 sku 编码	选填	string
query	create_time_start	产品创建时间开始时区：太平洋标准时间	选填	datetime
query	create_time_end	产品创建时间结束时区：太平洋标准时间	选填	datetime
query	update_time_start	产品更新时间开始时区：太平洋标准时间	选填	datetime
query	update_time_end	产品更新时间结束时区：太平洋标准时间	选填	datetime
query	next_token	下一页数据的秘钥	选填	string

键	值
errcode	0/4000
errmsg	ok/Error Info
data	Data Properties

Data properties

名称	描述	数据结构
product_id	产品 id	integer
sku	sku 编码	integer
customer_sku	客户的 sku 编码	string
product_name	产品名称	string
product_description	产品描述	string
package_weight	产品毛重(g)	double
package_length	产品包装后的长度 (cm)	double
package_width	产品包装后的宽度 (cm)	double
package_height	产品包装后的高度 (cm)	double
fulfilled_by_shipsage	是否由ShipSage 发货，0：否，2：是	integer
overpack	二次包装：单个产品运输时是否需要二次包装，以及使用什么包装可用值: NO_OVER_PACK: 单件产品不带任何包装发货, POLY_MAILER: 单个产品发货时将使用快递袋进行二次包装, BOX: 单件产品发货时将使用纸箱进行二次包装, SHRINK_WRAP: 单个产品发货时将使用塑料薄膜收缩包装进行二次包装	enum
overpack_backup	当 overpack 值为 SHRINK_WRAP 时，overpack_backup 值应从 NO_OVER_PACK、POLY_MAILER 和 BOX 中选择，否则默认与 overpack 值相同可用值: NO_OVER_PACK, POLY_MAILER, BOX	enum
prepacked_in_box	入库时是否有纸箱预包装可用值: 0: 没有纸箱预包装 1: 有纸箱预包装	enum
restriction_id	产品是否带电池可用值: 0: 没有电池 1: 有电池	enum
create_time	产品创建时间时区：太平洋标准时间	datetime
update_time	产品更新时间时区：太平洋标准时间	datetime
customer_codes	客户编码类别项	array
customer_codes.*.category	客户编码类别可用值: UPC, EAN, SELLING_SKU, Code-128	enum
customer_codes.*.code	客户编码，UPC码应该是12位，EAN码应该是13位	string

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "items": [
            {
                "product_id": 115463,
        "sku": 212945,
        "customer_sku": "212945",
        "product_name": "2pcs Fabric Beige Wood Leg Upholstered Counter Stool 24\" Height（样品：CH1543 米色麻布） D1_Kitchen & Dining Furniture",
        "product_description": "<p>2pcs Fabric Beige Wood Leg Wingback Fabric Upholstered Counter Stools 24\" Height</p>\r\n<p><audio controls=\"controls\" style=\"display: none;\"></audio></p>",
        "package_weight": 0,
        "package_length": 103.5,
        "package_width": 32,
        "package_height": 44.5,
        "fulfilled_by_shipsage": 1,
        "overpack": "NO_OVER_PACK",
        "overpack_backup": "NO_OVER_PACK",
        "prepacked_in_box": 0,
        "restriction_id": 0,
        "create_time": "2022-03-02 23:39:16",
        "update_time": "2022-03-02 23:39:17",
        "customer_codes": [
            {
                "category": "SELLING_SKU",
                "code": "F-212945"
            },
            {
                "category": "SELLING_SKU",
                "code": "212945"
            }
        ]
    },
    {
        "product_id": 115462,
        "sku": 212944,
        "customer_sku": "212944",
        "product_name": "2pcs Fabric Beige Wood Leg Upholstered Counter Stool 24\" Height（样品：CH1543 米色麻布） D1_Kitchen & Dining Furniture",
        "product_description": "<p>2pcs Fabric Beige Wood Leg Wingback Fabric Upholstered Counter Stools 24\" Height</p>",
        "package_weight": 0,
        "package_length": 103.5,
        "package_width": 32,
        "package_height": 44.5,
        "fulfilled_by_shipsage": 1,
        "overpack": "NO_OVER_PACK",
        "overpack_backup": "NO_OVER_PACK",
        "prepacked_in_box": 0,
        "restriction_id": 0,
        "create_time": "2022-03-02 23:37:22",
        "update_time": "2022-03-02 23:37:23",
        "customer_codes": [
            {
                "category": "SELLING_SKU",
                "code": "F-212944"
            },
            {
                "category": "SELLING_SKU",
                "code": "212944"
            }
                ]
            }
        ],
        "next_token": null
    }
}

POST /api/v202105/products

请求

参数

类型	名称	描述	必填/选填	数据结构
query	api	API 类型可用值: index.by-default	必填	enum
body	customer_sku	客户的 sku 编码	必填	string
body	product_name	产品名称	必填	string
body	product_description	产品描述	必填	string
body	package_weight	产品毛重 (g)	必填	double
body	package_length	产品包装后的长度 (cm)	必填	double
body	package_width	产品包装后的宽度 (cm)	必填	double
body	package_height	产品包装后的高度 (cm)	必填	double
body	fulfilled_by_shipsage	是否由ShipSage 发货，0：否，2：是	必填	integer
body	overpack	二次包装：单个产品运输时是否需要二次包装，以及使用什么包装可用值: NO_OVER_PACK: 单件产品不带任何包装发货, POLY_MAILER: 单个产品发货时将使用快递袋进行二次包装, BOX: 单件产品发货时将使用纸箱进行二次包装, SHRINK_WRAP: 单个产品发货时将使用塑料薄膜收缩包装进行二次包装	必填	enum
body	overpack_backup	当 overpack 值为 SHRINK_WRAP 时，overpack_backup 值应从 NO_OVER_PACK、POLY_MAILER 和 BOX 中选择，否则默认与 overpack 值相同可用值: NO_OVER_PACK, POLY_MAILER, BOX	选填	enum
body	prepacked_in_box	入库时是否有纸箱预包装可用值: 0: 没有纸箱预包装 1: 有纸箱预包装	必填	enum
body	restriction_id	产品是否带电池可用值: 0: 没有电池 1: 有电池	必填	enum
body	customer_codes	客户编码类别项	选填	array
body	customer_codes.*.category	客户编码类别可用值: UPC, EAN, SELLING_SKU, Code-128	选填	enum
body	customer_codes.*.code	客户编码，UPC码应该是12位，EAN码应该是13位	选填	string
body	lot_category_id	批次库存管理类别id，默认为1 可用值: 1:Template code 2:Unicargo	必填	string

请求示例

{
  "customer_sku": "C-SKU-01",
  "product_name": "test product name",
  "product_描述": "test product desc",
  "package_weight": 100,
  "package_length": 10.01,
  "package_width": 10.02,
  "package_height": 10,
  "fulfilled_by_shipsage": 2,
  "overpack": "NO_OVER_PACK",
  "overpack_backup": "NO_OVER_PACK",
  "prepacked_in_box": 0,
  "restriction_id": 0,
  "customer_codes": [
    {
      "category": "SELLING_SKU",
      "code": "S-SKU-01"
    },
    {
      "category": "SELLING_SKU",
      "code": "S-SKU-02"
    },
    {
      "category": "EAN",
      "code": "EAN-01"
    },
    {
      "category": "UPC",
      "code": "UPC-01"
    }
  ]
}

键	值
errcode	0/4000
errmsg	ok/Error Info
data	Data Properties

Data properties

Name	描述	数据结构
product_id	产品 id	integer

返回示例

[
  {"product_id": 115463}
]

PUT /api/v202105/products/{productId}

请求

参数

Type	Name	描述	必填/选填	数据结构
query	api	API 类型可用值: (index.by-default)	必填	enum
path	product_id	产品 id	必填	integer
body	customer_sku	客户的 sku 编码	选填	string
body	product_name	The product name	选填	string
body	product_描述	The product 描述	选填	string
body	package_weight	The product gross weight (g)	选填	double
body	package_length	产品包装后的长度 (cm)	选填	double
body	package_width	产品包装后的宽度 (cm)	选填	double
body	package_height	产品包装后的高度 (cm)	选填	double
body	fulfilled_by_shipsage	是否由ShipSage 发货	选填	integer
body	overpack	二次包装：单个产品运输时是否需要二次包装，以及使用什么包装可用值: NO_OVER_PACK: 单件产品不带任何包装发货, POLY_MAILER: 单个产品发货时将使用快递袋进行二次包装, BOX: 单件产品发货时将使用纸箱进行二次包装, SHRINK_WRAP: 单个产品发货时将使用塑料薄膜收缩包装进行二次包装	选填	enum
body	overpack_backup	当 overpack 值为 SHRINK_WRAP 时，overpack_backup 值应从 NO_OVER_PACK、POLY_MAILER 和 BOX 中选择，否则默认与 overpack 值相同可用值: NO_OVER_PACK, POLY_MAILER, BOX	选填	enum
body	prepacked_in_box	入库时是否有纸箱预包装可用值: 0: 没有纸箱预包装 1: 有纸箱预包装	选填	enum
body	restriction_id	产品是否带电池可用值: 0: 没有电池 1: 有电池	选填	enum
body	customer_codes	客户编码类别项	选填	array
body	customer_codes.*.category	客户编码类别可用值: UPC, EAN, SELLING_SKU, Code-128	选填	enum
body	customer_codes.*.code	客户编码，UPC码应该是12位，EAN码应该是13位	选填	string

请求示例

{
  "customer_sku": "C-SKU-01",
  "product_name": "test product name",
  "product_描述": "test product desc",
  "package_weight": 100,
  "package_length": 10.01,
  "package_width": 10.02,
  "package_height": 10,
  "fulfilled_by_shipsage": 2,
  "overpack": "NO_OVER_PACK",
  "overpack_backup": "NO_OVER_PACK",
  "prepacked_in_box": 0,
  "restriction_id": 0,
  "customer_codes": [
    {
      "category": "SELLING_SKU",
      "code": "S-SKU-01"
    },
    {
      "category": "SELLING_SKU",
      "code": "S-SKU-02"
    },
    {
      "category": "EAN",
      "code": "EAN-01"
    },
    {
      "category": "UPC",
      "code": "UPC-01"
    }
  ]
}

键	值
errcode	0/4000
errmsg	ok/Error Info
data	Data Properties

Data properties

Name	描述	数据结构
product_id	产品 id	integer

返回示例

[
  {"product_id": 115463}
]

产品

端点#

头部#

GET /api/v202105/products#

请求#

返回#

Data properties#

返回示例#

POST /api/v202105/products#

请求#

参数#

请求示例#

返回#

Data properties#

返回示例#

PUT /api/v202105/products/{productId}#

请求#

参数#

请求示例#

返回#

Data properties#

返回示例#

端点

头部

GET /api/v202105/products

请求

返回

Data properties

返回示例

POST /api/v202105/products

请求

参数

请求示例

返回

Data properties

返回示例

PUT /api/v202105/products/{productId}

请求

参数

请求示例

返回

Data properties

返回示例