快工助手跨境电商知识与商机助手

v2.global_product.get_global_model_list

Shopee 官方资料 · Shopee Open Platform 接口参考 · 适合开发者

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.api_reference
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.global_product.get_global_model_list

Get global model list. Only for China mainland sellers and Korean sellers.

#

§2 Overview

Overview

FieldValue
ModuleGlobalProduct
API typeMerchant
HTTP methodGET
Path/api/v2/global_product/get_global_model_list
Production URLhttps://partner.shopeemobile.com/api/v2/global_product/get_global_model_list
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/global_product/get_global_model_list
Rate limit[0, 0, 0]
PermissionERP System; Seller In House System; Product Management; Swam ERP
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
global_item_idint64Yes28001461The id of global item.
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
errorstringIndicate error type if hit error. Empty if no error happened.
messagestringIndicate error details if hit error. Empty if no error happened.
warningstringWarning message.
request_idstring98eae35efff24dd0974c21a847127184The identifier for an API request for error tracking.
responseobject
response.tier_variationobject[]Tier variation information of global item.
response.tier_variation.namestringtier name 1Tier name.
response.tier_variation.option_listobject[]Tier option list for corresponding tier name.
response.tier_variation.option_list.optionstringtier option 1Tier option.
response.tier_variation.option_list.imageobjectImage information of tier.
response.tier_variation.option_list.image.image_urlstringhttps://cf.shopee.sg/file/c54265d475b85e00ffb2404585e32b6fImage url.
response.tier_variation.option_list.image.image_idstringc54265d475b85e00ffb2404585e32b6fId of image.
response.global_modelobject[]Global models.
response.global_model.global_model_idint6420004490Id of global model.
response.global_model.global_model_skustringmodel skuSku of global model.
response.global_model.price_infoobjectPrice info of global model.
response.global_model.price_info.original_pricefloat100.5Original price of global model.
response.global_model.stock_infoobject[]Stock info of global model.
response.global_model.stock_info.stock_typeint321Stock type. "1" means wms on hand, "2" means seller on hand.
response.global_model.stock_info.stock_location_idstring1020Stock location id.
response.global_model.stock_info.current_stockint3210Current stock.
response.global_model.stock_info.normal_stockint3210Normal stock.
response.global_model.stock_info.reserved_stockint3210Reserved stock.
response.global_model.tier_indexint32[][0, 1]Tier index of global model.
response.global_model.weightstring"1.1"The weight of this global model, the unit is KG.; If don't set the weight of this global model, will use the weight of global item by default.
response.global_model.dimensionobjectThe dimension of this global model.; If don't set the dimension of this global model, will use the dimension of global item by default.
response.global_model.dimension.package_heightint3211The height of package for this global model, the unit is CM.
response.global_model.dimension.package_lengthint3211The length of package for this global model, the unit is CM.
response.global_model.dimension.package_widthint3211The width of package for this global model, the unit is CM.
response.global_model.pre_orderobjectPre-order information of this global model.; Notes: If don't set the DTS of this global model, will use the DTS of the global item by default.
response.global_model.pre_order.days_to_shipint322Days to ship.
response.global_model.is_fulfillment_by_shopeebooleanIf it it a FBS model
response.standardise_tier_variationobject[]Standardise Tier variation information of global item.
response.standardise_tier_variation.variation_idint32Standardise Tier variation ID.
response.standardise_tier_variation.variation_namestringStandardise Tier variation Name.
response.standardise_tier_variation.variation_group_idint32Standardise Tier variation Group ID.
response.standardise_tier_variation.variation_option_listobject[]Standardise Tier variation Options List.
response.standardise_tier_variation.variation_option_list.variation_option_idint32Standardise Tier variation Option ID.
response.standardise_tier_variation.variation_option_list.variation_option_namestringStandardise Tier variation Option Name.
response.standardise_tier_variation.variation_option_list.image_idstringID of image
response.standardise_tier_variation.variation_option_list.image_urlstringURL of image
#

§5 Common parameters

Common parameters

NameTypeRequiredSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
merchant_idint1Shopee’s unique identifier for a merchant. Required for all merchant level requests(CB CNSC user calling global product related APIs).
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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
#

§6 Request samples

Request samples

#

§7 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/global_product/get_global_model_list?access_token=access_token&timestamp=timestamp&sign=sign&global_item_id=2800146127&merchant_id=merchant_id&partner_id=partner_id")
.asString();
#

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/global_product/get_global_model_list?access_token=access_token&global_item_id=2800146127&merchant_id=merchant_id&partner_id=partner_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
#

§9 cURL

cURL

curl --location --request GET 'https://partner.shopeemobile.com/api/v2/global_product/get_global_model_list?access_token=access_token&timestamp=timestamp&sign=sign&global_item_id=2800146127&merchant_id=merchant_id&partner_id=partner_id' 
#

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/global_product/get_global_model_list?access_token=access_token&global_item_id=2800146127&merchant_id=merchant_id&partner_id=partner_id&sign=sign&timestamp=timestamp"

