1. SKU

API URL

post {HTTP(S)host} /api/{version}/sku

1.1. Query sku List

1.1.1. SERVICE_TYPE

QUERY_SIMPLE_LIST_SKU

1.1.2. Request

Params Require DataType Sample Description
page Y Number 1 Page number, default 1
pageSize Y Number 50 Number of records per page. no more than 200; Default is 100
categoryName1 N String Level 1 product classification
categoryName2 N String Secondary product categories
categoryName3 N String Three levels of product classification
updateTimeFrom N String 2022-09-26 Update start time
updateTimeTo N String 2022-09-26 Update end time
skus N List <String> ["123","456"] sku code
titles N List <String> ["The title of the product "] The title of the product
skuCustomFieldValueSOList N List<SkuCustomFieldValueSO> Custom Field Search criteria

SkuCustomFieldValueSO(Custom Field Search)

Params Require DataType Sample Description
customFieldId Y Long 3 SERVICE_TYPE=CUSTOMER_FIELD_QUERY return id
value N String “张三” Custom Field value: STRING,SELECT。
from N String "1970/01/01" Range query left interval :NUMBER,DATE。
to N String "1971/01/01" The range query is the right interval : NUMBER,DATE。

1.1.3. Reponse

Params Require DataType Sample Description
errorCode Y String “DATA_INPUT_ERROR” Error Code
errorMsg Y String “The input of Params is incorrect” Business Error Messages
state Y String success Response State
total Y Number 100 Total num
result Y List<Sku> For product list information, please check the table below for details

Sku

Params Require DataType Sample Description
sku Y String “sku1” sku , up to 255 characters
title Y String “abc” The title of the product, up to 255 characters
barcode N String Product barcode, up to 255 characters
type Y String “SINGLE” Sku Type
picUrl N String Image address, up to 255 characters
saleStatus N String Sales status, up to 50 characters
weight Y Decimal gross weight
netWeight Y Decimal net weight
weightUnit Y String Units of weight
abbrTitle N String Abbreviation, up to 255 characters
brand N String Product brand, up to 50 characters
unit N String Commodity unit, maximum 128 characters
color N String Color, up to 255 characters
size N String Size, up to 255 characters
length Y Decimal length
width Y Decimal width
height Y Decimal height
dimensionUnit Y String Units of length
itemPackage N Number Package quantity
description N String Product description, maximum 2048 characters
descriptionEn N String Product descriptions are in English, with a maximum of 2048 characters
functionDescription N String Performance description, up to 2048 characters
enable Y Number Item status (0: disabled; 1: Valid)
categoryName1 N String Level 1 commodity classification
categoryName2 N String Secondary product categories
categoryName3 N String Three levels of product classification
singleBoxCode N String Single-box barcode
singleItemVolume N Decimal The volume of the single item
cartonVolumeUnit N String Volume units
customProp1 N String Custom field 1
customProp2 N String Custom field 2
customProp3 N String Custom field 3
price N Decimal Default selling price
remarkName N String Description
singleSkuList N List <SubSkuDTO> In the case of a combination, the sub-product information is returned
skuCustomFieldValueVOList N SkuCustomFieldValueVO Custom Field info
packingRate N Number Number of single boxes
purchaseCost N Decimal Purchase cost
purchaseCostUnit N String Purchase cost currency
skuSupplierList N List <SkuSupplierDTO> Supplier
isRelatedSingleCost N Boolean Whether to associate the purchase cost of single items

SubSkuDTO(Sub-product information)

Params Require DataType Sample Description
sku Y String “sku1” sku , up to 255 characters
quantity Y Integer 1 quantity

SkuCustomFieldValueVO(Custom Field inf)

Params Require DataType Sample Description
tableName Y String SYS_ITEM SYS_ITEM： System sku Custom Field ； SYS_ORDER： Order Custom Field ； SYS_ODO： Outbound order Custom Field ； SYS_ASN： Inbound order Custom Field 。
columType Y String NUMBER Filter for different fill types Custom Field: NUMBER,DATE,STRING,SELECT。
columName Y String Date of manufacture The name of the field defined by the user
defaultValue N String 1970/01/01 Custom Field Default value
candidateValue N String ["1970/01/01","1970/01/02"] Candidate value for the drop-down box
remark N String The shelf date is distinguished from the date of manufacture Description
required N Integer 1 Whether to query only the required fields 1:true;0:false
isQuery N Integer 1 Whether to query only the columns that support the query 1:true;0:false
isShow N Integer 1 Specifies whether to query only the columns that support column configurations 1:true;0:false

