# Interface Field Definitions

# 1 Base Fields

# 1 System Fields

# 1.1 Return

Field Field Meaning Field Type Length Note
code error code int 20 Reference error code
result Whether or not the return is normal boolean 1
message return message string 200
data return data object interface data return
requestId requestId string 48 Flag request for logging errors

# 1.2 Paging

Field Field Meaning Field Type Length Note
pageNum Number of current pages int 20
pageSize Number of items returned per page int 20
total total int 20
list data list 20

# 2 Public Fields

# 2.1 Region

Field Field Meaning Field Type Length Note
areaId area id string 200
areaEn area name string 200
countryCode country code string 200

# 2.2 People

Field Field Meaning Field Type Length Note
creater creator string 200
createTime createTime string 200
updater modifier string 200
updateTime modifyTime string 200

# 2.3 Other

Field Field Meaning Field Type Length Note
sourceFrom source byte 4
comment comment string 200

Remarks:

sourceFrom: 0-erp entry, 1-store search entry, 2-Linkus search entry

# 2 Transaction Fields

# 1 Authentication Fields

# 1.1 Authorization

Field Definition Type Length Note
email Email string 200
password Password string 200

# 1.2 Token

Field Definition Type Length Note
accessToken Access Token string 200
accessTokenExpiryDate Access Token expiry time string 200 Default 7 days
refreshToken Refresh Token string 200
refreshTokenExpiryDate Refresh Token expiry time string 200 Default 180 days

# 2 Settings Fields

# 2.1 Account

Field Definition Type Length Note
openId Account ID string 200
openName Account Name string 200
openEmail Account Email string 200
root Root access string 200 root:NO_PERMISSION - not authorized
GENERAL - general account
VIP - VIP account
ADMIN - administrator
isSandbox (Whether) Sandbox account byte 4

# 2.2 API Setting

Field Definition Type Length Note
setting Settings list 200
quotaLimits Quota limits list Applicable on specific URLs
quotaUrl Quota URL string 200
quotaLimit Quota limit int 20
quotaType Quota Type byte 4 0-total,1-per year,2-per year,3-per quarter,4-per day,5-per hour
qpsLimit QPS limit int 20 Account queries per second

# 3 Product Fields

# 3.1 Product

Field Definition Type Length Note
pid Product ID string 200
productName Product name list 20
productNameEn Product name(EN) string 200
productSku Product sku string 200
productImage Product image string 200
productWeight Product weight int 200 unit: g
productType Product type byte 200
productUnit Product unit string 48
categoryId Category id string 200
categoryName Category name string 200
entryCode HS code string 200
entryName Customs name string 200
entryNameEn Customs name (EN) string 200
materialName Material string 200
materialNameEn Material (EN) string 200
materialKey Material attribute string 200
packWeight Package weight int 200 util: g
packingName Package name string 200
packingNameEn Package name (EN) string 200
packingKey Package attribute string 200
isActive (Whether) Active boolean 1
description Description string 200

Product Type

Product Type Type
ORDINARY_PRODUCT Ordinary product
SERVICE_PRODUCT Service product
PACKAGING_PRODUCT Packaging product
SUPPLIER_PRODUCT Supplier product
SUPPLIER_SHIPPED_PRODUCT Supplier shipped product

# 3.2 Variant

Field Definition Type Length Note
vid Variant ID string 200
variantName Variant name string 200
variantNameEn Variant name (EN) string 200
variantSku Variant SKU string 200
variantUnit Variant Unit string 200
variantProperty Variant Property string 200
variantKey Variant Key string 200
variantLength Variant Length int 200 unit: cm
variantWidth Variant Width int 200 unit: cm
variantHeight Variant Height int 200 unit: cm
variantVolume Variant Volume int 200 unit: cm3
variantWeight Variant Weight int 200 unit: g
variantSellPrice Variant Sell Price double 200 unit: $ (USD)

# 3.3 Supplier

Field Definition Type Length Note

# 3.4 Storage

Field Definition Type Length Note
storageNum Available inventory int 20
queryTime Refresh rate string 200