payload={}
headers = {

}
response = requests.request("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)
#

§11 Response sample

Response sample

#

§12 JSON

JSON

{
    "error": "",
    "message": "",
    "warning": "",
    "request_id": "369c79e9a42147f6912e2bf21c96ba23",
    "response": {
        "tier_variation": [
            {
                "name": "tier name 1",
                "option_list": [
                    {
                        "option": "tier option 1",
                        "image": {
                            "image_url": "https://cf.shopee.sg/file/c54265d475b85e00ffb2404585e32b6f",
                            "image_id": "c54265d475b85e00ffb2404585e32b6f"
                        }
                    },
                    {
                        "option": "tier option 2",
                        "image": {
                            "image_url": "https://cf.shopee.sg/file/c54265d475b85e00ffb2404585e32b61",
                            "image_id": "c54265d475b85e00ffb2404585e32b61"
                        }
                    }
                ]
            },
            {
                "name": "tier name 2",
                "option_list": [
                    {
                        "option": "tier option 1",
                        "image": {
                            "image_url": "https://cf.shopee.sg/file/c54265d475b85e00ffb2404585e32b66",
                            "image_id": "c54265d475b85e00ffb2404585e32b66"
                        }
                    },
                    {
                        "option": "tier option 2",
                        "image": {
                            "image_url": "https://cf.shopee.sg/file/c54265d475b85e00ffb2404585e32b69",
                            "image_id": "c54265d475b85e00ffb2404585e32b69"
                        }
                    }
                ]
            }
        ],
        "global_model": [
            {
                "global_model_id": 2000449065,
                "global_model_sku": "model sku",
                "price_info": {
                    "original_price": 100.5
                },
                "stock_info": [
                    {
                        "stock_type": 1,
                        "stock_location_id": 1020,
                        "current_stock": 10,
                        "normal_stock": 10,
                        "reserved_stock": 10
                    }
                ],
                "tier_index": [0, 0]
            },
            {
                "global_model_id": 2000449066,
                "global_model_sku": "model sku",
                "price_info": {
                    "original_price": 100.5
                },
                "stock_info": [
                    {
                        "stock_type": 1,
                        "stock_location_id": 1020,
                        "current_stock": 10,
                        "normal_stock": 10,
                        "reserved_stock": 10
                    }
                ],
                "tier_index": [0, 1]
            },
            {
                "global_model_id": 2000449067,
                "global_model_sku": "model sku",
                "price_info": {
                    "original_price": 100.5
                },
                "stock_info": [
                    {
                        "stock_type": 1,
                        "stock_location_id": 1020,
                        "current_stock": 10,
                        "normal_stock": 10,
                        "reserved_stock": 10
                    }
                ],
                "tier_index": [1, 0]
            },
            {
                "global_model_id": 2000449068,
                "global_model_sku": "model sku",
                "price_info": {
                    "original_price": 100.5
                },
                "stock_info": [
                    {
                        "stock_type": 1,
                        "stock_location_id": 1020,
                        "current_stock": 10,
                        "normal_stock": 10,
                        "reserved_stock": 10
                    }
                ],
                "tier_index": [1, 1]
            }
        ]
    }
}
#

§13 Error example

Error example

#

§14 JSON

JSON

{
    "error": "product.error_server",
    "message": "server internal error mtsku no found",
    "request_id": "c9a0df08a80c5d5955ac62420f644dbb"
}
#

§15 Errors

Errors

ErrorDescriptionSolution
error_networkInner http call failed
error_dataparse data failed
error_datadata not exist
error_paramparameter invalid
error_paramThe information you queried is not found.
error_paramWrong parameters, detail: {msg}.
error_serverSomething wrong. Please try later.
error_paramrequest not from gateway
error_authshop is upgrading
error_busi_global_item_not_foundGlobal item not found.
error_innerOur system is taking some time to respond, please try later.
error_innerSystem error, please try again later or contact the OpenAPI support team.
error_innerUpdate item failed {{.error_info}}
error_innerUpdate item failed {{.error_info}}
error_innerSystem error, please try again later or contact the OpenAPI support team.
error_innerSystem error, please try again later or contact the OpenAPI support team.
error_authYour shop can not use model level dts
error_system_busyOur system is taking some time to respond, please try later.
#

§16 Common errors

Common errors

ErrorDescriptionSolution
error_authpartner_id is invalid
error_authThe App is deleted, and you'll be unable to make any API call.
error_authApp developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_paramThere is no partner_id in query.
error_paramInvalid partner_id.
error_paramno timestamp
error_paramInvalid timestamp
error_paramThere is no sign in query.
error_signWrong sign.
invalid_partner_idInvalid partner_id, please have a check.
error_authNo permission to current api.
error_api_call_restrictedThe App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspendedThe API is offline. Please call v2 API instead.
error_limitThe total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limitToo many requests. You have reached the rate limit. Please try again later.
source_ip_undeclaredRequest Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_paramPermission denied. This API is currently offline or the request path is incorrect.
error_paramPartner_id is invalid, should be an integer between 0 and 4294967295.
error_paramno timestamp.
error_paramTimestamp is invalid, should be an integer between 0 and 4294967295.
error_paramTimestamp is expired.
error_partner_key_expiredYour API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permissionThis app type has no permission to this API.
error_paramThere is no access_token in query.
error_authInvalid access_token.
merchant_no_linkedPartner and merchant has no linked.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_frozenThe Partner has been frozen. Permissions for merchant authorization and API calls have been suspended until permissions are restored.
error_paramThere is no merchant_id in query.
error_parammerchant_id is invalid, should be an integer between 0 and 4294967295.
#

§17 Update log

Update log

DateChange
2025-02-17add is_fulfillment_by_shopee
2024-06-21add model level DTS
2024-05-29add model level weight and dimension
2024-03-26Add standard variation fields
2021-05-17Add CNSC introduction in API description
#