Predict Product Package Dimensions and Weight

POST

/product/202609/products/package/predict

Predicts the package dimensions and weight for one candidate product based on its leaf category. The result is generated synchronously and can be used to prepare the package information in a create or edit product request. When no prediction is available, data is an empty object.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Request Body^required

Media typeapplication/json

object

category_id

required

The ID of the leaf category selected for the product.

string

Example

{
  "category_id": "600001"
}

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

package_dimensions

Predicted package dimensions for the product.

object

height

required

Predicted positive package height.

integer format: int64

length

required

Predicted positive package length.

integer format: int64

unit

required

Unit of the predicted package dimensions. Possible values:

• CENTIMETER
• INCH
• FOOT
• MILLIMETER
• METER

string

Allowed values: CENTIMETER INCH FOOT MILLIMETER METER

width

required

Predicted positive package width.

integer format: int64

package_weight

Predicted package weight for the product.

object

unit

required

Unit of the predicted package weight. Possible values:

• GRAM
• POUND
• OUNCE
• KILOGRAM

string

Allowed values: GRAM POUND OUNCE KILOGRAM

value

required

Predicted positive package weight.

string

Example

{
  "code": 0,
  "data": {
    "package_dimensions": {
      "height": 10,
      "length": 30,
      "unit": "CENTIMETER",
      "width": 20
    },
    "package_weight": {
      "unit": "GRAM",
      "value": "500"
    }
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}