v2.global_product.get_global_item_info
GET /api/v2/global_product/get_global_item_info
Get global item info.Only for China mainland sellers and Korean sellers.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/global_product/get_global_item_info
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| merchant_id | int | 1 | Shopee’s unique identifier for a merchant. Required for all merchant level requests(CB CNSC user calling global product related APIs). |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, merchant_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| global_item_id_list | int64 | True | Global item id list. Length limit is [1,20]. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| warning | string | Warning massage. | |
| request_id | string | 6f235f4a343e4feb8a9ed74c439f6663 | The identifier of the API request for error tracking. |
| response | object | ||
| global_item_list | object[] | ||
| global_item_id | int64 | 27001415 | Shopee's unique identifier for an global item. |
| global_item_name | string | MY OLD NEW two tier model item 5 | Name of the global item. |
| description | string | MY OLD NEW default no model itemMY OLD NEW default no model itemMY OLD NEW default no model item | Description of the global item. |
| global_item_sku | string | sku1 | An global item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings. |
| global_item_status | string | NORMAL | The current status of the item. You can only query global product with normal status, otherwise api will return error. |
| create_time | timestamp | 1605247451 | Timestamp that indicates the date and time that the global item was created. |
| update_time | timestamp | 1605247451 | Timestamp that indicates the last time that there was a change in value of the global item. |
| stock_info | object[] | If the item has models, this field will not be returned, please get it through get_model_list api. | |
| stock_type | int32 | 2 | The stock type. |
| stock_location_id | string | KRZ | location_id of the stock. |
| normal_stock | int32 | 44 | The normal stock quantity of the variation in the listing currency. |
| reserved_stock | int32 | 0 | The reserved stock quantity of the variation in the listing currency. |
| price_info | object[] | If the item has models, price_info will not be returned. Please get the price of each model through the get_global_model_list api. | |
| currency | string | CNY | The three-digit code representing the currency unit used for the item in Shopee Listings. |
| original_price | float | 100.1 | The original price of the item in the listing currency. |
| sip_item_price | float | 11.11 | SIP item price. |
| sip_item_price_source | string | auto | source of sip' price. ( auto or manual). |
| image | object | ||
| image_id_list | string[] | ["bf5a022e4624ff6c01ef151001762db7", "1a689fb0124a6d8762761f3ae13815ed"] | List of image url. |
| image_url_list | string[] | ["https://s-cf-tw.shopeesz.com/file/bf5a022e4624ff6c01ef151001762db7", "https://s-cf-tw.shopeesz.com/file/1a689fb0124a6d8762761f3ae13815ed"] | List of image id. |
| weight | string | "1.1" | The weight of this global item, the unit is KG. If set the weight of global models under this item, will return the max weight of all global models during the switching period to ensure system compatibility, please switch to call v2.global_product.get_global_model_list to get the weight of models. |
| dimension | object | The dimension of this global item. If set the dimension of global models under this global item, will return the dimension with largest volume calculated by height*length*width during the switching period to ensure system compatibility, please switch to call v2.global_product.get_global_model_list to get the dimension of models. | |
| package_length | int32 | 11 | The length of package for this global item, the unit is CM. |
| package_width | int32 | 11 | The width of package for this global item, the unit is CM. |
| package_height | int32 | 11 | The height of package for this global item, the unit is CM. |
| pre_order | object | If set the DTS of global models under this item, will return the max DTS of all global models during the switching period to ensure system compatibility, please switch to call v2.global_product.get_global_model_list to get the DTS of models. | |
| days_to_ship | int32 | 3 | Days to ship. |
| size_chart | string | 1a689fb0124a6d8762761f3ae13815ed | Url of size chart image. |
| condition | string | NEW | Is it second-hand. |
| has_model | boolean | true | Does it contain model. |
| video | object | ||
| video_url | string | 1a689fb0124a6d8762761f3ae13815ed | Url of video. |
| thumbnail_url | string | 7432bfa3713715bc1f88f4025241eb6d | Thumbnail of video. |
| duration | int32 | 100 | Duration of video. |
| category_id | int32 | 2347462 | Shopee's unique identifier for a category. |
| brand | object | ||
| brand_id | int32 | 6238 | Id of brand. |
| original_brand_name | string | Nike | Original name of brand. |
| attribute_list | object[] | ||
| attribute_id | int32 | 4811 | The Identify of each category. |
| original_attribute_name | string | Brand: L2 Default [14644] | The name of each attribute. |
| attribute_value_list | object[] | ||
| value_id | int32 | 1047251 | Unique identifier for value of this item attribute. |
| original_value_name | string | 10 | Value name of this item attribute. |
| value_unit | string | kg | Value unit of this item attribute. |
| description_info | object | New description field.New description field. Only whitelist sellers can use it. If you use the field, please upload the description_type=extended otherwise api will return error. If you don't use this field, you don't need to upload the description_type or upload description_type=normal | |
| extended_description | object | If description_type is extended , Description information will be returned through this field. | |
| field_list | object[] | Field of extended description | |
| field_type | string | Type of extended description field: values: See Data Definition- description_field_type (text , image). | |
| text | string | If field_type is text, text information will be returned through this field. | |
| image_info | object | If field_type is image, image url will be returned through this field. | |
| image_id | string | Image id. | |
| image_url | string | Image url. | |
| description_type | object | Type of description : values: See Data Definition- description_type (normal , extended). | |
| is_fulfillment_by_shopee | boolean | whether item is fulfillment by shopee | |
| size_chart_id | int64 | size_chart 模板ID |