Orkas is an open-source (MIT), local-first AI team for your desktop: a Commander turns your goal into to-dos and coordinates 16 built-in specialist agents plus Claude Code, Codex, OpenCode, OpenClaw and Hermes, with projects, scheduled automations and connectors. Free app for macOS & Windows; built-in models or your own keys.
JavaScript agent-collaborationagent-harnessagent-orchestrationagent-teamagent-workflowai-assistantai-automationai-employeeai-productivityai-teamai-workflowautonomous-agentsclaude-code-guiclaude-coworkdesktop-agentlocal-firstmulti-agentmulti-agent-systemself-evolving-agentstask-automation
'use strict';
// Generated from pinned official Shopee API guide, 2026-10-01.
module.exports = {
"methods": {
"v2.product.get_category": {
"path": "/api/v2/product/get_category",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get category",
"input_schema": {
"type": "object",
"properties": {
"language": {
"type": "string",
"maxLength": 262144,
"description": "If language is not uploaded, the default language=en, the following are the languages supported by different markets SG: en ; MY: en / ms-my / zh-hans ; TH: en / th ; VN: en / vi ; PH: en ; TW: en / zh-hant ; ID: en / id ; BR: en / pt-br ; MX: en / es-mx ; CO: en/es-CO ; CL: en/es-CL .Note: For markets that have already launched global tree, Crossboard shop only support returning en and zh-hans language data"
}
},
"required": [],
"additionalProperties": false,
"description": "v2.product.get_category\nGet category tree data. More detail please check https://open.shopee.com/developer-guide/209\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"category_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID for category."
},
"parent_category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID for parent category."
},
"original_category_name": {
"type": "string",
"description": "Default name for category."
},
"display_category_name": {
"type": "string",
"description": "Display name dependent on display name."
},
"has_children": {
"type": "boolean",
"description": "Whether this category has active children category."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_attribute_tree": {
"path": "/api/v2/product/get_attribute_tree",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get attribute tree",
"input_schema": {
"type": "object",
"properties": {
"category_id_list": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int"
},
"maxItems": 20,
"description": "max count is 20"
},
"language": {
"type": "string",
"maxLength": 262144,
"description": "Language Support Lanuage: \"SG\": [ \"en\", \"zh-Hans\", \"ms\" ], \"MY\": [ \"en\", \"zh-Hans\", \"ms\" ], \"PH\": [ \"en\", \"zh-Hans\" ], \"VN\": [ \"vn\", \"en\" ], \"ID\": [ \"id\", \"en\" ], \"TH\": [ \"th\", \"en\" ], \"BR\": [ \"pt-BR\", \"en\" ], \"MX\": [ \"es-MX\", \"en\" ], \"CO\": [ \"es-CO\", \"en\" ], \"CL\": [ \"es-CL\", \"en\" ], \"TW\": [ \"zh-Hant\", \"zh-Hans\", \"en\" ], \"IN\": [ \"en\", \"hi\" ]"
}
},
"required": [
"category_id_list"
],
"additionalProperties": false,
"description": "v2.product.get_attribute_tree\nGet the attribute tree for categories\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Error"
},
"message": {
"type": "string",
"description": "Message"
},
"warning": {
"type": "string",
"description": "Warning"
},
"request_id": {
"type": "string",
"description": "Request ID"
},
"response": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute_tree": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Attribute ID"
},
"mandatory": {
"type": "boolean",
"description": "Is mandatory or not"
},
"name": {
"type": "string",
"description": "Attribute Name"
},
"attribute_value_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Value ID"
},
"name": {
"type": "string",
"description": "Value name"
},
"value_unit": {
"type": "string",
"description": "Value unit"
},
"child_attribute_list": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"description": "Child attributes for the value of parent attribute The structure content is the same as attribute_tree"
},
"multi_lang": {
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "Language"
},
"value": {
"type": "string",
"description": "Translate result"
}
},
"additionalProperties": true
},
"description": "Translate results for display"
}
},
"additionalProperties": true
},
"description": "All available values for this attribute"
},
"attribute_info": {
"type": "object",
"properties": {
"input_type": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "SINGLE_DROP_DOWN = 1 SINGLE_COMBO_BOX = 2 FREE_TEXT_FILED = 3 MULTI_DROP_DOWN = 4 MULTI_COMBO_BOX = 5"
},
"input_validation_type": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "VALIDATOR_NO_VALIDATE_TYPE = 0 VALIDATOR_INT_TYPE = 1 VALIDATOR_STRING_TYPE = 2 VALIDATOR_FLOAT_TYPE = 3 VALIDATOR_DATE_TYPE = 4"
},
"format_type": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "FORMAT_NORMAL = 1 FORMAT_QUANTITATIVE_WITH_UNIT = 2"
},
"date_format_type": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "YEAR_MONTH_DATE = 0 (DD/MM/YYYY) YEAR_MONTH = 1 (MM/YYYY)"
},
"attribute_unit_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "Attribute's available units list"
},
"max_value_count": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Max selected value count"
},
"introduction": {
"type": "string",
"description": "Introduction for special Attribute"
},
"is_oem": {
"type": "boolean"
},
"support_search_value": {
"type": "boolean",
"description": "Indicates whether this attribute has searchable values. If yes, please call v2.product.search_attribute_value_list to get the default values"
}
},
"additionalProperties": true,
"description": "Attribute extra info"
},
"multi_lang": {
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "Language"
},
"value": {
"type": "string",
"description": "Translate result"
}
},
"additionalProperties": true
},
"description": "Attribute translate info"
}
},
"additionalProperties": true
},
"description": "One category's attribute trees"
},
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Category ID"
},
"warning": {
"type": "string",
"description": "Warning msg"
}
},
"additionalProperties": true
},
"description": "Each result corresponds to one category in category_ids"
}
},
"additionalProperties": true,
"description": "Resopnse"
}
},
"additionalProperties": true
}
},
"v2.product.get_brand_list": {
"path": "/api/v2/product/get_brand_list",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get brand list",
"input_schema": {
"type": "object",
"properties": {
"offset": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Specifies the starting entry of data to return in the current call. Default is 0. If data is more than one page,this field needs to be replaced with \"next_offset\" to request,and the offset can be some entry to start next call."
},
"page_size": {
"description": "the size of one page.Max=100 Official limits: [1,100]",
"x-pageMax": 100,
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of category."
},
"status": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Brand status , 1: normal brand, 2: pending brand"
},
"language": {
"type": "string",
"maxLength": 262144,
"description": "If language is not uploaded, the default language=en, the following are the languages supported by different markets SG: en ; MY: en / ms-my / zh-hans ; TH: en / th ; VN: en / vi ; PH: en ; TW: en / zh-hant ; ID: en / id ; BR: en / pt-br ; MX: en / es-mx ; CO: en/es-CO ; CL: en/es-CL. Note: For markets that have already launched global tree, Crossboard shop only support returning en and zh-hans language data"
}
},
"required": [
"offset",
"page_size",
"category_id",
"status"
],
"additionalProperties": false,
"description": "v2.product.get_brand_list\nGet the brand data of a leaf category. More detail please check: https://open.shopee.com/developer-guide/209\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking"
},
"response": {
"type": "object",
"properties": {
"brand_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"original_brand_name": {
"type": "string",
"description": "Original name of brand"
},
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"display_brand_name": {
"type": "string",
"description": "Display name of brand"
}
},
"additionalProperties": true
}
},
"has_next_page": {
"type": "boolean",
"description": "This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items."
},
"next_offset": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "If has_next_page is true, this value need set to next request.offset"
},
"is_mandatory": {
"type": "boolean",
"description": "Whether is mandatory."
},
"input_type": {
"type": "string",
"description": "Input type: DROP_DOWN"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_item_limit": {
"path": "/api/v2/product/get_item_limit",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get item limit",
"input_schema": {
"type": "object",
"properties": {
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for a category."
}
},
"required": [],
"additionalProperties": false,
"description": "v2.product.get_item_limit\nGet item upload control.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"price_limit": {
"type": "object",
"properties": {
"min_limit": {
"type": "number",
"description": "Item price max limit."
},
"max_limit": {
"type": "number",
"description": "Item price min limit."
}
},
"additionalProperties": true
},
"wholesale_price_threshold_percentage": {
"type": "object",
"properties": {
"min_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item wholesale price percentage of original price min limit."
},
"max_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item wholesale price percentage of original price min limit."
}
},
"additionalProperties": true
},
"stock_limit": {
"type": "object",
"properties": {
"min_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item stock min limit."
},
"max_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item stock max limit."
}
},
"additionalProperties": true
},
"item_name_length_limit": {
"type": "object",
"properties": {
"min_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item name length min limit."
},
"max_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item name length max limit."
}
},
"additionalProperties": true
},
"item_image_count_limit": {
"type": "object",
"properties": {
"min_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item image count min limit."
},
"max_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item image count max limit."
}
},
"additionalProperties": true
},
"item_description_length_limit": {
"type": "object",
"properties": {
"min_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item description length min limit."
},
"max_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item description length max limit."
}
},
"additionalProperties": true
},
"tier_variation_name_length_limit": {
"type": "object",
"properties": {
"min_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item tier variation name length min limit."
},
"max_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item tier variation name length max limit."
}
},
"additionalProperties": true
},
"tier_variation_option_length_limit": {
"type": "object",
"properties": {
"min_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item tier variation option length min limit."
},
"max_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item tier variation option length max limit."
}
},
"additionalProperties": true
},
"item_count_limit": {
"type": "object",
"properties": {
"max_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item count max limit."
}
},
"additionalProperties": true
},
"extended_description_limit": {
"type": "object",
"properties": {
"description_text_length_min": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "length min limit for item extended description text part"
},
"description_text_length_max": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "length max limit for item extended description text part"
},
"description_image_num_min": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "length min limit for item extended description image num"
},
"description_image_num_max": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "length max limit for item extended description image num"
},
"description_image_width_min": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "length min limit for item extended description image width"
},
"description_image_height_min": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "length min limit for item extended description image hight"
},
"description_image_aspect_ratio_min": {
"type": "number",
"description": "length min limit for item extended description image aspect (image width / image hight )"
},
"description_image_aspect_ratio_max": {
"type": "number",
"description": "length max limit for item extended description image aspect (image width / image hight )"
}
},
"additionalProperties": true
},
"dts_limit": {
"type": "object",
"properties": {
"days_to_ship_limit": {
"type": "object",
"properties": {
"min_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int"
},
"max_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int"
}
},
"additionalProperties": true,
"description": "Pre order limits for the category"
},
"non_pre_order_days_to_ship": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int"
}
},
"additionalProperties": true
},
"weight_limit": {
"type": "object",
"properties": {
"weight_mandatory": {
"type": "boolean",
"description": "weight is mandatory or not"
}
},
"additionalProperties": true
},
"dimension_limit": {
"type": "object",
"properties": {
"dimension_mandatory": {
"type": "boolean",
"description": "dimension is mandatory or not for the category"
}
},
"additionalProperties": true
},
"size_chart_limit": {
"type": "object",
"properties": {
"size_chart_mandatory": {
"type": "boolean"
},
"support_image_size_chart": {
"type": "boolean"
},
"support_template_size_chart": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"gtin_limit": {
"type": "object",
"properties": {
"gtin_validation_rule": {
"type": "string",
"description": "Indicate gtin_code validation logic in v2.product.add_item v2.product.update_item v2.product.init_tier_variation v2.product.add_model v2.product.update_model - Mandatory : This field is required and must contain a correctly formatted GTiN number. - Flexible : This field is required and must contain either a correctly formatted GTlN number or \"00\" todeclare that the item/model has no valid GTlN. - Optional : This field is optional and can contain a correctly formatted GTiN number, \"00\" or be omittedentirely."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_item_list": {
"path": "/api/v2/product/get_item_list",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get item list",
"input_schema": {
"type": "object",
"properties": {
"offset": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Specifies the starting entry of data to return in the current call. Default is 0. if data is more than one page, the offset can be some entry to start next call."
},
"page_size": {
"description": "the size of one page.Max=100 Official limits: [1,100]",
"x-pageMax": 100,
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"update_time_from": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the item update time). The update_time_from field is the starting date range."
},
"update_time_to": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the item update time). The update_time_to field is the ending date range"
},
"item_status": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "NORMAL/BANNED/UNLIST/ REVIEWING/SELLER_DELETE/SHOPEE_DELETE If you want to search multiple status, please upload the url like this: item_status=NORMAL&item_status=BANNED"
}
},
"required": [
"offset",
"page_size",
"item_status"
],
"additionalProperties": false,
"description": "v2.product.get_item_list\nUse this call to get a list of items.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking"
},
"response": {
"type": "object",
"properties": {
"item": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for an item."
},
"item_status": {
"type": "string",
"description": "Enumerated type that defines the current status of the item. Applicable values: NORMAL, BANNED, UNLIST, REVIEWING, SELLER_DELETE, SHOPEE_DELETE ."
},
"update_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The update time of item."
},
"tag": {
"type": "object",
"properties": {
"kit": {
"type": "boolean",
"description": "Indicate if the item is kit item."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"description": "list of item info with item_id/ item_status/ update_time"
},
"total_count": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "total count of all items"
},
"has_next_page": {
"type": "boolean",
"description": "This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items."
},
"next_offset": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "if has_next_page is true, this value need set to next request.offset"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_item_base_info": {
"path": "/api/v2/product/get_item_base_info",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get item base info",
"input_schema": {
"type": "object",
"properties": {
"item_id_list": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"maxItems": 50,
"description": "item_id list; limit [0,50] Official limits: [0,50]",
"minItems": 0
},
"need_tax_info": {
"type": "boolean",
"description": "if true will response tax_info"
},
"need_complaint_policy": {
"type": "boolean",
"description": "if true will response complaint_policy"
}
},
"required": [
"item_id_list"
],
"additionalProperties": false,
"description": "v2.product.get_item_base_info\nUse this api to get basic info of item by item_id list.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for an item."
},
"category_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Shopee's unique identifier for a category."
},
"item_name": {
"type": "string",
"description": "Name of the item in local language."
},
"description": {
"type": "string",
"description": "if description_type is normal , Description information will be returned through this field,else description will be empty"
},
"item_sku": {
"type": "string",
"description": "An 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."
},
"create_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Timestamp that indicates the date and time that the item was created."
},
"update_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Timestamp that indicates the last time that there was a change in value of the item, such as price/stock change."
},
"attribute_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The Identify of each category."
},
"original_attribute_name": {
"type": "string",
"description": "The name of each attribute."
},
"is_mandatory": {
"type": "boolean",
"description": "This is to indicate whether this attribute is mandantory."
},
"attribute_value_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Unique identifier for value of this item attribute."
},
"original_value_name": {
"type": "string",
"description": "Value name of this item attribute."
},
"value_unit": {
"type": "string",
"description": "Value unit of this item attribute."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"price_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "The three-digit code representing the currency unit used for the item in Shopee Listings."
},
"original_price": {
"type": "number",
"description": "The original price of the item in the listing currency."
},
"current_price": {
"type": "number",
"description": "The current price of the item in the listing currency. If product under a onging promotion, current_price will be the promotion price"
},
"inflated_price_of_original_price": {
"type": "number",
"description": "The After-tax original price of the item in the listing currency."
},
"inflated_price_of_current_price": {
"type": "number",
"description": "The After-tax current price of the item in the listing currency."
},
"sip_item_price": {
"type": "number",
"description": "The price of the item in sip.If item is for CNSC primary shop, this field will not be returned"
},
"sip_item_price_source": {
"type": "string",
"description": "source of sip' price. ( auto or manual).If item is for CNSC SIP primary shop, this field will not be returned"
},
"local_price": {
"type": "number",
"description": "The original price multiplied by the local adjustment rate equals the local price. The local price is denominated in the local currency and is rounded to two decimal places."
},
"local_promotion_price": {
"type": "number",
"description": "During the promotion period, the CB price is multiplied by the local adjustment rate. Once the promotion starts, the price remains unchanged. During the promotion, the local_promotion_price= current_price, which is denominated in the local currency and retained to two decimal places."
}
},
"additionalProperties": true
},
"description": "If the item has models, price_info will not be returned. Please get the price of each model through the get_model_list api"
},
"image": {
"type": "object",
"properties": {
"image_url_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of image url."
},
"image_id_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of image id."
},
"image_ratio": {
"type": "string",
"description": "Image ratio"
}
},
"additionalProperties": true
},
"weight": {
"type": "string",
"description": "The weight of this item, the unit is KG. If set the weight of models under this item, will return the max weight of all models during the switching period to ensure system compatibility, please switch to call v2.product.get_model_list to get the weight of models."
},
"dimension": {
"type": "object",
"properties": {
"package_length": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The length of package for this item, the unit is CM."
},
"package_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The width of package for this item, the unit is CM."
},
"package_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The height of package for this item, the unit is CM."
}
},
"additionalProperties": true,
"description": "The dimension of this item. If set the dimension of models under this 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.product.get_model_list to get the dimension of models."
},
"logistic_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"logistic_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The identity of logistic channel."
},
"logistic_name": {
"type": "string",
"description": "The name of logistic."
},
"enabled": {
"type": "boolean",
"description": "Related to shopee.logistics.GetLogistics result.logistics.enabled only affect current item."
},
"shipping_fee": {
"type": "number",
"description": "Only needed when logistics fee_type = CUSTOM_PRICE."
},
"size_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "If specify logistic fee_type is SIZE_SELECTION size_id is required."
},
"is_free": {
"type": "boolean",
"description": "when seller chooses this option, the shipping fee of this channel on item will be set to 0. Default value is False."
},
"estimated_shipping_fee": {
"type": "number",
"description": "Estimated shipping fee calculated by weight. Don't exist if channel is no-integrated."
}
},
"additionalProperties": true
},
"description": "The logistics list."
},
"pre_order": {
"type": "object",
"properties": {
"is_pre_order": {
"type": "boolean",
"description": "Pre-order will be set true."
},
"days_to_ship": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The days to ship. Only work for pre-orde."
}
},
"additionalProperties": true
},
"wholesales": {
"type": "array",
"items": {
"type": "object",
"properties": {
"min_count": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The min count of this tier wholesale."
},
"max_count": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The max count of this tier wholesale."
},
"unit_price": {
"type": "number",
"description": "The current price of the wholesale in the listing currency.If item is in promotion, this price is useless."
},
"inflated_price_of_unit_price": {
"type": "number",
"description": "The After-tax Price of the wholesale show to buyer."
}
},
"additionalProperties": true
},
"description": "The wholesales tier list."
},
"condition": {
"type": "string",
"description": "Is it second-hand."
},
"size_chart": {
"type": "string",
"description": "Url of size chart image."
},
"item_status": {
"type": "string",
"description": "Enumerated type that defines the current status of the item. Applicable values: NORMAL, BANNED, UNLIST, SELLER_DELETE, SHOPEE_DELETE, REVIEWING ."
},
"deboost": {
"type": "boolean",
"description": "If deboost is true, means that the item's search ranking is lowered."
},
"has_model": {
"type": "boolean",
"description": "Does it contain model."
},
"has_promotion": {
"type": "boolean",
"description": "Indicates whether the item is currently under any ongoing promotion."
},
"video_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"video_url": {
"type": "string",
"description": "Url of video."
},
"thumbnail_url": {
"type": "string",
"description": "Thumbnail of video."
},
"duration": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Duration of video."
}
},
"additionalProperties": true
},
"description": "Info of video list."
},
"brand": {
"type": "object",
"properties": {
"brand_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Id of brand."
},
"original_brand_name": {
"type": "string",
"description": "Original name of brand."
}
},
"additionalProperties": true
},
"item_dangerous": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "This field is only applicable for local sellers in Indonesia and Malaysia. Use this field to identify whether a product is a dangerous product. 0 for non-dangerous product and 1 for dangerous product. For more information, please visit the market's respective Seller Education Hub."
},
"gtin_code": {
"type": "string",
"description": "gtin code for br region, will return this code only item has default model Note: gtin_code = \"00\" means that this item is “Item without GTIN”"
},
"size_chart_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "id of new size chart."
},
"promotion_image": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "Promotion image"
},
"image_url_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "Promiton image urls"
},
"image_ratio": {
"type": "string",
"description": "Promotion image ratio"
}
},
"additionalProperties": true
},
"compatibility_info": {
"type": "object",
"properties": {
"vehicle_info_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the brand."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the model."
},
"year_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the year."
},
"version_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the version."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"scheduled_publish_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Scheduled publish time of this item."
},
"authorised_brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of authorised reseller brand."
},
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for Shopee Standard Product."
},
"is_fulfillment_by_shopee": {
"type": "boolean",
"description": "return true if the item only has a default model and it is FBS model"
},
"tag": {
"type": "object",
"properties": {
"kit": {
"type": "boolean",
"description": "Indicate if the item is kit item."
}
},
"additionalProperties": true
},
"purchase_limit_info": {
"type": "object",
"properties": {
"min_purchase_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "minimum purchase count for each order"
},
"max_purchase_limit": {
"type": "object",
"properties": {
"purchase_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "maximum purchase limit for each order"
}
},
"additionalProperties": true
}
},
"additionalProperties": true,
"description": "purchase limit info"
},
"medicine_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "[Only for ID local sellers] as a unique identifier for each standardized medicine."
},
"certification_info": {
"type": "object",
"properties": {
"certification_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"permit_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Permit ID, get from v2.product.get_product_certification_rule"
},
"certification_no": {
"type": "string",
"description": "Certification No."
},
"expiry_date": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "expiry timestamp"
},
"certification_proofs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"description": "The unique image ID of the certification proof, returned by the image upload API."
},
"ratio": {
"type": "number",
"description": "image weight/ image height."
},
"file_name": {
"type": "string",
"description": "The name of the uploaded certification proof file."
},
"image_url": {
"type": "string",
"description": "The image url of the proof"
}
},
"additionalProperties": true
},
"description": "An array of proof documents for the certification; each element represents one proof file."
}
},
"additionalProperties": true
},
"description": "Array of certification records for the product, each containing type, certificate number, permit ID, and proof documents."
}
},
"additionalProperties": true,
"description": "For PH product certification input Required for some category and attribute option"
}
},
"additionalProperties": true
}
},
"complaint_policy": {
"type": "object",
"properties": {
"warranty_time": {
"type": "string",
"description": "Time for a warranty claim.Value should be in one of ONE_YEAR TWO_YEARS OVER_TWO_YEARS."
},
"exclude_entrepreneur_warranty": {
"type": "boolean",
"description": "If True means \"I exclude warranty complaints for entrepreneur\""
},
"complaint_address_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of complaint address."
},
"additional_information": {
"type": "string",
"description": "Additional information for complaint policy"
}
},
"additionalProperties": true,
"description": "Complaint policy.Only returned for local PL sellers, and need_complaint_policy in request is true."
},
"tax_info": {
"type": "object",
"properties": {
"ncm": {
"type": "string",
"description": "Mercosur Common Nomenclature, it is a convention between Mercosur member countries to easily recognize goods, services and productive factors negotiated among themselves.(BR region) Note: ncm = \"00\" means that this item doesn't have a NCM."
},
"diff_state_cfop": {
"type": "string",
"description": "Tax Code of Operations and Installments for orders that seller and buyer are in different states. It identifies a specific operation by category at the time of issuing the invoice. (BR region)"
},
"csosn": {
"type": "string",
"description": "Code of Operation Status – Simples Nacional, code for company operations to identify the origin of the goods and the taxation regime of the operations. (BR region)"
},
"origin": {
"type": "string",
"description": "Product source, domestic or foreig (BR region)"
},
"cest": {
"type": "string",
"description": "Tax Replacement Specifying Code (CEST), to separate within the same NCM products that do or do not have ICMS tax substitution. (BR region) Note: cest = \"00\" means that this item doesn't have a CEST."
},
"measure_unit": {
"type": "string",
"description": "(BR region)"
},
"invoice_option": {
"type": [
"string",
"null"
],
"description": "Value shuold be one of NO_INVOICES VAT_MARGIN_SCHEME_INVOICES VAT_INVOICES NON_VAT_INVOICES and if value is NON_VAT_INVOICE vat_rate should be null (PL region)"
},
"vat_rate": {
"type": "string",
"description": "Value should be one of 0% 5% 8% 23% NO_VAT_RATE (PL region)"
},
"hs_code": {
"type": "string",
"description": "HS Code (Only for IN region)"
},
"tax_code": {
"type": "string",
"description": "Tax Code (Only for IN region)"
},
"tax_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "tax_type only for TW whitelist shop. Shopee will referred Tax type when substitute sellers for issuing e-receipts to buyers. All variations share the same tax type. The meaning of value: 0: no tax type 1: tax-able 2: tax-free"
},
"pis": {
"type": "string",
"description": "Only for BR shop. PIS - Programa de Integração Social (Social Integration Program). It is a government tax to collect resources for the payment of unemployment insurance and other employee related rights. PIS % - the tax applied to this product"
},
"cofins": {
"type": "string",
"description": "Only for BR shop. COFINS – Contribuição para Financiamento da Seguridade Social (Contribution for Social Security Funding). It is a government tax to collect resources for public health system and social security. COFINS % - the tax applied to this product"
},
"icms_cst": {
"type": "string",
"description": "Only for BR shop. ICMS - Imposto sobre Circulação de Mercadorias e Serviços (Circulation of Goods and Services Tax). CST - Código da Situação Tributária (Tax Situation Code) is represented by a combination of 3 numbers with the purpose of demonstrating the origin of a product and determining the form of taxation that will apply to it. Therefore, each digit in the CST Table has a specific meaning: the first digit indicates the origin of the operation, the second digit represents the ICMS taxation on the operation and the third digit provides additional information about the form of taxation."
},
"pis_cofins_cst": {
"type": "string",
"description": "Only for BR shop. The CST PIS/Cofins is a code on the Electronic Invoice (NF-e) that identifies the tax situation of PIS (Programa de Integração Social) and Cofins (Contribuição para o Financiamento da Seguridade Social) in sales of goods."
},
"federal_state_taxes": {
"type": "string",
"description": "Only for BR shop. Enter the total percentage of the combination of federal, state, and municipal taxes, using up to two decimals."
},
"operation_type": {
"type": "string",
"description": "Only for BR shop. 1: Retailer 2: Manufacturer"
},
"ex_tipi": {
"type": "string",
"description": "Only for BR shop. The EXTIPI field in the NF-e (Nota Fiscal Eletrônica) is used to indicate if there's an exception to the IPI (Imposto sobre Produtos Industrializados) tax rate for a specific product."
},
"fci_num": {
"type": "string",
"description": "Only for BR shop. The FCI Control Number is a unique identifier assigned to each import FCI (Import Content Form). It's mandatory on the corresponding NF-e (electronic invoice) to ensure compliance with Brazilian import tax regulations."
},
"recopi_num": {
"type": "string",
"description": "Only for BR shop. RECOPI NACIONAL is a Brazilian government system that facilitates the registration and management of tax-exempt operations involving paper destined for printing books, newspapers, and periodicals (known as \"papel imune\" in Portuguese)."
},
"additional_info": {
"type": "string",
"description": "Only for BR shop. Include relevant information to display on Invoice."
},
"group_item_info": {
"type": "object",
"properties": {
"group_qtd": {
"type": "string",
"description": "Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unit), enter 6."
},
"group_unit": {
"type": "string",
"description": "Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unit), enter UNI for the individual can."
},
"group_unit_value": {
"type": "string",
"description": "Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unity), enter the value of the individual can."
},
"original_group_price": {
"type": "string",
"description": "Example: The item is a package that contains 6 soda cans. Enter the price of the whole package."
},
"group_gtin_sscc": {
"type": "string",
"description": "Example: The item is a package that contains 6 soda cans. Please inform the GTIN SSCC code for the package."
},
"group_grai_gtin_sscc": {
"type": "string",
"description": "Example: The item is box, that contain 6 packages. Each package contains 6 soda cans. Please inform the GRAI GTIN SSCC code for the Box."
}
},
"additionalProperties": true,
"description": "Only for BR shop. Required if the item is a group item."
},
"export_cfop": {
"type": "string",
"description": "7101 - for sales of self-produced goods 7102 - resale of third-party goods a tax code used in Brazil to classify and identify the nature of goods or services transactions for tax purposes. This is used for goods export to other counties"
}
},
"additionalProperties": true,
"description": "Tax information"
},
"description_info": {
"type": "object",
"properties": {
"extended_description": {
"type": "object",
"properties": {
"field_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_type": {
"type": "string",
"description": "Type of extended description field :values: See Data Definition- description_field_type (text , image)."
},
"text": {
"type": "string",
"description": "If field_type is text, text information will be returned through this field."
},
"image_info": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"description": "Image id"
},
"image_url": {
"type": "string",
"description": "Image url."
}
},
"additionalProperties": true,
"description": "If field_type is image, image url will be returned through this field."
}
},
"additionalProperties": true
},
"description": "Field of extended description"
}
},
"additionalProperties": true,
"description": "If description_type is extended , Description information will be returned through this field."
}
},
"additionalProperties": true,
"description": "New description field. Only whitelist sellers can use it."
},
"description_type": {
"type": "string",
"description": "Type of description : values: See Data Definition- description_type (normal , extended)."
},
"stock_info_v2": {
"type": "object",
"properties": {
"summary_info": {
"type": "object",
"properties": {
"total_reserved_stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Stock reserved for promotion. Note: For SIP P Item, will return the total reserved stock for P Item and all A Items under the P Item;"
},
"total_available_stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "total available stock"
}
},
"additionalProperties": true,
"description": "stock summary info"
},
"seller_stock": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"description": "location id"
},
"stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "stock in the current warehouse"
},
"if_saleable": {
"type": "boolean",
"description": "To return if the stock of the location id is saleable"
}
},
"additionalProperties": true
},
"description": "seller stock"
},
"shopee_stock": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"description": "location id"
},
"stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "stock in the current warehouse"
}
},
"additionalProperties": true
},
"description": "shopee stock"
},
"advance_stock": {
"type": "object",
"properties": {
"sellable_advance_stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Refers to Advance Fulfillment stock that Seller has shipped out and is available to be used to fulfill an order."
},
"in_transit_advance_stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Refers to Advance Fulfillment stock that seller has shipped out and is still in transit and unavailable to be used to fulfill an order."
}
},
"additionalProperties": true,
"description": "Only for PH/VN/ID/MY local selected shops."
}
},
"additionalProperties": true,
"description": "new stock object"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_item_extra_info": {
"path": "/api/v2/product/get_item_extra_info",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get item extra info",
"input_schema": {
"type": "object",
"properties": {
"item_id_list": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"maxItems": 50,
"description": "item_id list, limit [0,50] Official limits: [0,50]",
"minItems": 0
}
},
"required": [
"item_id_list"
],
"additionalProperties": false,
"description": "v2.product.get_item_extra_info\nUse this api to get extra info of item by item_id list.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit error. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for an item."
},
"sale": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The sales volume of item."
},
"views": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The page view of item."
},
"likes": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The collection number of item."
},
"rating_star": {
"type": "number",
"description": "The rating star scores of this item."
},
"comment_count": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Count of comments for the item."
}
},
"additionalProperties": true
},
"description": "extra info of item list."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.add_item": {
"path": "/api/v2/product/add_item",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: add item",
"input_schema": {
"type": "object",
"properties": {
"original_price": {
"type": "number",
"description": "Item price"
},
"description": {
"type": "string",
"maxLength": 262144,
"description": "if description_type is normal , Description information should be set by this field."
},
"weight": {
"type": "number",
"description": "The weight of this item, the unit is KG."
},
"item_name": {
"type": "string",
"maxLength": 262144,
"description": "Item name"
},
"item_status": {
"type": "string",
"maxLength": 262144,
"description": "Item status, could be UNLIST or NORMAL"
},
"dimension": {
"type": "object",
"properties": {
"package_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The height of package for this item, the unit is CM."
},
"package_length": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The length of package for this item, the unit is CM."
},
"package_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The width of package for this item, the unit is CM."
}
},
"required": [
"package_height",
"package_length",
"package_width"
],
"additionalProperties": false,
"description": "The dimension of this item."
},
"logistic_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"size_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Size ID, If specify logistic fee_type is SIZE_SELECTION size_id is required."
},
"shipping_fee": {
"type": "number",
"description": "Shipping fee, Only needed when logistics fee_type = CUSTOM_PRICE."
},
"enabled": {
"type": "boolean",
"description": "Whether channel is enabled for this item"
},
"logistic_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "ID of the channel"
},
"is_free": {
"type": "boolean",
"description": "Whether cover shipping fee for buyer"
}
},
"required": [
"enabled",
"logistic_id"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Logistic channel setting"
},
"attribute_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "ID of attribute"
},
"attribute_value_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Value ID. In the following cases, the value id needs to be uploaded as 0, and original_value_name is mandatory, needs to be filled in customized value. (1) AttributeInputType is TEXT_FILED; (2) AttributeInputType is COMBO_BOX or MULTIPLE_SELECT_COMBO_BOX, and the seller want to fill in a customized value."
},
"original_value_name": {
"type": "string",
"maxLength": 262144,
"description": "Value name. original_value_name from product.get_attributes api. If value id=0, this field is required. If AttributeType is DATE_TYPE or TIMESTAMP_TYPE, you can upload timestamp(string type) as the original_value_name."
},
"value_unit": {
"type": "string",
"maxLength": 262144,
"description": "Unit of attribute value (quantitative attribute only)."
}
},
"required": [
"value_id"
],
"additionalProperties": false
},
"maxItems": 10
}
},
"required": [
"attribute_id"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "This field is optional(expect Indonesia) depending on the specific attribute under different categories. Should call shopee.item.GetAttributes to get attribute first. Must contain all all mandatory attribute."
},
"category_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "ID of category"
},
"image": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "ID of image"
},
"image_ratio": {
"type": "string",
"maxLength": 262144,
"description": "Ratio of image, OptionalAllowed ratios : \"1:1\" (default) \"3:4\" only applicable to whitelisted seller."
}
},
"required": [
"image_id_list"
],
"additionalProperties": false,
"description": "Item images"
},
"pre_order": {
"type": "object",
"properties": {
"is_pre_order": {
"type": "boolean",
"description": "Whether item is pre order"
},
"days_to_ship": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The guaranteed days to ship orders. Please get the days_to_ship range from get_dts_limit api"
}
},
"required": [
"is_pre_order"
],
"additionalProperties": false,
"description": "Pre order setting"
},
"item_sku": {
"type": "string",
"maxLength": 262144,
"description": "SKU tag of item"
},
"condition": {
"type": "string",
"maxLength": 262144,
"description": "Condition of item, USED、Used and used will be mapped to Used; NEW、New and new will be mapped to New. Required for BR."
},
"wholesale": {
"type": "array",
"items": {
"type": "object",
"properties": {
"min_count": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Minimum count of this tier"
},
"max_count": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Maximum count of this tier"
},
"unit_price": {
"type": "number",
"description": "Unit price of this tier"
}
},
"required": [
"min_count",
"max_count",
"unit_price"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Wholesale setting"
},
"video_upload_id": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "Video upload ID returned from video uploading API. Only accept one video_upload_id."
},
"brand": {
"type": "object",
"properties": {
"brand_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Id of brand."
},
"original_brand_name": {
"type": "string",
"maxLength": 262144,
"description": "Original name of brand( No Brand if not brand)."
}
},
"required": [
"brand_id",
"original_brand_name"
],
"additionalProperties": false
},
"item_dangerous": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "This field is only applicable for local sellers in Indonesia and Malaysia. Use this field to identify whether a product is a dangerous product. 0 for non-dangerous product and 1 for dangerous product. For more information, please visit the market's respective Seller Education Hub."
},
"tax_info": {
"type": "object",
"properties": {
"ncm": {
"type": "string",
"maxLength": 262144,
"description": "Mercosur Common Nomenclature, it is a convention between Mercosur member countries to easily recognize goods, services and productive factors negotiated among themselves. (BR region) NCM must have 8 digits, OR, if your item doesn't have a NCM enter the value \"00\""
},
"same_state_cfop": {
"type": "string",
"maxLength": 262144,
"description": "Tax Code of Operations and Installments for orders that seller and buyer are in the same state. It identifies a specific operation by category at the time of issuing the invoice.(BR region)"
},
"diff_state_cfop": {
"type": "string",
"maxLength": 262144,
"description": "Tax Code of Operations and Installments for orders that seller and buyer are in different states. It identifies a specific operation by category at the time of issuing the invoice.(BR region)"
},
"csosn": {
"type": "string",
"maxLength": 262144,
"description": "Code of Operation Status – Simples Nacional, code for company operations to identify the origin of the goods and the taxation regime of the operations.(BR region)"
},
"origin": {
"type": "string",
"maxLength": 262144,
"description": "Product source, domestic or foreig (BR region). |0 - National, except for those indicated in codes 3, 4, 5, and 8| |1 - Foreign: Direct import, except for that indicated in code 6| |2 - Foreign: Acquired in the domestic market, except for that indicated in code 7| |3 - National: Goods or products with Import Content greater than 40% and less than or equal to 70%| |4 - National: Produced in compliance with the basic production processes outlined in the legislations cited in the Agreements| |5 - National: Goods or products with Import Content less than or equal to 40%| |6 - Foreign: Direct import, without a national equivalent, listed by CAMEX and natural gas| |7 - Foreign: Acquired in the domestic market, without a national equivalent, listed by CAMEX and natural gas| |8 - National: Goods or products with Import Content greater than 70%|"
},
"cest": {
"type": "string",
"maxLength": 262144,
"description": "Tax Replacement Specifying Code (CEST), to separate within the same NCM products that do or do not have ICMS tax substitution. (BR region) CEST must have 7 digits, OR, if your item doesn't have a CEST enter the value \"00\"."
},
"measure_unit": {
"type": "string",
"maxLength": 262144,
"description": "(BR region) The value must be provided in uppercase and must match one of the supported units below: AMPOLA, BALDE, BANDEJ, BARRA, BISNAG, BLOCO, BOBINA, BOMB, CAPS, CART, CENTO, CJ, CM, CM2, CX, CX2, CX3, CX5, CX10, CX15, CX20, CX25, CX50, CX100, DISP, DUZIA, EMBAL, FARDO, FOLHA, FRASCO, GALAO, GF, GRAMAS, JOGO, KG, KIT, LATA, LITRO, M, M2, M3, MILHEI, ML, MWH, PACOTE, PALETE, PARES, PC, POTE, K, RESMA, ROLO, SACO, SACOLA, TAMBOR, TANQUE, TON, TUBO, UN, VASIL, VIDRO."
},
"tax_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "tax_type only for TW whitelist shop. Shopee will referred Tax type when substitute sellers for issuing e-receipts to buyers. All variations share the same tax type. The meaning of value: 0: no tax type 1: tax-able 2: tax-free"
},
"pis": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. PIS - Programa de Integração Social (Social Integration Program). It is a government tax to collect resources for the payment of unemployment insurance and other employee related rights. PIS % - the tax applied to this product"
},
"cofins": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. COFINS – Contribuição para Financiamento da Seguridade Social (Contribution for Social Security Funding). It is a government tax to collect resources for public health system and social security. COFINS % - the tax applied to this product"
},
"icms_cst": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. ICMS - Imposto sobre Circulação de Mercadorias e Serviços (Circulation of Goods and Services Tax). CST - Código da Situação Tributária (Tax Situation Code) is represented by a combination of 3 numbers with the purpose of demonstrating the origin of a product and determining the form of taxation that will apply to it. Therefore, each digit in the CST Table has a specific meaning: the first digit indicates the origin of the operation, the second digit represents the ICMS taxation on the operation and the third digit provides additional information about the form of taxation."
},
"pis_cofins_cst": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. The CST PIS/Cofins is a code on the Electronic Invoice (NF-e) that identifies the tax situation of PIS (Programa de Integração Social) and Cofins (Contribuição para o Financiamento da Seguridade Social) in sales of goods."
},
"federal_state_taxes": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. Enter the total percentage of the combination of federal, state, and municipal taxes, using up to two decimals."
},
"operation_type": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. 1: Retailer 2: Manufacturer"
},
"ex_tipi": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. The EXTIPI field in the NF-e (Nota Fiscal Eletrônica) is used to indicate if there's an exception to the IPI (Imposto sobre Produtos Industrializados) tax rate for a specific product."
},
"fci_num": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. The FCI Control Number is a unique identifier assigned to each import FCI (Import Content Form). It's mandatory on the corresponding NF-e (electronic invoice) to ensure compliance with Brazilian import tax regulations."
},
"recopi_num": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. RECOPI NACIONAL is a Brazilian government system that facilitates the registration and management of tax-exempt operations involving paper destined for printing books, newspapers, and periodicals (known as \"papel imune\" in Portuguese)."
},
"additional_info": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. Include relevant information to display on Invoice."
},
"group_item_info": {
"type": "object",
"properties": {
"group_qtd": {
"type": "string",
"maxLength": 262144,
"description": "Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unit), enter 6."
},
"group_unit": {
"type": "string",
"maxLength": 262144,
"description": "Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unit), enter UNI for the individual can."
},
"group_unit_value": {
"type": "string",
"maxLength": 262144,
"description": "Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unity), enter the value of the individual can."
},
"original_group_price": {
"type": "string",
"maxLength": 262144,
"description": "Example: The item is a package that contains 6 soda cans. Enter the price of the whole package."
},
"group_gtin_sscc": {
"type": "string",
"maxLength": 262144,
"description": "Example: The item is a package that contains 6 soda cans. Please inform the GTIN SSCC code for the package."
},
"group_grai_gtin_sscc": {
"type": "string",
"maxLength": 262144,
"description": "Example: The item is box, that contain 6 packages. Each package contains 6 soda cans. Please inform the GRAI GTIN SSCC code for the Box."
}
},
"required": [],
"additionalProperties": false,
"description": "Only for BR shop. Required if the item is a group item."
},
"export_cfop": {
"type": "string",
"maxLength": 262144,
"description": "[BR region] 7101 - for sales of self-produced goods 7102 - resale of third-party goods"
}
},
"required": [],
"additionalProperties": false,
"description": "Tax information"
},
"complaint_policy": {
"type": "object",
"properties": {
"warranty_time": {
"type": "string",
"maxLength": 262144,
"description": "Value should be in one of ONE_YEAR TWO_YEARS OVER_TWO_YEARS."
},
"exclude_entrepreneur_warranty": {
"type": "boolean",
"description": "Whether to exclude warranty complaints for entrepreneurs.If True means \"I exclude warranty complaints for entrepreneur\""
},
"complaint_address_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Address for complaint. Fetch available addresses using v2.logistics.get_address_list, and use address_id returned from it."
},
"additional_information": {
"type": "string",
"maxLength": 262144,
"description": "Additional information for warranty claim. Should be less than 1000 characters."
}
},
"required": [],
"additionalProperties": false,
"description": "Complaint Policy for item. Only required for local PL sellers, ignored otherwise."
},
"description_info": {
"type": "object",
"properties": {
"extended_description": {
"type": "object",
"properties": {
"field_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_type": {
"type": "string",
"maxLength": 262144,
"description": "Type of extended description field :values: See Data Definition- description_field_type (text , image)."
},
"text": {
"type": "string",
"maxLength": 262144,
"description": "If field_type is text, text information will be set by this field."
},
"image_info": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"maxLength": 262144,
"description": "Image id."
}
},
"required": [],
"additionalProperties": false,
"description": "If field_type is image,image url will be set by this field."
}
},
"required": [],
"additionalProperties": false
},
"maxItems": 10,
"description": "Field of extended description."
}
},
"required": [],
"additionalProperties": false,
"description": "If description_type is extended , Description information should be set by this field."
}
},
"required": [],
"additionalProperties": false,
"description": "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"
},
"description_type": {
"type": "string",
"maxLength": 262144,
"description": "Values: See Data Definition- description_type (normal , extended). If you want to use extended_description, this field must be inputed"
},
"seller_stock": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"maxLength": 262144,
"description": "location id"
},
"stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "stock"
}
},
"required": [
"stock"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "seller stock(Please notice that stock(including Seller Stock and Shopee Stock) should be larger than or equal to real-time reserved stock)"
},
"gtin_code": {
"type": "string",
"maxLength": 262144,
"description": "- GTIN is an identifier for trade items, developed by the international organization GS1. - They have 8 to 14 digits. The most common are UPC, EAN, JAN and ISBN. - GTIN will help boost positioning in online marketing channels like Google and Facebook. - That incorporation with GTIN will also aid in Search and Recommendation in Shopee itself allowing buyers to have higher likelihood of finding one's listing. Note: If you want to set “Item without GTIN”, please pass the gtin_code as \"00\". The validation rule is based on the value return in gtin_validation_rule\" field in v2.product.get_item_limit API - Mandatory : This field is required and must contain a correctly formatted GTiN number. - Flexible : This field is required and must contain either a correctly formatted GTlN number or \"00\" to declare that the item/model has no valid GTlN. - Optional: This field is optional and can contain a correctly formatted GTiN number, \"00\" or be omitted entirely."
},
"ds_cat_rcmd_id": {
"type": "string",
"maxLength": 262144,
"description": "category recommendation service id"
},
"promotion_images": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "Promotion Image"
}
},
"required": [],
"additionalProperties": false,
"description": "Promotion Image Currently only allow one promoton image You could set promotion image only if the product images' ratio is 3:4"
},
"compatibility_info": {
"type": "object",
"properties": {
"vehicle_info_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the brand."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the model."
},
"year_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the year."
},
"version_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the version."
}
},
"required": [
"brand_id",
"model_id"
],
"additionalProperties": false
},
"maxItems": 10
}
},
"required": [
"vehicle_info_list"
],
"additionalProperties": false
},
"scheduled_publish_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Scheduled publish time of this item: 1) Can only set scheduled_publish_time for item with UNLIST status 2) Can only set the time from current time +1hour to current time +90days, and the time is only allowed to be accurate to the minute"
},
"authorised_brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of authorised reseller brand."
},
"size_chart_info": {
"type": "object",
"properties": {
"size_chart": {
"type": "string",
"maxLength": 262144,
"description": "ID of size chart image. If you want to remove the image size chart of the item, please pass the \"size_chart\" empty. You only need to fill out either the image or template. If both are filled, only the template will be kept. Notes: Both CB shops and local shops are supported to set \"size_chart\"."
},
"size_chart_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of template size chart. If you want to remove the template size chart of the item, please pass the \"size_chart_id\" as 0. You only need to fill out either the image or template. If both are filled, only the template will be kept. Notes: Only local shops are supported to set \"size_chart_id\", for CB shops please use \"size_chart\"."
}
},
"required": [],
"additionalProperties": false
},
"certification_info": {
"type": "object",
"properties": {
"certification_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"certification_no": {
"type": "string",
"maxLength": 262144,
"description": "Certification No."
},
"permit_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Permit ID, get from v2.product.get_product_certification_rule"
},
"expiry_date": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Expiry timestamp. Required for PH, but not needed for TW."
},
"certification_proofs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"file_name": {
"type": "string",
"maxLength": 262144,
"description": "The name of the uploaded certification proof file."
},
"image_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The unique image ID of the certification proof, returned by the image upload API."
},
"ratio": {
"type": "number",
"description": "image weight/ image height Will be optional in the future; can input 0.75 by default"
}
},
"required": [
"file_name",
"image_id",
"ratio"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "An array of proof documents for the certification; each element represents one proof file.<path></path>"
}
},
"required": [
"certification_no",
"permit_id",
"certification_proofs"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Array of certification records for the product, each containing type, certificate number, permit ID, and proof documents."
}
},
"required": [],
"additionalProperties": false,
"description": "For PH product certification input Required for some category and attribute option"
},
"purchase_limit_info": {
"type": "object",
"properties": {
"min_purchase_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "minimum purchase count for each order"
},
"max_purchase_limit": {
"type": "object",
"properties": {
"purchase_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "maximum purchase limit for each order."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false,
"description": "purchase limit info"
},
"medicine_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "[Only for ID local sellers] as a unique identifier for each standardized medicine, the medicine id can only be obtained offline"
},
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the Standardized Shop Product (SSP) to associate with the default model of the new item. The value must be greater than 0 when provided. If ssp_id is provided, cssp_id must also be provided."
},
"cssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the country-specific Standardized Shop Product (CSSP) to associate with the default model of the new item. The value must be greater than 0 when provided. This field is required when ssp_id is provided."
}
},
"required": [
"original_price",
"description",
"weight",
"item_name",
"logistic_info",
"category_id",
"image"
],
"additionalProperties": false,
"description": "v2.product.add_item\nAdd a new item.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking"
},
"response": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description of item"
},
"weight": {
"type": "number",
"description": "The weight of this item, the unit is KG."
},
"pre_order": {
"type": "object",
"properties": {
"days_to_ship": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The guaranteed days to ship orders."
},
"is_pre_order": {
"type": "boolean",
"description": "Whether this item is pre order"
}
},
"additionalProperties": true,
"description": "Pre order setting"
},
"item_name": {
"type": "string",
"description": "Item name"
},
"images": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "ID of image"
},
"image_url_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "Display URL of image"
}
},
"additionalProperties": true,
"description": "Item images"
},
"item_status": {
"type": "string",
"description": "Item status"
},
"price_info": {
"type": "object",
"properties": {
"current_price": {
"type": "number",
"description": "Current price of item"
},
"original_price": {
"type": "number",
"description": "Original price of item"
}
},
"additionalProperties": true,
"description": "Item price info"
},
"logistic_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"size_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Size ID"
},
"shipping_fee": {
"type": "number",
"description": "Shipping fee"
},
"enabled": {
"type": "boolean",
"description": "Whether this channel is enabled for this item"
},
"logistic_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Logistic channel ID"
},
"is_free": {
"type": "boolean",
"description": "Whether cover shipping fee for buyer"
}
},
"additionalProperties": true
},
"description": "Logistic setting"
},
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item ID"
},
"attribute": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Attribute ID"
},
"attribute_value_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"original_value_name": {
"type": "string",
"description": "Value name"
},
"value_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Value ID"
},
"value_unit": {
"type": "string",
"description": "Unit of attribute value"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"description": "Item attributes"
},
"category_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Category ID"
},
"dimension": {
"type": "object",
"properties": {
"package_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The width of package for this item, the unit is CM."
},
"package_length": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The length of package for this item, the unit is CM."
},
"package_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The height of package for this item, the unit is CM."
}
},
"additionalProperties": true,
"description": "The dimension of this item."
},
"condition": {
"type": "string",
"description": "Item condition, could be NEW or USED"
},
"video_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"video_url": {
"type": "string",
"description": "Video playback url"
},
"thumbnail_url": {
"type": "string",
"description": "Video preview image url"
},
"duration": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Video duration"
}
},
"additionalProperties": true
},
"description": "Item video"
},
"wholesale": {
"type": "array",
"items": {
"type": "object",
"properties": {
"min_count": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Minimum count of this tier"
},
"max_count": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Maximum count of this tier"
},
"unit_price": {
"type": "number",
"description": "Unit price of this tier"
}
},
"additionalProperties": true
},
"description": "Wholesale setting"
},
"brand": {
"type": "object",
"properties": {
"brand_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Id of brand."
},
"original_brand_name": {
"type": "string",
"description": "Original name of brand."
}
},
"additionalProperties": true
},
"item_dangerous": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "This field is only applicable for local sellers in Indonesia and Malaysia. Use this field to identify whether a product is a dangerous product. 0 for non-dangerous product and 1 for dangerous product. For more information, please visit the market's respective Seller Education Hub."
},
"description_info": {
"type": "object",
"properties": {
"extended_description": {
"type": "object",
"properties": {
"field_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_type": {
"type": "string",
"description": "Type of extended description field :values: See Data Definition- description_field_type (text , image)."
},
"text": {
"type": "string",
"description": "If field_type is text, text information will be set by this field."
},
"image_info": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"description": "Image id."
}
},
"additionalProperties": true,
"description": "If field_type is image, image url will be set by this field."
}
},
"additionalProperties": true
},
"description": "Field of extended description."
}
},
"additionalProperties": true,
"description": "If description_type is extended , description information should be set by this field."
}
},
"additionalProperties": true,
"description": "New description field. Only whitelist sellers can use it. If item with extended_description this field will return, otherwise do not return."
},
"description_type": {
"type": "string",
"description": "Values: See Data Definition- description_type (normal , extended)."
},
"complaint_policy": {
"type": "object",
"properties": {
"warranty_time": {
"type": "string",
"description": "Time for a warranty claim. Could be ONE_YEAR, TWO_YEARS, OVER_TWO_YEARS."
},
"exclude_entrepreneur_warranty": {
"type": "boolean",
"description": "If True means \"I exclude warranty complaints for entrepreneur\""
},
"complaint_address_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of complaint address."
},
"additional_information": {
"type": "string",
"description": "Additional information for complaint policy."
}
},
"additionalProperties": true,
"description": "Complaint Policy for item. Only returned for local PL sellers."
},
"seller_stock": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"description": "location id"
},
"stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "stock"
}
},
"additionalProperties": true
},
"description": "seller stock"
}
},
"additionalProperties": true
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
}
},
"additionalProperties": true
}
},
"v2.product.update_item": {
"path": "/api/v2/product/update_item",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: update item",
"input_schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"maxLength": 262144,
"description": "Description of item."
},
"weight": {
"type": "number",
"description": "The weight of this item, the unit is KG. Updating the weight of this item will overwrite the weight of all models under this item."
},
"pre_order": {
"type": "object",
"properties": {
"days_to_ship": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Days to ship."
},
"is_pre_order": {
"type": "boolean",
"description": "Whether the item is pre order."
}
},
"required": [
"days_to_ship",
"is_pre_order"
],
"additionalProperties": false,
"description": "Pre Order setting."
},
"item_name": {
"type": "string",
"maxLength": 262144,
"description": "Item name."
},
"attribute_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "ID of attribute."
},
"attribute_value_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "ID of attribute value. In the following cases, the value id needs to be uploaded as 0, and original_value_name is mandatory, needs to be filled in customized value. (1) AttributeInputType is TEXT_FILED; (2) AttributeInputType is COMBO_BOX or MULTIPLE_SELECT_COMBO_BOX, and the seller want to fill in a customized value."
},
"original_value_name": {
"type": "string",
"maxLength": 262144,
"description": "Value name. original_value_name from produc.get_attributes api. If value id=0, this field is required. If AttributeType is DATE_TYPE or TIMESTAMP_TYPE, you can upload timestamp(string type) as the original_value_name."
},
"value_unit": {
"type": "string",
"maxLength": 262144,
"description": "Unit of attribute value (quantitative attribute only)."
}
},
"required": [
"value_id"
],
"additionalProperties": false
},
"maxItems": 10
}
},
"required": [
"attribute_id"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Item attributes."
},
"image": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "Image ID."
},
"image_ratio": {
"type": "string",
"maxLength": 262144,
"description": "Ratio of image, OptionalAllowed ratios : \"1:1\" (default) \"3:4\""
}
},
"required": [
"image_id_list"
],
"additionalProperties": false,
"description": "Images of item."
},
"item_sku": {
"type": "string",
"maxLength": 262144,
"description": "SKU tag for item."
},
"item_status": {
"type": "string",
"maxLength": 262144,
"description": "Item status, could be UNLIST or NORMAL."
},
"wholesale": {
"type": "array",
"items": {
"type": "object",
"properties": {
"min_count": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Minimum count of this tier."
},
"unit_price": {
"type": "number",
"description": "Price of this tier."
},
"max_count": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Maximum count of this tier."
}
},
"required": [
"min_count",
"unit_price",
"max_count"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Wholesale setting. If you want to delete it, please pass it with blank."
},
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of item."
},
"category_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "ID of category."
},
"dimension": {
"type": "object",
"properties": {
"package_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The height of package for this item, the unit is CM."
},
"package_length": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The length of package for this item, the unit is CM."
},
"package_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The width of package for this item, the unit is CM."
}
},
"required": [
"package_height",
"package_length",
"package_width"
],
"additionalProperties": false,
"description": "The dimension of this item. Updating the dimension of this item will overwrite the dimension of all models under this item."
},
"condition": {
"type": "string",
"maxLength": 262144,
"description": "Condition of item, could be NEW or USED."
},
"video_upload_id": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "Video upload ID returned from video uploading API. If you want to delete it, please pass it with blank."
},
"brand": {
"type": "object",
"properties": {
"brand_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Id of brand."
},
"original_brand_name": {
"type": "string",
"maxLength": 262144,
"description": "Original name of brand."
}
},
"required": [],
"additionalProperties": false
},
"item_dangerous": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "This field is only applicable for local sellers in Indonesia and Malaysia. Use this field to identify whether a product is a dangerous product. 0 for non-dangerous product and 1 for dangerous product. For more information, please visit the market's respective Seller Education Hub."
},
"tax_info": {
"type": "object",
"properties": {
"ncm": {
"type": "string",
"maxLength": 262144,
"description": "Mercosur Common Nomenclature, it is a convention between Mercosur member countries to easily recognize goods, services and productive factors negotiated among themselves. (BR region) NCM must have 8 digits, OR, if your item doesn't have a NCM enter the value \"00\""
},
"same_state_cfop": {
"type": "string",
"maxLength": 262144,
"description": "Tax Code of Operations and Installments for orders that seller and buyer are in the same state. It identifies a specific operation by category at the time of issuing the invoice."
},
"diff_state_cfop": {
"type": "string",
"maxLength": 262144,
"description": "Tax Code of Operations and Installments for orders that seller and buyer are in different states. It identifies a specific operation by category at the time of issuing the invoice."
},
"csosn": {
"type": "string",
"maxLength": 262144,
"description": "Code of Operation Status – Simples Nacional, code for company operations to identify the origin of the goods and the taxation regime of the operations."
},
"origin": {
"type": "string",
"maxLength": 262144,
"description": "Product source, domestic or foreig"
},
"cest": {
"type": "string",
"maxLength": 262144,
"description": "Tax Replacement Specifying Code (CEST), to separate within the same NCM products that do or do not have ICMS tax substitution. (BR region) CEST must have 7 digits, OR, if your item doesn't have a CEST enter the value \"00\"."
},
"measure_unit": {
"type": "string",
"maxLength": 262144,
"description": "(BR region) The value must be provided in uppercase and must match one of the supported units below: AMPOLA, BALDE, BANDEJ, BARRA, BISNAG, BLOCO, BOBINA, BOMB, CAPS, CART, CENTO, CJ, CM, CM2, CX, CX2, CX3, CX5, CX10, CX15, CX20, CX25, CX50, CX100, DISP, DUZIA, EMBAL, FARDO, FOLHA, FRASCO, GALAO, GF, GRAMAS, JOGO, KG, KIT, LATA, LITRO, M, M2, M3, MILHEI, ML, MWH, PACOTE, PALETE, PARES, PC, POTE, K, RESMA, ROLO, SACO, SACOLA, TAMBOR, TANQUE, TON, TUBO, UN, VASIL, VIDRO."
},
"invoice_option": {
"type": "string",
"maxLength": 262144,
"description": "Value shuold be one of NO_INVOICES VAT_MARGIN_SCHEME_INVOICES VAT_INVOICES NON_VAT_INVOICES and if value is NON_VAT_INVOICE vat_rate should be null (PL region)"
},
"vat_rate": {
"type": "string",
"maxLength": 262144,
"description": "Value should be one of 0% 5% 8% 23% NO_VAT_RATE (PL region)"
},
"hs_code": {
"type": "string",
"maxLength": 262144,
"description": "HS Code. (Only for IN region) Official limits: 1234"
},
"tax_code": {
"type": "string",
"maxLength": 262144,
"description": "Tax Code. (Only for IN region) Official limits: GEN_Zero"
},
"tax_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "tax_type only for TW whitelist shop. Shopee will referred Tax type when substitute sellers for issuing e-receipts to buyers. All variations share the same tax type. The meaning of value: 0: no tax type 1: tax-able 2: tax-free"
},
"pis": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. PIS - Programa de Integração Social (Social Integration Program). It is a government tax to collect resources for the payment of unemployment insurance and other employee related rights. PIS % - the tax applied to this product"
},
"cofins": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. COFINS – Contribuição para Financiamento da Seguridade Social (Contribution for Social Security Funding). It is a government tax to collect resources for public health system and social security. COFINS % - the tax applied to this product"
},
"icms_cst": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. ICMS - Imposto sobre Circulação de Mercadorias e Serviços (Circulation of Goods and Services Tax). CST - Código da Situação Tributária (Tax Situation Code) is represented by a combination of 3 numbers with the purpose of demonstrating the origin of a product and determining the form of taxation that will apply to it. Therefore, each digit in the CST Table has a specific meaning: the first digit indicates the origin of the operation, the second digit represents the ICMS taxation on the operation and the third digit provides additional information about the form of taxation."
},
"pis_cofins_cst": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. The CST PIS/Cofins is a code on the Electronic Invoice (NF-e) that identifies the tax situation of PIS (Programa de Integração Social) and Cofins (Contribuição para o Financiamento da Seguridade Social) in sales of goods."
},
"federal_state_taxes": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. Enter the total percentage of the combination of federal, state, and municipal taxes, using up to two decimals."
},
"operation_type": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. 1: Retailer 2: Manufacturer"
},
"ex_tipi": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. The EXTIPI field in the NF-e (Nota Fiscal Eletrônica) is used to indicate if there's an exception to the IPI (Imposto sobre Produtos Industrializados) tax rate for a specific product."
},
"fci_num": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. The FCI Control Number is a unique identifier assigned to each import FCI (Import Content Form). It's mandatory on the corresponding NF-e (electronic invoice) to ensure compliance with Brazilian import tax regulations."
},
"recopi_num": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. RECOPI NACIONAL is a Brazilian government system that facilitates the registration and management of tax-exempt operations involving paper destined for printing books, newspapers, and periodicals (known as \"papel imune\" in Portuguese)."
},
"additional_info": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. Include relevant information to display on Invoice."
},
"group_item_info": {
"type": "object",
"properties": {
"group_qtd": {
"type": "string",
"maxLength": 262144,
"description": "Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unit), enter 6."
},
"group_unit": {
"type": "string",
"maxLength": 262144,
"description": "Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unit), enter UNI for the individual can."
},
"group_unit_value": {
"type": "string",
"maxLength": 262144,
"description": "Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unity), enter the value of the individual can."
},
"original_group_price": {
"type": "string",
"maxLength": 262144,
"description": "Example: The item is a package that contains 6 soda cans. Enter the price of the whole package."
},
"group_gtin_sscc": {
"type": "string",
"maxLength": 262144,
"description": "Example: The item is a package that contains 6 soda cans. Please inform the GTIN SSCC code for the package."
},
"group_grai_gtin_sscc": {
"type": "string",
"maxLength": 262144,
"description": "Example: The item is box, that contain 6 packages. Each package contains 6 soda cans. Please inform the GRAI GTIN SSCC code for the Box."
}
},
"required": [],
"additionalProperties": false,
"description": "Only for BR shop. Required if the item is a group item."
},
"export_cfop": {
"type": "string",
"maxLength": 262144,
"description": "7101 - for sales of self-produced goods 7102 - resale of third-party goods"
}
},
"required": [],
"additionalProperties": false,
"description": "Tax information"
},
"complaint_policy": {
"type": "object",
"properties": {
"warranty_time": {
"type": "string",
"maxLength": 262144,
"description": "Value should be in one of ONE_YEAR TWO_YEARS OVER_TWO_YEARS."
},
"exclude_entrepreneur_warranty": {
"type": "boolean",
"description": "If True means \"I exclude warranty complaints for entrepreneur\""
},
"complaint_address_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Address for complaint. Fetch available addresses using v2.logistics.get_address_list, and use address_id returned from it."
},
"additional_information": {
"type": "string",
"maxLength": 262144,
"description": "Additional information for warranty claim. Should be less than 1000 characters."
}
},
"required": [],
"additionalProperties": false,
"description": "Complaint Policy for item. Only required for local PL sellers, ignored otherwise."
},
"description_info": {
"type": "object",
"properties": {
"extended_description": {
"type": "object",
"properties": {
"field_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_type": {
"type": "string",
"maxLength": 262144,
"description": "Type of extended description field :values: See Data Definition- description_field_type (text , image)."
},
"text": {
"type": "string",
"maxLength": 262144,
"description": "If field_type is text, text information will be set by this field."
},
"image_info": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"maxLength": 262144,
"description": "Image id."
}
},
"required": [],
"additionalProperties": false,
"description": "If field_type is image,image url will be set by this field."
}
},
"required": [],
"additionalProperties": false
},
"maxItems": 10,
"description": "Field of extended description."
}
},
"required": [],
"additionalProperties": false,
"description": "If description_type is extended , description information should be set by this field."
}
},
"required": [],
"additionalProperties": false,
"description": "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"
},
"description_type": {
"type": "string",
"maxLength": 262144,
"description": "Values: See Data Definition- description_type (normal , extended). If you want to use extended_description or change description type ,this field must be inputed"
},
"gtin_code": {
"type": "string",
"maxLength": 262144,
"description": "- GTIN is an identifier for trade items, developed by the international organization GS1. - They have 8 to 14 digits. The most common are UPC, EAN, JAN and ISBN. - GTIN will help boost positioning in online marketing channels like Google and Facebook. - That incorporation with GTIN will also aid in Search and Recommendation in Shopee itself allowing buyers to have higher likelihood of finding one's listing. Note: If you want to set “Item without GTIN”, please pass the gtin_code as \"00\". The validation rule is based on the value return in gtin_validation_rule\" field in v2.product.get_item_limit API - Mandatory: This field is required and must contain a correctly formatted GTiN number. - Flexible: This field is required and must contain either a correctly formatted GTlN number or \"00\" to declare that the item/model has no valid GTlN. - Optional: This field is optional and can contain a correctly formatted GTiN number, \"00\" or be omitted entirely."
},
"ds_cat_rcmd_id": {
"type": "string",
"maxLength": 262144,
"description": "category recommendation service id"
},
"promotion_images": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "Promotion Image"
}
},
"required": [],
"additionalProperties": false,
"description": "Promotion Image Currently only allow one promoton image You could set promotion image only if the product images' ratio is 3:4"
},
"compatibility_info": {
"type": "object",
"properties": {
"vehicle_info_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the brand."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the model."
},
"year_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the year."
},
"version_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the version."
}
},
"required": [
"brand_id",
"model_id"
],
"additionalProperties": false
},
"maxItems": 10
}
},
"required": [
"vehicle_info_list"
],
"additionalProperties": false
},
"scheduled_publish_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Scheduled publish time of this item: 1) Can only set scheduled_publish_time for item with UNLIST status 2) Can only set the time from current time +1hour to current time +90days, and the time is only allowed to be accurate to the minute"
},
"authorised_brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of authorised reseller brand."
},
"size_chart_info": {
"type": "object",
"properties": {
"size_chart": {
"type": "string",
"maxLength": 262144,
"description": "ID of size chart image. If you want to remove the image size chart of the item, please pass the \"size_chart\" empty. You only need to fill out either the image or template. If both are filled, only the template will be kept. Notes: Both CB shops and local shops are supported to set \"size_chart\"."
},
"size_chart_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of template size chart. If you want to remove the template size chart of the item, please pass the \"size_chart_id\" as 0. You only need to fill out either the image or template. If both are filled, only the template will be kept. Notes: Only local shops are supported to set \"size_chart_id\", for CB shops please use \"size_chart\"."
}
},
"required": [],
"additionalProperties": false
},
"certification_info": {
"type": "object",
"properties": {
"certification_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"certification_no": {
"type": "string",
"maxLength": 262144,
"description": "Certification number issued by the regulatory or certifying authority; uniquely identifies the certification. refer to https://seller.shopee.ph/edu/article/24236"
},
"permit_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Platform-defined permit ID used to link to a specific certification template or rule. get from v2.product.get_product_certification_rule"
},
"expiry_date": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Expiry timestamp. Required for PH, but not needed for TW."
},
"certification_proofs": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"maxLength": 262144,
"description": "The unique image ID of the certification proof, returned by the image upload API."
},
"file_name": {
"type": "string",
"maxLength": 262144,
"description": "The name of the uploaded certification proof file."
},
"ratio": {
"type": "number",
"description": "image weight/ image height Will be optional in the future; can input 0.75 by default"
}
},
"required": [
"image_id",
"file_name",
"ratio"
],
"additionalProperties": false,
"description": "An array of proof documents for the certification; each element represents one proof file.<path></path>"
}
},
"required": [
"certification_no",
"permit_id"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Array of certification records for the product, each containing type, certificate number, permit ID, and proof documents."
}
},
"required": [],
"additionalProperties": false,
"description": "For PH product certification input Required for some category and attribute option"
},
"purchase_limit_info": {
"type": "object",
"properties": {
"min_purchase_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "minimum purchase count for each order"
},
"max_purchase_limit": {
"type": "object",
"properties": {
"purchase_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "maximum purchase limit for each order."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false,
"description": "purchase limit info"
},
"medicine_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "[Only for ID local sellers] as a unique identifier for each standardized medicine, the medicine id can only be obtained offline"
}
},
"required": [
"item_id"
],
"additionalProperties": false,
"description": "v2.product.update_item\nUpdate item.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Item description."
},
"weight": {
"type": "number",
"description": "The weight of this item, the unit is KG."
},
"pre_order": {
"type": "object",
"properties": {
"days_to_ship": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The time it takes to ship the item."
},
"is_pre_order": {
"type": "boolean",
"description": "Whether item is pre order."
}
},
"additionalProperties": true
},
"item_name": {
"type": "string",
"description": "Item name."
},
"item_status": {
"type": "string",
"description": "Item status."
},
"images": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "ID list of item image."
},
"image_url_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "URL list of item image"
}
},
"additionalProperties": true,
"description": "Item images."
},
"logistic_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"estimated_shipping_fee": {
"type": "number",
"description": "Estimated shipping fee."
},
"logistic_name": {
"type": "string",
"description": "Name of logistics channel."
},
"enabled": {
"type": "boolean",
"description": "Whether this channel is enabled."
},
"logistic_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "ID of this channel."
},
"is_free": {
"type": "boolean",
"description": "Whether cover shipping fee for buyer."
}
},
"additionalProperties": true
}
},
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of item."
},
"category_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "ID of item category."
},
"dimension": {
"type": "object",
"properties": {
"package_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The width of package for this item, the unit is CM."
},
"package_length": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The length of package for this item, the unit is CM."
},
"package_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The height of package for this item, the unit is CM."
}
},
"additionalProperties": true,
"description": "The dimension of this item."
},
"condition": {
"type": "string",
"description": "Item condition, could be USED or NEW."
},
"brand": {
"type": "object",
"properties": {
"brand_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Id of brand."
},
"original_brand_name": {
"type": "string",
"description": "Original name of brand."
}
},
"additionalProperties": true
},
"item_dangerous": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "This field is only applicable for local sellers in Indonesia and Malaysia. Use this field to identify whether a product is a dangerous product. 0 for non-dangerous product and 1 for dangerous product. For more information, please visit the market's respective Seller Education Hub."
},
"complaint_policy": {
"type": "object",
"properties": {
"warranty_time": {
"type": "string",
"description": "Value should be in one of ONE_YEAR TWO_YEARS OVER_TWO_YEARS."
},
"exclude_entrepreneur_warranty": {
"type": "boolean",
"description": "If True means \"I exclude warranty complaints for entrepreneur\""
},
"additional_information": {
"type": "string",
"description": "Additional information for complaint policy"
}
},
"additionalProperties": true,
"description": "Complaint policy"
},
"description_info": {
"type": "object",
"properties": {
"extended_description": {
"type": "object",
"properties": {
"field_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_type": {
"type": "string",
"description": "Type of extended description field :values: See Data Definition- description_field_type (text , image)."
},
"text": {
"type": "string",
"description": "If field_type is text, text information will be set by this field."
},
"image_info": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"description": "Image id."
}
},
"additionalProperties": true,
"description": "If field_type is image,image url will be set by this field."
}
},
"additionalProperties": true
},
"description": "Field of extended description."
}
},
"additionalProperties": true,
"description": "If description_type is extended , description information should be set by this field."
}
},
"additionalProperties": true,
"description": "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"
},
"description_type": {
"type": "string",
"description": "Values: See Data Definition- description_type (normal , extended)."
}
},
"additionalProperties": true
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
}
},
"additionalProperties": true
}
},
"v2.product.delete_item": {
"path": "/api/v2/product/delete_item",
"method": "POST",
"risk": "D",
"identity": "Shop",
"description": "product: delete item",
"input_schema": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of product item."
}
},
"required": [
"item_id"
],
"additionalProperties": false,
"description": "v2.product.delete_item\nUse this call to delete a product item.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking"
}
},
"additionalProperties": true
}
},
"v2.product.init_tier_variation": {
"path": "/api/v2/product/init_tier_variation",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: init tier variation",
"input_schema": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of item"
},
"model": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tier_index": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"maxItems": 10,
"description": "Tier index of this model. If you want to update one tier/two tier to no tier, can just pass the tier_variation and standardise_tier_variation as [], and pass the model >> tier_index as [], meanwhile pass the original_price, seller_stock, etc., to set the price and stock for the modified product with no tier structure."
},
"original_price": {
"type": "number",
"description": "Original price of this model. For CO local VAT responsible seller: Please remember the price you set in here must be VAT inclusive. If you have any doubts on how to calculate VAT for your product please refer to the Seller Education Hub(https://seller.shopee.com.co/edu/article/13565)"
},
"model_sku": {
"type": "string",
"maxLength": 262144,
"description": "Seller SKU of this model, model_sku length information needs to be no more than 100 characters."
},
"seller_stock": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"maxLength": 262144,
"description": "location id, you can get the location id from v2.shop.get_warehouse_detail api, if seller don't have any warehouse, you don't need to upload this field."
},
"stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "stock"
}
},
"required": [
"stock"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "new stock info(Please notice that stock(including Seller Stock and Shopee Stock) should be larger than or equal to real-time reserved stock)"
},
"gtin_code": {
"type": "string",
"maxLength": 262144,
"description": "- GTIN is an identifier for trade items, developed by the international organization GS1. - They have 8 to 14 digits. The most common are UPC, EAN, JAN and ISBN. - GTIN will help boost positioning in online marketing channels like Google and Facebook. - That incorporation with GTIN will also aid in Search and Recommendation in Shopee itself allowing buyers to have higher likelihood of finding one's listing. Note: If you want to set “Item without GTIN”, please pass the gtin_code as \"00\". The validation rule is based on the value return in gtin_validation_rule\" field in v2.product.get_item_limit API - Mandatory : This field is required and must contain a correctly formatted GTiN number. - Flexible : This field is required and must contain either a correctly formatted GTlN number or \"00\" to declare that the item/model has no valid GTlN. - Optional : This field is optional and can contain a correctly formatted GTiN number, \"00\" or be omitted entirely."
},
"weight": {
"type": "number",
"description": "The weight of this model, the unit is KG. If don't set the weight of this model, will use the weight of item by default. If set the dimension of this model, them must set the weight of this model."
},
"dimension": {
"type": "object",
"properties": {
"package_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The height of package for this model, the unit is CM."
},
"package_length": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The length of package for this model, the unit is CM."
},
"package_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The width of package for this model, the unit is CM."
}
},
"required": [
"package_height",
"package_length",
"package_width"
],
"additionalProperties": false,
"description": "The dimension of this model. If don't set the dimension of this model, will use the dimension of item by default."
},
"pre_order": {
"type": "object",
"properties": {
"is_pre_order": {
"type": "boolean",
"description": "Whether the model is pre order."
},
"days_to_ship": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Days to ship. Please get the days_to_ship range from the get_dts_limit API."
}
},
"required": [
"is_pre_order"
],
"additionalProperties": false,
"description": "Pre-order information of this model. Notes: If don't set the DTS of this model, will use the DTS of the item by default."
},
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the Standardized Shop Product (SSP) to associate with the default model of the new item. The value must be greater than 0 when provided. If ssp_id is provided, cssp_id must also be provided."
},
"cssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the country-specific Standardized Shop Product (CSSP) to associate with the default model of the new item. The value must be greater than 0 when provided. This field is required when ssp_id is provided."
}
},
"required": [
"tier_index",
"original_price",
"seller_stock"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Model info list, model number at most 50"
},
"standardise_tier_variation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variation_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "standardise tier variation ID."
},
"variation_name": {
"type": "string",
"maxLength": 262144,
"description": "standardise tier variation name"
},
"variation_group_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "standardise tier variation group ID"
},
"variation_option_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variation_option_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "standardise tier variation option ID."
},
"variation_option_name": {
"type": "string",
"maxLength": 262144,
"description": "standardise tier variation option value"
},
"image_id": {
"type": "string",
"maxLength": 262144,
"description": "standardise tier variation option image ID"
}
},
"required": [],
"additionalProperties": false
},
"maxItems": 10,
"description": "standardise tier variation option list"
}
},
"required": [
"variation_id",
"variation_option_list"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "There is at least one standardise_tier_variation and tier_variation. If you want to update one tier/two tier to no tier, can just pass the tier_variation and standardise_tier_variation as [], and pass the model >> tier_index as [], meanwhile pass the original_price, seller_stock, etc., to set the price and stock for the modified product with no tier structure."
}
},
"required": [
"item_id",
"model"
],
"additionalProperties": false,
"description": "v2.product.init_tier_variation\nThis API allows you to update the tier structure of a product. Defining only color creates one tier, while color + size creates two tiers (maximum supported). Supported changes include: no tier ↔ one/two tiers, one tier ↔ two/no tier, and two tiers ↔ one/no tier. For details, see Developer Guide. Please wait at least 5 seconds after creating an item before creating variants, as processing may be delayed.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking"
},
"response": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of item"
},
"tier_variation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Variation name"
},
"option_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"image": {
"type": "object",
"properties": {
"image_url": {
"type": "string",
"description": "URL of image"
}
},
"additionalProperties": true,
"description": "Image of this option"
},
"option": {
"type": "string",
"description": "Option name"
}
},
"additionalProperties": true
},
"description": "Options of this variation"
}
},
"additionalProperties": true
},
"description": "Variations of item"
},
"model": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tier_index": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": true
},
"description": "Tier index of model. Index starts from 0."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of model"
},
"model_sku": {
"type": "string",
"description": "Seller SKU of this model"
},
"price_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"original_price": {
"type": "number",
"description": "Original price"
}
},
"additionalProperties": true
}
},
"seller_stock": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"description": "location id"
},
"stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "stock"
}
},
"additionalProperties": true
},
"description": "new stock info"
},
"weight": {
"type": "number",
"description": "The weight of this model, the unit is KG. If don't set the weight of this model, will use the weight of item by default. If set the dimension of this model, them must set the weight of this model."
},
"dimension": {
"type": "object",
"properties": {
"package_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The height of package for this model, the unit is CM."
},
"package_length": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The length of package for this model, the unit is CM."
},
"package_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The width of package for this model, the unit is CM."
}
},
"additionalProperties": true,
"description": "The dimension of this model. If don't set the dimension of this model, will use the dimension of item by default."
},
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the Standardized Shop Product (SSP) to associate with the default model of the new item. The value must be greater than 0 when provided. If ssp_id is provided, cssp_id must also be provided."
},
"cssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the country-specific Standardized Shop Product (CSSP) to associate with the default model of the new item. The value must be greater than 0 when provided. This field is required when ssp_id is provided."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.update_tier_variation": {
"path": "/api/v2/product/update_tier_variation",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: update tier variation",
"input_schema": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of item."
},
"model_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of model"
},
"tier_index": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"maxItems": 10,
"description": "Model's tier_variation"
}
},
"required": [
"model_id",
"tier_index"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Item's model list"
},
"standardise_tier_variation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variation_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "standardise tier variation ID"
},
"variation_name": {
"type": "string",
"maxLength": 262144,
"description": "standardise tier variation name"
},
"variation_group_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "standardise tier variation group id"
},
"variation_option_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variation_option_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "standardise tier variation option ID"
},
"variation_option_name": {
"type": "string",
"maxLength": 262144,
"description": "standardise tier variation option value"
},
"image_id": {
"type": "string",
"maxLength": 262144,
"description": "ID of image"
}
},
"required": [
"variation_option_id"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "standardise tier variation option list"
}
},
"required": [
"variation_id",
"variation_option_list"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "item standardise tier variation There is at least one standardise_tier_variation and tier_variation"
}
},
"required": [
"item_id"
],
"additionalProperties": false,
"description": "v2.product.update_tier_variation\nThis api can only be used without changing the tier structure, you can add options, delete options, and update the option image by this api. More detail please check: https://open.shopee.com/developer-guide/219\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking"
}
},
"additionalProperties": true
}
},
"v2.product.get_model_list": {
"path": "/api/v2/product/get_model_list",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get model list",
"input_schema": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the item"
}
},
"required": [
"item_id"
],
"additionalProperties": false,
"description": "v2.product.get_model_list\nGet model list of an item.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"tier_variation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"option_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"option": {
"type": "string",
"description": "Option name."
},
"image": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"description": "Id of image"
},
"image_url": {
"type": "string",
"description": "Url of image."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"description": "Option list."
},
"name": {
"type": "string",
"description": "Variation name."
}
},
"additionalProperties": true
},
"description": "Variation config of item."
},
"model": {
"type": "array",
"items": {
"type": "object",
"properties": {
"price_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Currency for the item price."
},
"current_price": {
"type": "number",
"description": "Current price of item."
},
"original_price": {
"type": "number",
"description": "Original price of item."
},
"inflated_price_of_original_price": {
"type": "number",
"description": "Original price of item after tax."
},
"inflated_price_of_current_price": {
"type": "number",
"description": "Current price of item after tax."
},
"sip_item_price": {
"type": "number",
"description": "SIP item price. If item is from SIP primary shop, this field will be returned."
},
"sip_item_price_source": {
"type": "string",
"description": "SIP item price source, could be manual or auto.If item is from SIP primary shop, this field will be returned."
},
"sip_item_price_currency": {
"type": "string",
"description": "The currency of sip_item_price.If item is from SIP primary shop, this field will be returned."
},
"local_price": {
"type": "number",
"description": "The original price multiplied by the local adjustment rate equals the local price. The local price is denominated in the local currency and is rounded to two decimal places. <path></path>"
},
"local_promotion_price": {
"type": "number",
"description": "During the promotion period, the CB price is multiplied by the local adjustment rate. Once the promotion starts, the price remains unchanged. During the promotion, the local_promotion_price= current_price, which is denominated in the local currency and retained to two decimal places. <path></path>"
}
},
"additionalProperties": true
},
"description": "Price info. For SG/MY/BR/MX/PL/ES/AR seller: Sellers can set the price with two decimal place, other regions can only set the price as an integer."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Model ID."
},
"tier_index": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"description": "Tier index of this model."
},
"promotion_id": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,19})$"
}
],
"x-integer": "uint64",
"description": "Current promotion ID of this model."
},
"has_promotion": {
"type": "boolean",
"description": "Indicates whether the model is currently under any ongoing promotion."
},
"model_sku": {
"type": "string",
"description": "SKU of this model. the length should be under 100."
},
"model_status": {
"type": "string",
"description": "The model status. Should be MODEL_NORMAL or MODEL_UNAVAILABLE. MODEL_NORMAL models can be sold on the buyer's side, and MODEL_UNAVAILABLE models cannot be sold on the buyer's side."
},
"pre_order": {
"type": "object",
"properties": {
"is_pre_order": {
"type": "boolean",
"description": "Pre-order."
},
"days_to_ship": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The days to ship."
}
},
"additionalProperties": true,
"description": "(Only whitelisted users can use)"
},
"stock_info_v2": {
"type": "object",
"properties": {
"summary_info": {
"type": "object",
"properties": {
"total_reserved_stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Stock reserved for promotion. Note: For SIP P Item, will return the total reserved stock for P Item and all A Items under the P Item."
},
"total_available_stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Stock can be sold currently"
}
},
"additionalProperties": true,
"description": "stock summary Info"
},
"seller_stock": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"description": "location id"
},
"stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "stock in the current warehouse"
},
"if_saleable": {
"type": "boolean",
"description": "To return if the stock of the location id is saleable"
}
},
"additionalProperties": true
},
"description": "Seller-managed stock"
},
"shopee_stock": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"description": "location id"
},
"stock": {
"type": "string",
"description": "stock"
}
},
"additionalProperties": true
},
"description": "Shopee warehouse stock"
},
"advance_stock": {
"type": "object",
"properties": {
"sellable_advance_stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Refers to Advance Fulfillment stock that Seller has shipped out and is available to be used to fulfill an order."
},
"in_transit_advance_stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Refers to Advance Fulfillment stock that seller has shipped out and is still in transit and unavailable to be used to fulfill an order."
}
},
"additionalProperties": true,
"description": "Only for PH/VN/ID/MY local selected shops."
}
},
"additionalProperties": true,
"description": "new stock info. Please check this FAQ for more detail: https://open.shopee.com/faq?top=162&sub=166&page=1&faq=230"
},
"gtin_code": {
"type": "string",
"description": "(Only TW seller and BR local seller available) gtin code."
},
"weight": {
"type": "string",
"description": "The weight of this model, the unit is KG. If don't set the weight of this model, will use the weight of item by default."
},
"dimension": {
"type": "object",
"properties": {
"package_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The height of package for this model, the unit is CM."
},
"package_length": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The length of package for this model, the unit is CM."
},
"package_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The width of package for this model, the unit is CM."
}
},
"additionalProperties": true,
"description": "The dimension of this model. If don't set the dimension of this model, will use the dimension of item by default."
},
"is_fulfillment_by_shopee": {
"type": "boolean",
"description": "whether model is fulfillment by shopee"
},
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the Standardized Shop Product (SSP) to associate with the default model of the new item. The value must be greater than 0 when provided. If ssp_id is provided, cssp_id must also be provided."
},
"cssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the country-specific Standardized Shop Product (CSSP) to associate with the default model of the new item. The value must be greater than 0 when provided. This field is required when ssp_id is provided."
}
},
"additionalProperties": true
},
"description": "Model list."
},
"standardise_tier_variation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variation_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Standardise Variation ID"
},
"variation_name": {
"type": "string",
"description": "Standardise Variation Name"
},
"variation_group_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Standardise Variation Group ID"
},
"variation_option_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variation_option_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Standardise Option ID"
},
"variation_option_name": {
"type": "string",
"description": "Standardise Option Name"
},
"image_id": {
"type": "string",
"description": "ID of image"
},
"image_url": {
"type": "string",
"description": "URL of image"
}
},
"additionalProperties": true
},
"description": "Standardise Variation Option List"
}
},
"additionalProperties": true
},
"description": "Standardise Variation config of item."
}
},
"additionalProperties": true
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
}
},
"additionalProperties": true
}
},
"v2.product.add_model": {
"path": "/api/v2/product/add_model",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: add model",
"input_schema": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of item"
},
"model_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tier_index": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"maxItems": 10,
"description": "Tier index of model"
},
"original_price": {
"type": "number",
"description": "Normal stock for price"
},
"model_sku": {
"type": "string",
"maxLength": 262144,
"description": "Seller sku, model_sku length information needs to be no more than 100 characters."
},
"seller_stock": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"maxLength": 262144,
"description": "location id, you can get the location id from v2.shop.get_warehouse_detail api, if seller don't have any warehouse, you don't need to upload this field."
},
"stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "stock"
}
},
"required": [
"stock"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "new stock info for model(Please notice that stock(including Seller Stock and Shopee Stock) should be larger than or equal to real-time reserved stock)"
},
"gtin_code": {
"type": "string",
"maxLength": 262144,
"description": "- GTIN is an identifier for trade items, developed by the international organization GS1. - They have 8 to 14 digits. The most common are UPC, EAN, JAN and ISBN. - GTIN will help boost positioning in online marketing channels like Google and Facebook. - That incorporation with GTIN will also aid in Search and Recommendation in Shopee itself allowing buyers to have higher likelihood of finding one's listing. Note: If you want to set “Item without GTIN”, please pass the gtin_code as \"00\". The validation rule is based on the value return in gtin_validation_rule\" field in v2.product.get_item_limit API - Mandatory : This field is required and must contain a correctly formatted GTiN number. - Flexible : This field is required and must contain either a correctly formatted GTlN number or \"00\" to declare that the item/model has no valid GTlN. - Optional : This field is optional and can contain a correctly formatted GTiN number, \"00\" or be omitted entirely."
},
"weight": {
"type": "number",
"description": "The weight of this model, the unit is KG. If don't set the weight of this model, will use the weight of item by default. If set the dimension of this model, them must set the weight of this model."
},
"dimension": {
"type": "object",
"properties": {
"package_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The height of package for this model, the unit is CM."
},
"package_length": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The length of package for this model, the unit is CM."
},
"package_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The width of package for this model, the unit is CM."
}
},
"required": [
"package_height",
"package_length",
"package_width"
],
"additionalProperties": false,
"description": "The dimension of this model. If don't set the dimension of this model, will use the dimension of item by default."
},
"pre_order": {
"type": "object",
"properties": {
"is_pre_order": {
"type": "boolean",
"description": "Whether the model is pre order."
},
"days_to_ship": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Days to ship. Please get the days_to_ship range from the get_dts_limit API."
}
},
"required": [
"is_pre_order"
],
"additionalProperties": false,
"description": "Pre-order information of this model. Notes: If don't set the DTS of this model, will use the DTS of the item by default."
},
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the Standardized Shop Product (SSP) to associate with the default model of the new item. The value must be greater than 0 when provided. If ssp_id is provided, cssp_id must also be provided."
},
"cssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the country-specific Standardized Shop Product (CSSP) to associate with the default model of the new item. The value must be greater than 0 when provided. This field is required when ssp_id is provided."
}
},
"required": [
"tier_index",
"original_price",
"seller_stock"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Model list Official limits: [1,50]",
"minItems": 1
}
},
"required": [
"item_id",
"model_list"
],
"additionalProperties": false,
"description": "v2.product.add_model\nAdd model. More detail please check: https://open.shopee.com/developer-guide/219\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string"
},
"response": {
"type": "object",
"properties": {
"model": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tier_index": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"description": "model tier index"
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of model"
},
"model_sku": {
"type": "string",
"description": "Seller SKU of this model, model_sku length information needs to be no more than 100 characters."
},
"price_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"original_price": {
"type": "number",
"description": "Original Price. For CO local VAT responsible seller: Please remember the price you set in here must be VAT inclusive. If you have any doubts on how to calculate VAT for your product please refer to the Seller Education Hub(https://seller.shopee.com.co/edu/article/13565)"
}
},
"additionalProperties": true
}
},
"seller_stock": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"description": "location id"
},
"stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "stock"
}
},
"additionalProperties": true
},
"description": "new stock info"
},
"weight": {
"type": "number",
"description": "The weight of this model, the unit is KG. If don't set the weight of this model, will use the weight of item by default. If set the dimension of this model, them must set the weight of this model."
},
"dimension": {
"type": "object",
"properties": {
"package_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The height of package for this model, the unit is CM."
},
"package_length": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The length of package for this model, the unit is CM."
},
"package_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The width of package for this model, the unit is CM."
}
},
"additionalProperties": true,
"description": "The dimension of this model. If don't set the dimension of this model, will use the dimension of item by default."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.update_model": {
"path": "/api/v2/product/update_model",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: update model",
"input_schema": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of item"
},
"model": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of model"
},
"model_sku": {
"type": "string",
"maxLength": 262144,
"description": "Seller SKU for model, model_sku length information needs to be no more than 100 characters. CNSC and KRSC sellers are not allowed to update the MPSKU model sku."
},
"pre_order": {
"type": "object",
"properties": {
"is_pre_order": {
"type": "boolean",
"description": "Pre-order"
},
"days_to_ship": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The days to ship. Only work for is_pre_order=true"
}
},
"required": [
"is_pre_order",
"days_to_ship"
],
"additionalProperties": false
},
"gtin_code": {
"type": "string",
"maxLength": 262144,
"description": "- GTIN is an identifier for trade items, developed by the international organization GS1. - They have 8 to 14 digits. The most common are UPC, EAN, JAN and ISBN. - GTIN will help boost positioning in online marketing channels like Google and Facebook. - That incorporation with GTIN will also aid in Search and Recommendation in Shopee itself allowing buyers to have higher likelihood of finding one's listing. Note: If you want to set “Item without GTIN”, please pass the gtin_code as \"00\". The validation rule is based on the value return in gtin_validation_rule\" field in v2.product.get_item_limit API - Mandatory : This field is required and must contain a correctly formatted GTiN number. - Flexible : This field is required and must contain either a correctly formatted GTlN number or \"00\" to declare that the item/model has no valid GTlN. - Optional : This field is optional and can contain a correctly formatted GTiN number, \"00\" or be omitted entirely."
},
"model_status": {
"type": "string",
"maxLength": 262144,
"description": "can be \"NORMAL\" or \"UNAVAILABLE\". Only CNSC and KRSC sellers can set the model_status. Normal models can be sold on the buyer's side, and UNAVAILABLE models cannot be sold on the buyer's side."
},
"weight": {
"type": "number",
"description": "The weight of this model, the unit is KG. If don't set the weight of this model, will use the weight of item by default. If set the dimension of this model, them must set the weight of this model."
},
"dimension": {
"type": "object",
"properties": {
"package_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The height of package for this model, the unit is CM."
},
"package_length": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The length of package for this model, the unit is CM."
},
"package_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The width of package for this model, the unit is CM."
}
},
"required": [
"package_height",
"package_length",
"package_width"
],
"additionalProperties": false,
"description": "The dimension of this model. If don't set the dimension of this model, will use the dimension of item by default."
}
},
"required": [
"model_id",
"model_sku"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Length should be between 1 to 50",
"minItems": 1
}
},
"required": [
"item_id",
"model"
],
"additionalProperties": false,
"description": "v2.product.update_model\nUpdate seller sku/ pre order/ model status for model.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking"
}
},
"additionalProperties": true
}
},
"v2.product.delete_model": {
"path": "/api/v2/product/delete_model",
"method": "POST",
"risk": "D",
"identity": "Shop",
"description": "product: delete model",
"input_schema": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of item."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of model."
}
},
"required": [
"item_id",
"model_id"
],
"additionalProperties": false,
"description": "v2.product.delete_model\nDelete item model.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
}
},
"additionalProperties": true
}
},
"v2.product.unlist_item": {
"path": "/api/v2/product/unlist_item",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: unlist item",
"input_schema": {
"type": "object",
"properties": {
"item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for an item"
},
"unlist": {
"type": "boolean",
"description": "Unlist or not"
}
},
"required": [
"item_id",
"unlist"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Length should be between 1 to 50.",
"minItems": 1
}
},
"required": [
"item_list"
],
"additionalProperties": false,
"description": "v2.product.unlist_item\nUnlist item.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier of the API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"failure_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Failed item id"
},
"failed_reason": {
"type": "string",
"description": "Failed reason"
}
},
"additionalProperties": true
}
},
"success_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Success item id"
},
"unlist": {
"type": "boolean",
"description": "Whether the item is unlisted"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.update_price": {
"path": "/api/v2/product/update_price",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: update price",
"input_schema": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of item."
},
"price_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "0 for no model item."
},
"original_price": {
"type": "number",
"description": "Original price for this model. For CO local VAT responsible seller: Please remember the price you set in here must be VAT inclusive. If you have any doubts on how to calculate VAT for your product please refer to the Seller Education Hub(https://seller.shopee.com.co/edu/article/13565) For SG/MY/BR/MX/PL/ES/AR seller: Sellers can set the price with two decimal place, other regions can only set the price as an integer."
}
},
"required": [
"original_price"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Length should be between 1 to 50.",
"minItems": 1
}
},
"required": [
"item_id",
"price_list"
],
"additionalProperties": false,
"description": "v2.product.update_price\nUpdate price.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"failure_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of model."
},
"failed_reason": {
"type": "string",
"description": "Reason for failure."
}
},
"additionalProperties": true
},
"description": "Fail model list."
},
"success_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of model."
},
"original_price": {
"type": "number",
"description": "Original price for model."
}
},
"additionalProperties": true
},
"description": "Success model list."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.update_stock": {
"path": "/api/v2/product/update_stock",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: update stock",
"input_schema": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of item."
},
"stock_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "0 for no model item."
},
"seller_stock": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"maxLength": 262144,
"description": "location id, you can get the location id from v2.shop.get_warehouse_detail api, if seller don't have any warehouse, you don't need to upload this field."
},
"stock": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "stock"
}
},
"required": [
"stock"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "new stock info(Please notice that stock(including Seller Stock and Shopee Stock) should be larger than or equal to real-time reserved stock)"
}
},
"required": [
"seller_stock"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Length should be between 1 to 50.",
"minItems": 1
}
},
"required": [
"item_id",
"stock_list"
],
"additionalProperties": false,
"description": "v2.product.update_stock\nUse this API to update one item_id for each call, but still can support updating multiple model_ids stock of the same item_id (If you need batch modification, please call multiple times)This API will update only \"seller_stock\".Whenever there is a promotion ongoing or upcoming, the total stock must be larger than or equal to real-time “reserved_stock” promotion stock (Please check v2.get_item_promotion API for more details). Items that are deleted will not be allowed to modify stock.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"failure_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of model."
},
"failed_reason": {
"type": "string",
"description": "Reason for failure."
}
},
"additionalProperties": true
},
"description": "Fail model list."
},
"success_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of model."
},
"location_id": {
"type": "string",
"description": "location id; This field and the stock field are returned in pairs"
},
"stock": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "stock;This field is returned if seller stock is used in the request, and normal stock fields are not returned."
}
},
"additionalProperties": true
},
"description": "Success model list."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.boost_item": {
"path": "/api/v2/product/boost_item",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: boost item",
"input_schema": {
"type": "object",
"properties": {
"item_id_list": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"maxItems": 10,
"description": "Shopee's unique identifier for an item, limit:[1,5]"
}
},
"required": [
"item_id_list"
],
"additionalProperties": false,
"description": "v2.product.boost_item\nBoost item.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"failure_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Failed item ID."
},
"failed_reason": {
"type": "string",
"description": "Reason for failure."
}
},
"additionalProperties": true
}
},
"success_list": {
"type": "object",
"properties": {
"item_id_list": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"description": "Success item ID."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_boosted_list": {
"path": "/api/v2/product/get_boosted_list",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get boosted list",
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false,
"description": "v2.product.get_boosted_list\nGet boosted item list.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Shopee's unique identifier for an item"
},
"cool_down_second": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Remain cool down time"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_item_promotion": {
"path": "/api/v2/product/get_item_promotion",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get item promotion",
"input_schema": {
"type": "object",
"properties": {
"item_id_list": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"maxItems": 100,
"description": "Item ID list, can send 1 to 50 items."
}
},
"required": [
"item_id_list"
],
"additionalProperties": false,
"description": "v2.product.get_item_promotion\nGet item promotion info.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Waring message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"success_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "The identity of product item."
},
"promotion": {
"type": "array",
"items": {
"type": "object",
"properties": {
"promotion_type": {
"type": "string",
"description": "Promotion type, Applicable values: See Data Definition- PromotionType."
},
"promotion_id": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,19})$"
}
],
"x-integer": "uint64",
"description": "The identity of item promotion."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of product model."
},
"start_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Promotion start tiem."
},
"end_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Promotion end item."
},
"promotion_price_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"promotion_price": {
"type": "number",
"description": "Promotion price."
}
},
"additionalProperties": true
},
"description": "Promotion price info."
},
"promotion_staging": {
"type": "string",
"description": "Could be ongoing/upcoming"
},
"promotion_stock_info_v2": {
"type": "object",
"properties": {
"summary_info": {
"type": "object",
"properties": {},
"additionalProperties": true,
"description": "stock summary info"
},
"total_reserved_stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Total Stock reserved for promotion"
}
},
"additionalProperties": true,
"description": "new promotion stock"
}
},
"additionalProperties": true
},
"description": "Item promotion info list"
}
},
"additionalProperties": true
},
"description": "Success item promotion info."
},
"failure_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of item."
},
"failed_reason": {
"type": "string",
"description": "Fail reason."
}
},
"additionalProperties": true
},
"description": "Fail item promotion info."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.update_sip_item_price": {
"path": "/api/v2/product/update_sip_item_price",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: update sip item price",
"input_schema": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "ID of item."
},
"sip_item_price": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "0 for no model item."
},
"sip_item_price": {
"type": "number",
"description": "SIP item price."
}
},
"required": [
"sip_item_price"
],
"additionalProperties": false
},
"maxItems": 10
}
},
"required": [
"item_id"
],
"additionalProperties": false,
"description": "v2.product.update_sip_item_price\nUpdate sip item price.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
}
},
"additionalProperties": true
}
},
"v2.product.search_item": {
"path": "/api/v2/product/search_item",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: search item",
"input_schema": {
"type": "object",
"properties": {
"offset": {
"type": "string",
"maxLength": 262144,
"description": "Specifies the starting entry of data to return in the current call. Default is empty. if data is more than one page, the offset can be some entry to start next call."
},
"page_size": {
"description": "the size of one page. Official limits: [1,100]",
"x-pageMax": 100,
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"item_name": {
"type": "string",
"maxLength": 262144,
"description": "name of item."
},
"attribute_status": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "1:get item lack of requires attribute. 2:get item lack of optional attribute."
},
"item_sku": {
"type": "string",
"maxLength": 262144,
"description": "sku. If you search for item_sku and item_name at the same time, only the results that match item_sku will be returned. If you search for item_sku and attribute_status at the same time, the results that match both item_sku and attribute_status will be returned."
},
"item_status": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "NORMAL/BANNED/UNLIST/ REVIEWING/SELLER_DELETE/SHOPEE_DELETE If you want to search multiple status, please upload the url like this: item_status=NORMAL&item_status=BANNED"
},
"deboost_only": {
"type": "boolean",
"description": "If deboost_only is true, then API will return items whose deboost is true, if deboost_only is empty or false, then API will return items whose deboost is true and false simultaneously"
}
},
"required": [
"page_size"
],
"additionalProperties": false,
"description": "v2.product.search_item\nUse this call to search item.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking"
},
"response": {
"type": "object",
"properties": {
"item_id_list": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int"
},
"description": "List of item ID."
},
"total_count": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Total num of items match condation."
},
"next_offset": {
"type": "string",
"description": "If has_next_page is true, this value need set to next request.offset"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_comment": {
"path": "/api/v2/product/get_comment",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get comment",
"input_schema": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of product item."
},
"comment_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of comment."
},
"cursor": {
"type": "string",
"maxLength": 262144,
"description": "Specifies the starting entry of data to return in the current call. Default is \"\". If data is more than one page, the offset can be some entry to start next call."
},
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Each result set is returned as a page of entries. Use the \"page_size\" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single \"page\" of data. The limit of page_size if between 1 and 100.",
"x-pageMax": 100,
"default": 50
}
},
"required": [
"cursor",
"page_size"
],
"additionalProperties": false,
"description": "v2.product.get_comment\nUse this api to get comment by shop_id, item_id, or comment_id, get up to 1000 comments.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"more": {
"type": "boolean",
"description": "This is to indicate whether the comment list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of comments. But only respond 500 comments at most through OpenAPI, if there are more than 500, this field \"more\" also respond \"true\"."
},
"item_comment_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
},
"comment_id": {
"type": "string",
"description": "The identity of comment."
},
"comment": {
"type": "string",
"description": "The content of the comment."
},
"buyer_username": {
"type": "string",
"description": "The username of the buyer who posted the comment."
},
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The commented item's id"
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for a model of an item. It will only return 0 now. Will be offline on 2024-12-27 , please switch to use model_id_list."
},
"rating_star": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Buyer's rating for the item."
},
"editable": {
"type": "string",
"description": "The editable status of the comment. The value may be one of EXPIRED/EDITABLE/HAVE_EDIT_ONCE."
},
"hidden": {
"type": "boolean",
"description": "The comment is hidden or not."
},
"create_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The create time of the comment."
},
"comment_reply": {
"type": "object",
"properties": {
"reply": {
"type": "string",
"description": "The content of reply."
},
"hidden": {
"type": "boolean",
"description": "The comment reply is hidden or not."
},
"create_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The time the seller replied to the comment."
}
},
"additionalProperties": true,
"description": "The reply of the comment."
},
"model_id_list": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"description": "List of model id of the buyer's purchase corresponding to the comment."
},
"media": {
"type": "object",
"properties": {
"image_url_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of image url uploaded by the buyer in the comment."
},
"video_url_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of video url uploaded by the buyer in the comment."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"description": "The comment data list of the items."
},
"next_cursor": {
"type": "string",
"description": "If more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
}
},
"additionalProperties": true
}
},
"v2.product.reply_comment": {
"path": "/api/v2/product/reply_comment",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: reply comment",
"input_schema": {
"type": "object",
"properties": {
"comment_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"comment_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "The identity of comment."
},
"comment": {
"type": "string",
"maxLength": 262144,
"description": "The content of the comment."
}
},
"required": [
"comment_id",
"comment"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "The list of comment. The limit is between 1 and 100.",
"minItems": 1
}
},
"required": [
"comment_list"
],
"additionalProperties": false,
"description": "v2.product.reply_comment\nUse this api to reply comments from buyers in batch.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"result_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"comment_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "The identity of comment."
},
"fail_error": {
"type": "string",
"description": "Indicate error details if one element hit error."
},
"fail_message": {
"type": "string",
"description": "Indicate error type if one element hit error."
}
},
"additionalProperties": true
},
"description": "The result list of the request comment list."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
},
"warning": {
"type": "array",
"items": {
"type": "string"
},
"description": "Indicate warning message you should take care."
}
},
"additionalProperties": true
}
},
"v2.product.category_recommend": {
"path": "/api/v2/product/category_recommend",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: category recommend",
"input_schema": {
"type": "object",
"properties": {
"item_name": {
"type": "string",
"maxLength": 262144,
"description": "name of item"
},
"product_cover_image": {
"type": "string",
"maxLength": 262144,
"description": "Please use the image id returned by v2.media_space.upload_image api, we will ignore if this field is empty string"
}
},
"required": [
"item_name"
],
"additionalProperties": false,
"description": "v2.product.category_recommend\nRecommend category by item name.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"category_id": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int"
},
"description": "Shopee's unique identifier for a category."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.register_brand": {
"path": "/api/v2/product/register_brand",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: register brand",
"input_schema": {
"type": "object",
"properties": {
"original_brand_name": {
"type": "string",
"maxLength": 254,
"description": "Brand name, length<=254. Official limits: [0,254]",
"minLength": 0
},
"category_list": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int"
},
"maxItems": 10,
"description": "Category_id list for this brand, please input category in L1 or L2. Max input num of category_id is 50. Official limits: [1,50]",
"minItems": 1
},
"product_image": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 9,
"description": "Image Id of product image for this brand, max input num of file = 10 ,each file's length<=498. ID market is optional. Official limits: [0,10)",
"minItems": 0
}
},
"required": [
"image_id_list"
],
"additionalProperties": false
},
"app_logo_image_id": {
"type": "string",
"maxLength": 262144,
"description": "Image_id of logo for app client,please input hashcode of this picture."
},
"brand_website": {
"type": "string",
"maxLength": 254,
"description": "Official website of brand, length<=254. Official limits: [0,254]",
"minLength": 0
},
"brand_description": {
"type": "string",
"maxLength": 254,
"description": "The description of this brand, can input the information, length<=254. Official limits: [0,254]",
"minLength": 0
},
"additional_information": {
"type": "string",
"maxLength": 254,
"description": "Additional notes or comment can seller can add, length<=254. Official limits: [0,254]",
"minLength": 0
},
"pc_logo_image_id": {
"type": "string",
"maxLength": 262144,
"description": "Image_id of logo for pc client,please input hashcode of this picture."
},
"brand_region": {
"type": "string",
"maxLength": 262144,
"description": "origin region of brand."
},
"licenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"file_name": {
"type": "string",
"maxLength": 262144,
"description": "Brand registration certificate image name, len < 254"
},
"file_hash": {
"type": "string",
"maxLength": 262144,
"description": "Image id of brand registration certificate image , max input num of file = 1 , each file's length<=498"
}
},
"required": [],
"additionalProperties": false
},
"maxItems": 10,
"description": "For appeal blacklisted brand data"
},
"brand_registration_website": {
"type": "string",
"maxLength": 262144,
"description": "The link to brand registration website, It is mandatory when brand name hit blacklist.len<254"
}
},
"required": [
"original_brand_name",
"category_list",
"product_image",
"brand_region"
],
"additionalProperties": false,
"description": "v2.product.register_brand\nUse this call to register a brand.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "The identity of brand."
},
"original_brand_name": {
"type": "string",
"description": "Brand name"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_recommend_attribute": {
"path": "/api/v2/product/get_recommend_attribute",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get recommend attribute",
"input_schema": {
"type": "object",
"properties": {
"item_name": {
"type": "string",
"maxLength": 262144,
"description": "name of item"
},
"cover_image_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Cover image id of item"
},
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "ID of category"
}
},
"required": [
"item_name",
"category_id"
],
"additionalProperties": false,
"description": "v2.product.get_recommend_attribute\nGet recommend attributes.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking"
},
"response": {
"type": "object",
"properties": {
"attribute_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "ID of attribute."
},
"attribute_value_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "ID of attribute value."
}
},
"additionalProperties": true
},
"description": "Value list of this attribute."
}
},
"additionalProperties": true
},
"description": "Attribute info list."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_weight_recommendation": {
"path": "/api/v2/product/get_weight_recommendation",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "product: get weight recommendation",
"input_schema": {
"type": "object",
"properties": {
"item_name": {
"type": "string",
"maxLength": 262144,
"description": "Name of the item in local language."
},
"cover_image_id": {
"type": "string",
"maxLength": 262144,
"description": "Image id of first product image."
},
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Shopee's unique identifier for a category."
},
"attribute_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "The Identify of each attribute."
},
"attribute_value_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Unique identifier for value of this item attribute."
},
"original_value_name": {
"type": "string",
"maxLength": 262144,
"description": "Value name of this item attribute."
},
"value_unit": {
"type": "string",
"maxLength": 262144,
"description": "Value unit of this item attribute."
}
},
"required": [
"value_id"
],
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"attribute_id",
"attribute_value_list"
],
"additionalProperties": false
},
"maxItems": 100
},
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Id of brand."
},
"description_type": {
"type": "string",
"maxLength": 262144,
"description": "Type of description, values: See Data Definition- description_type (normal , extended)."
},
"description": {
"type": "string",
"maxLength": 262144,
"description": "If description_type is normal , Description information should be set by this field."
},
"description_info": {
"type": "object",
"properties": {
"extended_description": {
"type": "object",
"properties": {
"field_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_type": {
"type": "string",
"maxLength": 262144,
"description": "Type of extended description field, values: See Data Definition- description_field_type (text , image)."
},
"text": {
"type": "string",
"maxLength": 262144,
"description": "If field_type is text, text information will be set by this field."
},
"image_info": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"maxLength": 262144,
"description": "Image id."
}
},
"required": [],
"additionalProperties": false,
"description": "If field_type is image, image information will be set by this field."
}
},
"required": [],
"additionalProperties": false
},
"maxItems": 100,
"description": "Field of extended description."
}
},
"required": [],
"additionalProperties": false,
"description": "If description_type is extended , Description information should be set by this field."
}
},
"required": [],
"additionalProperties": false,
"description": "New description field. Only whitelist sellers can use it. If you use the field, please upload the description_type=extended."
}
},
"required": [
"item_name",
"cover_image_id",
"category_id",
"attribute_list",
"brand_id",
"description_type"
],
"additionalProperties": false,
"description": "v2.product.get_weight_recommendation\nGet recommended weight. Now only BR shop support to use this api to get recommended weight.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking"
},
"response": {
"type": "object",
"properties": {
"normal_weight_range": {
"type": "array",
"items": {
"type": "number"
},
"description": "Recommended weight range, in kg. If there are no recommended results, return empty."
}
},
"additionalProperties": true
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
}
},
"additionalProperties": true
}
},
"v2.product.get_size_chart_list": {
"path": "/api/v2/product/get_size_chart_list",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get size chart list",
"input_schema": {
"type": "object",
"properties": {
"category_id": {
"type": "string",
"maxLength": 262144,
"description": "category id under this shop"
},
"page_size": {
"type": "string",
"maxLength": 262144,
"description": "the size of one page. Max=50.",
"x-pageMax": 50,
"pattern": "^[1-9][0-9]{0,2}$",
"default": "50"
},
"cursor": {
"type": "string",
"maxLength": 262144,
"description": "Specifies the starting entry of data to return in the current call. Default is \"\". If data is more than one page, the cursor can be some entry to start next call."
}
},
"required": [
"category_id",
"page_size"
],
"additionalProperties": false,
"description": "v2.product.get_size_chart_list \nGet new size chart list. Now only support local shop to use new size chart.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"size_chart_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"size_chart_id": {
"type": "string",
"description": "ID of new size chart"
}
},
"additionalProperties": true
}
},
"total_count": {
"type": "string",
"description": "total number of new size chart under requested category_id"
},
"next_cursor": {
"type": "string",
"description": "if next_cursor has value, this value need set to next request.cursor"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_size_chart_detail": {
"path": "/api/v2/product/get_size_chart_detail",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get size chart detail",
"input_schema": {
"type": "object",
"properties": {
"size_chart_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "ID of new size chart"
}
},
"required": [
"size_chart_id"
],
"additionalProperties": false,
"description": "v2.product.get_size_chart_detail\nGet new size chart detail. Now only local shop support to use this api to get new size chart detail.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"size_chart_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "ID of new size chart"
},
"size_chart_name": {
"type": "string",
"description": "name of new size chart"
},
"size_chart_table": {
"type": "object",
"properties": {
"column_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"measurement": {
"type": "object",
"properties": {
"input_type": {
"type": "string",
"description": "there are 3 kinds of measurement type: Single Dropdown, Input Single Number, Input Range Number."
},
"display_name": {
"type": "string",
"description": "name of column header (measurement)"
},
"unit": {
"type": "string",
"description": "the unit of this size measurement."
}
},
"additionalProperties": true,
"description": "this is the column header which means a kind of measurement"
},
"measurement_value_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "if the input_type of measurement is single input number, measurement will have one value which is returned by this field."
},
"min_value": {
"type": "number",
"description": "if the input_type of measurement is input range number, measurement will be a range which is returned by 2 fields: min_value and max_value."
},
"max_value": {
"type": "number",
"description": "if the input_type of measurement is input range number, measurement will be a range which is returned by 2 fields: min_value and max_value."
},
"option": {
"type": "string",
"description": "if the input_type of measurement is single dropdown, measurement will have one value which is returned by this field."
}
},
"additionalProperties": true
},
"description": "the list of measurement value"
}
},
"additionalProperties": true
},
"description": "column list of new size chart table. it include one column (measurement) and multiple values (measurement value)"
}
},
"additionalProperties": true,
"description": "new size chart is a table format which include multiple columns. each column has column header (measurement) and multiple values (measurement value) of this column."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_item_violation_info": {
"path": "/api/v2/product/get_item_violation_info",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get item violation info",
"input_schema": {
"type": "object",
"properties": {
"item_id_list": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int"
},
"maxItems": 100,
"description": "item_id list; limit [0,50]"
}
},
"required": [
"item_id_list"
],
"additionalProperties": false,
"description": "v2.product.get_item_violation_info\nget item violation info\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Shopee's unique identifier for an item."
},
"item_name": {
"type": "string",
"description": "Name of the item."
},
"item_status": {
"type": "string",
"description": "Enumerated type that defines the current status of the item. Applicable values: NORMAL, BANNED, UNLIST, SELLER_DELETE, SHOPEE_DELETE, REVIEWING."
},
"deboost": {
"type": "boolean",
"description": "If deboost is true, means that the item's search ranking is lowered."
},
"item_status_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"violation_type": {
"type": "string",
"description": "Violation types defined by Shopee. Applicable values: Prohibited Listing Counterfeit and IP Infringement Spam Inappropriate Image Insufficient Information Mall Listing Improvement Other Listing Improvement"
},
"violation_reason": {
"type": "string",
"description": "The reason for violation."
},
"suggestion": {
"type": "string",
"description": "Shopee provides you with suggestions for modifying items."
},
"fix_deadline_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Action required deadline. Empty if no deadline."
},
"update_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Latest update time."
}
},
"additionalProperties": true
}
},
"deboost_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"violation_type": {
"type": "string",
"description": "Violation types defined by Shopee. Applicable values: Prohibited Listing Counterfeit and IP Infringement Spam Inappropriate Image Insufficient Information Mall Listing Improvement Other Listing Improvement"
},
"violation_reason": {
"type": "string",
"description": "The reason for violation."
},
"suggestion": {
"type": "string",
"description": "Shopee provides you with suggestions for modifying items."
},
"suggested_category": {
"type": "array",
"items": {
"type": "object",
"properties": {
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "ID for Shopee suggested category."
},
"category_name": {
"type": "string",
"description": "Default name for Shopee suggested category."
}
},
"additionalProperties": true
}
},
"fix_deadline_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Action required deadline. Empty if no deadline."
},
"update_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Latest update time."
}
},
"additionalProperties": true
}
},
"fail_error": {
"type": "string",
"description": "Indicate error type if one element hit error."
},
"fail_message": {
"type": "string",
"description": "Indicate error details if one element hit error."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_variation_tree": {
"path": "/api/v2/product/get_variation_tree",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get variation tree",
"input_schema": {
"type": "object",
"properties": {
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Leaf category id"
}
},
"required": [
"category_id"
],
"additionalProperties": false,
"description": "v2.product.get_variations\nGet the standardized tier variation defined by Shopee, which is currently a three-layer tree structure. The top layer is variations, the second layer is groups, groups are used to divide options, and the third layer is options.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"data": {
"type": "object",
"properties": {
"standardise_variation_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variation_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int"
},
"variation_name": {
"type": "string"
},
"variation_group_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variation_group_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int"
},
"variation_group_name": {
"type": "string"
},
"variation_option_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variation_option_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int"
},
"variation_option_name": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"description": "standardized tier variation tree"
}
},
"additionalProperties": true,
"description": "standardized tier variation data"
}
},
"additionalProperties": true
}
},
"v2.product.get_all_vehicle_list": {
"path": "/api/v2/product/get_all_vehicle_list",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get all vehicle list",
"input_schema": {
"type": "object",
"properties": {
"page_size": {
"description": "The size of one page. Max=100",
"x-pageMax": 100,
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"offset": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Specifies the starting entry of data to return in the current call. Default is 0, if data is more than one page, the offset can be some entry to start next call."
},
"language": {
"type": "string",
"maxLength": 262144,
"description": "If language is not uploaded, the default language=en, the following are the languages supported by different markets SG: en ; MY: en / ms-my / zh-hans ; TH: en / th ; VN: en / vi ; PH: en ; TW: en / zh-hant ; ID: en / id ; BR: en / pt-br ; MX: en / es-mx ; CO: en/es-CO ; CL: en/es-CL. Note: For markets that have already launched global tree, Crossboard shop only support returning en and zh-hans language data"
}
},
"required": [
"page_size"
],
"additionalProperties": false,
"description": "v2.product.get_all_vehicle_list\nUse this Open API to get all vehicle list.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking"
},
"response": {
"type": "object",
"properties": {
"vehicle_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the brand."
},
"brand_name": {
"type": "string",
"description": "Name of the brand."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the model."
},
"model_name": {
"type": "string",
"description": "Name of the model."
},
"year_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the year."
},
"year_name": {
"type": "string",
"description": "Name of the year."
},
"version_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the version."
},
"version_name": {
"type": "string",
"description": "Name of the version."
}
},
"additionalProperties": true
}
},
"has_next_page": {
"type": "boolean",
"description": "This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items."
},
"next_offset": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "If has_next_page is true, this value need set to next request offset"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_vehicle_list_by_compatibility_detail": {
"path": "/api/v2/product/get_vehicle_list_by_compatibility_detail",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get vehicle list by compatibility detail",
"input_schema": {
"type": "object",
"properties": {
"compatibility_details": {
"type": "string",
"maxLength": 262144,
"description": "To inform compatibility list, can be equal to Brand, Model, Year, or Version. Pass the compatibility_details=\"Brand\" to get all brand list; Pass the compatibility_details=\"Model\" and brand_id=1234 to get all model list under brand_id=1234; Pass the compatibility_details=\"Year\" and brand_id=1234 and model_id=2345 to get all year list under brand_id=1234 and model_id=2345; Pass the compatibility_details=\"Version\" and brand_id=1234 and model_id=2345 and year_id=3456 to get all version list under brand_id=1234 and model_id=2345 and year_id=3456."
},
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the brand."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the model."
},
"year_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the year."
},
"language": {
"type": "string",
"maxLength": 262144,
"description": "If language is not uploaded, the default language=en, the following are the languages supported by different markets SG: en ; MY: en / ms-my / zh-hans ; TH: en / th ; VN: en / vi ; PH: en ; TW: en / zh-hant ; ID: en / id ; BR: en / pt-br ; MX: en / es-mx ; CO: en/es-CO ; CL: en/es-CL. Note: For markets that have already launched global tree, Crossboard shop only support returning en and zh-hans language data."
}
},
"required": [
"compatibility_details"
],
"additionalProperties": false,
"description": "v2.product.get_vehicle_list_by_compatibility_detail\nUse this Open API to get vehicle list by brand, model, year, and version.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking"
},
"response": {
"type": "object",
"properties": {
"vehicle_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the brand."
},
"brand_name": {
"type": "string",
"description": "Name of the brand."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the model."
},
"model_name": {
"type": "string",
"description": "Name of the model."
},
"year_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the year."
},
"year_name": {
"type": "string",
"description": "Name of the year."
},
"version_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the version."
},
"version_name": {
"type": "string",
"description": "Name of the version."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_item_content_diagnosis_result": {
"path": "/api/v2/product/get_item_content_diagnosis_result",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "product: get item content diagnosis result",
"input_schema": {
"type": "object",
"properties": {
"item_id_list": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"maxItems": 100,
"description": "item_id list; limit [1,48]"
}
},
"required": [
"item_id_list"
],
"additionalProperties": false,
"description": "v2.product.get_item_content_diagnosis_result\nGet the content quality details (including content quality level, content issues, and system suggestions) for specific product list.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"success_item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for an item."
},
"quality_level": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Item's latest content quality level. Applicable values: 0: NONE (No quality level for item in SELLER_DELETE / SHOPEE_DELETE / BANNED status) 1: TO_BE_IMPROVED 2: QUALIFIED 3: EXCELLENT"
},
"unfinished_task": {
"type": "array",
"items": {
"type": "object",
"properties": {
"issue_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Item's content issue. Applicable values: 1: TOO_FEW_IMAGES 2: WRONG_CATEGORY 3: TOO_FEW_ATTRIBUTES_FOR_QUALIFIED 4: LACK_OF_SIZE_CHART 5: LACK_OF_STANDARD_VARIATION 6: LACK_BRAND 7: TOO_SHORT_DESCRIPTION 8: TOO_SHORT_OR_TOO_LONG_NAME 9: WRONG_WEIGHT 10: LACK_OF_VIDEO 11: TOO_FEW_ATTRIBUTES_FOR_EXCELLENT"
},
"suggestion": {
"type": "string",
"description": "System suggestion for item's content issue. Applicable values: Add at least 3 images Adopt suggested category Add at least 1 attributes Add size chart Adopt the color or size variation Add brand info Add at least 100 characters or 1 image for desc Add characters for name to 25~100 Adopt suggested weight Add video Add at least 3 attributes"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"failure_item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for an item."
},
"failed_reason": {
"type": "string",
"description": "Item's failure reason."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_item_list_by_content_diagnosis": {
"path": "/api/v2/product/get_item_list_by_content_diagnosis",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "product: get item list by content diagnosis",
"input_schema": {
"type": "object",
"properties": {
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 48,
"description": "the size of one page. Max=48",
"x-pageMax": 48,
"default": 48
},
"offset": {
"type": "string",
"maxLength": 262144,
"description": "Specifies the starting entry of data to return in the current call. Default is empty. if data is more than one page, the offset can be some entry to start next call."
},
"quality_level": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"maxItems": 100,
"description": "Item's latest content quality level. Applicable values: 1: TO_BE_IMPROVED 2: QUALIFIED 3: EXCELLENT"
},
"issue_type": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"maxItems": 100,
"description": "Item's content issue. Applicable values: 1: TOO_FEW_IMAGES 2: WRONG_CATEGORY 3: TOO_FEW_ATTRIBUTES_FOR_QUALIFIED 4: LACK_OF_SIZE_CHART 5: LACK_OF_STANDARD_VARIATION 6: LACK_BRAND 7: TOO_SHORT_DESCRIPTION 8: TOO_SHORT_OR_TOO_LONG_NAME 9: WRONG_WEIGHT 10: LACK_OF_VIDEO 11: TOO_FEW_ATTRIBUTES_FOR_EXCELLENT If you need to pass both quality_level and issue_type, the logic are as follows: - When quality_level is 1, issue_type can only be 1, 2, 3, 4, 5 - When quality_level is 2, issue_type can only be 6, 7, 8, 9, 10, 11 - When quality_level is 3, issue_type can only be empty"
}
},
"required": [
"page_size"
],
"additionalProperties": false,
"description": "v2.product.get_item_list_by_content_diagnosis\nQuery the list of products and their content quality details by content quality level or content issues.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking"
},
"response": {
"type": "object",
"properties": {
"item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for an item."
},
"quality_level": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Item's latest content quality level. Applicable values: 0: NONE (No quality level for item in SELLER_DELETE / SHOPEE_DELETE / BANNED status) 1: TO_BE_IMPROVED 2: QUALIFIED 3: EXCELLENT"
},
"unfinished_task": {
"type": "array",
"items": {
"type": "object",
"properties": {
"issue_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Item's content issue. Applicable values: 1: TOO_FEW_IMAGES 2: WRONG_CATEGORY 3: TOO_FEW_ATTRIBUTES_FOR_QUALIFIED 4: LACK_OF_SIZE_CHART 5: LACK_OF_STANDARD_VARIATION 6: LACK_BRAND 7: TOO_SHORT_DESCRIPTION 8: TOO_SHORT_OR_TOO_LONG_NAME 9: WRONG_WEIGHT 10: LACK_OF_VIDEO 11: TOO_FEW_ATTRIBUTES_FOR_EXCELLENT"
},
"suggestion": {
"type": "string",
"description": "System suggestion for item's content issue. Applicable values: Add at least 3 images Adopt suggested category Add at least 1 attributes Add size chart Adopt the color or size variation Add brand info Add at least 100 characters or 1 image for desc Add characters for name to 25~100 Adopt suggested weight Add video Add at least 3 attributes"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"total_count": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Total num of items match condition."
},
"has_next_page": {
"type": "boolean",
"description": "This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items."
},
"next_offset": {
"type": "string",
"description": "If has_next_page is true, this value need set to next request.offset"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_kit_item_limit": {
"path": "/api/v2/product/get_kit_item_limit",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get kit item limit",
"input_schema": {
"type": "object",
"properties": {
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for a category."
}
},
"required": [],
"additionalProperties": false,
"description": "v2.product.get_kit_item_limit\nGet the limit of Kit item.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"price_limit": {
"type": "object",
"properties": {
"min_limit": {
"type": "number",
"description": "Item price max limit."
},
"max_limit": {
"type": "number",
"description": "Item price min limit."
}
},
"additionalProperties": true
},
"item_name_length_limit": {
"type": "object",
"properties": {
"min_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item name length min limit."
},
"max_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item name length max limit."
}
},
"additionalProperties": true
},
"item_image_count_limit": {
"type": "object",
"properties": {
"min_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item image count min limit."
},
"max_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item image count max limit."
}
},
"additionalProperties": true
},
"description_limit": {
"type": "object",
"properties": {
"description_length_min": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item description length min limit."
},
"description_length_max": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "length max limit for item extended description text part."
},
"description_text_length_min": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "length min limit for item extended description text part, when one of the minimum limits for image and text is reached, the item can be added or updated successfully."
},
"description_text_length_max": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "length max limit for item extended description text part"
},
"description_image_num_min": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "length min limit for item extended description image num, when one of the minimum limits for image and text is reached, the item can be added or updated successfully."
},
"description_image_num_max": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "length max limit for item extended description image num."
},
"description_image_width_min": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "length min limit for item extended description image width."
},
"description_image_height_min": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "length min limit for item extended description image hight."
},
"description_image_aspect_ratio_min": {
"type": "number",
"description": "length min limit for item extended description image aspect ( aspect_ratio= image width / image hight )."
},
"description_image_aspect_ratio_max": {
"type": "number",
"description": "length max limit for item extended description image aspect ( aspect_ratio= image width / image hight )."
}
},
"additionalProperties": true
},
"tier_variation_name_length_limit": {
"type": "object",
"properties": {
"min_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Item tier variation name length min limit."
},
"max_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Item tier variation name length max limit."
}
},
"additionalProperties": true
},
"tier_variation_option_length_limit": {
"type": "object",
"properties": {
"min_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Item tier variation option length min limit."
},
"max_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Item tier variation option length max limit."
}
},
"additionalProperties": true
},
"weight_limit": {
"type": "object",
"properties": {
"weight_mandatory": {
"type": "boolean",
"description": "Whether weight is mandatory or not for the category."
}
},
"additionalProperties": true
},
"dimension_limit": {
"type": "object",
"properties": {
"dimension_mandatory": {
"type": "boolean",
"description": "Whether dimension is mandatory or not for the category."
}
},
"additionalProperties": true
},
"dts_limit": {
"type": "object",
"properties": {
"non_pre_order_days_to_ship": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Days to ship for non pre-order products."
},
"support_pre_order": {
"type": "boolean",
"description": "Whether support pre_order for the category."
},
"days_to_ship_limit": {
"type": "object",
"properties": {
"min_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Min limit of days to ship for pre-order products."
},
"max_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Max limit of days to ship for pre-order products."
}
},
"additionalProperties": true,
"description": "Days to ship for pre-order products."
}
},
"additionalProperties": true
},
"component_count_limit_of_single_model": {
"type": "object",
"properties": {
"min_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Item count min limit that each kit variations support."
},
"max_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Item count max limit that each kit variations support."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.add_kit_item": {
"path": "/api/v2/product/add_kit_item",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: add kit item",
"input_schema": {
"type": "object",
"properties": {
"item_setting": {
"type": "object",
"properties": {
"item_name": {
"type": "string",
"maxLength": 262144,
"description": "The name of this kit item."
},
"images": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "ID of image."
}
},
"required": [
"image_id_list"
],
"additionalProperties": false,
"description": "Item images with 1:1 ratio."
},
"long_images": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "ID of image."
}
},
"required": [
"image_id_list"
],
"additionalProperties": false,
"description": "Item images with 3:4 ratio."
},
"video_upload_id": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "Video upload ID returned from video uploading API. Only accept one video_upload_id."
},
"description": {
"type": "string",
"maxLength": 262144,
"description": "If description_type is normal, description information should be set by this field."
},
"description_info": {
"type": "object",
"properties": {
"extended_description": {
"type": "object",
"properties": {
"field_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_type": {
"type": "string",
"maxLength": 262144,
"description": "Type of extended description field. See Data Definition- description_field_type (text , image)."
},
"text": {
"type": "string",
"maxLength": 262144,
"description": "If field_type is text, text information will be set by this field."
},
"image_info": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"maxLength": 262144,
"description": "Image id."
}
},
"required": [
"image_id"
],
"additionalProperties": false,
"description": "If field_type is image, image will be set by this field."
}
},
"required": [
"field_type",
"text"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Field of extended description."
}
},
"required": [
"field_list"
],
"additionalProperties": false,
"description": "If description_type is extended , Description information should be set by this field."
}
},
"required": [
"extended_description"
],
"additionalProperties": false,
"description": "Rich text 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"
},
"description_type": {
"type": "string",
"maxLength": 262144,
"description": "See Data Definition- description_type (normal , extended). If you want to use extended_description, this field must be inputed."
},
"logistic_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"logistic_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the channel."
},
"enabled": {
"type": "boolean",
"description": "Whether channel is enabled for this kit item."
},
"shipping_fee": {
"type": "number",
"description": "Shipping fee. Only needed when logistics fee_type = CUSTOM_PRICE."
},
"size_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Size ID. Only needed when logistic fee_type = SIZE_SELECTION."
},
"is_free": {
"type": "boolean",
"description": "Whether cover shipping fee for buyer."
}
},
"required": [
"logistic_id",
"enabled"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Logistic channel setting."
},
"unlisted": {
"type": "boolean",
"description": "Unlist or not."
},
"item_sku": {
"type": "string",
"maxLength": 262144,
"description": "SKU tag of item"
},
"weight": {
"type": "number",
"description": "The weight of this kit item, the unit is KG."
},
"dimension": {
"type": "object",
"properties": {
"package_length": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The length of package for this kit item, the unit is CM."
},
"package_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The width of package for this kit item, the unit is CM."
},
"package_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The height of package for this kit item, the unit is CM."
}
},
"required": [
"package_length",
"package_width",
"package_height"
],
"additionalProperties": false,
"description": "The dimension of this kit item."
},
"pre_order": {
"type": "object",
"properties": {
"is_pre_order": {
"type": "boolean",
"description": "Whether kit item is pre order."
},
"days_to_ship": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The guaranteed days to ship orders. Please get the days_to_ship range from get_kit_item_limit api."
}
},
"required": [
"is_pre_order"
],
"additionalProperties": false,
"description": "Pre order setting."
},
"model_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tier_index": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"maxItems": 10,
"description": "Tier index of this kit model."
},
"model_sku": {
"type": "string",
"maxLength": 262144,
"description": "Seller SKU of this kit model, model_sku length information needs to be no more than 100 characters."
},
"original_price": {
"type": "number",
"description": "Original price of this kit model."
},
"component_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"component_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the item that composes this kit model."
},
"component_model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the model that composes this kit model."
},
"quantity": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The amount of the item/model that composes this kit model."
},
"main_component": {
"type": "boolean",
"description": "Whether this item/model is the main component for this kit. One kit item can only have one item/model as main component."
}
},
"required": [
"component_item_id",
"quantity"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Please get the amount of item/model that one kit model support from get_kit_item_limit."
}
},
"required": [
"tier_index",
"original_price",
"component_list"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Model info list, model number at most 9."
},
"tier_variation_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 262144,
"description": "Tier variation name."
},
"option_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"option": {
"type": "string",
"maxLength": 262144,
"description": "Option name."
},
"image": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"maxLength": 262144,
"description": "ID of image. If you choose to define, you need to define an image for all options."
}
},
"required": [
"image_id"
],
"additionalProperties": false,
"description": "Option image."
}
},
"required": [
"option"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Tier variation option info list."
}
},
"required": [
"option_list"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Tier variation info list. Only support one tier variation, and each kit item can have from 1 to 9 kit variations."
}
},
"required": [
"item_name",
"images",
"description_type",
"logistic_info",
"weight",
"model_list",
"tier_variation_list"
],
"additionalProperties": false
},
"sync_setting": {
"type": "object",
"properties": {
"auto_sync_dts": {
"type": "boolean",
"description": "Auto sync the pre_order setting from main component or not."
}
},
"required": [
"auto_sync_dts"
],
"additionalProperties": false
}
},
"required": [
"item_setting"
],
"additionalProperties": false,
"description": "v2.product.add_kit_item\nCreate the kit item by selecting multiple items and setting main component and quantity per kit.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
},
"warning": {
"type": "string"
},
"request_id": {
"type": "string"
},
"response": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.update_kit_item": {
"path": "/api/v2/product/update_kit_item",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: update kit item",
"input_schema": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of kit item."
},
"item_setting": {
"type": "object",
"properties": {
"item_name": {
"type": "string",
"maxLength": 262144,
"description": "The name of this kit item."
},
"images": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "ID of image."
}
},
"required": [
"image_id_list"
],
"additionalProperties": false,
"description": "Item images with 1:1 ratio."
},
"long_images": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "ID of image."
}
},
"required": [
"image_id_list"
],
"additionalProperties": false,
"description": "Item images with 3:4 ratio."
},
"video_upload_id": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "Video upload ID returned from video uploading API. Only accept one video_upload_id."
},
"description": {
"type": "string",
"maxLength": 262144,
"description": "If description_type is normal, description information should be set by this field."
},
"description_info": {
"type": "object",
"properties": {
"extended_description": {
"type": "object",
"properties": {
"field_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_type": {
"type": "string",
"maxLength": 262144,
"description": "Type of extended description field. See Data Definition- description_field_type (text , image)."
},
"text": {
"type": "string",
"maxLength": 262144,
"description": "If field_type is text, text information will be set by this field."
},
"image_info": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"maxLength": 262144,
"description": "Image id."
}
},
"required": [
"image_id"
],
"additionalProperties": false,
"description": "If field_type is image, image will be set by this field."
}
},
"required": [
"field_type",
"text"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Field of extended description."
}
},
"required": [
"field_list"
],
"additionalProperties": false,
"description": "If description_type is extended , Description information should be set by this field."
}
},
"required": [
"extended_description"
],
"additionalProperties": false,
"description": "Rich text 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"
},
"description_type": {
"type": "string",
"maxLength": 262144,
"description": "See Data Definition- description_type (normal , extended). If you want to use extended_description, this field must be inputed."
},
"logistic_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"logistic_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the channel."
},
"enabled": {
"type": "boolean",
"description": "Whether channel is enabled for this kit item."
},
"shipping_fee": {
"type": "number",
"description": "Shipping fee. Only needed when logistics fee_type = CUSTOM_PRICE."
},
"size_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Size ID. Only needed when logistic fee_type = SIZE_SELECTION."
},
"is_free": {
"type": "boolean",
"description": "Whether cover shipping fee for buyer."
}
},
"required": [
"logistic_id",
"enabled"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Logistic channel setting."
},
"unlisted": {
"type": "boolean",
"description": "Unlist or not."
},
"item_sku": {
"type": "string",
"maxLength": 262144,
"description": "SKU tag of item"
},
"weight": {
"type": "number",
"description": "The weight of this kit item, the unit is KG."
},
"dimension": {
"type": "object",
"properties": {
"package_length": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The length of package for this kit item, the unit is CM."
},
"package_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The width of package for this kit item, the unit is CM."
},
"package_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The height of package for this kit item, the unit is CM."
}
},
"required": [
"package_length",
"package_width",
"package_height"
],
"additionalProperties": false,
"description": "The dimension of this kit item."
},
"pre_order": {
"type": "object",
"properties": {
"is_pre_order": {
"type": "boolean",
"description": "Whether kit item is pre order."
},
"days_to_ship": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The guaranteed days to ship orders. Please get the days_to_ship range from get_kit_item_limit api."
}
},
"required": [
"is_pre_order"
],
"additionalProperties": false,
"description": "Pre order setting."
},
"model_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of this kit model."
},
"tier_index": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"maxItems": 10,
"description": "Tier index of this kit model."
},
"model_sku": {
"type": "string",
"maxLength": 262144,
"description": "Seller SKU of this kit model, model_sku length information needs to be no more than 100 characters."
},
"original_price": {
"type": "number",
"description": "Original price of this kit model."
},
"component_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"component_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the item that composes this kit model."
},
"component_model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the model that composes this kit model."
},
"quantity": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The amount of the item/model that composes this kit model."
},
"main_component": {
"type": "boolean",
"description": "Whether this item/model is the main component for this kit. One kit item can only have one item/model as main component."
}
},
"required": [
"component_item_id",
"quantity"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Please get the amount of item/model that one kit model support from get_kit_item_limit."
}
},
"required": [
"tier_index"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Model info list, model number at most 9."
},
"tier_variation_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 262144,
"description": "Tier variation name."
},
"option_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"option": {
"type": "string",
"maxLength": 262144,
"description": "Option name."
},
"image": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"maxLength": 262144,
"description": "ID of image. If you choose to define, you need to define an image for all options."
}
},
"required": [
"image_id"
],
"additionalProperties": false,
"description": "Option image."
}
},
"required": [
"option"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Tier variation option info list."
}
},
"required": [
"option_list"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Tier variation info list. Only support one tier variation, and each kit item can have from 1 to 9 kit variations."
}
},
"required": [],
"additionalProperties": false
},
"sync_setting": {
"type": "object",
"properties": {
"auto_sync_dts": {
"type": "boolean",
"description": "Auto sync the pre_order setting from main component or not."
}
},
"required": [
"auto_sync_dts"
],
"additionalProperties": false
}
},
"required": [
"item_id"
],
"additionalProperties": false,
"description": "v2.product.update_kit_item\nUpdate the kit basic information and kit components, only support adding kit variations and updating existing kit variation’s image, price, and model_sku, don’t support deleting existing kit variations and updating the items, main component and quantity per kit of existing kit variations.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
},
"warning": {
"type": "string"
},
"request_id": {
"type": "string"
}
},
"additionalProperties": true
}
},
"v2.product.get_kit_item_info": {
"path": "/api/v2/product/get_kit_item_info",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get kit item info",
"input_schema": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of kit item. Official limits: [0,50]"
}
},
"required": [
"item_id"
],
"additionalProperties": false,
"description": "v2.product.get_kit_item_info\nGet the kit basic information and kit components.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"product_info": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of this kit item."
},
"item_name": {
"type": "string",
"description": "The name of this kit item."
},
"category_id": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"description": "The category of this kit item, sync from the category of the main component of this kit item."
},
"item_status": {
"type": "string",
"description": "Enumerated type that defines the current status of the item. Applicable values: NORMAL, BANNED, UNLIST, SELLER_DELETE, SHOPEE_DELETE, REVIEWING."
},
"item_sku": {
"type": "string",
"description": "An 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."
},
"images": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of image id."
},
"image_url_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of image url."
},
"image_ratio": {
"type": "string",
"description": "1:1"
}
},
"additionalProperties": true,
"description": "Item images with 1:1 ratio."
},
"long_images": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of image id."
},
"image_url_list": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of image url."
},
"image_ratio": {
"type": "string",
"description": "3:4"
}
},
"additionalProperties": true,
"description": "Item images with 3:4 ratio."
},
"description_info": {
"type": "object",
"properties": {
"extended_description": {
"type": "object",
"properties": {
"field_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_type": {
"type": "string",
"description": "Type of extended description field. See Data Definition- description_field_type (text , image)."
},
"text": {
"type": "string",
"description": "If field_type is text, text information will be returned through this field."
},
"image_info": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"description": "Image id."
},
"image_url": {
"type": "string",
"description": "Image url."
}
},
"additionalProperties": true,
"description": "If field_type is image, image will be returned through this field."
}
},
"additionalProperties": true
},
"description": "Field of extended description."
}
},
"additionalProperties": true,
"description": "If description_type is extended , Description information will be returned through this field."
}
},
"additionalProperties": true,
"description": "Rich text description field. Only whitelist sellers can use it."
},
"description": {
"type": "string",
"description": "If description_type is normal, description information will be returned through this field, else description will be empty."
},
"description_type": {
"type": "string",
"description": "Type of description : values: See Data Definition- description_type (normal , extended)."
},
"video_list": {
"type": "object",
"properties": {
"video_url": {
"type": "string",
"description": "Url of video."
},
"thumbnail_url": {
"type": "string",
"description": "Thumbnail of video."
},
"duration": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Duration of video."
}
},
"additionalProperties": true,
"description": "Info of video list."
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The Identify of each attribute."
},
"original_attribute_name": {
"type": "string",
"description": "The name of each attribute."
},
"attribute_value_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Unique identifier for value of this item attribute."
},
"original_value_name": {
"type": "string",
"description": "Value name of this item attribute."
},
"value_unit": {
"type": "string",
"description": "Value unit of this item attribute."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"description": "The attributes of this kit item, sync from the attributes of the main component of this kit item."
},
"weight": {
"type": "string",
"description": "The weight of this kit item, the unit is KG."
},
"dimension": {
"type": "object",
"properties": {
"package_length": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The length of package for this item, the unit is CM."
},
"package_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The width of package for this item, the unit is CM."
},
"package_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The height of package for this item, the unit is CM."
}
},
"additionalProperties": true,
"description": "The dimension of this kit item."
},
"brand_info": {
"type": "object",
"properties": {
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Id of brand."
},
"original_brand_name": {
"type": "string",
"description": "Original name of brand."
}
},
"additionalProperties": true,
"description": "The brand of this kit item, sync from the brand of the main component of this kit item."
},
"model_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of this kit model."
},
"model_sku": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Seller SKU of this kit model."
},
"original_price": {
"type": "number",
"description": "Original price of this kit model."
},
"tier_index": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"description": "Tier index of this kit model."
},
"component_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"component_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the item that composes this kit model."
},
"component_item_name": {
"type": "string",
"description": "Name of the item that composes this kit model."
},
"component_model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the model that composes this kit model."
},
"component_model_name": {
"type": "string",
"description": "Name of the model that composes this kit model."
},
"quantity": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The amount of the item/model that composes this kit model."
},
"main_component": {
"type": "boolean",
"description": "Whether this item/model is the main component for this kit."
},
"component_item_or_model_image": {
"type": "string"
},
"component_item_or_model_sku": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"description": "Model info list, model number at most 9."
},
"pre_order_info": {
"type": "object",
"properties": {
"is_pre_order": {
"type": "boolean"
},
"days_to_ship": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
}
},
"additionalProperties": true
},
"tier_variation_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Variation name."
},
"option_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"option": {
"type": "string",
"description": "Option name."
},
"image": {
"type": "array",
"items": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"description": "Id of image."
},
"image_url": {
"type": "string",
"description": "Url of image."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"description": "Option list."
}
},
"additionalProperties": true
},
"description": "Variation config of item."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_aitem_by_pitem_id": {
"path": "/api/v2/product/get_aitem_by_pitem_id",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get aitem by pitem id",
"input_schema": {
"type": "object",
"properties": {
"pitem_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of item under SIP Primary Shop."
}
},
"required": [
"pitem_id"
],
"additionalProperties": false,
"description": "v2.product.get_aitem_by_pitem_id\nGet the list of A Items under SIP Affiliate Shop corresponding to P Items under SIP Primary Shop.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"aitem_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ashop_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of SIP Affiliate Shop."
},
"ashop_region": {
"type": "string",
"description": "Region of SIP Affiliate Shop."
},
"aitem_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of item under SIP Affiliate Shop corresponding to the P Item."
},
"model_mapping_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pmodel_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of model for the P Item."
},
"amodel_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of model for the A Item."
}
},
"additionalProperties": true
},
"description": "If the P Item does not have model, then the model_mapping_list will not be returned."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.search_attribute_value_list": {
"path": "/api/v2/product/search_attribute_value_list",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "product: search attribute value list",
"input_schema": {
"type": "object",
"properties": {
"attribute_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"value_name": {
"type": "string",
"maxLength": 262144,
"description": "search the keywords of the attributes value"
},
"cursor": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"limit": {
"description": "The range is 1 to 100",
"x-pageMax": 100,
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}
},
"required": [
"attribute_id",
"cursor",
"limit"
],
"additionalProperties": false,
"description": "v2.product.search_attribute_value_list\nthis api is for searching attribute value list for attribute with support_search_value flag\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"msg": {
"type": "string"
},
"warning": {
"type": "string"
},
"request_id": {
"type": "string"
},
"debug_message": {
"type": "string"
},
"response": {
"type": "object",
"properties": {
"value_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the predefined attributes value."
},
"value_name": {
"type": "string",
"description": "The name of the predefined attributes value."
}
},
"additionalProperties": true
}
},
"page_info": {
"type": "object",
"properties": {
"cursor": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"has_next": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_main_item_list": {
"path": "/api/v2/product/get_main_item_list",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get main item list",
"input_schema": {
"type": "object",
"properties": {
"direct_item_id": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"maxItems": 100,
"description": "Item id of direct shop."
}
},
"required": [
"direct_item_id"
],
"additionalProperties": false,
"description": "v2.product.get_main_item_list\nget main item by direct item.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking"
},
"response": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"direct_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item id of direct shop."
},
"main_shop_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Id of main shop."
},
"main_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item id of main shop."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_direct_item_list": {
"path": "/api/v2/product/get_direct_item_list",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get direct item list",
"input_schema": {
"type": "object",
"properties": {
"main_item_id": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"maxItems": 100,
"description": "Item id of main shop."
}
},
"required": [
"main_item_id"
],
"additionalProperties": false,
"description": "v2.product.get_direct_item_list\nget direct item by main item.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"main_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item id of main shop."
},
"direct_item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"direct_shop_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Id of direct shop."
},
"direct_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Item id of direct shop."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_direct_shop_recommended_price": {
"path": "/api/v2/product/get_direct_shop_recommended_price",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get direct shop recommended price",
"input_schema": {
"type": "object",
"properties": {
"main_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"direct_shop_regions": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Direct shop regions."
},
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Main_item's category."
},
"model_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Id of main model."
},
"tier_index": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"maxItems": 100,
"description": "Tier index of main model. Index starts from 0."
},
"input_price": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"weight": {
"type": "number"
}
},
"required": [],
"additionalProperties": false
},
"maxItems": 100,
"description": "Main model model info."
},
"enabled_channel_id_list": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"maxItems": 100,
"description": "direct shop enabled channel"
}
},
"required": [
"main_item_id",
"direct_shop_regions"
],
"additionalProperties": false,
"description": "v2.product.get_direct_shop_recommended_price\nget recommend price for direct shop.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking"
},
"response": {
"type": "object",
"properties": {
"direct_item_price": {
"type": "array",
"items": {
"type": "object",
"properties": {
"shop_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Id of direct shop."
},
"region": {
"type": "string",
"description": "Region of direct shop."
},
"hidden_price": {
"type": "number"
},
"item_model_price_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Id of main model."
},
"tier_index": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"description": "Tier index of main model. Index starts from 0."
},
"price": {
"type": "number"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_product_certification_rule": {
"path": "/api/v2/product/get_product_certification_rule",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "product: get product certification rule",
"input_schema": {
"type": "object",
"properties": {
"attribute_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of attribute."
},
"attribute_value_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of attribute value. In the following cases, the value id needs to be uploaded as 0, and original_value_name is mandatory, needs to be filled in customized value. (1) AttributeInputType is TEXT_FILED; (2) AttributeInputType is COMBO_BOX or MULTIPLE_SELECT_COMBO_BOX, and the seller want to fill in a customized value."
},
"original_value_name": {
"type": "string",
"maxLength": 262144,
"description": "Value name. original_value_name from produc.get_attributes api. If value id=0, this field is required. If AttributeType is DATE_TYPE or TIMESTAMP_TYPE, you can upload timestamp(string type) as the original_value_name."
},
"value_unit": {
"type": "string",
"maxLength": 262144,
"description": "Unit of attribute value (quantitative attribute only)."
}
},
"required": [
"value_id"
],
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"attribute_id"
],
"additionalProperties": false
},
"maxItems": 100,
"description": "Item attributes."
},
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of category."
}
},
"required": [],
"additionalProperties": false,
"description": "v2.product.get_product_certification_rule\nGet product certification rule\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"certification_rule_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"certification_type": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "type of certification; always=1"
},
"is_mandatory": {
"type": "boolean",
"description": "if this type of certification is mandatory for product"
},
"permit_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"name": {
"type": "string",
"description": "Permit Type Name"
}
},
"additionalProperties": true
},
"description": "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"
}
},
"additionalProperties": true
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
}
},
"additionalProperties": true
}
},
"v2.product.search_unpackaged_model_list": {
"path": "/api/v2/product/search_unpackaged_model_list",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "product: search unpackaged model list",
"input_schema": {
"type": "object",
"properties": {
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Each result set is returned as a page of entries. Use the \"page_size\" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single \"page\" of data. The limit of page_size if between 1 and 48.",
"x-pageMax": 100,
"default": 50
},
"cursor": {
"type": "string",
"maxLength": 262144,
"description": "Specifies the starting entry of data to return in the current call. Default is \"\". If data is more than one page, the cursor can be some entry to start next call."
},
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for an item."
},
"item_name": {
"type": "string",
"maxLength": 262144,
"description": "Name of the item."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for a model under item."
},
"unpackaged_sku_id": {
"type": "string",
"maxLength": 262144,
"description": "Unpackaged SKU ID of the model."
}
},
"required": [
"page_size"
],
"additionalProperties": false,
"description": "v2.product.search_unpackaged_model_list\nUse this API to retrieve Unpackaged SKU ID information for items that toggle on logistics channel 30029.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Total number of models that match the condition."
},
"next_cursor": {
"type": "string",
"description": "Pass the next_cursor in the next request as cursor to get the next page data."
},
"model_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for an item."
},
"item_name": {
"type": "string",
"description": "Name of the item."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for a model under item. 0 for no model item."
},
"unpackaged_sku_id": {
"type": "string",
"description": "Unpackaged SKU ID of the model."
}
},
"additionalProperties": true
},
"description": "List of models that match the condition."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
}
},
"additionalProperties": true
}
},
"v2.product.generate_kit_image": {
"path": "/api/v2/product/generate_kit_image",
"method": "POST",
"risk": "W",
"identity": "Shop",
"description": "product: generate kit image",
"input_schema": {
"type": "object",
"properties": {
"component_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"component_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the item that composes this kit model."
},
"component_model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the model that composes this kit model."
}
},
"required": [
"component_item_id"
],
"additionalProperties": false
},
"maxItems": 25,
"description": "Please send up until 9 components."
}
},
"required": [
"component_list"
],
"additionalProperties": false,
"description": "v2.product.generate_kit_image\nThis API generates a single consolidated image by combining the cover images of all selected items. It is typically used to create a unified product display image for kits or bundles.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking.<path></path><path></path>"
},
"response": {
"type": "object",
"properties": {
"kit_image": {
"type": "string",
"description": "generated kit image"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_mart_item_by_outlet_item_id": {
"path": "/api/v2/product/get_mart_item_by_outlet_item_id",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "product: get mart item by outlet item id",
"input_schema": {
"type": "object",
"properties": {
"outlet_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The item ID of the item in the outlet shop."
}
},
"required": [
"outlet_item_id"
],
"additionalProperties": false,
"description": "v2.product.get_mart_item_by_outlet_item_id\nGet the mapping information between a Mart item and its corresponding outlet item by outlet item ID.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"item_mapping_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mart_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The item ID of the item in the Mart shop."
},
"outlet_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The item ID of the corresponding item in the outlet shop."
},
"model_mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mart_model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The model ID of the product in the Mart shop."
},
"outlet_model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The model ID of the corresponding product in the outlet shop."
}
},
"additionalProperties": true
},
"description": "The mapping relationship between Mart models and outlet models under the mapped items."
}
},
"additionalProperties": true
},
"description": "A list of item mapping records between the Mart item and its corresponding outlet items."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_batch_task_result": {
"path": "/api/v2/product/get_batch_task_result",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get batch task result",
"input_schema": {
"type": "object",
"properties": {
"task_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The task type. 1: price; 2: stock; 3: publish outlet; 4: add item."
},
"task_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The task ID to query."
}
},
"required": [
"task_type",
"task_id"
],
"additionalProperties": false,
"description": "v2.product.get_batch_task_result\nQuery batch task result\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"publish_status": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The publish status. 1: ongoing; 2: finished."
},
"success_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"shop_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The shop ID"
},
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The item ID of the item in the shop."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The model ID of the model in the shop."
}
},
"additionalProperties": true
},
"description": "The batch task success records."
},
"failed_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"shop_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The shop ID"
},
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The item ID of the item in the shop."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The model ID of the model in the shop."
},
"failed_reason": {
"type": "string",
"description": "The failed reason."
}
},
"additionalProperties": true
},
"description": "The batch task failed records."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.batch_add_item": {
"path": "/api/v2/product/batch_add_item",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: batch add item",
"input_schema": {
"type": "object",
"properties": {
"item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"original_price": {
"type": "number",
"description": "Item price"
},
"description": {
"type": "string",
"maxLength": 262144,
"description": "if description_type is normal , Description information should be set by this field."
},
"weight": {
"type": "number",
"description": "The weight of this item, the unit is KG."
},
"item_name": {
"type": "string",
"maxLength": 262144,
"description": "Item name"
},
"item_status": {
"type": "string",
"maxLength": 262144,
"description": "Item status, could be UNLIST or NORMAL"
},
"dimension": {
"type": "object",
"properties": {
"package_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The height of package for this item, the unit is CM."
},
"package_length": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The length of package for this item, the unit is CM."
},
"package_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The width of package for this item, the unit is CM."
}
},
"required": [
"package_height",
"package_length",
"package_width"
],
"additionalProperties": false,
"description": "The dimension of this item."
},
"logistic_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"size_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Size ID, If specify logistic fee_type is SIZE_SELECTION size_id is required."
},
"shipping_fee": {
"type": "number",
"description": "Shipping fee, Only needed when logistics fee_type = CUSTOM_PRICE."
},
"enabled": {
"type": "boolean",
"description": "Whether channel is enabled for this item"
},
"logistic_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "ID of the channel"
},
"is_free": {
"type": "boolean",
"description": "Whether cover shipping fee for buyer"
}
},
"required": [
"enabled",
"logistic_id"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Logistic channel setting"
},
"attribute_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "ID of attribute"
},
"attribute_value_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Value ID. In the following cases, the value id needs to be uploaded as 0, and original_value_name is mandatory, needs to be filled in customized value. (1) AttributeInputType is TEXT_FILED; (2) AttributeInputType is COMBO_BOX or MULTIPLE_SELECT_COMBO_BOX, and the seller want to fill in a customized value."
},
"original_value_name": {
"type": "string",
"maxLength": 262144,
"description": "Value name. original_value_name from product.get_attributes api. If value id=0, this field is required. If AttributeType is DATE_TYPE or TIMESTAMP_TYPE, you can upload timestamp(string type) as the original_value_name."
},
"value_unit": {
"type": "string",
"maxLength": 262144,
"description": "Unit of attribute value (quantitative attribute only)."
}
},
"required": [
"value_id"
],
"additionalProperties": false
},
"maxItems": 10
}
},
"required": [
"attribute_id"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "This field is optional(expect Indonesia) depending on the specific attribute under different categories. Should call shopee.item.GetAttributes to get attribute first. Must contain all all mandatory attribute."
},
"category_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "ID of category"
},
"image": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "ID of image"
},
"image_ratio": {
"type": "string",
"maxLength": 262144,
"description": "Ratio of image, OptionalAllowed ratios : \"1:1\" (default) \"3:4\" only applicable to whitelisted seller."
}
},
"required": [
"image_id_list"
],
"additionalProperties": false,
"description": "Item images"
},
"pre_order": {
"type": "object",
"properties": {
"is_pre_order": {
"type": "boolean",
"description": "Whether item is pre order"
},
"days_to_ship": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The guaranteed days to ship orders. Please get the days_to_ship range from get_dts_limit api"
}
},
"required": [
"is_pre_order"
],
"additionalProperties": false,
"description": "Pre order setting"
},
"item_sku": {
"type": "string",
"maxLength": 262144,
"description": "SKU tag of item"
},
"condition": {
"type": "string",
"maxLength": 262144,
"description": "Condition of item, could be USED or NEW"
},
"wholesale": {
"type": "array",
"items": {
"type": "object",
"properties": {
"min_count": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Minimum count of this tier"
},
"max_count": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Maximum count of this tier"
},
"unit_price": {
"type": "number",
"description": "Unit price of this tier"
}
},
"required": [
"min_count",
"max_count",
"unit_price"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Wholesale setting"
},
"video_upload_id": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "Video upload ID returned from video uploading API. Only accept one video_upload_id."
},
"brand": {
"type": "object",
"properties": {
"brand_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Id of brand."
},
"original_brand_name": {
"type": "string",
"maxLength": 262144,
"description": "Original name of brand( No Brand if not brand)."
}
},
"required": [
"brand_id",
"original_brand_name"
],
"additionalProperties": false
},
"item_dangerous": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "This field is only applicable for local sellers in Indonesia and Malaysia. Use this field to identify whether a product is a dangerous product. 0 for non-dangerous product and 1 for dangerous product. For more information, please visit the market's respective Seller Education Hub."
},
"tax_info": {
"type": "object",
"properties": {
"ncm": {
"type": "string",
"maxLength": 262144,
"description": "Mercosur Common Nomenclature, it is a convention between Mercosur member countries to easily recognize goods, services and productive factors negotiated among themselves. (BR region) NCM must have 8 digits, OR, if your item doesn't have a NCM enter the value \"00\""
},
"same_state_cfop": {
"type": "string",
"maxLength": 262144,
"description": "Tax Code of Operations and Installments for orders that seller and buyer are in the same state. It identifies a specific operation by category at the time of issuing the invoice.(BR region)"
},
"diff_state_cfop": {
"type": "string",
"maxLength": 262144,
"description": "Tax Code of Operations and Installments for orders that seller and buyer are in different states. It identifies a specific operation by category at the time of issuing the invoice.(BR region)"
},
"csosn": {
"type": "string",
"maxLength": 262144,
"description": "Code of Operation Status – Simples Nacional, code for company operations to identify the origin of the goods and the taxation regime of the operations.(BR region)"
},
"origin": {
"type": "string",
"maxLength": 262144,
"description": "Product source, domestic or foreig (BR region). |0 - National, except for those indicated in codes 3, 4, 5, and 8| |1 - Foreign: Direct import, except for that indicated in code 6| |2 - Foreign: Acquired in the domestic market, except for that indicated in code 7| |3 - National: Goods or products with Import Content greater than 40% and less than or equal to 70%| |4 - National: Produced in compliance with the basic production processes outlined in the legislations cited in the Agreements| |5 - National: Goods or products with Import Content less than or equal to 40%| |6 - Foreign: Direct import, without a national equivalent, listed by CAMEX and natural gas| |7 - Foreign: Acquired in the domestic market, without a national equivalent, listed by CAMEX and natural gas| |8 - National: Goods or products with Import Content greater than 70%|"
},
"cest": {
"type": "string",
"maxLength": 262144,
"description": "Tax Replacement Specifying Code (CEST), to separate within the same NCM products that do or do not have ICMS tax substitution. (BR region) CEST must have 7 digits, OR, if your item doesn't have a CEST enter the value \"00\"."
},
"measure_unit": {
"type": "string",
"maxLength": 262144,
"description": "(BR region)"
},
"tax_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "tax_type only for TW whitelist shop. Shopee will referred Tax type when substitute sellers for issuing e-receipts to buyers. All variations share the same tax type. The meaning of value: 0: no tax type 1: tax-able 2: tax-free"
},
"pis": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. PIS - Programa de Integração Social (Social Integration Program). It is a government tax to collect resources for the payment of unemployment insurance and other employee related rights. PIS % - the tax applied to this product"
},
"cofins": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. COFINS – Contribuição para Financiamento da Seguridade Social (Contribution for Social Security Funding). It is a government tax to collect resources for public health system and social security. COFINS % - the tax applied to this product"
},
"icms_cst": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. ICMS - Imposto sobre Circulação de Mercadorias e Serviços (Circulation of Goods and Services Tax). CST - Código da Situação Tributária (Tax Situation Code) is represented by a combination of 3 numbers with the purpose of demonstrating the origin of a product and determining the form of taxation that will apply to it. Therefore, each digit in the CST Table has a specific meaning: the first digit indicates the origin of the operation, the second digit represents the ICMS taxation on the operation and the third digit provides additional information about the form of taxation."
},
"pis_cofins_cst": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. The CST PIS/Cofins is a code on the Electronic Invoice (NF-e) that identifies the tax situation of PIS (Programa de Integração Social) and Cofins (Contribuição para o Financiamento da Seguridade Social) in sales of goods."
},
"federal_state_taxes": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. Enter the total percentage of the combination of federal, state, and municipal taxes, using up to two decimals."
},
"operation_type": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. 1: Retailer 2: Manufacturer"
},
"ex_tipi": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. The EXTIPI field in the NF-e (Nota Fiscal Eletrônica) is used to indicate if there's an exception to the IPI (Imposto sobre Produtos Industrializados) tax rate for a specific product."
},
"fci_num": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. The FCI Control Number is a unique identifier assigned to each import FCI (Import Content Form). It's mandatory on the corresponding NF-e (electronic invoice) to ensure compliance with Brazilian import tax regulations."
},
"recopi_num": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. RECOPI NACIONAL is a Brazilian government system that facilitates the registration and management of tax-exempt operations involving paper destined for printing books, newspapers, and periodicals (known as \"papel imune\" in Portuguese)."
},
"additional_info": {
"type": "string",
"maxLength": 262144,
"description": "Only for BR shop. Include relevant information to display on Invoice."
},
"group_item_info": {
"type": "object",
"properties": {
"group_qtd": {
"type": "string",
"maxLength": 262144,
"description": "Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unit), enter 6."
},
"group_unit": {
"type": "string",
"maxLength": 262144,
"description": "Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unit), enter UNI for the individual can."
},
"group_unit_value": {
"type": "string",
"maxLength": 262144,
"description": "Example: The package contains 6 soda cans. Whether you are selling a pack of 6 cans (fardo) or a single can (unity), enter the value of the individual can."
},
"original_group_price": {
"type": "string",
"maxLength": 262144,
"description": "Example: The item is a package that contains 6 soda cans. Enter the price of the whole package."
},
"group_gtin_sscc": {
"type": "string",
"maxLength": 262144,
"description": "Example: The item is a package that contains 6 soda cans. Please inform the GTIN SSCC code for the package."
},
"group_grai_gtin_sscc": {
"type": "string",
"maxLength": 262144,
"description": "Example: The item is box, that contain 6 packages. Each package contains 6 soda cans. Please inform the GRAI GTIN SSCC code for the Box."
}
},
"required": [],
"additionalProperties": false,
"description": "Only for BR shop. Required if the item is a group item."
},
"export_cfop": {
"type": "string",
"maxLength": 262144,
"description": "[BR region] 7101 - for sales of self-produced goods 7102 - resale of third-party goods"
}
},
"required": [],
"additionalProperties": false,
"description": "Tax information"
},
"complaint_policy": {
"type": "object",
"properties": {
"warranty_time": {
"type": "string",
"maxLength": 262144,
"description": "Value should be in one of ONE_YEAR TWO_YEARS OVER_TWO_YEARS."
},
"exclude_entrepreneur_warranty": {
"type": "boolean",
"description": "Whether to exclude warranty complaints for entrepreneurs.If True means \"I exclude warranty complaints for entrepreneur\""
},
"complaint_address_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Address for complaint. Fetch available addresses using v2.logistics.get_address_list, and use address_id returned from it."
},
"additional_information": {
"type": "string",
"maxLength": 262144,
"description": "Additional information for warranty claim. Should be less than 1000 characters."
}
},
"required": [],
"additionalProperties": false,
"description": "Complaint Policy for item. Only required for local PL sellers, ignored otherwise."
},
"description_info": {
"type": "object",
"properties": {
"extended_description": {
"type": "object",
"properties": {
"field_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_type": {
"type": "string",
"maxLength": 262144,
"description": "Type of extended description field :values: See Data Definition- description_field_type (text , image)."
},
"text": {
"type": "string",
"maxLength": 262144,
"description": "If field_type is text, text information will be set by this field."
},
"image_info": {
"type": "object",
"properties": {
"image_id": {
"type": "string",
"maxLength": 262144,
"description": "Image id."
}
},
"required": [],
"additionalProperties": false,
"description": "If field_type is image,image url will be set by this field."
}
},
"required": [],
"additionalProperties": false
},
"maxItems": 10,
"description": "Field of extended description."
}
},
"required": [],
"additionalProperties": false,
"description": "If description_type is extended , Description information should be set by this field."
}
},
"required": [],
"additionalProperties": false,
"description": "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"
},
"description_type": {
"type": "string",
"maxLength": 262144,
"description": "Values: See Data Definition- description_type (normal , extended). If you want to use extended_description, this field must be inputed"
},
"seller_stock": {
"type": "array",
"items": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"maxLength": 262144,
"description": "location id"
},
"stock": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "stock"
}
},
"required": [
"stock"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "seller stock(Please notice that stock(including Seller Stock and Shopee Stock) should be larger than or equal to real-time reserved stock)"
},
"gtin_code": {
"type": "string",
"maxLength": 262144,
"description": "- GTIN is an identifier for trade items, developed by the international organization GS1. - They have 8 to 14 digits. The most common are UPC, EAN, JAN and ISBN. - GTIN will help boost positioning in online marketing channels like Google and Facebook. - That incorporation with GTIN will also aid in Search and Recommendation in Shopee itself allowing buyers to have higher likelihood of finding one's listing. Note: If you want to set “Item without GTIN”, please pass the gtin_code as \"00\". The validation rule is based on the value return in gtin_validation_rule\" field in v2.product.get_item_limit API - Mandatory : This field is required and must contain a correctly formatted GTiN number. - Flexible : This field is required and must contain either a correctly formatted GTlN number or \"00\" to declare that the item/model has no valid GTlN. - Optional: This field is optional and can contain a correctly formatted GTiN number, \"00\" or be omitted entirely."
},
"ds_cat_rcmd_id": {
"type": "string",
"maxLength": 262144,
"description": "category recommendation service id"
},
"promotion_images": {
"type": "object",
"properties": {
"image_id_list": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "Promotion Image"
}
},
"required": [],
"additionalProperties": false,
"description": "Promotion Image Currently only allow one promoton image You could set promotion image only if the product images' ratio is 3:4"
},
"compatibility_info": {
"type": "object",
"properties": {
"vehicle_info_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the brand."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the model."
},
"year_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the year."
},
"version_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the version."
}
},
"required": [
"brand_id",
"model_id"
],
"additionalProperties": false
},
"maxItems": 10
}
},
"required": [
"vehicle_info_list"
],
"additionalProperties": false
},
"scheduled_publish_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Scheduled publish time of this item: 1) Can only set scheduled_publish_time for item with UNLIST status 2) Can only set the time from current time +1hour to current time +90days, and the time is only allowed to be accurate to the minute"
},
"authorised_brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of authorised reseller brand."
},
"size_chart_info": {
"type": "object",
"properties": {
"size_chart": {
"type": "string",
"maxLength": 262144,
"description": "ID of size chart image. If you want to remove the image size chart of the item, please pass the \"size_chart\" empty. You only need to fill out either the image or template. If both are filled, only the template will be kept. Notes: Both CB shops and local shops are supported to set \"size_chart\"."
},
"size_chart_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of template size chart. If you want to remove the template size chart of the item, please pass the \"size_chart_id\" as 0. You only need to fill out either the image or template. If both are filled, only the template will be kept. Notes: Only local shops are supported to set \"size_chart_id\", for CB shops please use \"size_chart\"."
}
},
"required": [],
"additionalProperties": false
},
"certification_info": {
"type": "object",
"properties": {
"certification_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"certification_no": {
"type": "string",
"maxLength": 262144,
"description": "Certification No."
},
"permit_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Permit ID, get from v2.product.get_product_certification_rule"
},
"expiry_date": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Expiry timestamp. Required for PH, but not needed for TW."
},
"certification_proofs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"file_name": {
"type": "string",
"maxLength": 262144,
"description": "The name of the uploaded certification proof file."
},
"image_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The unique image ID of the certification proof, returned by the image upload API."
},
"ratio": {
"type": "number",
"description": "image weight/ image height Will be optional in the future; can input 0.75 by default"
}
},
"required": [
"file_name",
"image_id",
"ratio"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "An array of proof documents for the certification; each element represents one proof file.<path></path>"
}
},
"required": [
"certification_no",
"permit_id",
"certification_proofs"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Array of certification records for the product, each containing type, certificate number, permit ID, and proof documents."
}
},
"required": [],
"additionalProperties": false,
"description": "For PH product certification input Required for some category and attribute option"
},
"purchase_limit_info": {
"type": "object",
"properties": {
"min_purchase_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "minimum purchase count for each order"
},
"max_purchase_limit": {
"type": "object",
"properties": {
"purchase_limit": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "maximum purchase limit for each order."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false,
"description": "purchase limit info"
},
"medicine_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "[Only for ID local sellers] as a unique identifier for each standardized medicine, the medicine id can only be obtained offline"
},
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the Standardized Shop Product (SSP) to associate with the default model of the new item. The value must be greater than 0 when provided. If ssp_id is provided, cssp_id must also be provided."
},
"cssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the country-specific Standardized Shop Product (CSSP) to associate with the default model of the new item. The value must be greater than 0 when provided. This field is required when ssp_id is provided."
}
},
"required": [
"original_price",
"description",
"weight",
"item_name",
"logistic_info",
"category_id",
"image"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "The item list to batch add. The list size must be between 1 and 100.",
"minItems": 1
}
},
"required": [
"item_list"
],
"additionalProperties": false,
"description": "v2.product.batch_add_item\nCreate asynchronous task to batch add item\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate waring details if hit waring. Empty if no waring happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"task_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The task ID of the batch add item task."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.product.get_ssp_detail": {
"path": "/api/v2/product/get_ssp_detail",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get ssp detail",
"input_schema": {
"type": "object",
"properties": {
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the Standardized Shop Product (SSP)."
},
"cssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the country-specific Standardized Shop Product (CSSP)."
}
},
"required": [],
"additionalProperties": false,
"description": "v2.product.get_ssp_detail\nGet the details of an SSP or CSSP. At least one of ssp_id and cssp_id is required, and cssp_id takes priority when both are provided. The response covers the product content such as the category path, attributes, brand and variations. Each entry in cssps is a country-specific SSP under the SSP, and its tier_indices point to the selected options of the parent tier_variation.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "The error code. Empty when the request succeeds."
},
"message": {
"type": "string",
"description": "Error details. Empty when no error occurs."
},
"warning": {
"type": "string",
"description": "Warning details. Empty when no warning occurs."
},
"request_id": {
"type": "string",
"description": "The request identifier used for troubleshooting."
},
"response": {
"type": "object",
"properties": {
"ssp_info": {
"type": "object",
"properties": {
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the Standardized Shop Product (SSP)."
},
"title": {
"type": "string",
"description": "The display title of the SSP."
},
"images": {
"type": "array",
"items": {
"type": "string"
},
"description": "Image identifiers associated with the SSP or CSSP."
},
"category_path": {
"type": "array",
"items": {
"type": "object",
"properties": {
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The category ID."
},
"category_name": {
"type": "string",
"description": "The category name."
},
"display_name": {
"type": "string",
"description": "The localized display name."
}
},
"additionalProperties": true
},
"description": "The category hierarchy of the SSP."
},
"description": {
"type": "string",
"description": "The SSP description."
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attr_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The attribute ID."
},
"attr_name": {
"type": "string",
"description": "The attribute name."
},
"attr_display_name": {
"type": "string",
"description": "The localized attribute name."
},
"attr_val_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attr_val_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The attribute value ID."
},
"attr_val": {
"type": "string",
"description": "The attribute value."
},
"attr_val_display_name": {
"type": "string",
"description": "The localized attribute value."
},
"custom_value": {
"type": "string",
"description": "A custom attribute value when applicable."
}
},
"additionalProperties": true
},
"description": "The values of the attribute."
},
"input_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The input type of the attribute."
},
"input_validator": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The validator type of the attribute."
},
"format_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The format type of the attribute."
},
"datetime_format": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The date-time format when the attribute is a date or time."
}
},
"additionalProperties": true
},
"description": "The attributes associated with the SSP or CSSP."
},
"brand": {
"type": "object",
"properties": {
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The brand ID."
},
"display_name": {
"type": "string",
"description": "The localized display name."
}
},
"additionalProperties": true,
"description": "The SSP brand information."
},
"tier_variation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The tier variation name."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "The available tier variation options."
},
"images": {
"type": "array",
"items": {
"type": "string"
},
"description": "Image identifiers associated with the SSP or CSSP."
}
},
"additionalProperties": true
},
"description": "The tier variation definitions."
},
"cssps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the Standardized Shop Product (SSP)."
},
"cssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the country-specific Standardized Shop Product (CSSP)."
},
"title": {
"type": "string",
"description": "The display title of the CSSP."
},
"images": {
"type": "array",
"items": {
"type": "string"
},
"description": "Image identifiers associated with the SSP or CSSP."
},
"tier_indices": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"description": "The tier option indices identifying the CSSP variation."
},
"desc": {
"type": "string",
"description": "The CSSP description."
},
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The brand ID."
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attr_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The attribute ID."
},
"attr_name": {
"type": "string",
"description": "The attribute name."
},
"attr_display_name": {
"type": "string",
"description": "The localized attribute name."
},
"attr_val_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attr_val_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The attribute value ID."
},
"attr_val": {
"type": "string",
"description": "The attribute value."
},
"attr_val_display_name": {
"type": "string",
"description": "The localized attribute value."
},
"custom_value": {
"type": "string",
"description": "A custom attribute value when applicable."
}
},
"additionalProperties": true
},
"description": "The values of the attribute."
},
"input_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The input type of the attribute."
},
"input_validator": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The validator type of the attribute."
},
"format_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The format type of the attribute."
},
"datetime_format": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The date-time format when the attribute is a date or time."
}
},
"additionalProperties": true
},
"description": "The attributes associated with the SSP or CSSP."
},
"tier_variation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The tier variation name."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "The available tier variation options."
},
"images": {
"type": "array",
"items": {
"type": "string"
},
"description": "Image identifiers associated with the SSP or CSSP."
}
},
"additionalProperties": true
},
"description": "The tier variation definitions."
},
"brand_name": {
"type": "string",
"description": "The brand name."
}
},
"additionalProperties": true
},
"description": "The country-specific products under the SSP."
},
"profile_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The SSP profile type."
}
},
"additionalProperties": true,
"description": "The requested SSP details."
}
},
"additionalProperties": true,
"description": "The response data."
}
},
"additionalProperties": true
}
},
"v2.product.get_ssp_recommendation": {
"path": "/api/v2/product/get_ssp_recommendation",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "product: get ssp recommendation",
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false,
"description": "v2.product.get_ssp_recommendation\nGet the SSP enrollment recommendations of the authorized shop, separating items that can be enrolled automatically from items that may be enrolled after further action. auto_enroll_time is the automatic enrollment time in seconds as a future timestamp, returned for automatic enrollment only.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "The error code. Empty when the request succeeds."
},
"message": {
"type": "string",
"description": "Error details. Empty when no error occurs."
},
"warning": {
"type": "string",
"description": "Warning details. Empty when no warning occurs."
},
"request_id": {
"type": "string",
"description": "The request identifier used for troubleshooting."
},
"response": {
"type": "object",
"properties": {
"auto_enroll_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the item."
},
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the Standardized Shop Product (SSP)."
},
"model_cssp": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the item model."
},
"cssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the country-specific Standardized Shop Product (CSSP)."
},
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the Standardized Shop Product (SSP)."
}
},
"additionalProperties": true,
"description": "The model and CSSP mapping recommended for the item."
}
},
"additionalProperties": true
},
"description": "Items that are eligible for automatic SSP enrollment."
},
"possible_to_be_enroll_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the item."
},
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the Standardized Shop Product (SSP)."
},
"model_cssp": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the item model."
},
"cssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the country-specific Standardized Shop Product (CSSP)."
},
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the Standardized Shop Product (SSP)."
}
},
"additionalProperties": true,
"description": "The model and CSSP mapping recommended for the item."
}
},
"additionalProperties": true
},
"description": "Items that may be eligible for SSP enrollment."
},
"auto_enroll_time": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The automatic enrollment end time as a Unix timestamp in seconds. This field is meaningful for automatic-enrollment items and may be zero or absent otherwise."
}
},
"additionalProperties": true,
"description": "The response data."
}
},
"additionalProperties": true
}
},
"v2.product.search_ssp_list": {
"path": "/api/v2/product/search_ssp_list",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "product: search ssp list",
"input_schema": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 262144,
"description": "Title text for SSP search. Required when image_id_list is empty and must contain at least three Unicode characters."
},
"image_id_list": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Image IDs used for visually similar SSP search. When at least one image ID is supplied, title is ignored."
}
},
"required": [],
"additionalProperties": false,
"description": "v2.product.search_ssp_list\nSearch SSPs by title or by image. At most 50 results are returned. When image_id_list is provided, the search is based on image similarity and title is ignored; otherwise title must contain at least three characters.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "The error code. Empty when the request succeeds."
},
"message": {
"type": "string",
"description": "Error details. Empty when no error occurs."
},
"warning": {
"type": "string",
"description": "Warning details. Empty when no warning occurs."
},
"request_id": {
"type": "string",
"description": "The request identifier used for troubleshooting."
},
"response": {
"type": "object",
"properties": {
"ssp_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the Standardized Shop Product (SSP)."
},
"title": {
"type": "string",
"description": "The display title of the SSP returned by the search."
},
"images": {
"type": "array",
"items": {
"type": "string"
},
"description": "Image identifiers associated with the SSP or CSSP."
},
"category_path": {
"type": "array",
"items": {
"type": "object",
"properties": {
"category_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The category ID."
},
"category_name": {
"type": "string",
"description": "The category name."
},
"display_name": {
"type": "string",
"description": "The localized display name."
}
},
"additionalProperties": true
},
"description": "The category hierarchy of the SSP."
},
"description": {
"type": "string",
"description": "The SSP description."
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attr_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The attribute ID."
},
"attr_name": {
"type": "string",
"description": "Attribute metadata that may be omitted by the current search converter."
},
"attr_display_name": {
"type": "string",
"description": "Attribute metadata that may be omitted by the current search converter."
},
"attr_val_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attr_val_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The attribute value ID."
},
"attr_val": {
"type": "string",
"description": "Attribute metadata that may be omitted by the current search converter."
},
"attr_val_display_name": {
"type": "string",
"description": "Attribute metadata that may be omitted by the current search converter."
},
"custom_value": {
"type": "string",
"description": "A custom attribute value when applicable."
}
},
"additionalProperties": true
},
"description": "The values of the attribute."
},
"input_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Attribute metadata that may be omitted by the current search converter."
},
"input_validator": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Attribute metadata that may be omitted by the current search converter."
},
"format_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Attribute metadata that may be omitted by the current search converter."
},
"datetime_format": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Attribute metadata that may be omitted by the current search converter."
}
},
"additionalProperties": true
},
"description": "The attributes associated with the SSP or CSSP."
},
"brand": {
"type": "object",
"properties": {
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The brand ID."
},
"display_name": {
"type": "string",
"description": "The localized display name."
}
},
"additionalProperties": true,
"description": "The SSP brand information."
},
"tier_variation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The tier variation name."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "The available tier variation options."
},
"images": {
"type": "array",
"items": {
"type": "string"
},
"description": "Image identifiers associated with the SSP or CSSP."
}
},
"additionalProperties": true
},
"description": "The tier variation definitions."
},
"cssps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the Standardized Shop Product (SSP)."
},
"cssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the country-specific Standardized Shop Product (CSSP)."
},
"title": {
"type": "string",
"description": "The display title of the CSSP returned by the search."
},
"images": {
"type": "array",
"items": {
"type": "string"
},
"description": "Image identifiers associated with the SSP or CSSP."
},
"tier_indices": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"description": "The tier option indices identifying the CSSP variation."
},
"desc": {
"type": "string",
"description": "The CSSP description."
},
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The brand ID."
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attr_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The attribute ID."
},
"attr_name": {
"type": "string",
"description": "Attribute metadata that may be omitted by the current search converter."
},
"attr_display_name": {
"type": "string",
"description": "Attribute metadata that may be omitted by the current search converter."
},
"attr_val_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attr_val_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The attribute value ID."
},
"attr_val": {
"type": "string",
"description": "Attribute metadata that may be omitted by the current search converter."
},
"attr_val_display_name": {
"type": "string",
"description": "Attribute metadata that may be omitted by the current search converter."
},
"custom_value": {
"type": "string",
"description": "A custom attribute value when applicable."
}
},
"additionalProperties": true
},
"description": "The values of the attribute."
},
"input_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Attribute metadata that may be omitted by the current search converter."
},
"input_validator": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Attribute metadata that may be omitted by the current search converter."
},
"format_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Attribute metadata that may be omitted by the current search converter."
},
"datetime_format": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Attribute metadata that may be omitted by the current search converter."
}
},
"additionalProperties": true
},
"description": "The attributes associated with the SSP or CSSP."
},
"tier_variation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The tier variation name."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "The available tier variation options."
},
"images": {
"type": "array",
"items": {
"type": "string"
},
"description": "Image identifiers associated with the SSP or CSSP."
}
},
"additionalProperties": true
},
"description": "The tier variation definitions."
},
"brand_name": {
"type": "string",
"description": "The brand name."
}
},
"additionalProperties": true
},
"description": "The country-specific products under the SSP."
},
"profile_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The SSP profile type."
}
},
"additionalProperties": true
},
"description": "The list of SSPs matching the search criteria."
}
},
"additionalProperties": true,
"description": "The response data."
}
},
"additionalProperties": true
}
},
"v2.product.link_item_to_ssp": {
"path": "/api/v2/product/link_item_to_ssp",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "product: link item to ssp",
"input_schema": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the item."
},
"model_cssp_pairs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the item model."
},
"cssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the country-specific Standardized Shop Product (CSSP)."
},
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The optional ID of the parent Standardized Shop Product (SSP)."
}
},
"required": [
"model_id",
"cssp_id"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Non-empty mappings between item models and CSSPs. Each mapping requires model_id and cssp_id; ssp_id is optional.",
"minItems": 1
}
},
"required": [
"item_id",
"model_cssp_pairs"
],
"additionalProperties": false,
"description": "v2.product.link_item_to_ssp\nLink one or more models of an item to their country-specific SSPs. item_id and model_cssp_pairs are required, and each pair must contain model_id and cssp_id; ssp_id is optional.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "The error code. Empty when the request succeeds."
},
"message": {
"type": "string",
"description": "Error details. Empty when no error occurs."
},
"warning": {
"type": "string",
"description": "Warning details. Empty when no warning occurs."
},
"request_id": {
"type": "string",
"description": "The request identifier used for troubleshooting."
}
},
"additionalProperties": true
}
},
"v2.product.unlink_item_from_ssp": {
"path": "/api/v2/product/unlink_item_from_ssp",
"method": "POST",
"risk": "D",
"identity": "Shop",
"description": "product: unlink item from ssp",
"input_schema": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the item."
},
"model_cssp_pairs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the item model."
},
"cssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the country-specific Standardized Shop Product (CSSP)."
},
"ssp_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The optional ID of the parent Standardized Shop Product (SSP)."
}
},
"required": [
"model_id",
"cssp_id"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Non-empty mappings between item models and CSSPs. Each mapping requires model_id and cssp_id; ssp_id is optional.",
"minItems": 1
}
},
"required": [
"item_id",
"model_cssp_pairs"
],
"additionalProperties": false,
"description": "v2.product.unlink_item_from_ssp\nRemove the SSP links of one or more models of an item. item_id and model_cssp_pairs are required, and each pair must contain model_id and cssp_id; ssp_id is optional.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "The error code. Empty when the request succeeds."
},
"message": {
"type": "string",
"description": "Error details. Empty when no error occurs."
},
"warning": {
"type": "string",
"description": "Warning details. Empty when no warning occurs."
},
"request_id": {
"type": "string",
"description": "The request identifier used for troubleshooting."
}
},
"additionalProperties": true
}
},
"v2.media_space.init_video_upload": {
"path": "/api/v2/media_space/init_video_upload",
"method": "POST",
"risk": "W",
"identity": "Shop",
"description": "media space: init video upload",
"input_schema": {
"type": "object",
"properties": {
"file_md5": {
"type": "string",
"maxLength": 262144,
"description": "md5 of video file"
},
"file_size": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "size of video file, in bytes, maximum is 30MB"
}
},
"required": [
"file_md5",
"file_size"
],
"additionalProperties": false,
"description": "v2.media_space.init_video_upload\nInitiate video upload session. Video duration should be between 10s and 60s (inclusive).\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"request_id": {
"type": "string",
"description": "The identifier of the API request for error tracking"
},
"response": {
"type": "object",
"properties": {
"video_upload_id": {
"type": "string",
"description": "The identifier of this upload session, used in following video upload request and item creating and/or updating"
}
},
"additionalProperties": true
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
}
},
"additionalProperties": true
}
},
"v2.media_space.complete_video_upload": {
"path": "/api/v2/media_space/complete_video_upload",
"method": "POST",
"risk": "W",
"identity": "Public",
"description": "media space: complete video upload",
"input_schema": {
"type": "object",
"properties": {
"video_upload_id": {
"type": "string",
"maxLength": 262144,
"description": "The ID of this upload session, returned in init_video_upload."
},
"part_seq_list": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"maxItems": 25,
"description": "All uploaded sequence number."
},
"report_data": {
"type": "object",
"properties": {
"upload_cost": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,19})$"
}
],
"x-integer": "uint64",
"description": "Time used for uploading the video file via upload_video_part api, in milliseconds. For video upload performance tracking purpose."
}
},
"required": [
"upload_cost"
],
"additionalProperties": false
}
},
"required": [
"video_upload_id",
"part_seq_list",
"report_data"
],
"additionalProperties": false,
"description": "v2.media_space.complete_video_upload\nComplete the video upload and starts the transcoding process when all parts are uploaded successfully.\nAuthorization: Public; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"request_id": {
"type": "string",
"description": "The identifier of this upload session, used in following video upload request and item creating and/or updating"
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
}
},
"additionalProperties": true
}
},
"v2.media_space.get_video_upload_result": {
"path": "/api/v2/media_space/get_video_upload_result",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "media space: get video upload result",
"input_schema": {
"type": "object",
"properties": {
"video_upload_id": {
"type": "string",
"maxLength": 262144
}
},
"required": [
"video_upload_id"
],
"additionalProperties": false,
"description": "v2.media_space.get_video_upload_result\nQuery the upload status and result of video upload.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Current status of this video upload session. could be: INITIATED(waiting for part uploading and/or the complete_video_upload API call), TRANSCODING(has received all video parts, and is transcoding the video file), SUCCEEDED(transcoding completed, and this upload_id can now be used for item adding/updating), FAILED(this upload failed, see the message filed for some info), CANCELLED(this upload is cancelled)"
},
"video_info": {
"type": "object",
"properties": {
"video_url_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"video_url_region": {
"type": "string",
"description": "The region of this video URL."
},
"video_url": {
"type": "string",
"description": "Video playback URL."
}
},
"additionalProperties": true
},
"description": "Video playback URL list."
},
"thumbnail_url_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"image_url_region": {
"type": "string",
"description": "The region of this image URL."
},
"image_url": {
"type": "string",
"description": "Image display URL."
}
},
"additionalProperties": true
},
"description": "Video thumbnail image URL list."
},
"duration": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^(0|[1-9][0-9]{0,19})$"
}
],
"x-integer": "uint64",
"description": "Duration of this video, in seconds."
}
},
"additionalProperties": true,
"description": "Transcoded video info, will be present if status is SUCCEEDED."
},
"message": {
"type": "string",
"description": "Detail error message if video uploading/transcoding failed."
}
},
"additionalProperties": true
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
}
},
"additionalProperties": true
}
},
"v2.media_space.cancel_video_upload": {
"path": "/api/v2/media_space/cancel_video_upload",
"method": "POST",
"risk": "D",
"identity": "Shop",
"description": "media space: cancel video upload",
"input_schema": {
"type": "object",
"properties": {
"video_upload_id": {
"type": "string",
"maxLength": 262144,
"description": "The ID of this upload session, returned in init_video_upload."
}
},
"required": [
"video_upload_id"
],
"additionalProperties": false,
"description": "v2.media_space.cancel_video_upload\nCancel a video upload session\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Warning message."
}
},
"additionalProperties": true
}
},
"v2.media.init_video_upload": {
"path": "/api/v2/media/init_video_upload",
"method": "POST",
"risk": "W",
"identity": "Public",
"description": "media: init video upload",
"input_schema": {
"type": "object",
"properties": {
"business": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Defines the business type of the uploaded image. Supported values: 3 = Video"
},
"scene": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Defines the purpose of the uploaded image under the specified business type. Supported values: - If business = 3 (Video): 1 = Shopee Video"
},
"file_name": {
"type": "string",
"maxLength": 262144,
"description": "Original video file name."
},
"file_size": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Total video file size in bytes. Rules and restrictions by business and scene: - If business = 3 (Video) and scene = 1 (Shopee Video): Maximum 1GB ."
},
"duration": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Video duration in seconds. Rules and restrictions by business and scene: - If business = 3 (Video) and scene = 1 (Shopee Video): 1s~180s ."
}
},
"required": [
"business",
"scene",
"file_name",
"file_size",
"duration"
],
"additionalProperties": false,
"description": "v2.media.init_video_upload\nUse this API to initialize a new video upload task and obtain a unique upload session ID.\nAuthorization: Public; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate warning message you should take care."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"video_upload_id": {
"type": "string",
"description": "Unique upload session ID."
},
"part_size": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The size of each part. When uploading video chunks, the video must be split according to this part size for each upload request."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.media.complete_video_upload": {
"path": "/api/v2/media/complete_video_upload",
"method": "POST",
"risk": "W",
"identity": "Public",
"description": "media: complete video upload",
"input_schema": {
"type": "object",
"properties": {
"video_upload_id": {
"type": "string",
"maxLength": 262144,
"description": "The unique ID of the upload task, returned by v2.media.init_video_upload."
}
},
"required": [
"video_upload_id"
],
"additionalProperties": false,
"description": "v2.media.complete_video_upload\nUse this API to finalize a video upload task. Once called, the system will transcode all uploaded video parts and prepare the video for use. All parts must be fully uploaded before calling this API.\nAuthorization: Public; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate warning message you should take care."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
}
},
"additionalProperties": true
}
},
"v2.media.get_video_upload_result": {
"path": "/api/v2/media/get_video_upload_result",
"method": "GET",
"risk": "R",
"identity": "Public",
"description": "media: get video upload result",
"input_schema": {
"type": "object",
"properties": {
"video_upload_id": {
"type": "string",
"maxLength": 262144,
"description": "The unique ID of the upload task, returned by v2.media.init_video_upload."
}
},
"required": [
"video_upload_id"
],
"additionalProperties": false,
"description": "v2.media.get_video_upload_result\nUse this API to retrieve the current status and result of a video upload task. You can also use video_upload_result_push to get notified immediately when a video upload reaches a final status (SUCCEEDED, FAILED, or CANCELLED).\nAuthorization: Public; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate warning message you should take care."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Current status of the upload task. Possible values: - INITIATED: Upload task has been created (via init_video_upload) but no parts have been uploaded yet. - UPLOADING: Video file parts are being uploaded. The upload has started but is not yet completed. - UPLOADED: All video parts have been uploaded successfully, waiting for complete_video_upload to trigger processing. - PROCESSING: Video is being transcoded/validated by the system (duration, format, resolution checks). - SUCCEEDED: Video upload and transcoding completed successfully. Video URL and cover URL are available for use. - FAILED: Upload or processing failed (e.g., invalid format, duration not within allowed range, transcoding error). - CANCELLED: Upload task was explicitly canceled by the client (cancel_video_upload), and the video is discarded."
},
"reason": {
"type": "string",
"description": "Detailed fail or cancel reason, will be returned if status is FAILED or CANCELLED."
},
"update_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The time of video status updates."
},
"video_info": {
"type": "object",
"properties": {
"video_url": {
"type": "string",
"description": "Video playback url."
},
"video_thumbnail_url": {
"type": "string",
"description": "Video thumbnail image url."
},
"thumbnail_width": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Video thumbnail image width."
},
"thumbnail_height": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Video thumbnail image width."
},
"duration": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Video duration in seconds."
},
"resolution": {
"type": "string",
"description": "Video resolution, e.g., \"1280x1280\"."
}
},
"additionalProperties": true,
"description": "Transcoded video info, will be returned if status is SUCCEEDED."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.media.cancel_video_upload": {
"path": "/api/v2/media/cancel_video_upload",
"method": "POST",
"risk": "D",
"identity": "Public",
"description": "media: cancel video upload",
"input_schema": {
"type": "object",
"properties": {
"video_upload_id": {
"type": "string",
"maxLength": 262144,
"description": "The unique ID of the upload task, returned by v2.media.init_video_upload."
}
},
"required": [
"video_upload_id"
],
"additionalProperties": false,
"description": "v2.media.cancel_video_upload\nUse this API to cancel an ongoing video upload task. If the upload has already succeeded, failed, or been cancelled, this operation will fail and return error.\nAuthorization: Public; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "string",
"description": "Indicate warning message you should take care."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
}
},
"additionalProperties": true
}
},
"v2.shop.get_shop_info": {
"path": "/api/v2/shop/get_shop_info",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "shop: get shop info",
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false,
"description": "v2.shop.get_shop_info\nUse this call to get information of shop\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"shop_name": {
"type": "string",
"description": "Name of the shop."
},
"region": {
"type": "string",
"description": "Shop's area."
},
"status": {
"type": "string",
"description": "Applicable status: BANNED , FROZEN , NORMAL ."
},
"sip_affi_shops": {
"type": "array",
"items": {
"type": "object",
"properties": {
"affi_shop_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Affiliate shop's id."
},
"region": {
"type": "string",
"description": "Affiliate Shop's area."
}
},
"additionalProperties": true
},
"description": "SIP affiliate shops info list.If you request for SIP primary shop,this field will be returned, if you request for SIP affiliate shop,this field won't be returned"
},
"is_cb": {
"type": "boolean",
"description": "Use this filed to indicate whether the shop is a cross-border shop."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"auth_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The timestamp when the shop was authorized to the partner."
},
"expire_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Use this field to indicate the expiration date for shop authorization."
},
"is_sip": {
"type": "boolean",
"description": "This filed will return \"true\" when SIP primary shop or affiliate shop calls"
},
"is_upgraded_cbsc": {
"type": "boolean",
"description": "Use this filed to indicate whether this merchant is upgraded to CBSC, including CNSC and KRSC."
},
"merchant_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
},
{
"type": "null"
}
],
"x-integer": "int64",
"description": "Shopee’s unique identifier for a merchant. If the shop won't under any merchant, then the value will be null."
},
"shop_fulfillment_flag": {
"type": "string",
"description": "Use this field to indicate the fulfillment type of current shop, the applicable values: - Pure - FBS Shop: Single mode, refer to Local/CB shops which only have Shopee official warehouse stock, orders are fulfilled by Shopee from Shopee official warehouse; - Pure - 3PF Shop: Single mode, refer to CB shops which only have local seller warehouse stock, orders are fulfilled by seller from local seller warehouse via local logistics channels; - PFF - FBS Shop: 1) Hybird mode, refer to Local shops which have both Shopee official warehouse stock and local seller warehouse stock, orders can be fulfilled by Shopee from Shopee official warehouse and can also fulfilled by seller from local seller warehouse via local logistics channels; 2) Hybrid mode, refer to CB shops which have both Shopee official warehouse stock and CB seller warehouse stock, orders can be fulfilled by Shopee from Shopee official warehouse and can also fulfilled by seller from CB seller warehouse via CB logistics channels; - PFF - 3PF Shop: Hybrid mode, refer to CB shops which have both local seller warehouse stock and CB seller warehouse stock, orders can be fulfilled by seller from local seller warehouse via local logistics channels and can also fulfilled by seller from CB seller warehouse via CB logistics channels; - LFF Hybrid Shop: Hybrid mode, refer to CB shops which have 3 types of stock: FBS stock (Shopee official warehouse stock), 3PF stock (CB seller own stock in the local market) and CB SLS stock (CB seller own stock in CN/HK/KR); - Others - Unknown: Returned when obtaining shop_fulfillment_flag information fails"
},
"is_main_shop": {
"type": "boolean",
"description": "Identifies if the current shop is a Local Shop linked to Cross Border Direct Shop."
},
"is_direct_shop": {
"type": "boolean",
"description": "Identifies if the current shop is a Cross Border Direct Shop."
},
"linked_main_shop_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Returns the Shop ID of the Local Shop linked to the Cross Border Direct Shop."
},
"linked_direct_shop_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"direct_shop_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shop ID of the Cross Border Direct Shop."
},
"direct_shop_region": {
"type": "string",
"description": "Shop Region of the Cross Border Direct Shop."
}
},
"additionalProperties": true
},
"description": "Returns the list of Cross Border Direct Shops linked to the Local Shop."
},
"is_one_awb": {
"type": "boolean",
"description": "Use this filed to indicate if the shop is in 1-AWB whitelist. If is_one_awb return true, please use new AWB size (10cm x 15cm thermal paper) to print AWB. For more details, please refer to: https://open.shopee.com/announcements/1138?category=3&is_top=false"
},
"is_mart_shop": {
"type": "boolean",
"description": "Indicates whether the current shop is a Mart Shop."
},
"is_outlet_shop": {
"type": "boolean",
"description": "Indicates whether the current shop is an Outlet Shop."
},
"mart_shop_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "(Only returned when requesting an Outlet Shop) Refers to the Mart Shop ID this Outlet belongs to."
},
"outlet_shop_info_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"outlet_shop_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shop ID of the Outlet Shop."
}
},
"additionalProperties": true
},
"description": "(Only returned when requesting a Mart Shop) List of Outlet Shop IDs under this Mart Shop."
},
"mart_outlet_structure_type": {
"type": "string",
"description": "(Only returned when requesting a Mart or Outlet Shop) Indicates the structure type of the Mart or Outlet shop. Applicable values are: normal_mart_shop, warehouse_mart_shop, normal_outlet_shop, warehouse_outlet_shop"
}
},
"additionalProperties": true
}
},
"v2.shop.get_profile": {
"path": "/api/v2/shop/get_profile",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "shop: get profile",
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false,
"description": "v2.shop.get_profile\nThis API support to get information of shop.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Messages about the error and it's cause if there're errors. It will be just return the updated information if there's no error."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"shop_logo": {
"type": "string",
"description": "The Image URL of the shop logo."
},
"description": {
"type": "string",
"description": "The content of the shop description."
},
"shop_name": {
"type": "string",
"description": "The content of the shop name."
},
"invoice_issuer": {
"type": "string",
"description": "The invoice issuer information for the shop. It could be \"Shopee\" or \"Other\" as the invoice issuer. This is for BR CNPJ seller only."
}
},
"additionalProperties": true,
"description": "The information about shop logo, shop name, shop description."
},
"error": {
"type": "string",
"description": "The error key if there's error."
}
},
"additionalProperties": true
}
},
"v2.shop.update_profile": {
"path": "/api/v2/shop/update_profile",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "shop: update profile",
"input_schema": {
"type": "object",
"properties": {
"shop_name": {
"type": "string",
"maxLength": 262144,
"description": "The new shop name"
},
"shop_logo": {
"type": "string",
"maxLength": 262144,
"description": "The new shop logo url. Recommend to use images"
},
"description": {
"type": "string",
"maxLength": 262144,
"description": "The new shop description."
}
},
"required": [],
"additionalProperties": false,
"description": "v2.shop.update_profile\nThis API support to let sellers to update the shop name, shop logo, and shop description.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Messages about the error and it's cause if there're errors. It will be just return the updated information if there's no error."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "string",
"description": "If update successfully, the information is about shop logo, shop name, shop description."
},
"error": {
"type": "string",
"description": "The error key if there's error."
}
},
"additionalProperties": true
}
},
"v2.shop.get_warehouse_detail": {
"path": "/api/v2/shop/get_warehouse_detail",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "shop: get warehouse detail",
"input_schema": {
"type": "object",
"properties": {
"warehouse_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Type of warehouse. Applicable values: - 1: Pickup Warehouse - 2: Return Warehouse Default value is 1 (Pickup Warehouse)"
}
},
"required": [],
"additionalProperties": false,
"description": "v2.shop.get_warehouse_detail\nFor given shop id and region, return warehouse info including warehouse id, address id and location id, return all warehouse with once call.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "The error key if there's error."
},
"message": {
"type": "string",
"description": "Messages about the error and it's cause if there're errors. It will be just return the updated information if there's no error."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "array",
"items": {
"type": "object",
"properties": {
"warehouse_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Warehouse address identifier. It should be unique for every warehouse address"
},
"warehouse_name": {
"type": "string",
"description": "The warehouse name filled in when creating the warehouse address"
},
"warehouse_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Type of warehouse. Applicable values: - 1: Pickup Warehouse - 2: Return Warehouse"
},
"location_id": {
"type": "string",
"description": "Location identifier for stocks. Different location_ids represent that your addresses are in different item stocks"
},
"address_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Identity of address"
},
"region": {
"type": "string",
"description": "Region of your warehouse address"
},
"state": {
"type": "string",
"description": "State of your warehouse address"
},
"city": {
"type": "string",
"description": "City of your warehouse address"
},
"address": {
"type": "string",
"description": "Detail address of your warehouse address"
},
"zipcode": {
"type": "string",
"description": "Zipcode of your warehouse address"
},
"district": {
"type": "string",
"description": "Distinct of your warehouse address"
},
"town": {
"type": "string",
"description": "Town of your warehouse address"
},
"state_code": {
"type": "string",
"description": "State code of your warehouse address"
},
"holiday_mode_state": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The holiday mode state of your address. 0: not in holiday mode 1: holiday mode active 2: holiday mode is turning of 3: holiday mode is turning on"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"v2.shop.get_shop_notification": {
"path": "/api/v2/shop/get_shop_notification",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "shop: get shop notification",
"input_schema": {
"type": "object",
"properties": {
"cursor": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "The last notification_id returned on the page. When using the cursor, notifications will start with the one following this cursor notification. If no cursor is provided, the latest message from the shop will be returned."
},
"page_size": {
"description": "Default 10; maximum 50",
"x-pageMax": 50,
"type": "integer",
"minimum": 1,
"maximum": 50,
"default": 50
}
},
"required": [],
"additionalProperties": false,
"description": "v2.shop.get_shop_notification\nget Seller Center notification, the permission is controlled by App type\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"cursor": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Last notification_id returned in the page"
},
"data": {
"type": "object",
"properties": {
"create_time": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "the notification create time"
},
"content": {
"type": "string",
"description": "The content of the notification"
},
"title": {
"type": "string",
"description": "The content of the notification"
},
"url": {
"type": "string",
"description": "Some notification may be attached with URL, it will redirect to seller center"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.shop.get_authorised_reseller_brand": {
"path": "/api/v2/shop/get_authorised_reseller_brand",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "shop: get authorised reseller brand",
"input_schema": {
"type": "object",
"properties": {
"page_no": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call."
},
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Each result set is returned as a page of entries. Use the \"page_size\" filters to control the maximum number of entries to retrieve per page (i.e., per call), and the \"page_no\" to start next call. This integer value is used to specify the maximum number of entries to return in a single \"page\" of data. The limit of page_size if between 1 and 30.",
"x-pageMax": 100,
"default": 50
}
},
"required": [
"page_no",
"page_size"
],
"additionalProperties": false,
"description": "v2.shop.get_authorised_reseller_brand\nGet the authorised reseller brand list for the shop.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"is_authorised_reseller": {
"type": "boolean",
"description": "This is to indicate whether the shop is authorised reseller."
},
"total_count": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The number of authorised brand linked with the shop."
},
"more": {
"type": "boolean",
"description": "This is to indicate whether the authorised brand list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of authorised brand."
},
"authorised_brand_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the authorised brand, it may be the same in different regions."
},
"brand_name": {
"type": "string",
"description": "Name of the authorised brand."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.shop.get_br_shop_onboarding_info": {
"path": "/api/v2/shop/get_br_shop_onboarding_info",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "shop: get br shop onboarding info",
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false,
"description": "v2.shop.get_br_shop_onboarding_info\n[For BR Shop Only] Use this API to get shop KYC registration and qualification information.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"tax_id_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Type of the shop’s tax ID. Applicable values: 1: Personal seller (CPF) 2: Company seller (CNPJ)"
},
"tax_id": {
"type": "string",
"description": "The shop’s tax ID. - When tax_id_type = 1 (Personal seller), it is CPF. - When tax_id_type = 2 (Company seller), it is CNPJ."
},
"cpf_id": {
"type": "string",
"description": "CPF number of the individual seller. Valid only when tax_id_type = 1."
},
"cnpj_id": {
"type": "string",
"description": "CNPJ number of the company seller. Valid only when tax_id_type = 2."
},
"name": {
"type": "string",
"description": "Full name of the individual seller. Valid only when tax_id_type = 1."
},
"legal_entity_name": {
"type": "string",
"description": "Legal name of the company seller. Valid only when tax_id_type = 2."
},
"birthday": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Birthday of the individual seller (stored as Unix timestamp). Valid only when tax_id_type = 1."
},
"birthday_str": {
"type": "string",
"description": "Birthday of the individual seller (formatted as YYYY-MM-DD). Valid only when tax_id_type = 1."
},
"state_registration": {
"type": "string",
"description": "State registration number of the shop."
},
"billing_address": {
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "State of the billing address."
},
"city": {
"type": "string",
"description": "City of the billing address."
},
"address": {
"type": "string",
"description": "Specific detail of the billing address."
},
"zipcode": {
"type": "string",
"description": "ZIP code of the billing address."
},
"neighborhood": {
"type": "string",
"description": "Neighborhood of the billing address."
}
},
"additionalProperties": true,
"description": "Shop’s billing address details."
},
"onboarding_status": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Status of the shop’s current KYC onboarding process. Applicable values: 0: None 1: Regis Processing 2: Regis Validated 3: Regis Rejected 4: KYC Pending 5: KYC Processing 6: KYC Processing Manually 7: KYC Validated 8: KYC Rejected"
},
"submission_time": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Timestamp when the onboarding information was submitted."
},
"nationality": {
"type": "string",
"description": "Nationality of the individual seller. Valid only when tax_id_type=1."
},
"cnae_main": {
"type": "string",
"description": "Main CNAE code."
},
"cnae_secondary": {
"type": "string",
"description": "Secondary CNAE code."
},
"mei_check": {
"type": "string",
"description": "MEI verification result. Applicable values: 0: No 1: Yes"
},
"onboarding_passed": {
"type": "boolean",
"description": "Indicate if the shop has passed KYC verification."
}
},
"additionalProperties": true,
"description": "Onboarding information of the Shop."
}
},
"additionalProperties": true
}
},
"v2.shop.get_shop_holiday_mode": {
"path": "/api/v2/shop/get_shop_holiday_mode",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "shop: get shop holiday mode",
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false,
"description": "v2.shop.get_shop_holiday_mode\nUse this API to check whether a shop has enabled holiday mode and its ongoing and upcoming holiday mode period.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"holiday_mode_on": {
"type": "boolean",
"description": "Indicate whether the shop has enabled holiday mode. true means ON, false means OFF."
},
"holiday_mode_mtime": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The last time the holiday mode was modifies."
},
"holiday_mode_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Indicate whether the holiday mode is partial holiday or full holiday. 1: Partial Holiday: seller can still receive orders during partial holiday 0: Full Holiday: seller can not receive orders during full holiday only when holiday_mode_on = true will the holiday_mode_type work"
},
"holiday_mode_start_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Holiday start time timestamp."
},
"holiday_mode_end_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Holiday end time timestamp."
},
"holiday_mode_description": {
"type": "string",
"description": "Description of the holiday"
},
"debug_msg": {
"type": "string",
"description": "Debug message."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.shop.set_shop_holiday_mode": {
"path": "/api/v2/shop/set_shop_holiday_mode",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "shop: set shop holiday mode",
"input_schema": {
"type": "object",
"properties": {
"holiday_mode_on": {
"type": "boolean",
"description": "Indicate whether to enable holiday mode for the shop. true means turn ON, false means turn OFF."
},
"holiday_mode_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Holiday type: 0 - Full holiday,buyers cannot place new orders. The behavior remains consistent with the current Holiday Mode. 1 - Partial holiday, buyers can continue placing orders, and the system will automatically extend the order’s Ship-By-Date (SBD)."
},
"holiday_mode_start_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Holiday start time should be whole hour and could be parsed as \"2026:01:16 15:00:00\""
},
"holiday_mode_end_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Holiday end time plus one second should be whole hour, which means the input timestamp must be able to be parsed as \"2025:01:20 17:59:59\" and the holiday_end_time must be larger than holiday_start_time"
},
"holiday_mode_description": {
"type": "string",
"maxLength": 262144,
"description": "Description of the holiday"
}
},
"required": [
"holiday_mode_on"
],
"additionalProperties": false,
"description": "v2.shop.set_shop_holiday_mode\nUse this API to set holiday periods in advance for automatic on/off of holiday mode and there are two holiday modes allowing sellers to choose whether to accept new orders during holiday.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"debug_msg": {
"type": "string",
"description": "Debug message."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.order.get_order_list": {
"path": "/api/v2/order/get_order_list",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "order: get order list",
"input_schema": {
"type": "object",
"properties": {
"time_range_field": {
"type": "string",
"maxLength": 262144,
"description": "The kind of time_from and time_to. Available value: create_time, update_time."
},
"time_from": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The time_from and time_to fields specify a date range for retrieving orders (based on the time_range_field). The time_from field is the starting date range. The maximum date range that may be specified with the time_from and time_to fields is 15 days."
},
"time_to": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The time_from and time_to fields specify a date range for retrieving orders (based on the time_range_field). The time_from field is the starting date range. The maximum date range that may be specified with the time_from and time_to fields is 15 days."
},
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Each result set is returned as a page of entries. Use the \"page_size\" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single \"page\" of data.The limit of page_size if between 1 and 100.",
"x-pageMax": 100,
"default": 50
},
"cursor": {
"type": "string",
"maxLength": 262144,
"description": "Specifies the starting entry of data to return in the current call. The default is empty. If the data is more than one page, the offset can be some entry to start the next call."
},
"order_status": {
"type": "string",
"maxLength": 262144,
"description": "The order_status filter for retriveing orders and each one only every request. Available value: UNPAID/READY_TO_SHIP/PROCESSED/SHIPPED/COMPLETED/IN_CANCEL/CANCELLED/INVOICE_PENDING"
},
"response_optional_fields": {
"type": "string",
"maxLength": 262144,
"description": "Optional fields in response. Available value: order_status."
},
"request_order_status_pending": {
"type": "boolean",
"description": "Compatible parameter during migration period, send True will let API support PENDING status, send False or don’t send will fallback to old logic."
},
"logistics_channel_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The identity of logistic channel. Valid only for BR."
}
},
"required": [
"time_range_field",
"time_from",
"time_to",
"page_size"
],
"additionalProperties": false,
"description": "v2.order.get_order_list\nUse this api to search orders. You may also filter them by status, if needed.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"more": {
"type": "boolean",
"description": "This is to indicate whether the order list is more than one page. If this value is true, you may want to continue to check next page to retrieve orders."
},
"order_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
},
"order_status": {
"type": "string",
"description": "The order_status filter for retriveing orders and each one only every request. Available value: UNPAID/READY_TO_SHIP/PROCESSED/SHIPPED/COMPLETED/IN_CANCEL/CANCELLED"
},
"booking_sn": {
"type": "string",
"description": "Return by default. Shopee's unique identifier for a booking. Only returned for advance fulfilment matched order only."
}
},
"additionalProperties": true
}
},
"next_cursor": {
"type": "string",
"description": "If more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
}
},
"additionalProperties": true
}
},
"v2.order.get_order_detail": {
"path": "/api/v2/order/get_order_detail",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "order: get order detail",
"input_schema": {
"type": "object",
"properties": {
"order_sn_list": {
"type": "string",
"maxLength": 262144,
"description": "The set of order_sn. If there are multiple order_sn, you need to use English comma to connect them. limit [1,50]",
"x-csvMax": 50
},
"request_order_status_pending": {
"type": "boolean",
"description": "Compatible parameter during migration period, send True will let API support PENDING status and return pending_terms, send False or don’t send will fallback to old logic"
},
"response_optional_fields": {
"type": "string",
"maxLength": 262144,
"description": "a response fields you want to get. Please select from the below response parameters. If you input an object field, all the params under it will be included automatically in the response. If there are multiple response fields you want to get, you need to use English comma to connect them. Available values: buyer_user_id,buyer_username,estimated_shipping_fee,recipient_address,actual_shipping_fee ,goods_to_declare,note,note_update_time,item_list,pay_time,dropshipper, dropshipper_phone,split_up,buyer_cancel_reason,cancel_by,cancel_reason,actual_shipping_fee_confirmed,buyer_cpf_id,fulfillment_flag,pickup_done_time,package_list,shipping_carrier,payment_method,total_amount,buyer_username,invoice_data,order_chargeable_weight_gram,return_request_due_date,edt,payment_info,international_label"
}
},
"required": [
"order_sn_list"
],
"additionalProperties": false,
"description": "v2.order.get_order_detail\nUse this api to get order detail.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"order_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Return by default. Shopee's unique identifier for an order."
},
"region": {
"type": "string",
"description": "Return by default. The two-digit code representing the region where the order was made."
},
"currency": {
"type": "string",
"description": "Return by default. The three-digit code representing the currency unit for which the order was paid."
},
"cod": {
"type": "boolean",
"description": "Return by default. This value indicates whether the order was a COD (cash on delivery) order."
},
"total_amount": {
"type": "number",
"description": "The total amount paid by the buyer for the order. This amount includes the total sale price of items, shipping cost beared by buyer; and offset by Shopee promotions if applicable. This value will only return after the buyer has completed payment for the order."
},
"pending_terms": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of pending terms. Applicable values: - SYSTEM_PENDING: Under Shopee internal processing. - KYC_PENDING: Under KYC checking (TW CB order only). - ARRANGE_SHIPMENT_PENDING: Temporarily held due to 3PL capacity constraints."
},
"pending_description": {
"type": "array",
"items": {
"type": "string"
},
"description": "The value of this field is the description of pending reason corresponding with pending terms. Applicable values: - For SYSTEM_PENDING: Order is being processed by Shopee. - For KYC_PENDING: Order is pending buyer TW KYC pre-authorization. - For ARRANGE_SHIPMENT_PENDING: Allocating delivery resources due to high order volume. Label print will be available within 4 days after buyer paid."
},
"order_status": {
"type": "string",
"description": "Return by default. Enumerated type that defines the current status of the order."
},
"shipping_carrier": {
"type": "string",
"description": "The logistics service provider that the buyer selected for the order to deliver items. Note: If logistics_channel_id is 90021, 90025 or 90026, service_code will be appended, e.g., Entrega Turbo - M1020."
},
"payment_method": {
"type": "string",
"description": "The payment method that the buyer selected to pay for the order. Applicable values: See Data Definition- Payment Methods."
},
"estimated_shipping_fee": {
"type": "number",
"description": "The estimated shipping fee is an estimation calculated by Shopee based on specific logistics courier's standard."
},
"message_to_seller": {
"type": "string",
"description": "Return by default. Message to seller."
},
"create_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Return by default. Timestamp that indicates the date and time that the order was created."
},
"update_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Return by default. Timestamp that indicates the last time that there was a change in value of order, such as order status changed from 'Paid' to 'Completed'."
},
"days_to_ship": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Return by default. Shipping preparation time set by the seller when listing item on Shopee."
},
"ship_by_date": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Return by default. The deadline to ship out the parcel."
},
"buyer_user_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The user id of buyer of this order, will be empty if it is a non-integrated order in TW region."
},
"buyer_username": {
"type": "string",
"description": "The name of buyer, will be masked as \"****\" if it is a non-integrated order in TW region."
},
"recipient_address": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Recipient's name for the address."
},
"phone": {
"type": "string",
"description": "Recipient's phone number input when order was placed. [Only for TW non-integrated channel] Will return \"****\" when the \"virtual_contact_number\" is available"
},
"town": {
"type": "string",
"description": "The town of the recipient's address. Whether there is a town will depend on the region and/or country."
},
"district": {
"type": "string",
"description": "The district of the recipient's address. Whether there is a district will depend on the region and/or country."
},
"city": {
"type": "string",
"description": "The city of the recipient's address. Whether there is a city will depend on the region and/or country."
},
"state": {
"type": "string",
"description": "The state/province of the recipient's address. Whether there is a state/province will depend on the region and/or country."
},
"region": {
"type": "string",
"description": "The two-digit code representing the region of the Recipient."
},
"zipcode": {
"type": "string",
"description": "Recipient's postal code."
},
"full_address": {
"type": "string",
"description": "The full address of the recipient, including country, state, even street, and etc."
},
"geolocation": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "Latitude."
},
"longitude": {
"type": "number",
"description": "Longitude."
}
},
"additionalProperties": true,
"description": "Geolocation info. Only available for logistics_channel_id 90026."
}
},
"additionalProperties": true,
"description": "This object contains detailed breakdown for the recipient address. Different parameters might be masked according to each market and kind of seller. For TW region integrated channel orders will be all masked as \"****\". More details may refer the announcement."
},
"actual_shipping_fee": {
"type": "number",
"description": "The actual shipping fee of the order if available from external logistics partners."
},
"goods_to_declare": {
"type": "boolean",
"description": "Only work for cross-border order.This value indicates whether the order contains goods that are required to declare at customs. \"T\" means true and it will mark as \"T\" on the shipping label; \"F\" means false and it will mark as \"P\" on the shipping label. This value is accurate ONLY AFTER the order trackingNo is generated, please capture this value AFTER your retrieve the trackingNo."
},
"note": {
"type": "string",
"description": "The note seller made for own reference."
},
"note_update_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Update time for the note."
},
"item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for an item."
},
"item_name": {
"type": "string",
"description": "The name of the item."
},
"item_sku": {
"type": "string",
"description": "A 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."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the model that belongs to the same item."
},
"model_name": {
"type": "string",
"description": "Name of the model that belongs to the same item. A seller can offer models of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate model. Each model can have a different quantity and price."
},
"model_sku": {
"type": "string",
"description": "A model SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are models of one item in Shopee Listings."
},
"model_quantity_purchased": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The number of identical items purchased at the same time by the same buyer from one listing/item."
},
"is_fulfillment_mapping": {
"type": "boolean",
"description": "Flag indicating whether the item contains any bundle items configured with Fulfillment Mapping (FFM). Returns 'true' if the item uses FFM logic, 'false' otherwise. Field will only be returned if shop is whitelisted."
},
"bundle_sku_id": {
"type": "string",
"description": "The unique identifier (SKU ID) of the front-facing Bundle SKU purchased by the buyer on Shopee. Field will only be returned if shop is whitelisted and is_fulfillment_mapping returns true."
},
"components": {
"type": "array",
"items": {
"type": "object",
"properties": {
"parent_sku_id": {
"type": "string",
"description": "The unique identifier (SKU ID) of the underlying physical component item (Parent SKU)."
},
"barcode_upc": {
"type": "string",
"description": "The physical barcode or UPC of the Parent SKU, used for scanning and inventory picking in the warehouse."
},
"quantity": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The mapping ratio/quantity of this specific Parent SKU required for ONE unit of the Bundle SKU (e.g., if Bundle A contains 2 units of Parent SKU B, quantity = 2)"
},
"warehouse_id": {
"type": "string",
"description": "The ID of the warehouse where the Parent SKU component is located/stored."
},
"mapping_type": {
"type": "string",
"description": "The structure/type of mapping defined for the bundle. Available values: 1: Group 2: Lucky bag 3: Mapping List"
}
},
"additionalProperties": true
},
"description": "List of underlying Parent SKUs (component level) associated with the mapped Bundle SKU, used by WMS/ERP for physical picking and fulfillment. If is_fulfillment_mapping returns 'false', this array will not be returned. Array will only be returned if shop is whitelisted and is_fulfillment_mapping returns true."
},
"model_original_price": {
"type": "number",
"description": "The original price of the item in the listing currency."
},
"model_discounted_price": {
"type": "number",
"description": "The after-discount price of the item in the listing currency. If there is no discount, this value will be same as that of model_original_price. In case of bundle deal item, this value will return 0 as by design bundle deal discount will not be breakdown to item/model level. Due to technical restriction, the value will return the price before bundle deal if we don't configure it to 0. Please call GetEscrowDetails if you want to calculate item-level discounted price for bundle deal item."
},
"wholesale": {
"type": "boolean",
"description": "This value indicates whether buyer buy the order item in wholesale price."
},
"weight": {
"type": "number",
"description": "The weight of the item"
},
"add_on_deal": {
"type": "boolean",
"description": "To indicate if this item belongs to an addon deal."
},
"main_item": {
"type": "boolean",
"description": "To indicate if this item is main item or sub item. True means main item, false means sub item."
},
"add_on_deal_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "A unique ID to distinguish groups of items in Cart, and Order. (e.g. AddOnDeal)"
},
"promotion_type": {
"type": "string",
"description": "Available type:product_promotion, flash_sale, bundle_deal, add_on_deal_main, add_on_deal_sub. For items which attend multiple promotions will only show one promotion, the order of priority is: bundle_deal > add_on_deal_main > add_on_deal_sub > product_promotion >flash_sale"
},
"promotion_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The ID of the promotion."
},
"order_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identify of order item."
},
"line_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of order item. In case the order item is a bundle deal, this value will be unique to distinguish the order item"
},
"promotion_group_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The identify of product promotion."
},
"image_info": {
"type": "object",
"properties": {
"image_url": {
"type": "string",
"description": "The image url of the product. Default to be variation image, if the model does not have a variation image, will use an item main image instead."
}
},
"additionalProperties": true,
"description": "Image info of the product."
},
"product_location_id": {
"type": "string",
"description": "The fulfilment warehouse ID(s) of the items in the order. (Multi-Warehouse sellers only)"
},
"is_prescription_item": {
"type": "boolean",
"description": "To indicate if this item is prescription item. Only for PH, TH, ID local shop."
},
"error_in_fetching_is_prescription_item": {
"type": "boolean",
"description": "To indicate if there was an error when validating whether this item is prescription. Default false. If is_prescription_item=false and this field is true, the item's prescription status is uncertain (label service call failed). Only for TH, PH, ID local shop."
},
"consultation_id": {
"type": "string",
"description": "An identifier of teleconsultation session which buyer did to order this item. Empty if item is not ordered through teleconsultation session"
},
"is_b2c_owned_item": {
"type": "boolean",
"description": "determine if item is B2C_shop_item It should be ` is_b2c_shop_item ` but it was a bug from dev. Then now it's is_b2c_owned_item"
},
"promotion_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"promotion_type": {
"type": "string",
"description": "Indicates the type of item or package level promotion applied to a product. Each item can be associated with at most one item promotion and one package promotion at a time. Item Promotions: low_price_promotion deep_discount platform_sale seller_discount flash_sale wholesale welcome_package_free_gift brand_flash_sale in_shop_flash_sale synced_promo platform_streaming_price seller_streaming_price exclusive_streamer_price price_bidding_with_rebate price_bidding_without_rebate seller_advisor_price selling_price settlement_price campaign_settlement_price local_sip_settlement_price platform_exclusive_price seller_exclusive_price seller_member_exclusive_sku item_price order_sync_price Package Promotions: bundle_deal add_on_deal_main add_on_deal_sub"
},
"promotion_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Represents the unique identifier of a specific promotion applied to an item. Each promotion_id corresponds to a distinct promotion rule or campaign, defined under a particular promotion_type. The value is expressed in a numeric string format."
}
},
"additionalProperties": true
}
},
"hot_listing_item": {
"type": "boolean",
"description": "[Only for PH,TH,VN,MY,BR,TW] True if the item is hot listing."
},
"active_qty": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The quantity of the item model that remains active in the order and is still expected to be fulfilled."
},
"cancel_requested_qty": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The quantity of the item model that is currently under a cancellation request but has not yet reached the final cancelled status."
},
"cancelled_qty": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The quantity of the item model that has already been successfully cancelled."
},
"return_requested_qty": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The quantity of the item model that is currently under a return/refund request."
},
"returned_qty": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The quantity of the item model that has already been successfully returned through the return/refund process."
}
},
"additionalProperties": true
},
"description": "This object contains the detailed breakdown for the result of this API call."
},
"pay_time": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 9007199254740991,
"description": "The time when the order status is updated from UNPAID to PAID. This value is NULL when order is not paid yet."
},
"dropshipper": {
"type": "string",
"description": "For Indonesia orders only. The name of the dropshipper."
},
"dropshipper_phone": {
"type": "string",
"description": "The phone number of dropshipper, could be empty."
},
"split_up": {
"type": "boolean",
"description": "To indicate whether this order is split to fullfil order(forder) level. Call GetForderInfo if it's \"true\"."
},
"buyer_cancel_reason": {
"type": "string",
"description": "Cancel reason from buyer, could be empty."
},
"cancel_by": {
"type": "string",
"description": "Could be one of buyer, seller, system or Ops."
},
"cancel_reason": {
"type": "string",
"description": "Use this field to get reason for buyer, seller, and system cancellation."
},
"actual_shipping_fee_confirmed": {
"type": "boolean",
"description": "Use this filed to judge whether the actual_shipping_fee is confirmed."
},
"buyer_cpf_id": {
"type": "string",
"description": "Buyer's CPF number for taxation and invoice purposes. Only for Brazil order."
},
"fulfillment_flag": {
"type": "string",
"description": "Use this field to indicate the order is fulfilled by shopee or seller. Applicable values: fulfilled_by_shopee, fulfilled_by_cb_seller, fulfilled_by_local_seller."
},
"pickup_done_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The timestamp when pickup is done."
},
"package_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
},
"logistics_status": {
"type": "string",
"description": "The Shopee logistics status for the order. Applicable values: See Data Definition-LogisticsStatus."
},
"logistics_channel_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of logistic channel."
},
"shipping_carrier": {
"type": "string",
"description": "The logistics service provider that the buyer selected for the order to deliver items. Note: If logistics_channel_id is 90021, 90025 or 90026, service_code will be appended, e.g., Entrega Turbo - M1020."
},
"allow_self_design_awb": {
"type": "boolean",
"description": "To indicate whether the package allows for self-designed AWB, if allow_self_design_awb returns false, it means that the package does not allow for self-designed AWB and only the system-AWB can be used."
},
"item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for an item."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for a model."
},
"model_quantity": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The number of identical items/variations purchased at the same time by the same buyer from one listing/item."
},
"order_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identify of order item. For items in one same bundle deal promotion, the order_item_id should share the same id, such as 1,2. For items not in bundle deal promotion, the order_item_id should be the same as item_id."
},
"promotion_group_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The identify of product promotion."
},
"product_location_id": {
"type": "string",
"description": "The warehouse ID of the item."
}
},
"additionalProperties": true
},
"description": "The lis of items."
},
"parcel_chargeable_weight": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "display weight used to calculate ASF for this parcel"
},
"group_shipment_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The common identifier for multiple orders combined in the same parcel."
},
"virtual_contact_number": {
"type": "string",
"description": "[Only for TW non-integrated channel] The virtual phone number to contact the recipient."
},
"package_query_number": {
"type": "string",
"description": "[Only for TW non-integrated channel] The query number used in virtual phone number calls to contact the recipient of this package."
},
"sorting_group": {
"type": "string",
"description": "[Only for TW 30029 channel] This field indicate the sorting group value of the package. This field is only available for logistics_channel_id = 30029 and after the package has been arranged for shipment."
}
},
"additionalProperties": true
},
"description": "The list of package under an order"
},
"invoice_data": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The number of the invoice."
},
"series_number": {
"type": "string",
"description": "The series number of the invoice."
},
"access_key": {
"type": "string",
"description": "The access key of the invoice."
},
"issue_date": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The issue date of the invoice."
},
"total_value": {
"type": "number",
"description": "The total value of the invoice."
},
"products_total_value": {
"type": "number",
"description": "The products total value of the invoice."
},
"tax_code": {
"type": "string",
"description": "The tax code for the invoice."
},
"status": {
"type": "string",
"description": "The invoice statuses should be: - valid (The invoice sent is valid) - pending (System is waiting to receive the invoice)"
},
"pending_reason": {
"type": "string",
"description": "It's the failed reason if status is pending"
}
},
"additionalProperties": true,
"description": "The invoice data of the order."
},
"checkout_shipping_carrier": {
"type": "string",
"description": "For non masking order, the logistics service provider that the buyer selected for the order to deliver items. For masking order, the logistics service type that the buyer selected for the order to deliver items."
},
"reverse_shipping_fee": {
"type": "number",
"description": "Shopee charges the reverse shipping fee for the returned order.The value of this field will be non-negative."
},
"order_chargeable_weight_gram": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "display weight used to calculate ASF for this order"
},
"prescription_check_status": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Prescription check status. For ID, PH whitelisted sellers, the applicable values: 0: NONE 1: PASSED 2: FAILED For TH whitelisted sellers, the applicable values: 0: NONE 1: PASSED"
},
"pharmacist_name": {
"type": "string",
"description": "Name of the Pharmacist for Prescription Order."
},
"prescription_images": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return prescription images of this order, only for ID and PH whitelist sellers. Please add the prefix to review: for ID: https://cf.shopee.co.id/file/+prescription_image for PH: https://cf.shopee.ph/file/+prescription_image"
},
"prescription_approval_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Time of when the prescription is approved."
},
"prescription_rejection_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Time of when the prescription is rejected."
},
"prescription_reject_reason": {
"type": "string",
"description": "Return the reason why a prescription is rejected. If there is no rejection reason, return empty.Only for ID and PH whitelist sellers"
},
"is_buyer_shop_collection": {
"type": "boolean",
"description": "To indicate if this order is buyer self collection at store order"
},
"buyer_proof_of_collection": {
"type": "array",
"items": {
"type": "string"
},
"description": "The image url of the buyer self collection at the store."
},
"edt_from": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Earliest estimated delivery date of orders (only available for BR region)"
},
"edt_to": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Latest estimated delivery time of orders (only available for BR region)"
},
"booking_sn": {
"type": "string",
"description": "Return by default. Shopee's unique identifier for a booking. Only returned for advance fulfilment matched order only."
},
"advance_package": {
"type": "boolean",
"description": "Indicate whether order will be fulfilled using advance fulfilment stock or not. If value is true, order will be matched with a booking and seller should not arrange shipment."
},
"return_request_due_date": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "This field represents the deadline for buyers to initiate returns and refunds after order is completed. The “return_request_due_date” response parameter will be returned if the requested order meets ALL the conditions below: - The status of the order is COMPLETED - The return refund eligibility of the order is true If you have any questions related to the function of \"returns and refunds after order is completed,\" please refer to the following link: https://seller.shopee.tw/edu/article/18474"
},
"payment_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"payment_method": {
"type": "string",
"description": "[Only for BR] Payment method used in the order, such as Credit Card, Debit Card, Pix, etc."
},
"payment_processor_register": {
"type": "string",
"description": "[Only for BR] CNPJ of the payment processor handling the transaction."
},
"card_brand": {
"type": "string",
"description": "[Only for BR] Card brand for credit or debit transactions, such as VISA, MASTER, etc. Empty string for Pix payments."
},
"transaction_id": {
"type": "string",
"description": "[Only for BR] Payment authorization code generated by the bank or payment processor to validate the transaction."
},
"payment_amount": {
"type": "number",
"description": "[Only for BR] Amount paid by the corresponding payment method."
}
},
"additionalProperties": true
},
"description": "[Only for BR] List of payment information, to follow NT 2025.001 (BR government invoice rules)."
},
"hot_listing_order": {
"type": "boolean",
"description": "[Only for PH,TH,VN,MY,BR,TW] True if the order includes hot listing item."
},
"is_international": {
"type": "boolean",
"description": "[Only for BR] Indicate if the order is SIP order. This field will only be returned if international_label is included in response_optional_field in the request."
},
"can_full_cancel_order": {
"type": "boolean",
"description": "Indicates whether the order can be full cancelled: - If this value is true, seller can cancel the entire order - If the value is false, full order cancellation is not available for the order"
},
"can_partial_cancel_order": {
"type": "boolean",
"description": "Indicates whether the order is eligible for partial cancellation. This value is determined by both the system eligibility check and the buyer’s out-of-stock handling preference. - If this value is true, seller can cancel selected out-of-stock item quantities while continuing to fulfill the remaining items. - If this value is false, partial cancellation is not allowed."
},
"buyer_preference_for_partial_cancellation": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Indicates the buyer’s preference for handling out-of-stock items in the order. Applicable values: 0 = Ship Available Items Only (The buyer allows the seller to cancel unavailable items and continue shipping the remaining available items) 1 = Cancel The Entire Order (The buyer does not allow partial cancellation. If any item is unavailable, the seller should cancel the entire order instead)"
},
"affiliate_sample_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Indicates that this order is a refundable sample order. Applicable values: 0 = Order is not a refundable sample order 1 = Order is a refundable sample order"
}
},
"additionalProperties": true
},
"description": "The list of orders."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
},
"warning": {
"type": "array",
"items": {
"type": "string"
},
"description": "Indicate warning message you should take care."
}
},
"additionalProperties": true
}
},
"v2.order.get_shipment_list": {
"path": "/api/v2/order/get_shipment_list",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "order: get shipment list",
"input_schema": {
"type": "object",
"properties": {
"cursor": {
"type": "string",
"maxLength": 262144,
"description": "Specifies the starting entry of data to return in the current call. Default is \"\". If data is more than one page, the offset can be some entry to start next call."
},
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Each result set is returned as a page of entries. Use the \"page_size\" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single \"page\" of data.The limit of page_size if between 1 and 100.",
"x-pageMax": 100,
"default": 50
}
},
"required": [
"page_size"
],
"additionalProperties": false,
"description": "v2.order.get_shipment_list\nUse this api to get order list which order_status is READY_TO_SHIP or RETRY_SHIP to start process the whole shipping progress.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"order_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order"
}
},
"additionalProperties": true
},
"description": "The list of shipment orders"
},
"more": {
"type": "boolean",
"description": "This is to indicate whether the order list is more than one page. If this value is true, you may want to continue to check next page to retrieve orders."
},
"next_cursor": {
"type": "string",
"description": "If more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
}
},
"additionalProperties": true
}
},
"v2.order.search_package_list": {
"path": "/api/v2/order/search_package_list",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "order: search package list",
"input_schema": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"package_status": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Use this field to filter the packages of specific status. Applicable values: 0: All 1: Pending 2: ToProcess 3: Processed Default value = 2 (ToProcess)"
},
"product_location_ids": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "List of product_location_id. Use this field to filter the packages under specific warehouses."
},
"logistics_channel_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"maxItems": 100,
"description": "List of logistics_channel_id. Use this field to filter the packages under specific logistics channels."
},
"fulfillment_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Use this field to filter the packages fulfilled by shopee or seller. Applicable values: 0: None (not apply filter) 1: Shopee 2: Seller Default value = 2 (Seller)"
},
"invoice_pending": {
"type": "boolean",
"description": "Use this field to filter the packages under invoice_pending. Default value = false"
},
"sorting_group": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "[Only for TW 30029 channel] Use this field to filter the sorting group of parcel. This field is only available for package with package_status = 3 and logistics_channel_id = 30029. Applicable values: 0: All 1: North 2: South"
},
"order_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Use this field to filter packages by order type. Applicable values: 0: All 1: Regular Order 2: Instant Order Default value = 0 (All) Note: For VN shops, using 2: Instant Order will return both Instant Delivery and Same-day Delivery packages."
},
"is_pre_order": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Use this field to filter packages by pre-order status. Applicable values: 0: All 1: Pre-Order 2: Non Pre-Order Default value = 0 (All)"
},
"shipping_priority": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Use this field to filter packages by shipping priority. Applicable values: - For MY/PH/TW/TH shops, and VN Preferred/Preferred Plus/Shopee Mall shops: 0: All 1: Overdue 2: Ship by Today 3: Ship by Tomorrow - For other shops: 0: All 1: Overdue 2: Within 24h 3: Beyond 24h Default value = 0 (All)"
}
},
"required": [],
"additionalProperties": false
},
"pagination": {
"type": "object",
"properties": {
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Each result set is returned as a page of entries. Use the \"page_size\" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single \"page\" of data.The limit of page_size if between 1 and 100.",
"x-pageMax": 100,
"default": 50
},
"cursor": {
"type": "string",
"maxLength": 262144,
"description": "Specifies the starting entry of data to return in the current call. Default is \"\". If data is more than one page, the offset can be some entry to start next call."
}
},
"required": [
"page_size"
],
"additionalProperties": false
},
"sort": {
"type": "object",
"properties": {
"sort_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Use this field to specify which field to use to sort the returned package list. Available values: 1: ShipByDate 2: CreateDate 3: ConfirmedDate Default value = 1 (ShipByDate)"
},
"ascending": {
"type": "boolean",
"description": "Use this field to specify whether the returned package list is sorted in ascending or descending sort_type. Default value = true"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"pagination"
],
"additionalProperties": false,
"description": "v2.order.search_package_list\nUse this API to search the list of packages that have not been SHIPPED to proceed arranging shipment, and it supports various filters and sort fields.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"mesage": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"packages_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order"
},
"logistics_channel_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The identity of logistic channel."
},
"product_location_id": {
"type": "string",
"description": "Just use this field to pass the next step of Mass ArrangeShipment"
},
"sorting_group": {
"type": "string",
"description": "[Only for TW 30029 channel] This field indicate the sorting group value of the package. This field is only available for logistics_channel_id = 30029 and after the package has been arranged for shipment."
},
"is_shipment_arranged": {
"type": "boolean",
"description": "Only effective when the package's logistics_status/fulfillment_status is LOGISTICS_READY. This parameter further distinguishes between two scenarios: - true: Package shipment has been arranged (Seller has processed shipment, system is generating tracking number, not yet updated to LOGISTICS_REQUEST_CREATED, no duplicate action needed) - false: Package awaiting shipment arrangement (Seller hasn't processed shipment yet, shipping arrangement required)"
}
},
"additionalProperties": true
}
},
"pagination": {
"type": "object",
"properties": {
"total_count": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Total orders can be returned with your query"
},
"next_cursor": {
"type": "string",
"description": "if packages is not empty or length of packages <= page_size. You should pass the next_cursor in the next request as page_sentinel."
},
"more": {
"type": "boolean",
"description": "To indicate, it's a the last page or not"
}
},
"additionalProperties": true
},
"sort": {
"type": "object",
"properties": {
"sort_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "As same as request param"
},
"is_asc": {
"type": "boolean",
"description": "As same as request param"
}
},
"additionalProperties": true,
"description": "As same as request param"
}
},
"additionalProperties": true
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
}
},
"additionalProperties": true
}
},
"v2.order.get_package_detail": {
"path": "/api/v2/order/get_package_detail",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "order: get package detail",
"input_schema": {
"type": "object",
"properties": {
"package_number_list": {
"type": "string",
"maxLength": 262144,
"description": "The set of package_number. If there are multiple package_number, you need to use English comma to connect them. limit [1,50]",
"x-csvMax": 50
}
},
"required": [
"package_number_list"
],
"additionalProperties": false,
"description": "v2.order.get_package_detail\nUse this api to get package detail.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"response": {
"type": "object",
"properties": {
"package_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
},
"fulfillment_status": {
"type": "string",
"description": "The Shopee fulfillment status for the package. Applicable values: See V2.0 Data Definition - PackageFulfillmentStatus."
},
"update_time": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Timestamp that indicates the last time that there was a change in value of package."
},
"logistics_channel_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of logistic channel."
},
"shipping_carrier": {
"type": "string",
"description": "The logistics service provider that the buyer selected for the package to deliver items. Note: If logistics_channel_id is 90021, 90025 or 90026, service_code will be appended, e.g., Entrega Turbo - M1020."
},
"allow_self_design_awb": {
"type": "boolean",
"description": "To indicate whether the package allows for self-designed AWB, if allow_self_design_awb returns false, it means that the package does not allow for self-designed AWB and only the system-AWB can be used."
},
"days_to_ship": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shipping preparation time set by the seller when listing item on Shopee."
},
"ship_by_date": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The deadline to ship out the package."
},
"pending_terms": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of pending terms. Applicable values: - SYSTEM_PENDING: Under Shopee internal processing. - KYC_PENDING: Under KYC checking (TW CB order only). - ARRANGE_SHIPMENT_PENDING: Temporarily held due to 3PL capacity constraints."
},
"pending_description": {
"type": "array",
"items": {
"type": "string"
},
"description": "The value of this field is the description of pending reason corresponding with pending terms. Applicable values: - For SYSTEM_PENDING: Order is being processed by Shopee. - For KYC_PENDING: Order is pending buyer TW KYC pre-authorization. - For ARRANGE_SHIPMENT_PENDING: Allocating delivery resources due to high order volume. Label print will be available within 4 days after buyer paid."
},
"tracking_number": {
"type": "string",
"description": "The tracking number of this package."
},
"tracking_number_expiration_date": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "[TW only] Tracking number expiration date"
},
"pickup_done_time": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The timestamp when pickup is done."
},
"is_split_up": {
"type": "boolean",
"description": "To indicate whether this parcel is split."
},
"item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for an item."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for a model."
},
"item_sku": {
"type": "string",
"description": "A 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."
},
"model_sku": {
"type": "string",
"description": "ID of the model that belongs to the same item."
},
"model_quantity": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The number of identical items/variations purchased at the same time by the same buyer from one listing/item."
},
"is_fulfillment_mapping": {
"type": "boolean",
"description": "Flag indicating whether the item contains any bundle items configured with Fulfillment Mapping (FFM). Returns 'true' if the item uses FFM logic, 'false' otherwise. Field will only be returned if shop is whitelisted."
},
"bundle_sku_id": {
"type": "string",
"description": "The unique identifier (SKU ID) of the front-facing Bundle SKU purchased by the buyer on Shopee. Field will only be returned if shop is whitelisted and is_fulfillment_mapping returns true."
},
"components": {
"type": "array",
"items": {
"type": "object",
"properties": {
"parent_sku_id": {
"type": "string",
"description": "The unique identifier (SKU ID) of the underlying physical component item (Parent SKU)."
},
"barcode_upc": {
"type": "string",
"description": "The physical barcode or UPC of the Parent SKU, used for scanning and inventory picking in the warehouse."
},
"quantity": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The mapping ratio/quantity of this specific Parent SKU required for ONE unit of the Bundle SKU (e.g., if Bundle A contains 2 units of Parent SKU B, quantity = 2)"
},
"warehouse_id": {
"type": "string",
"description": "The ID of the warehouse where the Parent SKU component is located/stored."
},
"mapping_type": {
"type": "string",
"description": "The structure/type of mapping defined for the bundle. Available values: 1: Group 2: Lucky bag 3: Mapping List"
}
},
"additionalProperties": true
},
"description": "List of underlying Parent SKUs (component level) associated with the mapped Bundle SKU, used by WMS/ERP for physical picking and fulfillment. If is_fulfillment_mapping returns 'false', this array will not be returned. Array will only be returned if shop is whitelisted and is_fulfillment_mapping returns true."
},
"order_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identify of order item. For items in one same bundle deal promotion, the order_item_id should share the same id, such as 1,2. For items not in bundle deal promotion, the order_item_id should be the same as item_id."
},
"promotion_group_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identify of product promotion."
},
"product_location_id": {
"type": "string",
"description": "The warehouse ID of the item."
},
"consultation_id": {
"type": "string",
"description": "An identifier of teleconsultation session which buyer did to order this item. Empty if item is not ordered through teleconsultation session"
},
"is_prescription_item": {
"type": "boolean",
"description": "To indicate if this item is a prescription item. Default false. Only for PH, TH, ID whitelist shops."
},
"error_in_fetching_is_prescription_item": {
"type": "boolean",
"description": "To indicate if there was an error when validating whether this item is prescription. Default false. If is_prescription_item=false and this field is true, the item's prescription status is uncertain (label service call failed). Only for PH, TH, ID whitelist shops."
},
"prescription_check_status": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Prescription check status. For ID, PH whitelisted sellers, the applicable values: 0: NONE 1: PASSED 2: FAILED For TH whitelisted sellers, the applicable values: 0: NONE 1: PASSED"
},
"prescription_reject_reason": {
"type": "string",
"description": "Return the reason why a prescription is rejected. If no rejection reason, return empty. Only for ID and PH whitelist sellers."
}
},
"additionalProperties": true
},
"description": "The lis of items in the package."
},
"recipient_address": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Recipient's name for the address."
},
"phone": {
"type": "string",
"description": "Recipient's phone number input when order was placed. [Only for TW non-integrated channel] Will return \"****\" when the \"virtual_contact_number\" is available"
},
"town": {
"type": "string",
"description": "The town of the recipient's address. Whether there is a town will depend on the region and/or country."
},
"district": {
"type": "string",
"description": "The district of the recipient's address. Whether there is a district will depend on the region and/or country."
},
"city": {
"type": "string",
"description": "The city of the recipient's address. Whether there is a city will depend on the region and/or country."
},
"state": {
"type": "string",
"description": "The state/province of the recipient's address. Whether there is a state/province will depend on the region and/or country."
},
"region": {
"type": "string",
"description": "The two-digit code representing the region of the Recipient."
},
"zipcode": {
"type": "string",
"description": "Recipient's postal code."
},
"full_address": {
"type": "string",
"description": "The full address of the recipient, including country, state, even street, and etc."
},
"geolocation": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "Latitude."
},
"longitude": {
"type": "number",
"description": "Longitude."
}
},
"additionalProperties": true,
"description": "Geolocation info. Only available for logistics_channel_id 90026."
}
},
"additionalProperties": true,
"description": "This object contains detailed breakdown for the recipient address. Different parameters might be masked according to each market and kind of seller. For TW region integrated channel orders will be all masked as \"****\". More details may refer the announcement."
},
"parcel_chargeable_weight_gram": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "display weight used to calculate ASF for this parcel"
},
"group_shipment_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The common identifier for multiple orders combined in the same parcel."
},
"virtual_contact_number": {
"type": "string",
"description": "[Only for TW non-integrated channel] The virtual phone number to contact the recipient."
},
"package_query_number": {
"type": "string",
"description": "[Only for TW non-integrated channel] The query number used in virtual phone number calls to contact the recipient of this package."
},
"sorting_group": {
"type": "string",
"description": "[Only for TW 30029 channel] This field indicate the sorting group value of the package. This field is only available for logistics_channel_id = 30029 and after the package has been arranged for shipment."
},
"is_shipment_arranged": {
"type": "boolean",
"description": "Only effective when the package's logistics_status/fulfillment_status is LOGISTICS_READY. This parameter further distinguishes between two scenarios: - true: Package shipment has been arranged (Seller has processed shipment, system is generating tracking number, not yet updated to LOGISTICS_REQUEST_CREATED, no duplicate action needed) - false: Package awaiting shipment arrangement (Seller hasn't processed shipment yet, shipping arrangement required)"
},
"status_info_tag": {
"type": "object",
"properties": {
"tag_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Shipping urgency tag type, applicable values below: 0: No tag 1: Will be cancelled within 1 day 2: Must ship before the specified timestamp 3: Shipment delayed 4: Must ship within the current hour 5: Will be cancelled at the specified timestamp"
},
"timestamp": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "When tag_id is 2 or 5, returns specific timestamp (e.g., cancel time, shipment deadline); otherwise returns 0."
}
},
"additionalProperties": true,
"description": "Package shipping urgency tag information."
},
"can_split_order": {
"type": "boolean",
"description": "This field indicates whether this order can be split into multiple packages for separate shipment. - true: Support splitting, can call v2.order.split_order to execute - false: Does not support splitting"
},
"can_unsplit_order": {
"type": "boolean",
"description": "This field indicates whether this order can be unsplit. - true: Support unsplitting, can call v2.order.unsplit_order to execute - false: Does not support unsplitting"
},
"is_pre_order": {
"type": "boolean",
"description": "This field indicates whether this order is a pre-order. - true: Pre-order - false: Non pre-order"
},
"pharmacist_name": {
"type": "string",
"description": "Name of the Pharmacist for Prescription Order."
},
"prescription_images": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return prescription images of this order, only for ID and PH whitelist sellers. Please add the prefix to review: for ID: https://cf.shopee.co.id/file/+prescription_image for PH: https://cf.shopee.ph/file/+prescription_image"
},
"prescription_approval_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Time of when the prescription is approved."
},
"prescription_rejection_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Time of when the prescription is rejected."
},
"is_buyer_shop_collection": {
"type": "boolean",
"description": "To indicate if this order is buyer self collection at store order."
},
"buyer_proof_of_collection": {
"type": "array",
"items": {
"type": "string"
},
"description": "The image url of the proof for buyer self collection at the store."
},
"preparation_end_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The system-calculated deadline for package preparation. When the package fulfillment_status/logistics_status changes to \"LOGISTICS_READY\", the system calculates this time based on the \"Preparation Time\" configured for the logistics channel of this package. Notes: 1) Only effective for logistics channels that have Auto Call Driver enabled and Preparation Time configured. 2) Seller needs to complete packing and waybill printing before this time to ensure the package is ready when the driver arrives. 3) When this time is reached, the system will automatically arrange shipment and trigger driver dispatch: - If driver calling is successful, the package fulfillment_status/logistics_status will change from “LOGISTICS_READY” to “LOGISTICS_REQUEST_CREATED”. - If driver calling fails, the package fulfillment_status/logistics_status will remain unchanged, and the seller must arrange shipment manually."
},
"driver_info": {
"type": "object",
"properties": {
"driver_name": {
"type": "string",
"description": "Driver Name"
},
"driver_phone": {
"type": "string",
"description": "Driver phone number"
},
"vehicle_type": {
"type": "string",
"description": "Delivery vehicle type"
},
"license_plate": {
"type": "string",
"description": "License plate number"
},
"courier_photo": {
"type": "string",
"description": "URL of the driver's photo"
},
"eta_start_time": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Earliest estimated arrival time at pickup address"
},
"eta_end_time": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Latest estimated arrival time at pickup address"
},
"driver_status": {
"type": "string",
"description": "Driver status. Applicable values: - Allocating Driver - Driver assigned - Driver is on the way - Driver is arrived - Driver should arrive by {starting_time} - {end_time}"
}
},
"additionalProperties": true,
"description": "After the driver is successfully called, the driver's information will be returned. Note: Data availability depends on the specific 3PL provider; certain fields may be omitted due to provider policies, PII restrictions, or data unavailability."
},
"can_full_cancel_order": {
"type": "boolean",
"description": "Indicates whether the order can be full cancelled: - If this value is true, seller can cancel the entire order - If the value is false, full order cancellation is not available for the order"
},
"can_partial_cancel_order": {
"type": "boolean",
"description": "Indicates whether the order is eligible for partial cancellation. This value is determined by both the system eligibility check and the buyer’s out-of-stock handling preference. - If this value is true, seller can cancel selected out-of-stock item quantities while continuing to fulfill the remaining items. - If this value is false, partial cancellation is not allowed."
},
"buyer_preference_for_partial_cancellation": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Indicates the buyer’s preference for handling out-of-stock items in the order. Applicable values: 0 = Ship Available Items Only (The buyer allows the seller to cancel unavailable items and continue shipping the remaining available items) 1 = Cancel The Entire Order (The buyer does not allow partial cancellation. If any item is unavailable, the seller should cancel the entire order instead)"
},
"invoice_pending": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The invoice statuses should be: - valid (The invoice sent is valid) - pending (System is waiting to receive the invoice)"
},
"pending_reason": {
"type": "string",
"description": "It's the failed reason if status is pending"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"description": "The list of packages."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
},
"warning": {
"type": "string",
"description": "Indicate warning message you should take care."
}
},
"additionalProperties": true
}
},
"v2.order.split_order": {
"path": "/api/v2/order/split_order",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "order: split order",
"input_schema": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
},
"package_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for an item."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for a model of an item. For single item without variation, you can set model_id as 0."
},
"order_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "The identify of order item. For items in one same bundle deal promotion, the order_item_id should share the same id, such as 1,2. For items not in bundle deal promotion, the order_item_id should be the same as item_id."
},
"promotion_group_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "The identify of product promotion.It's required for add on deal and bundle deal items. For items in one same add on deal or bundle deal promotion, the promotion_group_id should share the same id. For items not in add on deal or bundle deal promotion, the promotion_group_id should be 0. And the data is from promotion_group_id of v2,order.get_order_detail."
},
"model_quantity": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The number of identical items put in the package, the quantity sum of the same item from each parcel must be the full item quantity of the whole order. This field is only eligible for the shop whitelisted to the unit-level split in SG/TH/TW/MY markets."
}
},
"required": [
"item_id",
"model_id"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "The list of items under the same package."
}
},
"required": [
"item_list"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "The list of packages that you want to split. Note: - Orders that include installation services cannot be split by quantity. - When splitting the order, must contain all items in the order in one request. - You can split the order into 30 parcels at most in TW and 5 parcels at most in other regions."
}
},
"required": [
"order_sn",
"package_list"
],
"additionalProperties": false,
"description": "v2.order.split_order\nUse this api to split an order into multiple packages. Orders that include installation services cannot be split by quantity.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
},
"package_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
},
"item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for an item."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for a model."
},
"order_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "The identify of order item. For items in one same bundle deal promotion, the order_item_id should share the same id, such as 1,2. For items not in bundle deal promotion, the order_item_id should be the same as item_id."
},
"promotion_group_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "The identify of product promotion. For items in one same add on deal promotion, the promotion_group_id should share the same id. For items not in add on deal promotion, the promotion_group_id should be 0. And the data is from group_id of shopee.orders.GetOrderDetails."
},
"model_quantity": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "The number of identical items put in the package."
}
},
"additionalProperties": true
},
"description": "The list of items under this package."
}
},
"additionalProperties": true
},
"description": "The list of package under this order you have split."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
},
"request_id": {
"type": "string",
"description": "The identifier of the API request for error tracking."
}
},
"additionalProperties": true
}
},
"v2.order.unsplit_order": {
"path": "/api/v2/order/unsplit_order",
"method": "POST",
"risk": "D",
"identity": "Shop",
"description": "order: unsplit order",
"input_schema": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
}
},
"required": [
"order_sn"
],
"additionalProperties": false,
"description": "v2.order.unsplit_order\nUse this ai to undo split of order. After undo split, the order will have only one package. It can only be used when order status still at READY_TO_SHIP.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"request_id": {
"type": "string",
"description": "The identifier of the API request for error tracking."
}
},
"additionalProperties": true
}
},
"v2.order.cancel_order": {
"path": "/api/v2/order/cancel_order",
"method": "POST",
"risk": "D",
"identity": "Shop",
"description": "order: cancel order",
"input_schema": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
},
"cancel_reason": {
"type": "string",
"maxLength": 262144,
"description": "The reason seller want to cancel this order. Applicable values: OUT_OF_STOCK CUSTOMER_REQUEST UNDELIVERABLE_AREA (Note: Only apply for TW and MY) COD_NOT_SUPPORTED"
},
"item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Id of item."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Id of the model that belongs to the same item."
}
},
"required": [
"item_id",
"model_id"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Required when cancel_reason is OUT_OF_STOCK."
},
"partial_cancel_item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The unique identifier of the item to be partially cancelled."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The unique identifier of the model to be partially cancelled."
},
"order_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identify of order item. For items in one same bundle deal promotion, the order_item_id should share the same id, such as 1,2. For items not in bundle deal promotion, the order_item_id should be the same as item_id."
},
"promotion_group_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identify of product promotion.It's required for add on deal and bundle deal items. For items in one same add on deal or bundle deal promotion, the promotion_group_id should share the same id. For items not in add on deal or bundle deal promotion, the promotion_group_id should be 0. And the data is from promotion_group_id of v2,order.get_order_detail."
},
"model_quantity": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The quantity of the specified item model to be cancelled."
}
},
"required": [
"item_id",
"model_id",
"model_quantity"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "The list of item models and quantities that the seller wants to partially cancel. This field should be provided when the seller intends to cancel only part of the order due to unavailable items while continuing to fulfill the remaining items."
}
},
"required": [
"order_sn",
"cancel_reason"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"cancel_reason": {
"const": "OUT_OF_STOCK"
}
},
"required": [
"cancel_reason"
]
},
"then": {
"required": [
"item_list"
]
}
}
],
"description": "v2.order.cancel_order\nUse this api to cancel an order. This action can only be performed before the order has been shipped.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"update_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The time when the order is updated."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
}
},
"additionalProperties": true
}
},
"v2.order.handle_buyer_cancellation": {
"path": "/api/v2/order/handle_buyer_cancellation",
"method": "POST",
"risk": "D",
"identity": "Shop",
"description": "order: handle buyer cancellation",
"input_schema": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
},
"operation": {
"type": "string",
"maxLength": 262144,
"description": "The operation you want to handle.Avaiable value: ACCEPT, REJECT"
}
},
"required": [
"order_sn",
"operation"
],
"additionalProperties": false,
"description": "v2.order.handle_buyer_cancellation\nUse this api to handle buyer's cancellation application.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"update_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The time when the order is updated."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
}
},
"additionalProperties": true
}
},
"v2.order.set_note": {
"path": "/api/v2/order/set_note",
"method": "POST",
"risk": "W",
"identity": "Shop",
"description": "order: set note",
"input_schema": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
},
"note": {
"type": "string",
"maxLength": 262144,
"description": "The note seller add for reference."
}
},
"required": [
"order_sn",
"note"
],
"additionalProperties": false,
"description": "v2.order.set_note\nUse this api to set note for an order.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
}
},
"additionalProperties": true
}
},
"v2.order.get_pending_buyer_invoice_order_list": {
"path": "/api/v2/order/get_pending_buyer_invoice_order_list",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "order: get pending buyer invoice order list",
"input_schema": {
"type": "object",
"properties": {
"cursor": {
"type": "string",
"maxLength": 262144,
"description": "Specifies the starting entry of data to return in the current call. Default is \"\". If data is more than one page, the offset can be some entry to start next call."
},
"page_size": {
"description": "Each result set is returned as a page of entries. Use the \"page_size\" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single \"page\" of data.The limit of page_size if between 1 and 100. Official limits: 1-100",
"x-pageMax": 100,
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}
},
"required": [
"page_size"
],
"additionalProperties": false,
"description": "v2.order.get_pending_buyer_invoice_order_list\nThis endpoint only for PH and BR local sellers only. This API is used for seller to retrieve a list of order IDs that are pending invoice upload.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"more": {
"type": "boolean",
"description": "This is to indicate whether the order list is more than one page. If this value is true, you may want to continue to check next page to retrieve orders."
},
"next_cursor": {
"type": "string",
"description": "If more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false."
},
"order_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
}
},
"additionalProperties": true
}
},
"v2.order.get_buyer_invoice_info": {
"path": "/api/v2/order/get_buyer_invoice_info",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "order: get buyer invoice info",
"input_schema": {
"type": "object",
"properties": {
"queries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
}
},
"required": [
"order_sn"
],
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"queries"
],
"additionalProperties": false,
"description": "v2.order.get_buyer_invoice_info\nAPI to obtain buyer submitted invoice info for VN, TH and PH local sellers only.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"invoice_info_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
},
"invoice_type": {
"type": "string",
"description": "Type of invoice requested: {1: personal, 2: company, 3: household}."
},
"invoice_detail": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Buyer name (has value when invoice_type is personal, household, or company) - VN, TH, PH only"
},
"email": {
"type": "string",
"description": "Buyer email address (has value when invoice_type is personal and household) - VN, TH, PH only"
},
"phone_number": {
"type": "string",
"description": "Buyer phone number - TH only"
},
"tax_id": {
"type": "string",
"description": "has value when invoice_type is personal and household. - VN, TH, PH only"
},
"address": {
"type": "string",
"description": "Buyer address in format \"Street & number, city, zipcode, any additional info provided by buyer\" (has value when invoice_type is personal and household) - PH, VN only"
},
"id_card_address": {
"type": "string",
"description": "Same function as the address, only having a different field name for TH.Buyer address in format \"Street & number, city, zipcode, any additional info provided by buyer\" (only has value when invoice_type is personal)."
},
"address_breakdown": {
"type": "object",
"properties": {
"region": {
"type": "string",
"description": "Return region value - PH, TH only"
},
"state": {
"type": "string",
"description": "Return value - TH: Province"
},
"city": {
"type": "string",
"description": "Return value - TH: District"
},
"town": {
"type": "string",
"description": "Return value - TH: Sub district"
},
"postcode": {
"type": "string",
"description": "Return value - TH: Postal code - PH: Postal code"
},
"detailed_address": {
"type": "string",
"description": "Return value - PH: Additional details, i.e. street name, building - TH: Additional details, i.e. house number"
},
"additional_info": {
"type": "string",
"description": "Return value: - Empty for PH, TH"
},
"full_address": {
"type": "string",
"description": "- only has value when invoice_type is personal - Buyer address in format \"detailed_address, town, district, state, postcode, additional_info\" for all regions --- for TH: leave the 'additional_info' as empty"
}
},
"additionalProperties": true,
"description": "Buyer address breakdown. - TH, PH only"
},
"company_head_office": {
"type": "string",
"description": "- return value for TH only (only has value when invoice_type is company)"
},
"company_name": {
"type": "string",
"description": "- Only return value when invoice type is company - VN, TH, PH only"
},
"company_branch_name": {
"type": "string",
"description": "- Only return value when invoice type is company - TH only"
},
"company_branch_id": {
"type": "string",
"description": "- Only return value when invoice type is company - TH only"
},
"company_type": {
"type": "string",
"description": "- Only return value when invoice type is company - TH only"
},
"company_email": {
"type": "string",
"description": "- Only return value when invoice type is company - VN, TH, PH only"
},
"company_tax_id": {
"type": "string",
"description": "- Only return value when invoice type is company - VN, TH, PH only"
},
"company_address": {
"type": "string",
"description": "Buyer address in format \"Street & number,city, zipcode, any additional info provided by buyer\" (only has value when invoice_type is company) - VN, TH only"
},
"company_address_breakdown": {
"type": "object",
"properties": {
"company_region": {
"type": "string",
"description": "Return region value - PH, TH only"
},
"company_state": {
"type": "string",
"description": "Return value - PH: Province - TH: Province"
},
"company_city": {
"type": "string",
"description": "Return value - PH: City"
},
"company_district": {
"type": "string",
"description": "Return value - PH: Barangay - TH: District"
},
"company_town": {
"type": "string",
"description": "Return value - TH: Sub district"
},
"company_postcode": {
"type": "string",
"description": "Return postal code - TH, PH only"
},
"company_detailed_address": {
"type": "string",
"description": "Return value - PH: Detailed address - TH: Detailed address"
},
"company_additional_info": {
"type": "string",
"description": "Return value: - Empty for PH, TH"
},
"company_full_address": {
"type": "string",
"description": "Concatenation of company address breakdown - only has value when invoice_type is company"
}
},
"additionalProperties": true,
"description": "Company address breakdown - PH, TH only"
},
"household_address_breakdown": {
"type": "object",
"properties": {
"household_region": {
"type": "string",
"description": "Region of the household address."
},
"household_state": {
"type": "string",
"description": "State of the household address."
},
"household_city": {
"type": "string",
"description": "City of the household address."
},
"household_province": {
"type": "string",
"description": "Province of the household address."
},
"household_district": {
"type": "string",
"description": "District of the household address."
},
"household_town": {
"type": "string",
"description": "Town of the household address."
},
"household_barangay": {
"type": "string",
"description": "Barangay of the household address."
},
"household_postcode": {
"type": "string",
"description": "Postal code of the household address."
},
"household_detailed_address": {
"type": "string",
"description": "Detailed street address of the household."
},
"household_additional_info": {
"type": "string",
"description": "Additional address information provided by the buyer."
},
"household_full_address": {
"type": "string",
"description": "Full formatted household address."
}
},
"additionalProperties": true,
"description": "Household address breakdown -Only for VN"
},
"national_id": {
"type": "string",
"description": "National ID information provided by the buyer. - Only return value when invoice_type is personal - VN only"
}
},
"additionalProperties": true,
"description": "Invoice info submitted by buyer. Might be masked, e.g. A****b, depending on order status."
},
"error": {
"type": "string",
"description": "Error in retrieving the receipt setting of a particular order."
},
"is_requested": {
"type": "boolean",
"description": "To identify order with and without buyer request, applicable to PL."
}
},
"additionalProperties": true
}
},
"request_id": {
"type": "string",
"description": "Request id for debugging purposes"
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
}
},
"additionalProperties": true
}
},
"v2.order.handle_prescription_check": {
"path": "/api/v2/order/handle_prescription_check",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "order: handle prescription check",
"input_schema": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
},
"is_approved": {
"type": "boolean",
"description": "Approve or reject the prescription. Available values: TRUE, FALSE."
},
"reject_reason_code": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Reject reason code. Available values: 1 = Invalid Prescription (counterfeit/incorrect format) 2 = Incorrect Dosage 3 = No Prescription 4 = Unclear Image 5 = Free Text"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Shopee's unique identifier for an item."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "Shopee's unique identifier for a model of an item."
},
"group_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "The identify of product promotion. For items in one same add on deal promotion, the group_id should share the same id. For items not in add on deal promotion, the group_id should be 0. And the data is from group_id of shopee.orders.GetOrderDetails."
}
},
"required": [
"item_id",
"model_id",
"group_id"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "The list of invalid items that make the prescription get rejected"
},
"pharmacist_name": {
"type": "string",
"maxLength": 262144,
"description": "Full name of the pharmacist. Required for PH and ID Prescription Orders."
},
"free_text": {
"type": "string",
"maxLength": 262144,
"description": "The reason for rejecting the prescription. Only usable when the reject_reason_code = 5."
}
},
"required": [
"order_sn",
"is_approved"
],
"additionalProperties": false,
"description": "v2.order.handle_prescription_check\nUse this API to approve or reject a prescription\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"is_success": {
"type": "boolean",
"description": "This is to indicate whether the request has been executed successfully."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
}
},
"additionalProperties": true
}
},
"v2.order.get_warehouse_filter_config": {
"path": "/api/v2/order/get_warehouse_filter_config",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "order: get warehouse filter config",
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false,
"description": "v2.order.get_warehouse_filter_config\nFor multi-warehouse shops, return all warehouses with packages that have not been SHIPPED including product_location_id and address_id. Compared to v2.shop.get_warehouse_detail, it covers some edge cases like warehouse that have been unlinked but still retain packages that have not been SHIPPED, and does not cover some cases like single warehouse with default product_location_id and FBS shop.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
},
"request_id": {
"type": "string"
},
"response": {
"type": "object",
"properties": {
"warehouse_filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"warehouse_name": {
"type": "string",
"description": "The warehouse name filled in when creating the warehouse address."
},
"warehouse_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Type of warehouse. Applicable values: - 1: Local Warehouse - 2: CB Warehouse"
},
"product_location_id": {
"type": "string",
"description": "Location identifier for stocks. Different location_ids represent that your addresses are in different item stocks."
},
"address_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Identity of address."
},
"address": {
"type": "string",
"description": "Detail address of your warehouse."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.order.get_booking_list": {
"path": "/api/v2/order/get_booking_list",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "order: get booking list",
"input_schema": {
"type": "object",
"properties": {
"time_range_field": {
"type": "string",
"maxLength": 262144,
"description": "The kind of time_from and time_to. Available value: create_time, update_time."
},
"time_from": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The time_from and time_to fields specify a date range for retrieving bookings (based on the time_range_field). The time_from field is the starting date range. The maximum date range that may be specified with the time_from and time_to fields is 15 days."
},
"time_to": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The time_from and time_to fields specify a date range for retrieving bookings (based on the time_range_field). The time_from field is the starting date range. The maximum date range that may be specified with the time_from and time_to fields is 15 days."
},
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Each result set is returned as a page of entries. Use the \"page_size\" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single \"page\" of data.The limit of page_size if between 1 and 100.",
"x-pageMax": 100,
"default": 50
},
"cursor": {
"type": "string",
"maxLength": 262144,
"description": "Specifies the starting entry of data to return in the current call. Default is \"\". If data is more than one page, the offset can be some entry to start next call."
},
"booking_status": {
"type": "string",
"maxLength": 262144,
"description": "The booking_status filter for retrieving bookings and each one only every request. Available value: READY_TO_SHIP/PROCESSED/SHIPPED/CANCELLED/MATCHED"
}
},
"required": [
"time_range_field",
"time_from",
"time_to",
"page_size"
],
"additionalProperties": false,
"description": "v2.order.get_booking_list\nUse this api to search bookings. You may also filter them by status, if needed.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"more": {
"type": "boolean",
"description": "This is to indicate whether the booking list is more than one page. If this value is true, you may want to continue to check next page to retrieve bookings."
},
"booking_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"booking_sn": {
"type": "string",
"description": "Shopee's unique identifier for a booking."
},
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order. Only return if booking_status is MATCHED."
},
"booking_status": {
"type": "string",
"description": "The booking_status filter for retrieving booking and each one only every request. Available value: READY_TO_SHIP/PROCESSED/SHIPPED/CANCELLED/MATCHED"
},
"next_cursor": {
"type": "string",
"description": "If more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true,
"description": "Detail information you are querying."
}
},
"additionalProperties": true
}
},
"v2.order.get_booking_detail": {
"path": "/api/v2/order/get_booking_detail",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "order: get booking detail",
"input_schema": {
"type": "object",
"properties": {
"booking_sn_list": {
"type": "string",
"maxLength": 262144,
"description": "The set of booking_sn. If there are multiple booking_sn, you need to use English comma to connect them. limit [1,50]",
"x-csvMax": 50
},
"response_optional_fields": {
"type": "string",
"maxLength": 262144,
"description": "The response fields you want to get. Please select from the below response parameters. If you input an object field, all the params under it will be included automatically in the response. If there are multiple response fields you want to get, you need to use English comma to connect them. Available values: item_list,cancel_by,cancel_reason,fulfillment_flag,pickup_done_time,shipping_carrier, recipient_address, dropshipper, dropshipper_phone"
}
},
"required": [
"booking_sn_list"
],
"additionalProperties": false,
"description": "v2.order.get_booking_detail\nUse this api to get booking detail.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"booking_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"booking_sn": {
"type": "string",
"description": "Return by default. Shopee's unique identifier for a booking."
},
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order. Only return if booking_status is MATCHED."
},
"region": {
"type": "string",
"description": "Return by default. The two-digit code representing the region where the booking was made."
},
"booking_status": {
"type": "string",
"description": "Return by default. Enumerated type that defines the current status of the booking. Available value: READY_TO_SHIP/PROCESSED/SHIPPED/CANCELLED/MATCHED"
},
"match_status": {
"type": "string",
"description": "MATCH_PENDING/MATCH_SUCCESSFUL/MATCH_FAILED"
},
"shipping_carrier": {
"type": "string",
"description": "The logistics service provider that will deliver the booking."
},
"create_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Return by default. Timestamp that indicates the date and time that the booking was created."
},
"update_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Return by default. Timestamp that indicates the last time that there was a change in value of booking, such as booking status changed from 'Processed' to 'Shipped'."
},
"ship_by_date": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Return by default. The deadline to ship out the parcel."
},
"recipient_address": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Recipient's name for the address."
},
"phone": {
"type": "string",
"description": "Recipient's phone number input when booking was placed."
},
"town": {
"type": "string",
"description": "The town of the recipient's address. Whether there is a town will depend on the region and/or country."
},
"district": {
"type": "string",
"description": "The district of the recipient's address. Whether there is a district will depend on the region and/or country."
},
"city": {
"type": "string",
"description": "The city of the recipient's address. Whether there is a city will depend on the region and/or country."
},
"state": {
"type": "string",
"description": "The state/province of the recipient's address. Whether there is a state/province will depend on the region and/or country."
},
"region": {
"type": "string",
"description": "The two-digit code representing the region of the Recipient."
},
"zipcode": {
"type": "string",
"description": "Recipient's postal code."
},
"full_address": {
"type": "string",
"description": "The full address of the recipient, including country, state, even street, and etc."
}
},
"additionalProperties": true,
"description": "This object contains detailed breakdown for the recipient address."
},
"item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Shopee's unique identifier for an item."
},
"item_name": {
"type": "string",
"description": "The name of the item."
},
"item_sku": {
"type": "string",
"description": "A 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."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "ID of the model that belongs to the same item."
},
"model_name": {
"type": "string",
"description": "Name of the model that belongs to the same item. A seller can offer models of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate model. Each model can have a different quantity and price."
},
"model_sku": {
"type": "string",
"description": "A model SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are models of one item in Shopee Listings."
},
"model_quantity_purchased": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The number of identical items from one listing/item in the same booking."
},
"weight": {
"type": "number",
"description": "The weight of the item"
},
"product_location_id": {
"type": "string",
"description": "The fulfilment warehouse ID(s) of the items in the booking. (Multi-Warehouse sellers only)"
},
"image_info": {
"type": "object",
"properties": {
"image_url": {
"type": "string",
"description": "The image url of the product. Default to be variation image, if the model does not have a variation image, will use an item main image instead."
}
},
"additionalProperties": true,
"description": "Image info of the product."
}
},
"additionalProperties": true
},
"description": "This object contains the detailed breakdown for the result of this API call."
},
"dropshipper": {
"type": "string",
"description": "For Indonesia bookings only. The name of the dropshipper."
},
"dropshipper_phone": {
"type": "string",
"description": "The phone number of dropshipper, could be empty."
},
"cancel_by": {
"type": "string",
"description": "Could be one of buyer, seller, system or Ops."
},
"cancel_reason": {
"type": "string",
"description": "Use this field to get reason for buyer, seller, and system cancellation."
},
"fulfillment_flag": {
"type": "string",
"description": "Use this field to indicate the booking is fulfilled by shopee or seller. Applicable values: fulfilled_by_shopee, fulfilled_by_cb_seller, fulfilled_by_local_seller."
},
"pickup_done_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The timestamp when pickup is done."
}
},
"additionalProperties": true
},
"description": "The list of bookings."
}
},
"additionalProperties": true,
"description": "Detail information you are querying."
},
"warning": {
"type": "string",
"description": "Indicate warning message you should take care."
}
},
"additionalProperties": true
}
},
"v2.order.generate_fbs_invoices": {
"path": "/api/v2/order/generate_fbs_invoices",
"method": "POST",
"risk": "W",
"identity": "Shop",
"description": "order: generate fbs invoices",
"input_schema": {
"type": "object",
"properties": {
"batch_download": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Format YYYYMMDD e.g. 20240101"
},
"end": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Format YYYYMMDD e.g. 20240101"
},
"document_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "1 = Remessa 2 = Return 3 = Symbolic Return 4 = Sale 5 = Entrada 6 = Symbolic Remessa 7 = all"
},
"file_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "1 = xml only 2 = pdf only 3 = both"
},
"document_status": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "1= authorized only 2= cancelled Default: If document_status not passed or passed empty, means documents under ALL status (both authorized and cancelled) must be included"
}
},
"required": [
"start",
"end",
"document_type",
"file_type"
],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false,
"description": "v2.order.generate_fbs_invoices\nThis API creates a task to download a specific tax document (e.g., sales invoice, remessa invoice) for the seller's account, available only after the document is issued by the system as part of the Fulfilled by Shopee (FBS) process. The workflow is as follows: (1) v2.order.generate_fbs_invoices; (2) v2.order.get_fbs_invoices_result; (3) v2.order.download_fbs_invoices. Please note: The download link for the document will expire 30 minutes after being generated.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Indicate error type if hit error. Empty if no error happened."
},
"error_msg": {
"type": "string",
"description": "Error messages"
},
"result_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"request_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Unique task identifier that includes one or more tax documents to be downloaded according to the filters sent in the request."
},
"fail_error": {
"type": "string",
"description": "Indicate error type if one element hit error. Empty if no error happened."
},
"fail_message": {
"type": "string",
"description": "Indicate error details if one element hit error. Empty if no error happened."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"v2.order.get_fbs_invoices_result": {
"path": "/api/v2/order/get_fbs_invoices_result",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "order: get fbs invoices result",
"input_schema": {
"type": "object",
"properties": {
"request_id_list": {
"type": "object",
"properties": {
"request_id": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"maxItems": 100,
"description": "A list of integers representing the request IDs to be queried."
}
},
"required": [
"request_id"
],
"additionalProperties": false,
"description": "-"
}
},
"required": [
"request_id_list"
],
"additionalProperties": false,
"description": "v2.order.get_fbs_invoices_result\nThis API allows you to consult the status of a previously requested batch download for FBS tax documents.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Indicate error type if hit error. Empty if no error happened."
},
"error_msg": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"result_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"request_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Represents the current status of the request"
},
"file_name": {
"type": "string",
"description": "Name of the file to be downloaded"
},
"status": {
"type": "string",
"description": "Represents the current status of the request"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"v2.order.download_fbs_invoices": {
"path": "/api/v2/order/download_fbs_invoices",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "order: download fbs invoices",
"input_schema": {
"type": "object",
"properties": {
"request_id_list": {
"type": "object",
"properties": {
"request_id": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"maxItems": 100
}
},
"required": [
"request_id"
],
"additionalProperties": false,
"description": "list of request id (task identifiers)"
}
},
"required": [],
"additionalProperties": false,
"description": "v2.order.download_fbs_invoices\nThis API allows you to download FBS invoices. To use this API, the client must first call v2.order.generate_fbs_invoices to create a new shipping document task, followed by calling v2.order.get_fbs_invoices_result to check the task status. The document can only be downloaded once the task status is \"READY.\"\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"request_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64"
},
"file_link": {
"type": "string"
}
},
"additionalProperties": true
},
"error": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"error_msg": {
"type": "string"
},
"request_id": {
"type": "string"
},
"timestamp": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"additionalProperties": true
}
},
"v2.order.get_estimate_cancel_value": {
"path": "/api/v2/order/get_estimate_cancel_value",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "order: get estimate cancel value",
"input_schema": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
},
"partial_cancel_item_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The unique identifier of the item to be included in the estimated cancellation value calculation."
},
"model_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The unique identifier of the model to be included in the estimated cancellation value calculation."
},
"order_item_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identify of order item. For items in one same bundle deal promotion, the order_item_id should share the same id, such as 1,2. For items not in bundle deal promotion, the order_item_id should be the same as item_id."
},
"promotion_group_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identify of product promotion.It's required for add on deal and bundle deal items. For items in one same add on deal or bundle deal promotion, the promotion_group_id should share the same id. For items not in add on deal or bundle deal promotion, the promotion_group_id should be 0. And the data is from promotion_group_id of v2,order.get_order_detail."
},
"model_quantity": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The quantity of the specified item model to be included in the estimated cancellation value calculation."
}
},
"required": [
"item_id",
"model_id",
"model_quantity"
],
"additionalProperties": false
},
"maxItems": 100,
"description": "The list of item models and quantities for which the seller wants to estimate the cancellation value before submitting the actual partial cancellation request."
}
},
"required": [
"order_sn",
"partial_cancel_item_list"
],
"additionalProperties": false,
"description": "v2.order.get_estimate_cancel_value\nReturns the estimated refund value for a partial order cancellation given the specified items to cancel.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"cancel_value_price": {
"type": "string",
"description": "The estimated cancellation value for the selected item quantities. This value is calculated before the actual cancellation is submitted and can be used by sellers to preview the expected cancellation amount and support partial cancellation confirmation."
}
},
"additionalProperties": true
}
},
"v2.logistics.get_shipping_parameter": {
"path": "/api/v2/logistics/get_shipping_parameter",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "logistics: get shipping parameter",
"input_schema": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is't a package number."
}
},
"required": [
"order_sn"
],
"additionalProperties": false,
"description": "v2.logistics.get_shipping_parameter\nUse this api to check if the package support pickup, dropoff, or non-integrated method. For pickup, will return addresses and pickup time id options. For dropoff, will return branch id, sender real name etc, depending on 3PL requirements. [Please call this API when packages meet: 1) fulfillment status is LOGISTICS_READY; or 2) fulfillment status is LOGISTICS_PICKUP_RETRY; or 3) fulfillment status is LOGISTICS_REQUEST_CREATED and meet Instant Order Reschedule Pickup conditions]\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"info_needed": {
"type": "object",
"properties": {
"dropoff": {
"type": "array",
"items": {
"type": "string"
},
"description": "Could contain 'branch_id', 'sender_real_name' or 'tracking_no'. If it contains 'branch_id', choose one to Init. If it contains 'sender_real_name' or 'tracking_no', should manually input these values in Init API. If it has empty value, developer should still include \"dropoff\" field in Init API.Could contain 'slug'.If it contains 'slug', to return selected 3PL partner only for TW C2C sellers to drop-off parcels with."
},
"pickup": {
"type": "array",
"items": {
"type": "string"
},
"description": "Could contain 'address_id' and 'pickup_time_id'. Choose one address_id and its corresponding pickup_time_id to Init. If it has empty value, developer should still include \"pickup\" field in Init API.It could contains \"tracking_number\" returned from \"info_need\"for some channels, please also add it when init."
},
"non_integrated": {
"type": "array",
"items": {
"type": "string"
},
"description": "Could contain 'tracking_no'. If it contains 'tracking_no', should manually input these values in Init API. If it has empty value, developer should still include \"non-integrated\" field in Init API."
}
},
"additionalProperties": true,
"description": "The parameters required based on each specific order to Init. Must use the fields included under info_needed to call Init. For logistic_id 80003 and 80004, both Regular and JOB shipping methods are supported. If you choose Regular shipping method, please use \"tracking_no\" to call Init API. If you choose JOB shipping method, please use \"sender_real_name\" to call Init API. Note that only one of \"tracking_no\" and \"sender_real_name\" can be selected."
},
"dropoff": {
"type": "object",
"properties": {
"branch_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"branch_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "The identity of logistics branch."
},
"region": {
"type": "string",
"description": "The region of specify address."
},
"state": {
"type": "string",
"description": "The state of specify address."
},
"city": {
"type": "string",
"description": "The city of specify address."
},
"address": {
"type": "string",
"description": "The address description of specify address."
},
"zipcode": {
"type": "string",
"description": "The zipcode of specify address."
},
"district": {
"type": "string",
"description": "The district of specify address."
},
"town": {
"type": "string",
"description": "The town of specify address."
}
},
"additionalProperties": true
},
"description": "List of available dropoff branches info."
},
"slug_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"slug": {
"type": "string",
"description": "The identity of slug."
},
"slug_name": {
"type": "string",
"description": "The name of slug."
}
},
"additionalProperties": true
},
"description": "List of available TW 3PL drop-off partners."
}
},
"additionalProperties": true,
"description": "Logistics information for dropoff mode order."
},
"pickup": {
"type": "object",
"properties": {
"address_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of address."
},
"region": {
"type": "string",
"description": "The region of specify address."
},
"state": {
"type": "string",
"description": "The state of specify address."
},
"city": {
"type": "string",
"description": "The city of specify address."
},
"district": {
"type": "string",
"description": "The district of specify address."
},
"town": {
"type": "string",
"description": "The town of specify address."
},
"address": {
"type": "string",
"description": "The address description of specify address."
},
"zipcode": {
"type": "string",
"description": "The zipcode of specify address."
},
"address_flag": {
"type": "array",
"items": {
"type": "string"
},
"description": "The flag of shop address, applicable values: default_address, pickup_address, return_address, current_address(only for multi-warehouse sellers)"
},
"time_slot_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The date of pickup time. In timestamp."
},
"time_text": {
"type": "string",
"description": "The text description of pickup time. Only applicable for certain channels."
},
"pickup_time_id": {
"type": "string",
"description": "The identity of pickuptime."
},
"flags": {
"type": "array",
"items": {
"type": "string"
},
"description": "This field will have the value “recommended” for the time slot that Shopee suggests sellers choose. While it is advisable for sellers to choose the recommended time slot, they can also choose other time slots that do not have the recommended flag."
}
},
"additionalProperties": true
},
"description": "List of pickup_time information corresponding to the address_id. Some logistics channels may not return any date or time for pickup time slots. In such cases, sellers can arrange shipment without selecting any time slot, and Shopee will arrange a suitable timing for these situations."
}
},
"additionalProperties": true
},
"description": "List of available pickup address info."
}
},
"additionalProperties": true,
"description": "Logistics information for pickup mode order."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
}
},
"additionalProperties": true
}
},
"v2.logistics.get_mass_shipping_parameter": {
"path": "/api/v2/logistics/get_mass_shipping_parameter",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "logistics: get mass shipping parameter",
"input_schema": {
"type": "object",
"properties": {
"logistics_channel_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The API can only batch request the shipping parameter for multiple packages under the same product_location_id and same logistics_channel_id. Use this field to specify the logistics_channel_id for the request. If not specified, will use the logistics_channel_id corresponds to the first package_number by default."
},
"product_location_id": {
"type": "string",
"maxLength": 262144,
"description": "The API can only batch request the shipping parameter for multiple packages under the same product_location_id and same logistics_channel_id. Use this field to specify the product_location_id for the request. If not specified, will use the product_location_id corresponds to the first package_number by default."
},
"package_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"package_number": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for the package under an order. You shouldn't fill the field with empty string when there isn't a package number."
}
},
"required": [
"package_number"
],
"additionalProperties": false
},
"maxItems": 100,
"description": "The list of packages you want to get shipping parameters. limit [1, 50]."
}
},
"required": [
"package_list"
],
"additionalProperties": false,
"description": "v2.logistics.get_mass_shipping_parameter\nUse this api to check if package support pickup, dropoff, non-integrated. For pickup, return address and pickup time id options. For dropoff, return branch id, sender real name, etc. Can batch request for packages under same product_location_id and logistics_channel_id. [Please call it when packages meet: 1) fulfillment status is LOGISTICS_READY; or 2) fulfillment status is LOGISTICS_PICKUP_RETRY; or 3) fulfillment status is LOGISTICS_REQUEST_CREATED and meet Instant Order Reschedule conditions]\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened.<path></path><path></path>"
},
"response": {
"type": "object",
"properties": {
"info_needed": {
"type": "object",
"properties": {
"dropoff": {
"type": "array",
"items": {
"type": "string"
},
"description": "Could contain 'branch_id', 'sender_real_name', or 'tracking_no'. If it contains 'branch_id', choose one to Init. If it contains 'sender_real_name' or 'tracking_no', should manually input these values in Init API. If it has empty value, developer should still include \"dropoff\" field in Init API."
},
"pickup": {
"type": "array",
"items": {
"type": "string"
},
"description": "Could contain 'address_id' and 'pickup_time_id'. Choose one address_id and its corresponding pickup_time_id to Init. If it has empty value, developer should still include \"pickup\" field in Init API. It could contains \"tracking_number\" returned from \"info_need\"for some channels, please also add it when init."
},
"non_integrated": {
"type": "array",
"items": {
"type": "string"
},
"description": "Could contain 'tracking_no'. If it contains 'tracking_no', should manually input these values in Init API. If it has empty value, developer should still include \"non-integrated\" field in Init API."
}
},
"additionalProperties": true,
"description": "The parameters required based on each specific order to Init. Must use the fields included under info_needed to call Init. For logistic_id 80003 and 80004, both Regular and JOB shipping methods are supported. If you choose Regular shipping method, please use \"tracking_no\" to call Init API. If you choose JOB shipping method, please use \"sender_real_name\" to call Init API. Note that only one of \"tracking_no\" and \"sender_real_name\" can be selected."
},
"dropoff": {
"type": "object",
"properties": {
"branch_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"branch_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of logistics branch."
},
"region": {
"type": "string",
"description": "The region of specify address."
},
"state": {
"type": "string",
"description": "The state of specify address."
},
"city": {
"type": "string",
"description": "The city of specify address."
},
"address": {
"type": "string",
"description": "The address description of specify address."
},
"zipcode": {
"type": "string",
"description": "The zipcode of specify address."
},
"district": {
"type": "string",
"description": "The district of specify address."
},
"town": {
"type": "string",
"description": "The town of specify address."
}
},
"additionalProperties": true
},
"description": "List of available dropoff branches info."
}
},
"additionalProperties": true,
"description": "Logistics information for dropoff mode package."
},
"pickup": {
"type": "object",
"properties": {
"address_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of address."
},
"region": {
"type": "string",
"description": "The region of specify address."
},
"state": {
"type": "string",
"description": "The state of specify address."
},
"city": {
"type": "string",
"description": "The city of specify address."
},
"district": {
"type": "string",
"description": "The district of specify address."
},
"town": {
"type": "string",
"description": "The town of specify address."
},
"address": {
"type": "string",
"description": "The address description of specify address."
},
"zipcode": {
"type": "string",
"description": "The zipcode of specify address."
},
"address_flag": {
"type": "array",
"items": {
"type": "string"
},
"description": "The flag of shop address, applicable values: default_address, pickup_address, return_address, current_address (Multi-Warehouse sellers only)"
},
"time_slot_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The date of pickup time. In timestamp."
},
"time_text": {
"type": "string",
"description": "The text description of pickup time. Only applicable for certain channels."
},
"pickup_time_id": {
"type": "string",
"description": "The identity of pickuptime."
},
"flags": {
"type": "array",
"items": {
"type": "string"
},
"description": "This field will have the value “recommended” for the time slot that Shopee suggests sellers choose. While it is advisable for sellers to choose the recommended time slot, they can also choose other time slots that do not have the recommended flag."
}
},
"additionalProperties": true
},
"description": "List of pickup_time information corresponding to the address_id. Some logistics channels may not return any date or time for pickup time slots. In such cases, sellers can arrange shipment without selecting any time slot, and Shopee will arrange a suitable timing for these situations."
}
},
"additionalProperties": true
},
"description": "List of available pickup address info. For Multi-Warehouse sellers, note that changing pickup address from Current may incur higher shipping fees."
}
},
"additionalProperties": true,
"description": "Logistics information for pickup mode package."
},
"success_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
}
},
"additionalProperties": true
},
"description": "Success package list."
},
"fail_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
},
"fail_reason": {
"type": "string",
"description": "Reason for failure."
}
},
"additionalProperties": true
},
"description": "Fail package list."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"v2.logistics.ship_order": {
"path": "/api/v2/logistics/ship_order",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "logistics: ship order",
"input_schema": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is't a package number."
},
"pickup": {
"type": "object",
"properties": {
"address_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of address. Retrieved from v2.logistics.get_shipping_parameter."
},
"pickup_time_id": {
"type": "string",
"maxLength": 262144,
"description": "The pickup time id. Retrieved from v2.logistics.get_shipping_parameter, you can only select one from the time_slot_list. Some logistics channels may not return any date or time for pickup time slots. In such cases, sellers can arrange shipment without selecting any time slot, and Shopee will arrange a suitable timing for these situations."
},
"tracking_number": {
"type": "string",
"maxLength": 262144,
"description": "Need input this field when \"tracking_number\" is returned from \"info_need\". Please note that this tracking number is assigned by third-party shipping carrier for item shipment."
}
},
"required": [
"address_id"
],
"additionalProperties": false,
"description": "Required parameter ONLY if get_shipping_parameter returns \"pickup\" under \"info_needed\". Developer should still include \"pickup\" field in the call even if \"pickup\" has empty value."
},
"dropoff": {
"type": "object",
"properties": {
"branch_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of branch."
},
"sender_real_name": {
"type": "string",
"maxLength": 262144,
"description": "The real name of sender."
},
"tracking_number": {
"type": "string",
"maxLength": 262144,
"description": "Need input this field when \"tracking_number\" is returned from \"info_need\". Please note that this tracking number is assigned by third-party shipping carrier for item shipment."
},
"slug": {
"type": "string",
"maxLength": 262144,
"description": "The selected 3PL partner to drop-off parcels with."
}
},
"required": [],
"additionalProperties": false,
"description": "Required parameter ONLY if get_shipping_parameter returns \"dropoff\" under \"info_needed\". Developer should still include \"dropoff\" field in the call even if \"dropoff\" has empty value. For logistic_id 80003 and 80004, both Regular and JOB shipping methods are supported. If you choose Regular shipping method, please use \"tracking_no\" to call Init API. If you choose JOB shipping method, please use \"sender_real_name\" to call Init API. Note that only one of \"tracking_no\" and \"sender_real_name\" can be selected."
},
"non_integrated": {
"type": "object",
"properties": {
"tracking_number": {
"type": "string",
"maxLength": 262144,
"description": "Optional parameter for non-integrated channel order. The tracking number assigned by the shipping carrier for item shipment."
}
},
"required": [],
"additionalProperties": false,
"description": "Optional parameter when get_shipping_parameter returns \"non-integrated\" under \"info_needed\"."
}
},
"required": [
"order_sn"
],
"additionalProperties": false,
"description": "v2.logistics.ship_order\nUse this api to initiate logistics including arrange pickup, dropoff or shipment for non-integrated logistic channels. Should call v2.logistics.get_shipping_parameter to fetch all required param first. It's recommended to initiate logistics one hour after the orders were placed.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
}
},
"additionalProperties": true
}
},
"v2.logistics.mass_ship_order": {
"path": "/api/v2/logistics/mass_ship_order",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "logistics: mass ship order",
"input_schema": {
"type": "object",
"properties": {
"logistics_channel_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The API can only batch arrange shipment for multiple packages under the same product_location_id and same logistics_channel_id. Use this field to specify the logistics_channel_id for the request. If not specified, will use the logistics_channel_id corresponds to the first package_number by default."
},
"product_location_id": {
"type": "string",
"maxLength": 262144,
"description": "The API can only batch arrange shipment for multiple packages under the same product_location_id and same logistics_channel_id. Use this field to specify the product_location_id for the request. If not specified, will use the product_location_id corresponds to the first package_number by default."
},
"package_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"package_number": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is't a package number."
}
},
"required": [
"package_number"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "The list of packages you want to arrange shipment. limit [1, 50]."
},
"pickup": {
"type": "object",
"properties": {
"address_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of address."
},
"pickup_time_id": {
"type": "string",
"maxLength": 262144,
"description": "The pickup time id. Retrieved from v2.logistics.get_mass_shipping_parameter, you can only select one from the time_slot_list. Some logistics channels may not return any date or time for pickup time slots. In such cases, sellers can arrange shipment without selecting any time slot, and Shopee will arrange a suitable timing for these situations."
}
},
"required": [],
"additionalProperties": false,
"description": "Required parameter ONLY if GetParameterForInit returns \"pickup\" or if GetLogisticsInfo returns \"pickup\" under \"info_needed\" for the same order. Developer should still include \"pickup\" field in the call even if \"pickup\" has empty value."
},
"dropoff": {
"type": "object",
"properties": {
"branch_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of branch."
},
"sender_real_name": {
"type": "string",
"maxLength": 262144,
"description": "The real name of sender."
},
"tracking_number": {
"type": "string",
"maxLength": 262144,
"description": "Need input this field when \"tracking_number\" is returned from \"info_need\". Please note that this tracking number is assigned by third-party shipping carrier for item shipment."
}
},
"required": [],
"additionalProperties": false,
"description": "Required parameter ONLY if GetParameterForInit returns \"dropoff\" or if GetLogisticsInfo returns \"dropoff\" under \"info_needed\" for the same order. Developer should still include \"dropoff\" field in the call even if \"dropoff\" has empty value. For logistic_id 80003 and 80004, both Regular and JOB shipping methods are supported. If you choose Regular shipping method, please use \"tracking_no\" to call Init API. If you choose JOB shipping method, please use \"sender_real_name\" to call Init API. Note that only one of \"tracking_no\" and \"sender_real_name\" can be selected."
},
"non_integrated": {
"type": "object",
"properties": {
"tracking_number": {
"type": "array",
"items": {
"type": "object",
"properties": {
"package_number": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for the package under an order."
},
"tracking_number": {
"type": "string",
"maxLength": 262144,
"description": "Optional parameter for non-integrated channel order. The tracking number assigned by the shipping carrier for item shipment."
}
},
"required": [
"package_number",
"tracking_number"
],
"additionalProperties": false
},
"maxItems": 10,
"description": "Optional parameter for non-integrated channel order. The tracking number assigned by the shipping carrier for item shipment."
}
},
"required": [],
"additionalProperties": false,
"description": "Optional parameter when get_mass_shipping_parameter returns \"non-integrated\" under \"info_needed\"."
}
},
"required": [
"package_list"
],
"additionalProperties": false,
"description": "v2.logistics.mass_ship_order\nUse this api to initiate logistics including arrange pickup, dropoff or shipment for non-integrated logistic channels. Should call v2.logistics.get_mass_shipping_parameter to fetch all required params first. It's recommended to initiate logistics one hour after the orders were placed since there is one-hour window buyer can cancel any order without request to seller. The API can only batch arrange shipment for multiple packages under the same product_location_id and same logistics_channel_id.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"success_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
}
},
"additionalProperties": true
},
"description": "Success package list."
},
"fail_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
},
"fail_reason": {
"type": "string",
"description": "Reason for failure."
}
},
"additionalProperties": true
},
"description": "Fail package list."
}
},
"additionalProperties": true
}
},
"v2.logistics.update_shipping_order": {
"path": "/api/v2/logistics/update_shipping_order",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "logistics: update shipping order",
"input_schema": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is't a package number."
},
"pickup": {
"type": "object",
"properties": {
"address_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of address. Retrieved from get_shipping_parameter."
},
"pickup_time_id": {
"type": "string",
"maxLength": 262144,
"description": "The pickup time id. Retrieved from get_shipping_parameter."
}
},
"required": [
"address_id",
"pickup_time_id"
],
"additionalProperties": false,
"description": "Required parameter ONLY if GetParameterForInit returns \"pickup\" or if GetLogisticsInfo returns \"pickup\" under \"info_needed\" for the same order. Developer should still include \"pickup\" field in the call even if \"pickup\" has empty value."
}
},
"required": [
"order_sn",
"pickup"
],
"additionalProperties": false,
"description": "v2.logistics.update_shipping_order\nFor pickup method only, use this api to update pickup address and pickup time for packages meet: 1) package's fulfillment status is LOGISTICS_PICKUP_RETRY; or 2) package's fulfillment status is 'LOGISTICS_REQUEST_CREATED' and meets the Instant Order Reschedule Pickup conditions.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
}
},
"additionalProperties": true
}
},
"v2.logistics.get_tracking_number": {
"path": "/api/v2/logistics/get_tracking_number",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "logistics: get tracking number",
"input_schema": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there isn't a package number."
},
"response_optional_fields": {
"type": "string",
"maxLength": 262144,
"description": "Indicate response fields you want to get. Please select from the below response parameters. If you input an object field, all the params under it will be included automatically in the response. If there are multiple response fields you want to get, you need to use English comma to connect them. Available values: plp_number, first_mile_tracking_number,last_mile_tracking_number"
}
},
"required": [
"order_sn"
],
"additionalProperties": false,
"description": "v2.logistics.get_tracking_number\nAfter arranging shipment (v2.logistics.ship_order) for the integrated channel, use this api to get the tracking_number, which is a required parameter for creating shipping labels. The api response can return tracking_number empty, since this info is dependent from the 3PL, due to this it is allowed to keep calling the api within 5 minutes interval, until the tracking_number is returned.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"tracking_number": {
"type": "string",
"description": "The tracking number of this order."
},
"plp_number": {
"type": "string",
"description": "The unique identifier for package of BR correios."
},
"first_mile_tracking_number": {
"type": "string",
"description": "The first mile tracking number of the order. Only for Cross Border Seller"
},
"last_mile_tracking_number": {
"type": "string",
"description": "The last mile tracking number of the order. Only for Cross Border BR seller."
},
"hint": {
"type": "string",
"description": "Indicate hint information if cannot get some fields under special scenarios. For example, cannot get tracking_number when cvs store is closed."
},
"pickup_code": {
"type": "string",
"description": "For drivers to quickly identify parcel to be picked up. Only returned for ID local orders who using instant+sameday for delivery."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
}
},
"additionalProperties": true
}
},
"v2.logistics.get_mass_tracking_number": {
"path": "/api/v2/logistics/get_mass_tracking_number",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "logistics: get mass tracking number",
"input_schema": {
"type": "object",
"properties": {
"package_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"package_number": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there isn't a package number."
}
},
"required": [
"package_number"
],
"additionalProperties": false
},
"maxItems": 100,
"description": "The list of packages you want to get tracking number. limit [1, 50]."
},
"response_optional_fields": {
"type": "string",
"maxLength": 262144,
"description": "Indicate response fields you want to get. Please select from the below response parameters. If you input an object field, all the params under it will be included automatically in the response. If there are multiple response fields you want to get, you need to use English comma to connect them. Available values: plp_number, first_mile_tracking_number,last_mile_tracking_number."
}
},
"required": [
"package_list"
],
"additionalProperties": false,
"description": "v2.logistics.get_mass_tracking_number\nAfter arranging shipment (v2.logistics.mass_ship_order) for the integrated channel, use this api to get the tracking_number, which is a required parameter for creating shipping labels. The api response can return tracking_number empty, since this info is dependent from the 3PL, due to this it is allowed to keep calling the api within 5 minutes interval, until the tracking_number is returned.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"success_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
},
"tracking_number": {
"type": "string",
"description": "The tracking number of this order."
},
"plp_number": {
"type": "string",
"description": "The unique identifier for package of BR correios."
},
"first_mile_tracking_number": {
"type": "string",
"description": "The first mile tracking number of the order. Only for Cross Border Seller"
},
"last_mile_tracking_number": {
"type": "string",
"description": "The last mile tracking number of the order. Only for Cross Border BR seller."
},
"hint": {
"type": "string",
"description": "Indicate hint information if cannot get some fields under special scenarios. For example, cannot get tracking_number when cvs store is closed."
},
"pickup_code": {
"type": "string",
"description": "For drivers to quickly identify parcel to be picked up. Only returned for instant+sameday orders."
}
},
"additionalProperties": true
},
"description": "Success package list."
},
"fail_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
},
"fail_reason": {
"type": "string",
"description": "Reason for failure."
}
},
"additionalProperties": true
},
"description": "Fail package list."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
}
},
"additionalProperties": true
}
},
"v2.logistics.get_shipping_document_parameter": {
"path": "/api/v2/logistics/get_shipping_document_parameter",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "logistics: get shipping document parameter",
"input_schema": {
"type": "object",
"properties": {
"order_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is't a package number."
}
},
"required": [
"order_sn"
],
"additionalProperties": false
},
"maxItems": 100,
"description": "The list of orders you want to get. limit [1,50]"
}
},
"required": [
"order_list"
],
"additionalProperties": false,
"description": "v2.logistics.get_shipping_document_parameter\nUse this api to get the selectable shipping_document_type and suggested shipping_document_type.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
}
},
"additionalProperties": true
},
"description": "Indicate warning message you should take care."
},
"response": {
"type": "object",
"properties": {
"result_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
},
"suggest_shipping_document_type": {
"type": "string",
"description": "The shipping document type Shopee suggests. If you don't select any shipping document type, Shopee will use this as default shipping document type."
},
"selectable_shipping_document_type": {
"type": "array",
"items": {
"type": "string"
},
"description": "The shipping document type you can select of this order."
},
"fail_error": {
"type": "string",
"description": "Indicate error type if one element hit error."
},
"fail_message": {
"type": "string",
"description": "Indicate error details if one element hit error."
}
},
"additionalProperties": true
},
"description": "The list of the result data."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
}
},
"additionalProperties": true
}
},
"v2.logistics.create_shipping_document": {
"path": "/api/v2/logistics/create_shipping_document",
"method": "POST",
"risk": "W",
"identity": "Shop",
"description": "logistics: create shipping document",
"input_schema": {
"type": "object",
"properties": {
"order_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is not a package number."
},
"tracking_number": {
"type": "string",
"maxLength": 262144,
"description": "The tracking number of order. Required except for the channel allow print before arrange shipment."
},
"shipping_document_type": {
"type": "string",
"maxLength": 262144,
"description": "The type of shipping document. Available values: NORMAL_AIR_WAYBILL, THERMAL_AIR_WAYBILL, NORMAL_JOB_AIR_WAYBILL, THERMAL_JOB_AIR_WAYBILL, THERMAL_UNPACKAGED_LABEL"
}
},
"required": [
"order_sn"
],
"additionalProperties": false
},
"maxItems": 25,
"description": "The list of order you want to create shipping document. limit [1, 50]"
}
},
"required": [
"order_list"
],
"additionalProperties": false,
"description": "v2.logistics.create_shipping_document\nUse this api to create shipping document task for each order or package and this API is only available after retrieving the tracking number.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier of the API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
}
},
"additionalProperties": true
},
"description": "Indicate warning message you should take care."
},
"response": {
"type": "object",
"properties": {
"result_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
},
"fail_error": {
"type": "string",
"description": "Indicate error type if one element hit error."
},
"fail_message": {
"type": "string",
"description": "Indicate error details if one element hit error."
}
},
"additionalProperties": true
},
"description": "The list of the result data."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
}
},
"additionalProperties": true
}
},
"v2.logistics.get_shipping_document_result": {
"path": "/api/v2/logistics/get_shipping_document_result",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "logistics: get shipping document result",
"input_schema": {
"type": "object",
"properties": {
"order_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is't a package number."
},
"shipping_document_type": {
"type": "string",
"maxLength": 262144,
"description": "The type of shipping document. Available values: NORMAL_AIR_WAYBILL, THERMAL_AIR_WAYBILL, NORMAL_JOB_AIR_WAYBILL, THERMAL_JOB_AIR_WAYBILL, THERMAL_UNPACKAGED_LABEL"
}
},
"required": [
"order_sn"
],
"additionalProperties": false
},
"maxItems": 100,
"description": "The list of orders, limit [1,50]"
}
},
"required": [
"order_list"
],
"additionalProperties": false,
"description": "v2.logistics.get_shipping_document_result\nUse this api to retrieve the status of the shipping document task. Document will be available for download only after the status change to 'READY'.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"warning": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
}
},
"additionalProperties": true
},
"description": "Indicate warning message you should take care."
},
"response": {
"type": "object",
"properties": {
"result_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
},
"status": {
"type": "string",
"description": "The status of the shipping document task you querying with order_sn. Available values: READY, FAILED, PROCESSING"
},
"fail_error": {
"type": "string",
"description": "Indicate error type if one element hit error."
},
"fail_message": {
"type": "string",
"description": "Indicate error details if one element hit error."
}
},
"additionalProperties": true
},
"description": "The result data list of the API response."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
}
},
"additionalProperties": true
}
},
"v2.logistics.get_shipping_document_data_info": {
"path": "/api/v2/logistics/get_shipping_document_data_info",
"method": "POST",
"risk": "R",
"identity": "Shop",
"description": "logistics: get shipping document data info",
"input_schema": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for the package under an order. You shouldn't fill the field with empty string when there isn't a package number."
},
"recipient_address_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 262144,
"description": "fields to query in the recipient address, should be name , phone , full_address, town , district , city , state , region , zipcode ."
},
"style": {
"type": "object",
"properties": {
"text_style": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "supports bold and italic"
},
"font_size": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "supports 1 - 108"
},
"text_color": {
"type": "string",
"maxLength": 262144,
"description": "color string like \"#AbCd12\""
},
"image_width": {
"type": "number",
"description": "supports 0.1-30, in centimeters"
},
"h_align": {
"type": "string",
"maxLength": 262144,
"description": "text horizontal align, supports left, center and right."
}
},
"required": [],
"additionalProperties": false,
"description": "image style"
}
},
"required": [
"key"
],
"additionalProperties": false
},
"maxItems": 100,
"description": "recipient address to query as image"
}
},
"required": [
"order_sn"
],
"additionalProperties": false,
"description": "v2.logistics.get_shipping_document_data_info\nUse this api to fetch the logistics information of an order, these info can be used for self-design AWB printing. Besides, this api supports returning personal info as images.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"recipient_address_info": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "queried field in recipient address"
},
"image": {
"type": "string",
"description": "base64 encoded png data string"
}
},
"additionalProperties": true
},
"shipping_document_info": {
"type": "object",
"properties": {
"cod": {
"type": "boolean",
"description": "This value indicates whether the order was a COD (cash on delivery) order."
},
"cod_amount": {
"type": "string",
"description": "Use this field to indicate cod amount."
},
"order_weight": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Use this field to indicate order weight when calculate the shipping fee. The unit of weigh is gram."
},
"logistics_channel_id": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The identity of logistic channel."
},
"shipping_carrier": {
"type": "string",
"description": "The logistics service provider that the buyer selected for the order to deliver items."
},
"service_code": {
"type": "string",
"description": "Only work for cross-border order. This code is required at some sorting hub. Please ensure the service_code is INCLUDED on your shipping label, otherwise the parcel cannot be processed by the warehouse. If you didn't retrieve service_code after you first called this API, please try few more times within 30 minutes."
},
"first_mile_name": {
"type": "string",
"description": "Only work for cross-border order.The name of the carrier ships cross country or region."
},
"last_mile_name": {
"type": "string",
"description": "Only work for cross-border order.The name of the carrier delivers the parcels in local country or region."
},
"goods_to_declare": {
"type": "boolean",
"description": "Only work for cross-border order.This value indicates whether the order contains goods that are required to declare at customs. \"T\" means true and it will mark as \"T\" on the shipping label; \"F\" means false and it will mark as \"P\" on the shipping label. This value is accurate ONLY AFTER the order trackingNo is generated, please capture this value AFTER your retrieve the trackingNo."
},
"lane_code": {
"type": "string",
"description": "Only work for cross-border order. The string use for waybill printing. The format is \"S - region_code and lane_number\". For example, S-TH01, S-TH02"
},
"warehouse_address": {
"type": "string",
"description": "Only work for cross-border order in some special shop. The address info of the warehouse."
},
"warehouse_id": {
"type": "string",
"description": "Only work for cross-border order in some special shop. The ID of the warehouse."
},
"recipient_sort_code": {
"type": "object",
"properties": {
"first_recipient_sort_code": {
"type": "string",
"description": "The first-level sort_code of recipient."
},
"second_recipient_sort_code": {
"type": "string",
"description": "The second-level sort_code of recipient."
},
"third_recipient_sort_code": {
"type": "string",
"description": "The third-level sort_code of recipient."
}
},
"additionalProperties": true,
"description": "The sort_code of recipient."
},
"sender_sort_code": {
"type": "object",
"properties": {
"first_sender_sort_code": {
"type": "string",
"description": "The first-level sort_code of sender."
},
"second_sender_sort_code": {
"type": "string",
"description": "The second-level sort_code of sender."
},
"third_sender_sort_code": {
"type": "string",
"description": "The third-level sort_code of sender."
}
},
"additionalProperties": true,
"description": "The sort_code of sender."
},
"return_sort_code": {
"type": "object",
"properties": {
"return_first_sort_code": {
"type": "string",
"description": "The first-level sort code for 3PL doing RTS."
}
},
"additionalProperties": true,
"description": "The sort code for 3PL doing RTS."
},
"third_party_logistic_info": {
"type": "object",
"properties": {
"service_description": {
"type": "string",
"description": "Use this field to indicate the order category."
},
"barcode": {
"type": "string",
"description": "The manufacturer barcode."
},
"purchase_time": {
"type": "string",
"description": "The purchase_time of the store."
},
"return_time": {
"type": "string",
"description": "The return_time of the store."
},
"manufacturers_name": {
"type": "string",
"description": "The name of manufacturers."
},
"manufacturers_website": {
"type": "string",
"description": "The website of manufacturers."
},
"recipient_area": {
"type": "string",
"description": "The identification of recipient area."
},
"route_step": {
"type": "string",
"description": "The route code of the waybill."
},
"suda5_code": {
"type": "string",
"description": "The tally code of the waybill."
},
"large_logistics_id": {
"type": "string",
"description": "The code of large logistics."
},
"parent_id": {
"type": "string",
"description": "The parent code of the waybill."
},
"return_cycle": {
"type": "string",
"description": "Use this field to indicate the return cycle."
},
"return_mode": {
"type": "string",
"description": "Use this field to indicate the return mode."
},
"prompt": {
"type": "string",
"description": "The reminder of stork work."
},
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
},
"qrcode": {
"type": "string",
"description": "The QR code of the waybill."
},
"ec_supplier_name": {
"type": "string",
"description": "The supplier name of channel."
},
"ec_bar_code16": {
"type": "string",
"description": "Use this field to indicate the first barcode."
},
"equipment_id": {
"type": "string",
"description": "The device code."
},
"eshop_id": {
"type": "string",
"description": "The child code for B2C Family-mart."
},
"ec_bar_code9": {
"type": "string",
"description": "Use this field to indicate the pick barcode."
},
"pelican_tracking_no": {
"type": "string",
"description": "The tracking number of Shopee Delivery."
},
"print_date": {
"type": "string",
"description": "The date of printing the wayBill."
},
"pzip": {
"type": "string",
"description": "The sort code of the order."
},
"pzip_c": {
"type": "string",
"description": "The barcode of the sort code."
},
"deliver_area_txt": {
"type": "string",
"description": "The code of the delivery area."
},
"deliver_date_ymd": {
"type": "string",
"description": "Expected delivery date of the order."
},
"sd_driver_code": {
"type": "string",
"description": "Lorry driver code of the order."
},
"md_driver_code": {
"type": "string",
"description": "Motorcycle driver code of the order."
},
"putorder_stackzone_code": {
"type": "string",
"description": "Stacking area of the order."
},
"customer_code": {
"type": "string",
"description": "The customer code of Shopee."
},
"deliver_router": {
"type": "string",
"description": "Use this field to indicate the delivery router."
},
"store_type": {
"type": "string",
"description": "Use this field to indicate the store type."
},
"pick_router": {
"type": "string",
"description": "Use this field to indicate the pick router."
},
"barcode_dc": {
"type": "string",
"description": "The main logistic barcode of the waybill."
},
"ec_order_number": {
"type": "string",
"description": "Use this field to indicate the logistics order number."
},
"barcode_pr": {
"type": "string",
"description": "The sorting barcode of the waybill."
},
"first_pick_barcode": {
"type": "string",
"description": "The first pick barcode of the waybill."
},
"second_pick_barcode": {
"type": "string",
"description": "The second pick barcode of the waybill."
},
"is_cod_bool": {
"type": "string",
"description": "Use this field to indicate the service type."
},
"receiver_name": {
"type": "string",
"description": "Use this field to indicate the receiver name."
},
"rcv_store_name": {
"type": "string",
"description": "Use this field to indicate the receiver store name."
},
"branch_code": {
"type": "string",
"description": "Use this field indicates destination service point code."
},
"branch_name": {
"type": "string",
"description": "Use this field indicates destination service point name."
},
"last_third_digits_recipient_phone": {
"type": "string",
"description": "Use this field indicates buyer phone number (last 3 digits)."
},
"last_third_digits_sender_phone": {
"type": "string",
"description": "Use this field indicates seller phone number (last 3 digits)."
},
"barcode_no1": {
"type": "string",
"description": "First barcode no. sacnned when seller drop off"
},
"barcode_no2": {
"type": "string",
"description": "Second barcode no. sacnned when seller drop off"
},
"print_datetime": {
"type": "string",
"description": "AWB Print date and time"
},
"ok_mid_type": {
"type": "string",
"description": "Middle type used in OK Mart SOC"
},
"ok_aisle_no": {
"type": "string",
"description": "Aisle no. used in OK Mart SOC"
},
"ok_grid_no": {
"type": "string",
"description": "Grid no used in OK Mart SOC"
},
"ok_tracking_number": {
"type": "string",
"description": "The tracking number of OK Mart."
},
"barcode_no3": {
"type": "string",
"description": "OK SOC received no."
},
"ship_type": {
"type": "string",
"description": "Ship type used by OK Mart"
},
"area": {
"type": "string",
"description": "The area of the collect OK branch used for OK sorting"
},
"barcode_no4": {
"type": "string",
"description": "First barcode no. sacnned when buyer collect"
},
"barcode_no5": {
"type": "string",
"description": "Second barcode no. sacnned when buyer collect"
},
"tw_last_three_digits_buyer_phone": {
"type": "string",
"description": "[Only for local TW orders] Last 3 digits of buyer's phone number, apply for channel_id: 30005, 30006, 30007,30014,30015"
},
"tw_store_name": {
"type": "string",
"description": "[Only for TW channel_id:30005 ] Store name for 7-ELEVEN orders."
},
"tw_store_number": {
"type": "string",
"description": "[Only for TW channel_id:30005 ]Store number for 7-ELEVEN orders."
},
"buyer_prefer_delivery_time": {
"type": "object",
"properties": {
"slot_id": {
"type": "string",
"description": "The slot which buyer choose"
},
"start_time": {
"type": "string",
"description": "The start time of a day buyer prefer to receive the packages"
},
"end_time": {
"type": "string",
"description": "The end time of a day buyer prefer to receive the packages."
},
"description": {
"type": "string",
"description": "The detailed instructions of the package delivering."
}
},
"additionalProperties": true,
"description": "[Only for TW channel:30017] The time buyer prefers to receive the packages."
}
},
"additionalProperties": true,
"description": "Only used for TW sellers."
},
"tracking_number": {
"type": "string",
"description": "The tracking number assigned by the shipping carrier for item shipment."
},
"shopee_tracking_number": {
"type": "string",
"description": "First mile tracking NO. for CrossBoard BR seller can be used to self-design CB Brazil AWB."
},
"last_mile_tracking_number": {
"type": "string",
"description": "The last-mile tracking number. Only for Cross Board BR seller."
},
"pickup_hub": {
"type": "string",
"description": "The name of pickup hub."
},
"delivery_hub": {
"type": "string",
"description": "The name of delivery hub."
},
"deliver_area": {
"type": "string",
"description": "Zone name."
},
"ec_order_no": {
"type": "string",
"description": "The name of ec order."
},
"create_date_ymd_sl": {
"type": "string",
"description": "The date of create shipment order."
},
"manufacturers_name": {
"type": "string",
"description": "The name of manufacturer."
},
"manufacturers_website": {
"type": "string",
"description": "The website of manufacturer."
},
"is_lm_dg_bool": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Use this field to indicate order contains dangerous goods or not. 0: Non-dangerous good 1: Dangerous good 2: Prohibited"
},
"preferred_delivery_option": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Use this field to indicate delivery address is residential or office address. 0: not configured 1: office address 2: residential address"
},
"spx_sub_district": {
"type": "string",
"description": "The sub-district of recipient's address."
},
"spx_receive_station": {
"type": "object",
"properties": {
"spx_first_receive_station": {
"type": "string",
"description": "The first pickup station."
}
},
"additionalProperties": true,
"description": "The spx receive station."
},
"zone": {
"type": "string",
"description": "The zone of this order."
},
"zone_code": {
"type": "string",
"description": "Delivery Sub Zone."
},
"destination_base_code": {
"type": "string",
"description": "Distribution Center Code."
},
"last_third_digits_buyer_phone": {
"type": "string",
"description": "Use this field indicates buyer phone number (last 3 digits). For non-TW local sellers"
},
"parcel_size": {
"type": "string",
"description": "corresponding locker sizing for self-collection locker channels [only available for specific logistic channels: 148003 and 140006]"
},
"sod": {
"type": "boolean",
"description": "this value indicates whether the buyer select \"scan on delivery\" payment channel at checkout."
},
"buyer_cpf_id": {
"type": "string",
"description": "Buyer's CPF number for taxation and invoice purposes. Only for Brazil order."
},
"mutual_check": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "only apply for ID/VN shops. mutual_check indicates whether the parcel is eligible for Return-on-the-Spot (RoS) co-check. If mutual_check=1, then the parcel is RoS eligible, where drivers and buyers can co-check the parcel. Buyer can then choose to accept or reject the parcel on the spot. If mutual_check=0, then the parcel is ineligible for RoS."
},
"dely_fri_label": {
"type": "string",
"description": "Probability of Successful Friday Delivery. The value of L(low), M(medium), H(high) represent the chances of successful delivery attempts on Friday."
},
"dely_sat_label": {
"type": "string",
"description": "Probability of Successful Saturday Delivery The value of L(low), M(medium), H(high) represent the chances of successful delivery attempts on Saturday."
},
"dely_sun_label": {
"type": "string",
"description": "Probability of Successful Sunday Delivery. The value of L(low), M(medium), H(high) represent the chances of successful delivery attempts on Sunday."
},
"pickup_code": {
"type": "string",
"description": "For drivers to quickly identify parcel to be picked up. Only returned for ID and TH local orders which use instant+sameday for delivery."
},
"sorting_group": {
"type": "string",
"description": "[Only for TW 30029 channel] This field indicate the sorting group value of the package. Available values: - North - South"
},
"unpackaged_sku_id": {
"type": "string",
"description": "[Only for TW 30029 channel] Please refer to this number instead of tracking number for this this channel. This field will be empty for other channels."
},
"unpackaged_sku_id_qrcode": {
"type": "string",
"description": "[Only for TW 30029 channel] Please refer to this field to generate the QR code for the shipping document for this channel. This field will be empty for other channels."
},
"high_value": {
"type": "boolean",
"description": "This value indicates whether the order is considered a “high value” item and requires special handling by the logistics provider. The threshold to be considered \"high value\" item differs by region, and is only applicable to SPX channels. For regions other than Malaysia and Thailand, this field will always return empty."
},
"dg_specific_type": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "Currently only applicable for Brazil, Indonesia, Vietnam, Philippines. For orders with Dangerous Goods, this value indicates the severity of the danger and requires special handling by the logistics provider. 0 = Not classified / no DG sub-type 1 = DG_A 2 = DG_B 3 = DG_C 4 = DG_D"
},
"hotspot_id": {
"type": "string",
"description": "This ID is used by 3PL to determine parcel routing. For regions other than Malaysia and Thailand, this field will always return empty."
},
"weekend1_delivery_success_label": {
"type": "string",
"description": "This value indicates whether an order has a high / medium / low delivery success rate on each weekend (e.g. sat and sun respectively). For regions other than Malaysia, this field will always return empty. High = H Medium = M Low = L"
},
"weekend2_delivery_success_label": {
"type": "string",
"description": "This value indicates whether an order has a high / medium / low delivery success rate on each weekend (e.g. sat and sun respectively). For regions other than Malaysia, this field will always return empty. High = H Medium = M Low = L"
}
},
"additionalProperties": true
}
},
"additionalProperties": true,
"description": "Detail informations you are querying. Note: For parcels that support pre-shipment printing, calling this API before shipment will only return the following fields: response recipient_address_info key image shipping_document_info cod cod_amount order_weight logistics_channel_id shipping_carrier pickup_code"
}
},
"additionalProperties": true
}
},
"v2.logistics.get_tracking_info": {
"path": "/api/v2/logistics/get_tracking_info",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "logistics: get tracking info",
"input_schema": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"maxLength": 262144,
"description": "Shopee's unique identifier for the package under an order. You shouldn't fill the field with empty string when there is a package number."
}
},
"required": [
"order_sn"
],
"additionalProperties": false,
"description": "v2.logistics.get_tracking_info\nUse this api to get the logistics tracking information of an order.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"order_sn": {
"type": "string",
"description": "Shopee's unique identifier for an order."
},
"package_number": {
"type": "string",
"description": "Shopee's unique identifier for the package under an order."
},
"logistics_status": {
"type": "string",
"description": "The logistics status for the order. Applicable values: See Data Definition- LogisticsStatus."
},
"tracking_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"update_time": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The time when the logistics tracking info is updated."
},
"description": {
"type": "string",
"description": "The description of the logistics tracking info."
},
"logistics_status": {
"type": "string",
"description": "The logistics status for the order. Applicable values: See Data Definition- LogisticsStatus."
},
"return_code": {
"type": "string",
"description": "The OTP generated after the parcel enters the RTS (Return to Seller) process. Sellers need to provide this OTP to the driver to complete the return confirmation. Note: - This field only applies to orders under the SPX Instant & Sameday channel in ID region. - This field is only returned when the driver has initiated the return process to the seller. If the driver has not initiated the return process for the parcel, this field will be empty."
}
},
"additionalProperties": true
},
"description": "The tracking info of the order."
},
"collection_pin_code": {
"type": "string",
"description": "[TW Only] The unique 6-digit PIN code for sellers to collect RTS (Return to Seller) parcels at service points. This field is returned when the channel is C2C and the logistics_status is FULFILMENT_DELIVERY_FAILED."
},
"reversed_tracking_number": {
"type": "string",
"description": "The tracking number of the reversed logistics. Note: Only apply to the cross-border segment of failed delivery parcels returned from the local return warehouse to the seller."
},
"reversed_courier_name": {
"type": "string",
"description": "The courier name of the reversed logistics. Note: Only apply to the cross-border segment of failed delivery parcels returned from the local return warehouse to the seller."
},
"reversed_tracking_info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"update_time": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The time when the reversed logistics tracking info is updated."
},
"description": {
"type": "string",
"description": "The description of the reversed logistics tracking info."
}
},
"additionalProperties": true
},
"description": "The tracking information of the reversed logistics. Note: Only apply to the cross-border segment of failed delivery parcels returned from the local return warehouse to the seller."
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
}
},
"additionalProperties": true
}
},
"v2.logistics.get_address_list": {
"path": "/api/v2/logistics/get_address_list",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "logistics: get address list",
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false,
"description": "v2.logistics.get_address_list\nFor integrated logistics channel, use this call to get pickup address for pickup mode order.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"show_pickup_address": {
"type": "boolean",
"description": "Show pickup address or not."
},
"address_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of address."
},
"region": {
"type": "string",
"description": "The region of specify address."
},
"state": {
"type": "string",
"description": "The state of specify address."
},
"city": {
"type": "string",
"description": "The city of specify address."
},
"address": {
"type": "string",
"description": "The address description of specify address."
},
"zipcode": {
"type": "string",
"description": "The zipcode of specify address."
},
"district": {
"type": "string",
"description": "The district of specify address."
},
"town": {
"type": "string",
"description": "The town of specify address."
},
"address_type": {
"type": "array",
"items": {
"type": "string"
},
"description": "The flag of shop address.Available values: DEFAULT_ADDRESS, PICK_UP_ADDRESS, RETURN_ADDRESS, INBOUND_PICKUP_ADDRESS."
}
},
"additionalProperties": true
},
"description": "The address list of you shop"
}
},
"additionalProperties": true,
"description": "Detail informations you are querying."
}
},
"additionalProperties": true
}
},
"v2.logistics.set_address_config": {
"path": "/api/v2/logistics/set_address_config",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "logistics: set address config",
"input_schema": {
"type": "object",
"properties": {
"show_pickup_address": {
"type": "boolean",
"description": "Definite show pickup address or not."
},
"address_type_config": {
"type": "object",
"properties": {
"address_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identifier id of the address."
},
"address_type": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "The type of address. Available values: DEFAULT_ADDRESS, PICKUP_ADDRESS, RETURN_ADDRESS, INBOUND_PICKUP_ADDRESS."
}
},
"required": [],
"additionalProperties": false,
"description": "The config of your shop addres."
}
},
"required": [],
"additionalProperties": false,
"description": "v2.logistics.set_address_config\nUse this API to set address config of your shop.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
}
},
"additionalProperties": true
}
},
"v2.logistics.update_address": {
"path": "/api/v2/logistics/update_address",
"method": "POST",
"risk": "H",
"identity": "Shop",
"description": "logistics: update address",
"input_schema": {
"type": "object",
"properties": {
"address_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Unique identifier for the address. You can get the address_id via v2.logistics.get_address_list."
},
"region": {
"type": "string",
"maxLength": 262144,
"description": "The region of the address. Note: Do not allow to update the region of the address."
},
"state": {
"type": "string",
"maxLength": 262144,
"description": "The state of the address."
},
"city": {
"type": "string",
"maxLength": 262144,
"description": "The city of the address."
},
"district": {
"type": "string",
"maxLength": 262144,
"description": "The district of the address."
},
"town": {
"type": "string",
"maxLength": 262144,
"description": "The town of the address."
},
"address": {
"type": "string",
"maxLength": 262144,
"description": "The detailed address description of the address."
},
"zipcode": {
"type": "string",
"maxLength": 262144,
"description": "The zipcode of the address."
},
"name": {
"type": "string",
"maxLength": 262144,
"description": "Recipient’s name at this address."
},
"phone": {
"type": "string",
"maxLength": 262144,
"description": "Contact phone number for the recipient."
},
"geo_info": {
"type": "string",
"maxLength": 262144,
"description": "Geolocation information for the address. Type: JSON string Note: 1) To clear existing geo info, pass \"\" or {} . 2) To keep existing geo info, do not include this field . 3) The JSON may include optional fields: - formattedAddress (string): full formatted address. - region (object) – contains latitude and longitude as floats. - user_verified (boolean) – whether the geolocation is verified by the user. - user_adjusted (boolean) – whether the geolocation was adjusted by the user."
}
},
"required": [
"address_id"
],
"additionalProperties": false,
"description": "v2.logistics.update_address\nUse this API to update the address of a shop.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
}
},
"additionalProperties": true
}
},
"v2.logistics.delete_address": {
"path": "/api/v2/logistics/delete_address",
"method": "POST",
"risk": "D",
"identity": "Shop",
"description": "logistics: delete address",
"input_schema": {
"type": "object",
"properties": {
"address_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int",
"description": "The identity of address you want to delete."
}
},
"required": [
"address_id"
],
"additionalProperties": false,
"description": "v2.logistics.delete_address\nUse this api to delete address.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"request_id": {
"type": "string",
"description": "The identifier for an API request for error tracking."
},
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
}
},
"additionalProperties": true
}
},
"v2.logistics.get_channel_list": {
"path": "/api/v2/logistics/get_channel_list",
"method": "GET",
"risk": "R",
"identity": "Shop",
"description": "logistics: get channel list",
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false,
"description": "v2.logistics.get_channel_list\nUse this api to get all supported logistic channels.\nAuthorization: Shop; existing bound shop and Seller In House System app. Platform market, enrollment and method permissions still apply."
},
"output_schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Indicate error type if hit error. Empty if no error happened."
},
"message": {
"type": "string",
"description": "Indicate error details if hit error. Empty if no error happened."
},
"response": {
"type": "object",
"properties": {
"logistics_channel_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"logistics_channel_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "The identity of logistic channel."
},
"logistics_channel_name": {
"type": "string",
"description": "The name of logistic channel."
},
"cod_enabled": {
"type": "boolean",
"description": "This is to indicate whether this logistic channel supports COD"
},
"enabled": {
"type": "boolean",
"description": "Whether this logistic channel is enabled on shop level."
},
"fee_type": {
"type": "string",
"description": "SIZE_SELECTION SIZE_INPUT FIXED_DEFAULT_PRICE CUSTOM_PRICE"
},
"size_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"size_id": {
"type": "string",
"description": "The identity of size."
},
"name": {
"type": "string",
"description": "The name of size."
},
"default_price": {
"type": "number",
"description": "The pre-defined shipping fee for the specific size."
}
},
"additionalProperties": true
},
"description": "Only for fee_type is SIZE_SELECTION"
},
"weight_limit": {
"type": "object",
"properties": {
"item_max_weight": {
"type": [
"number",
"null"
],
"description": "The max weight for an item on this logistic channel.If the value is 0 or null, that means there is no limit."
},
"item_min_weight": {
"type": [
"number",
"null"
],
"description": "The min weight for an item on this logistic channel. If the value is 0 or null, that means there is no limit."
}
},
"additionalProperties": true,
"description": "The weight limit for this logistic channel."
},
"item_max_dimension": {
"type": "object",
"properties": {
"height": {
"type": "number",
"description": "The max height limit."
},
"width": {
"type": "number",
"description": "The max width limit."
},
"length": {
"type": "number",
"description": "The max length limit."
},
"unit": {
"type": "string",
"description": "The unit for the limit."
},
"dimension_sum": {
"type": "number",
"description": "The sum of the item's dimension"
}
},
"additionalProperties": true,
"description": "The dimension limit for this logistic channel."
},
"volume_limit": {
"type": "object",
"properties": {
"item_max_volume": {
"type": [
"number",
"null"
],
"description": "The max volume for an item on this logistic channel.If the value is 0 or null, that means there is no limit for the item weight."
},
"item_min_volume": {
"type": [
"number",
"null"
],
"description": "The min volume for an item on this logistic channel. If the value is 0 or null, that means there is no limit for the item weight."
}
},
"additionalProperties": true,
"description": "The limit of item volume."
},
"logistics_description": {
"type": "string",
"description": "For checkout channels, this field indicates its corresponding fulfillment channels."
},
"force_enable": {
"type": "boolean",
"description": "Indicates whether the logistic channel is force enabled on Shop Level. If true, sellers cannot close this channel."
},
"mask_channel_id": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,18})$"
}
],
"x-integer": "int64",
"description": "Indicate the parent logistic channel ID. If it’s 0, it indicates the channel is a checkout(masked) channel; if it’s not 0, indicate the channel is a fulfillment channel and has a checkout channel(checkout channel’s channel_id equals this mask_channel_id) on top of it. Multiple channels may share the same mask_channel_id."
},
"block_seller_cover_shipping_fee": {
"type": "boolean",
"description": "Indicate whether the channel is blocked to use seller cover shipping fee function. if the channel does not allow sellers to cover shipping fee, then the block_seller_cover_shipping_fee field will return true, otherwise it will return false."
},
"support_cross_border": {
"type": "boolean",
"description": "Indicate whether this channel support cross border shipping."
},
"seller_logistic_has_configuration": {
"type": [
"boolean",
"null"
],
"description": "Indicate If seller has set the Seller logistics configuration if set will return true, otherwise it will return false or null."
},
"logistics_capability": {
"type": "object",
"properties": {
"seller_logistics": {
"type": "boolean",
"description": "Indicate If it's a Seller logistics channel, if it's a Seller logistics channel will return true, otherwise it will return false."
}
},
"additionalProperties": true,
"description": "The capability of one logistic channel."
},
"preprint": {
"type": "boolean",
"description": "Indicate whether this channel support pre-print AWB"
},
"service_type_identifier": {
"type": [
"string",
"null"
],
"description": "This parameter specifies the delivery service type of logistics channel. Applicable values: - instant - same_day - null"
},
"auto_call_driver_setting": {
"type": "object",
"properties": {
"auto_call_driver_eligible": {
"type": "boolean",
"description": "Indicate whether this channel is eligible for Auto Call Driver."
},
"auto_call_driver_enabled": {
"type": "boolean",
"description": "Indicate whether Auto Call Driver is currently enabled for this channel"
},
"preparation_time": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The current valid preparation time for this channel, in minutes."
},
"preparation_time_limit": {
"type": "object",
"properties": {
"min_preparation_time": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The minimum allowable preparation time, in minutes."
},
"max_preparation_time": {
"type"File truncated at 1 MB.