SkuSupplierDTO(Supplier information)

Params Require DataType Sample Description
name Y String Supplier name
isDefault Y Boolean Whether default supplier
purchaserList Y List <String> Purchaser, is username not name
deliveryCycle Y Number Delivery Date, day
purchasePrice N Decimal Purchase price, two digits after the decimal point are significant, and round up or down
purchasePriceUnit N String Purchase price currency（CNY,USD,CAD,GBP, EUR,JRY,etc）
minimumPurchaseQuantity N Number Minimum purchase quantity, which should be a positive integer
purchaseTaxRate N Decimal Purchase tax rate, unit: %
drawbackRate N Decimal Tax rebate rate, unit: %
purchaseUrl N String Purchase url

1.2. Create sku

1.2.1. SERVICE_TYPE

INSERT_SKU_INFO

1.2.2. Request

Params Require DataType Sample Description
sku Y String “sku1” sku , up to 255 characters
title Y String “abc” The title of the product , up to 255 characters
barcode N String Product barcode, up to 255 characters
type Y String “SINGLE” Sku Type
picUrl N String Image address, up to 255 characters
saleStatus N String Sales status, up to 50 characters
weight Y Decimal gross weight
netWeight Y Decimal net weight
weightUnit Y String Units of weight
abbrTitle N String Abbreviation, up to 255 characters
brand N String Product brand, up to 50 characters
unit N String Commodity unit, maximum 128 characters
color N String Color, up to 255 characters
size N String Size, up to 255 characters
length Y Decimal length
width Y Decimal width
height Y Decimal height
dimensionUnit Y String Units of length
itemPackage N Number Package quantity
description N String Product description, maximum 2048 characters
descriptionEn N String Product descriptions are in English, with a maximum of 2048 characters
functionDescription N String Performance description, up to 2048 characters
enable Y Number Item status (0: disabled; 1: Valid)
packingRate N Number Packing rate ，If it is not filled, the size of the outer box and the outer box will not be saved gross weight 、Outer box net weight
cartonLength N Decimal The outer box length
cartonWidth N Decimal The outer box width
cartonHeight N Decimal The outer box height
cartonWeight N Decimal The outer box gross weight
cartonNetWeight N Decimal The outer box net weight
cartonDimensionUnit N String The outer box Dimension units（cm; m）
cartonWeightUnit N String The outer box Units of weight（KG; G）
chineseCustomsDeclarationName N String Chinese customs declaration name
englishCustomsDeclarationName N String English customs declaration name
cdPriceMethod N String How the customs declaration price is calculated（RATE:proportion; CONSTANT:fixed）
cdPriceRate N Decimal Proportion of customs declaration price
cdPriceMaximum N Decimal The maximum value of the customs declaration price
customsDeclarationPrice N Decimal Customs price
customsDeclarationPriceUnit N String Unit of customs declaration price（CNY; USD; CAD; GBP; EUR; JRY）
customsCode N String Officers code
exportTax N Decimal Export tax rates
declaration N String Instructions for declaration
dangerousTransportGoodsType N String Type of dangerous goods（NONE, LIQUID, POWDER, CONTAIN_ELECTRIC, ELECTRIC）
batteryType N Integer Battery type (0: uncharged; 1: Supporting lithium-ion battery; 2: Built-in lithium-ion battery; 3: Supporting lithium metal battery; 4: Built-in lithium metal battery; 5: Dry battery)
ccPriceMethod N String How the customs clearance price is calculated（RATE:proportion; CONSTANT:fixed）
ccPriceRate N Decimal Percentage of customs clearance price
ccPriceMaximum N Decimal The maximum value of the customs clearance price
ccPrice N Decimal Customs clearance price
ccPriceUnit N String The currency of the customs clearance price（CNY; USD; CAD; GBP; EUR; JRY）
needQualityInspection N Boolean Whether quality inspection is required
price N Decimal Default selling price
priceUnit N String Default selling price unit (uppercase 3 digit code)
asin N String ASIN
customProp1 N String Custom attribute 1
customProp2 N String Custom Attribute 2
customProp3 N String Custom attribute 3
categoryName1 N String Level 1 commodity classification
categoryName2 N String Secondary product categories
categoryName3 N String Three levels of product classification
remarkName N String Description
singleSkuList N List <SubSkuDTO> Sub-product information
singleBoxCode N String Single-box barcode
singleItemVolume N Decimal The volume of the single item
skuCustomFieldValueVOList N List <SkuCustomFieldValueVO> Custom Field info
purchaseCost N Decimal Purchase cost
purchaseCostUnit N String Purchase cost currency
skuSupplierList N List <SkuSupplierDTO> Supplier
isRelatedSingleCost N Boolean Whether to associate the purchase cost of single items. This only takes effect for combined items
warehouseNameList N List ["warehouseName1"] When filling in this field and type=SINGLE, automatically create warehouse products and asynchronously distribute them to the warehouse

