Product

Endpoints

Method	Endpoint	Description
GET	/api/v202105/products	Retrieves a list of products
POST	/api/v202105/products	Create a new product
PUT	/api/v202105/products/{productId}	Update a product

Header

Key	Value
Authorization	Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi ...

GET /api/v202105/products

Request

Type	Name	Description	Required/Optional	Schema
query	api	The API type Available Values: index.by-default	required	enum
query	product_id	The shipsage product id	optional	integer
query	sku	The shipsage sku	optional	integer
query	customer_sku	The customer sku	optional	string
query	create_time_start	The shipsage product create time start timezone:PST	optional	datetime
query	create_time_end	The shipsage product create time end timezone:PST	optional	datetime
query	update_time_start	The shipsage product update time start timezone:PST	optional	datetime
query	update_time_end	The shipsage product update time end timezone:PST	optional	datetime
query	next_token	The next page data	optional	string

Response

Key	Value
errcode	0/4000
errmsg	ok/Error Info
data	Data Properties

Data properties

Name	Description	Schema
product_id	The shipsage product id	integer
sku	The shipsage sku	integer
customer_sku	The customer sku	string
product_name	The product name	string
product_description	The product description	string
package_weight	The product gross weight (g)	double
package_length	The product package length (cm)	double
package_width	The product package width (cm)	double
package_height	The product package height (cm)	double
fulfilled_by_shipsage	Whether shipped by shipsage，0：No，2：Yes	integer
overpack	Secondary packaging: Whether secondary packaging is required when a single product is shipped, and what packaging is used Available Values: NO_OVER_PACK: A single product will be shipped without any packaging, POLY_MAILER: A single product will be packaged in a courier bag when shipped, BOX: A carton will be used for secondary packaging when a single product is shipped, SHRINK_WRAP: A single product will be packaged with plastic film shrink wrap for secondary packaging	enum
overpack_backup	When the value of 'overpack' is SHRINK_WRAP, the value of 'overpack_backup' should be selected from NO_OVER_PACK, POLY_MAILER and BOX, otherwise the default is the same as the value of 'overpack' Available Values: NO_OVER_PACK, POLY_MAILER, BOX	enum
prepacked_in_box	Whether the carton is pre-packed Available Values: 0: No carton pre-packing 1: Pre-packed in carton	enum
restriction_id	Whether have restriction product Available Values: 0: No restriction 1: Have battery	enum
create_time	The product create time timezone:PST	datetime
update_time	The product update time timezone:PST	datetime
customer_codes	The customer coding category items	array
customer_codes.*.category	The customer coding category Available Values: UPC, EAN, SELLING_SKU, Code-128	enum
customer_codes.*.code	The customer code, UPC code should be 12 digits, EAN code should be 13 digits	string

Data Demo

{
    "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

Request

Params

Type	Name	Description	Required/Optional	Schema
query	api	The API type Available Values: index.by-default	required	enum
body	customer_sku	The customer sku	required	string
body	product_name	The product name	required	string
body	product_description	The product description	required	string
body	package_weight	The product gross weight (g)	required	double
body	package_length	The product package length (cm)	required	double
body	package_width	The product package width (cm)	required	double
body	package_height	The product package height (cm)	required	double
body	fulfilled_by_shipsage	Whether shipped by shipsage，0：No，2：Yes	required	integer
body	overpack	Secondary packaging: Whether secondary packaging is required when a single product is shipped, and what packaging is used Available Values: NO_OVER_PACK: A single product will be shipped without any packaging, POLY_MAILER: A single product will be packaged in a courier bag when shipped, BOX: A carton will be used for secondary packaging when a single product is shipped, SHRINK_WRAP: A single product will be packaged with plastic film shrink wrap for secondary packaging	required	enum
body	overpack_backup	When the value of 'overpack' is SHRINK_WRAP, the value of 'overpack_backup' should be selected from NO_OVER_PACK, POLY_MAILER and BOX,Otherwise, the default value will be the same as the value of 'overpack' Available Values: NO_OVER_PACK, POLY_MAILER, BOX	optional	enum
body	prepacked_in_box	Whether the carton is pre-packed Available Values: 0: No carton pre-packing 1: Pre-packed in carton	required	enum
body	restriction_id	Whether have restriction product Available Values: 0: No restriction 1: Have battery	required	enum
body	customer_codes	The customer coding category items	optional	array
body	customer_codes.*.category	The customer coding category Available Values: UPC, EAN, SELLING_SKU, Code-128	optional	enum
body	customer_codes.*.code	The customer code, UPC code should be 12 digits, EAN code should be 13 digits	optional	string
body	lot_category_id	The lot category id, default 1 Available Values: 1:Template code 2:Unicargo	required	string

Body Demo

{
  "customer_sku": "C-SKU-01",
  "product_name": "test product name",
  "product_description": "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"
    }
  ]
}

