Get Global Categories

GET

/product/202309/global_categories

Retrieve all available product categories, regardless of market variations. Product categories are updated frequently, so it’s recommended to call the API in real time to ensure you are using the latest category data. Caching category data locally may result in using outdated information, leading to errors when creating global products.

Authorizations

• accessToken

Parameters

Query Parameters

locale

string

Allowed values: cs-CZ de-AT de-BE de-DE el-GR en-GB en-IE en-US es-ES es-MX fr-FR fr-BE hu-HU id-ID it-IT ja-JP ms-MY nl-NL nl-BE pl-PL pt-BR pt-PT th-TH vi-VN zh-CN

The BCP-47 locale codes for displaying category information. Default: The default locale of your shop. Possible values:

• cs-CZ
• de-AT
• de-BE
• de-DE
• el-GR
• en-GB
• en-IE
• en-US
• es-ES
• es-MX
• fr-FR
• fr-BE
• hu-HU
• id-ID
• it-IT
• ja-JP
• ms-MY
• nl-NL
• nl-BE
• pl-PL
• pt-BR
• pt-PT
• th-TH
• vi-VN
• zh-CN

keyword

string

Filter categories by this keyword in local_name.

category_version

string

Filter categories by the category tree version.Possible values based on region:

• US, EU and SEA: v2, represents the 7-level category tree. Important: For US, EU and SEA shops, you must pass v2 when using this API.
• Other regions: v1, represents the 3-level category tree.Default: v1

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

categories

The list of categories that meet the query conditions.

Array<object>

object

id

The category ID.

string

parent_id

The parent category ID. For the root category, the parent ID is 0.

string

local_name

The name of the category.

string

is_leaf

A flag to indicate if the category is a leaf category. Note: You can only create or edit products that belong to a leaf category.

boolean

permission_statuses

The shop’s permission status for this category. Possible values:

• AVAILABLE: You have the permission to create products in this category.
• NON_MAIN_CATEGORY: This category is out of scope for this seller, and you do not have permission to use it. Contact your account manager for assistance.

Array<string>

Allowed values: AVAILABLE NON_MAIN_CATEGORY

Example

{
  "code": 0,
  "data": {
    "categories": [
      {
        "id": "600001",
        "parent_id": "0",
        "local_name": "Home Supplies",
        "is_leaf": false,
        "permission_statuses": [
          "AVAILABLE"
        ]
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}