SubSkuDTO(Sub sku)

Params Require DataType Sample Description
sku Y String “sku1” Sub-product SKUs
quantity Y Number 3 The number of sub-products in the combination

SkuCustomFieldValueVO(Custom Field )

Params Require DataType Sample Description
customFieldId Y Long 3 SERVICE_TYPE=CUSTOMER_FIELD_QUERY return id
value Y String “michael” Custom Field value

SkuSupplierDTO(Supplier information)

Params Require DataType Sample Description
name Y String Supplier name
isDefault Y Boolean Whether default supplier
purchaserList Y List <String> Purchaser, is username not name
deliveryCycle Y Number Delivery Date, day
purchasePrice N Decimal Purchase price, two digits after the decimal point are significant, and round up or down
purchasePriceUnit N String Purchase price currency（CNY,USD,CAD,GBP, EUR,JRY,etc）
minimumPurchaseQuantity N Number Minimum purchase quantity, which should be a positive integer
purchaseTaxRate N Decimal Purchase tax rate, unit: %
drawbackRate N Decimal Tax rebate rate, unit: %
purchaseUrl N String Purchase url

1.2.3. Reponse

Params Require DataType Sample Description
errorCode Y String “DATA_INPUT_ERROR” Error Code
errorMsg Y String “The input of Params is incorrect” Business Error Messages
state Y String success Response State

1.3. Update sku

1.3.1. SERVICE_TYPE

UPDATE_SKU_INFO

1.3.2. Request