Response

Key	Value
errcode	0/4000
errmsg	ok/Error Info
data	Data Properties

Data properties

Name	Description	Schema
product_id	The shipsage product id	integer

Data Demo

[
  {"product_id": 115463}
]

PUT /api/v202105/products/{productId}

Request

Params

Type	Name	Description	Required/Optional	Schema
query	api	The API type Available Values: (index.by-default)	required	enum
path	product_id	The shipsage product id	required	integer
body	customer_sku	The customer sku	optional	string
body	product_name	The product name	optional	string
body	product_description	The product description	optional	string
body	package_weight	The product gross weight (g)	optional	double
body	package_length	The product package length (cm)	optional	double
body	package_width	The product package width (cm)	optional	double
body	package_height	The product package height (cm)	optional	double
body	fulfilled_by_shipsage	Whether shipped by shipsage	optional	integer
body	overpack	Secondary packaging: Whether secondary packaging is required when a single product is shipped, and what packaging is used Available Values: NO_OVER_PACK: A single product will be shipped without any packaging, POLY_MAILER: A single product will be packaged in a courier bag when shipped, BOX: A carton will be used for secondary packaging when a single product is shipped, SHRINK_WRAP: A single product will be packaged with plastic film shrink wrap for secondary packaging	required	enum
body	overpack_backup	When the value of 'overpack' is SHRINK_WRAP, the value of 'overpack_backup' should be selected from NO_OVER_PACK, POLY_MAILER and BOX,Otherwise, the default value will be the same as the value of 'overpack' Available Values: NO_OVER_PACK, POLY_MAILER, BOX	optional	enum
body	prepacked_in_box	Whether the carton is pre-packed Available Values: 0: No carton pre-packing 1: Pre-packed in carton	required	enum
body	restriction_id	Whether have restriction product Available Values: 0: No restriction 1: Have battery	optional	enum
body	customer_codes	The customer coding category items	optional	array
body	customer_codes.*.category	The customer coding category Available Values: UPC, EAN, SELLING_SKU, Code-128	optional	enum
body	customer_codes.*.code	The customer code, UPC code should be 12 digits, EAN code should be 13 digits	optional	string

Body Demo

{
  "customer_sku": "C-SKU-01",
  "product_name": "test product name",
  "product_description": "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"
    }
  ]
}

Response

Key	Value
errcode	0/4000
errmsg	ok/Error Info
data	Data Properties

Data properties

Name	Description	Schema
product_id	The shipsage product id	integer

Data Demo

[
  {"product_id": 115463}
]

Endpoints#

Header#

GET /api/v202105/products#

Request#

Response#

Data properties#

Data Demo#

POST /api/v202105/products#

Request#

Params#

Body Demo#

Response#

Data properties#

Data Demo#

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

Request#

Params#

Body Demo#

Response#

Data properties#

Data Demo#

Endpoints

Header

GET /api/v202105/products

Request

Response

Data properties

Data Demo

POST /api/v202105/products

Request

Params

Body Demo

Response

Data properties

Data Demo

PUT /api/v202105/products/{productId}

Request

Params

Body Demo

Response

Data properties

Data Demo