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

v2.product.register_brand

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.product.register_brand

Use this call to register a brand.

#

§2 Overview

Overview

FieldValue
ModuleProduct
API typeShop
HTTP methodPOST
Path/api/v2/product/register_brand
Production URLhttps://partner.shopeemobile.com/api/v2/product/register_brand
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/product/register_brand
Rate limit[0, 0, 0]
PermissionERP System; Seller In House System; Product Management; Swam ERP
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
original_brand_namestringYesNikeBrand name, length<=254.
category_listint[]Yes[16521,16522]Category_id list for this brand, please input category in L1 or L2. Max input num of category_id is 50.
product_imageobjectYes
product_image.image_id_liststring[]YesImage Id of product image for this brand, max input num of file = 10 ,each file's length<=498. ID market is optional.
app_logo_image_idstringNo6373157f9408b42c8aacda1d63d3a209Image_id of logo for app client,please input hashcode of this picture.
brand_websitestringNowww.nike.comOfficial website of brand, length<=254.
brand_descriptionstringNoOur mission is what drives us to do everything possible to expand human potential. We do that by creating groundbreaking sport innovations, by making our products more sustainably, by building a creative and diverse global team and by making a positive impact in communities where we live and workThe description of this brand, can input the information, length<=254.
additional_informationstringNoadditional notes or comment can seller can addAdditional notes or comment can seller can add, length<=254.
pc_logo_image_idstringNo6373157f9408b42c8aacda1d63d3a209Image_id of logo for pc client,please input hashcode of this picture.
brand_regionstringYesUSorigin region of brand.
licensesobject[]NoFor appeal blacklisted brand data
licenses.file_namestringNoimage.jpgBrand registration certificate image name, len < 254
licenses.file_hashstringNo6373157f9408b42c8aacda1d63d3a209Image id of brand registration certificate image , max input num of file = 1 , each file's length<=498
brand_registration_websitestringNohttps://www.jumbomark.com/indonesia/trademark-registration/mischief-DID2019017755The link to brand registration website, It is mandatory when brand name hit blacklist.len<254
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
request_idstring3e0976b06baa4e059b278ef1fdae1f01The identifier for an API request for error tracking.
errorstringproduct.duplicate_requestIndicate error type if hit error. Empty if no error happened.
messagestringYou has replied this comment already.Indicate error details if hit error. Empty if no error happened.
responseobject
response.brand_idintThe identity of brand.
response.original_brand_namestringBrand name
#

§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.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature generated by partner_id, api path, timestamp, access_token, shop_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 Payload

Payload

{
	"original_brand_name": "Nike",
	"category_list": [
		16521,
		16522
	],
	"product_image": {
		"image_id_list": [
			"-"
		]
	},
	"app_logo_image_id": "6373157f9408b42c8aacda1d63d3a209",
	"brand_website": "www.nike.com",
	"brand_description": "Our mission is what drives us to do everything possible to expand human potential. We do that by creating groundbreaking sport innovations, by making our products more sustainably, by building a creative and diverse global team and by making a positive impact in communities where we live and work",
	"additional_information": "additional notes or comment can seller can add",
	"pc_logo_image_id": "6373157f9408b42c8aacda1d63d3a209",
	"brand_region": "US"
}
#

§8 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/product/register_brand?shop_id=shop_id&partner_id=partner_id&sign=sign&access_token=access_token&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"additional_information\": \"additional notes or comment can seller can add\",
   \"app_logo_image_id\": \"6373157f9408b42c8aacda1d63d3a209\",
   \"brand_country\": \"US\",
   \"brand_description\": \"Our mission is what drives us to do everything possible to expand human potential. We do that by creating groundbreaking sport innovations, by making our products more sustainably, by building a creative and diverse global team and by making a positive impact in communities where we live and work\",
   \"brand_website\": \"www.nike.com\",
   \"category_list\": [
      16521,
      16522
   ],
   \"original_brand_name\": \"Nike\",
   \"pc_logo_image_id\": \"6373157f9408b42c8aacda1d63d3a209\",
   \"product_image\": {
      \"image_id_list\": [
         \"-\"
      ]
   }
}")
.asString();
#