Params Require DataType Sample Description
sku Y String “sku1” sku , up to 255 characters
title Y String “abc” The title of the product , up to 255 characters
barcode N String Product barcode, up to 255 characters
type Y String “SINGLE” Sku Type
picUrl N String Image address, up to 255 characters
saleStatus N String Sales status, up to 50 characters
weight Y Decimal gross weight
netWeight Y Decimal net weight
weightUnit Y String Units of weight
abbrTitle N String Abbreviation, up to 255 characters
brand N String Product brand, up to 50 characters
unit N String Commodity unit, maximum 128 characters
color N String Color, up to 255 characters
size N String Size, up to 255 characters
length Y Decimal length
width Y Decimal width
height Y Decimal height
dimensionUnit Y String Units of length
itemPackage N Number Package quantity
description N String Product description, maximum 2048 characters
descriptionEn N String Product descriptions are in English, with a maximum of 2048 characters
functionDescription N String Performance description, up to 2048 characters
enable Y Number Item status (0: disabled; 1: Valid)
packingRate N Number Packing rate ，If it is not filled, the size of the outer box and the outer box will not be saved gross weight 、Outer box net weight
cartonLength N Decimal The outer box length
cartonWidth N Decimal The outer box width
cartonHeight N Decimal The outer box height
cartonWeight N Decimal The outer box gross weight
cartonNetWeight N Decimal The outer box net weight
cartonDimensionUnit N String The outer box Dimension units（cm; m）
cartonWeightUnit N String The outer box Units of weight（KG; G）
chineseCustomsDeclarationName N String Chinese customs declaration name
englishCustomsDeclarationName N String English customs declaration name
cdPriceMethod N String How the customs declaration price is calculated（RATE:proportion; CONSTANT:fixed）
cdPriceRate N Decimal Proportion of customs declaration price
cdPriceMaximum N Decimal The maximum value of the customs declaration price
customsDeclarationPrice N Decimal Customs price
customsDeclarationPriceUnit N String Unit of customs declaration price（CNY; USD; CAD; GBP; EUR; JRY）
customsCode N String Officers code
exportTax N Decimal Export tax rates
declaration N String Instructions for declaration
dangerousTransportGoodsType N String Type of dangerous goods（NONE, LIQUID, POWDER, CONTAIN_ELECTRIC, ELECTRIC）
batteryType N Integer Battery type (0: uncharged; 1: Supporting lithium-ion battery; 2: Built-in lithium-ion battery; 3: Supporting lithium metal battery; 4: Built-in lithium metal battery; 5: Dry battery)
ccPriceMethod N String How the customs clearance price is calculated（RATE:proportion; CONSTANT:fixed）
ccPriceRate N Decimal Percentage of customs clearance price
ccPriceMaximum N Decimal The maximum value of the customs clearance price
ccPrice N Decimal Customs clearance price
ccPriceUnit N String The currency of the customs clearance price（CNY; USD; CAD; GBP; EUR; JRY）
needQualityInspection N Boolean Whether quality inspection is required
price N Decimal Default selling price
priceUnit N String Default selling price unit (uppercase 3 digit code)
asin N String ASIN
customProp1 N String Custom attribute 1
customProp2 N String Custom Attribute 2
customProp3 N String Custom attribute 3
categoryName1 N String Level 1 commodity classification
categoryName2 N String Secondary product categories
categoryName3 N String Three levels of product classification
remarkName N String Description
singleSkuList N List <SubSkuDTO> Sub-product information
singleBoxCode N String Single-box barcode
singleItemVolume N Decimal The volume of the single item
skuCustomFieldValueVOList N List <SkuCustomFieldValueVO> Custom Field info
purchaseCost N Decimal Purchase cost
purchaseCostUnit N String Purchase cost currency
skuSupplierList N List <SkuSupplierDTO> Supplier
isRelatedSingleCost N Boolean Whether to associate the purchase cost of single items. This only takes effect for combined items

SubSkuDTO(Sub-product information)

Params Require DataType Sample Description
sku Y String “sku1” Sub-product SKUs
quantity Y Number 3 The number of sub-products in the combination

SkuCustomFieldValueVO(Custom Field )

Params Require DataType Sample Description
customFieldId Y Long 3 SERVICE_TYPE=CUSTOMER_FIELD_QUERY return id
value Y String “michael” Custom Field value

SkuSupplierDTO(Supplier information)

Params Require DataType Sample Description
name Y String Supplier name
isDefault Y Boolean Whether default supplier
purchaserList Y List <String> Purchaser, is username not name
deliveryCycle Y Number Delivery Date, day
purchasePrice N Decimal Purchase price, two digits after the decimal point are significant, and round up or down
purchasePriceUnit N String Purchase price currency（CNY,USD,CAD,GBP, EUR,JRY,etc）
minimumPurchaseQuantity N Number Minimum purchase quantity, which should be a positive integer
purchaseTaxRate N Decimal Purchase tax rate, unit: %
drawbackRate N Decimal Tax rebate rate, unit: %
purchaseUrl N String Purchase url

1.3.3. Reponse

Params Require DataType Sample Description
errorCode Y String “DATA_INPUT_ERROR” Error Code
errorMsg Y String “The input of Params is incorrect” Business Error Messages
state Y String success Response State

1.4. Enables/deactivates the sku

1.4.1. SERVICE_TYPE

UPDATE_SKU_STATUS

1.4.2. Request

Params Require DataType Sample Description
sku Y String “sku1” The SKU that was entered when adding a product
enable Y Number Item status (0: disabled; 1: Valid)

1.4.3. Reponse

Params Require DataType Sample Description
errorCode Y String “DATA_INPUT_ERROR” Error Code
errorMsg Y String “The input of Params is incorrect” Business Error Messages
state Y String success Response State
© Copyright QianYi Team 2025 All Rights Reserved            Updated 2025-06-13 09:54:22

results matching ""

    No results matching ""