§9 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/product/register_brand?access_token=access_token&partner_id=partner_id&shop_id=shop_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 => 'POST',
  CURLOPT_POSTFIELDS => '{
    "additional_information": "additional notes or comment can seller can add",
    "app_logo_image_id": "6373157f9408b42c8aacda1d63d3a209",
    "brand_country": "US",
    "brand_description": "Our mission is what drives us to do everything possible to expand human potential. We do that by creating groundbreaking sport innovations, by making our products more sustainably, by building a creative and diverse global team and by making a positive impact in communities where we live and work",
    "brand_website": "www.nike.com",
    "category_list": [
        16521,
        16522
    ],
    "original_brand_name": "Nike",
    "pc_logo_image_id": "6373157f9408b42c8aacda1d63d3a209",
    "product_image": {
        "image_id_list": [
            "-"
        ]
    }
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
#

§10 cURL

cURL

curl --location --request POST 'https://partner.shopeemobile.com/api/v2/product/register_brand?shop_id=shop_id&partner_id=partner_id&sign=sign&access_token=access_token&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "additional_information": "additional notes or comment can seller can add",
   "app_logo_image_id": "6373157f9408b42c8aacda1d63d3a209",
   "brand_country": "US",
   "brand_description": "Our mission is what drives us to do everything possible to expand human potential. We do that by creating groundbreaking sport innovations, by making our products more sustainably, by building a creative and diverse global team and by making a positive impact in communities where we live and work",
   "brand_website": "www.nike.com",
   "category_list": [
      16521,
      16522
   ],
   "original_brand_name": "Nike",
   "pc_logo_image_id": "6373157f9408b42c8aacda1d63d3a209",
   "product_image": {
      "image_id_list": [
         "-"
      ]
   }
}'
#

§11 Python

Python

import requests
import json

url = "https://partner.shopeemobile.com/api/v2/product/register_brand?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "additional_information": "additional notes or comment can seller can add",
  "app_logo_image_id": "6373157f9408b42c8aacda1d63d3a209",
  "brand_country": "US",
  "brand_description": "Our mission is what drives us to do everything possible to expand human potential. We do that by creating groundbreaking sport innovations, by making our products more sustainably, by building a creative and diverse global team and by making a positive impact in communities where we live and work",
  "brand_website": "www.nike.com",
  "category_list": [
    16521,
    16522
  ],
  "original_brand_name": "Nike",
  "pc_logo_image_id": "6373157f9408b42c8aacda1d63d3a209",
  "product_image": {
    "image_id_list": [
      "-"
    ]
  }
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.request("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)
#

§12 Response sample

Response sample

#

§13 JSON

JSON

{
    "error": "",
    "message": "",
    "warning": "",
    "request_id": "558ce5454c9b461aad47aa5cd8bb1e9f",
    "response":{
        "brand_id":1234,
        "original_brand_name":"brand_name"
    }
}
#

§14 Error example

Error example

#

§15 JSON

JSON

{
    "error": "product.error_param",
    "message": "invalid field OriginalBrandName: value must  Not Null",
    "request_id": "ebaa7a85d3fa6829daaea57ebb8ef6a0"
}
#

§16 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_shopshopid is invalid
error_paramrequest not from gateway
error_param_shop_id_not_foundShop_id is not found.
error_parambrand image is required
error_invalid_categoryInvalid category ID {{.error_info}}
unsupport_region_for_register_brandThe market this shop belongs to do not support brand registration.
error_busi_duplicatedBrand already exists. If you want to add available category for this brand, you can change the category.
error_busi_pending_qcThe brand you registered is in the inspection process. Please contact Shopee Customer Service for more information.
error_busi_blacklistThis brand name can't be used in several selected categories. You can contact Shopee CS for brand appeal offline if need.
error_busi_blacklist_need_licenseRisky brand name, please provide related license and brand registration website to register this specific brand.
#

§17 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.
error_authInvalid partner_id or shopid.
shop_no_linkedPartner and shop has no linked.
shop_bannedThe shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_shop_no_linkInvalid partner_id or shop_id, please have a check.
error_ashop_api_permissionThe shop is Affiliate shop has no permission to call this API.
error_kyc_authNo permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_authSystem error, please try again later.
error_paramThere is no shop_id in query.
error_paramshop_id is invalid, should be an integer between 0 and 4294967295.
#

§18 Update log

Update log

DateChange
2023-05-26update the parameter name from brand_country to brand_region
2022-09-29add the licenses and brand_registration_website request parameters
2021-09-06New API
#