About Object
objectRepresents the resources you can access in GraphQL. An object can contain a series of fields, each with a specific type.
GraphQL object types define the data structure of the data returned by the query, each object type contains multiple fields, and each field has its specific data type.These object types constitute the API data model, defining the data structures and relationships that the client can retrieve.
In this system, the object type covers data structures for content management, user information, product data, comment systems, and many other aspects, providing a unified data access interface for various business scenarios.
Object Type Classification
The types of objects in this system mainly include:
- Content-related objects: such asArchive(Document Details),Archive List(Document list),Category(Classification information) and other
- User-related objects: such asUser(User information),UserGroup(User group) et al.
- Product-related objects: such asSku(Product SKU information),ArchiveSkuProduct specification SKU information and so on
- System setting object: such asSystemSetting(System settings),Contact SettingContact information and so on
- Interactive related object: such asComment（Comment）,Review（Product Review）etc.
Each object type lists its fields and field descriptions in detail, making it easy for clients to accurately obtain the required data.
Archive
Document details, including articles and products
field
| name | Description |
|---|---|
| allow oversold(Boolean) | Does it support overselling? |
| amount(Integer) | Amount |
| brand(String) | Brand |
| canonical_url(String) | Standard URL |
| cart_id(Integer) | Shopping cart ID |
| category(Category) | Category information |
| category_id(Integer) | Category ID |
| category_ids(Integer) | Category ID list |
| category_titles(String) | category_titles_list |
| Comment Count(Integer) | Number of comments |
| content(String) | content |
| cost_price(Integer) | Cost price |
| created_time(Integer) | Timestamp of creation |
| description(String) | description |
| extra(JSON) | Extended field |
| Favorable price(Integer) | Discount price |
| favorite count(Integer) | Number of favorites |
| fixed link(String) | Fixed link |
| flag(String) | Marker |
| has_order_fields(Boolean) | Field for order status |
| has_ordered(Boolean) | Whether the order has been placed |
| has_password(Boolean) | Does it have a password |
| has_pseudo(Integer) | Does it have virtual sales |
| id(Integer) | Document ID |
| Images(String) | Image List |
| is_favorite(Boolean) | Whether favorited |
| Is Free Shipping(Boolean) | Is Delivery Free |
| is_wholesale(Boolean) | Whether support wholesale |
| keyword_id(Integer) | Keyword ID |
| keywords(String) | Keywords |
| link(String) | links |
| Logo(String) | Logo |
| module_id(Integer) | Model ID |
| Module name(String) | Model name |
| Need Logistics(Boolean) | Whether need logistics |
| option type(Integer) | Option type |
| options(Archive option) | Specification option list |
| order_fields(CustomField) | Order Field List |
| order_extra(JSON) | Order extension information |
| original amount(Integer) | Original Amount |
| origin_id(Integer) | Original ID |
| origin_price(Integer) | Original Price |
| Origin Title(String) | Original Title |
| origin_url(String) | Original URL |
| parent_id(Integer) | Parent ID |
| password(String) | Password |
| password_valid(Boolean) | Is the password valid |
| price(Integer) | Price |
| quantity(Integer) | Quantity |
| read_level(Integer) | reading level |
| review count(Integer) | Number of reviews |
| seo title(String) | SEO title |
| sold_count(Integer) | Sales quantity |
| sort(Integer) | Sorting |
| stock(Integer) | Inventory |
| Skus(ArchiveSku) | SKU list |
| sku(Sku) | Selected SKU information |
| tags(Tag) | Tag list |
| template(String) | Template |
| thumbnail(String) | Thumbnail |
| Title(String) | Title |
| type(String) | Type |
| updated_time(Integer) | update timestamp |
| URL Token(String) | URL identifier |
| user_id(Integer) | User ID |
| Video URL(String) | Video URL |
| Views(Integer) | view count |
| weight(Float) | weight |
| weight unit(String) | Weight unit |
| wholesale rule(WholesaleRule) | wholesale rule |
| Wholesale rules(WholesaleRule) | List of wholesale rules |
Archive List
document, product list, product transfer module_id=2
field
| name | Description |
|---|---|
| items(Archive) | Document/Product List |
| page(Integer) | page number |
| Total(Integer) | Total |
Archive option
Product Specification Name
field
| name | Description |
|---|---|
| archive_id(Integer) | Product ID |
| created_time(Integer) | Timestamp of creation |
| id(Integer) | ID |
| is_main(Integer) | Is Main Option |
| sort(Integer) | Sorting |
| Title(String) | Title |
| updated_time(Integer) | update timestamp |
| values(Archive Option Value) | Spec value list |
Archive Option Value
Product specification options
field
| name | Description |
|---|---|
| archive_id(Integer) | Product ID |
| color(String) | color |
| created_time(Integer) | Timestamp of creation |
| id(Integer) | ID |
| option id(Integer) | Option ID |
| Images(String) | Image List |
| Logo(String) | Logo |
| thumbnail(String) | Thumbnail |
| price(Integer) | Price |
| sort(Integer) | Sorting |
| Title(String) | Title |
| updated_time(Integer) | update timestamp |
ArchiveSku
Product specification SKU information
field
| name | Description | |
|---|---|---|
| archive_id(Integer) | Product ID | |
| barcode(String) | Barcode | |
| cost_price(Integer) | Cost price | |
| created_time(Integer) | Timestamp of creation | |
| hs_code(String) | Customs Code | |
| id(Integer) | ID | |
| link(String) | SKU link | |
| Images(String) | Image List | |
| Logo(String) | Logo | |
| origin_price(Integer) | Price | |
| price(Integer) | Price | |
| sku(String) | SKU | |
| sold_count(Integer) | Sales quantity | |
| stock(Integer) | Inventory | |
| symbol(String) | SKU Symbol | |
| thumbnail(String) | Thumbnail | |
| Title(String) | Title | |
| updated_time(Integer) | update timestamp | |
| weight(Float) | weight | |
| weight unit(String) | Weight unit | |
Banner Item
Home Banner
field
| name | Description |
|---|---|
| alt(String) | Alternative text |
| description(String) | description |
| id(Integer) | ID |
| link(String) | links |
| Logo(String) | Logo |
| type(String) | Type |
Category
Document, product category
field
| name | Description |
|---|---|
| archive_count(Integer) | Document/ Product quantity |
| content(String) | content |
| description(String) | description |
| detail_template(String) | Detail template |
| extra(JSON) | Extended field |
| has_children(Boolean) | Has children |
| id(Integer) | ID |
| Images(String) | Image List |
| is_current(Boolean) | Is current category |
| Inherits(Integer) | Inherit |
| keywords(String) | Keywords |
| link(String) | links |
| Logo(String) | Logo |
| module_id(Integer) | Model ID |
| parent_id(Integer) | Parent ID |
| seo title(String) | SEO title |
| sort(Integer) | Sorting |
| Spacer(String) | Separator |
| status(Integer) | Status |
| template(String) | Template |
| thumbnail(String) | Thumbnail |
| Title(String) | Title |
| type(Integer) | Type |
| URL Token(String) | URL identifier |
Comment
Comment
field
| name | Description |
|---|---|
| active(Boolean) | Whether active |
| archive_id(Integer) | Document ID |
| content(String) | Comment content |
| created_time(Integer) | Timestamp of creation |
| id(Integer) | ID |
| IP(String) | IP address |
| item title(String) | Document title |
| parent(Comment) | Parent Comment |
| parent_id(Integer) | Parent ID |
| status(Integer) | Status |
| to_uid(Integer) | Target User ID |
| user_id(Integer) | User ID |
| user_name(String) | Username |
| Vote count(Integer) | Vote Count |
Comment list
Comment List
field
| name | Description |
|---|---|
| items(Comment) | Comment List |
| page(Integer) | page number |
| Total(Integer) | Total |
Contact Setting
Contact Information
field
| name | Description |
|---|---|
| address(String) | address |
| cellphone(String) | Phone number |
| email(String) | |
| extra fields(ExtraField) | extended field list |
| facebook(String) | |
| instagram(String) | |
| linkedin(String) | |
| pinterest(String) | |
| qq(String) | |
| qrcode(String) | QR Code |
| TikTok(String) | TikTok |
| Twitter(String) | |
| user_name(String) | Username |
| wechat(String) | |
| whatsapp(String) | |
| youtube(String) | YouTube |
Currency Setting
currency settings
field
| name | Description |
|---|---|
| currency(String) | currency code |
| name(String) | Currency Name |
| symbol(String) | Currency Symbol |
CustomField
Custom field
field
| name | Description |
|---|---|
| content(String) | content |
| field_name(String) | Field name |
| follow_level(Boolean) | Follow user group level |
| is_filter(Boolean) | Whether to filter |
| is_system(Boolean) | Whether it is a system field |
| items(String) | Project list |
| name(String) | name |
| required(Boolean) | Mandatory? |
| type(String) | Type |
ExtraField
Document extension field
field
| name | Description |
|---|---|
| content(String) | content |
| name(String) | name |
| remark(String) | Note |
| type(String) | Type |
| value(JSON) | Value |
FilterGroup
Document, product filter group
field
| name | Description |
|---|---|
| field_name(String) | Field name |
| items(FilterItem) | Filter options list |
| name(String) | name |
| range(Range) | Range |
FilterItem
Document, Product Filter Options
field
| name | Description |
|---|---|
| is_current(Boolean) | Is the Current Item |
| label(String) | Tag |
| link(String) | links |
| Total(Integer) | Total |
FriendLink
Friendship Link
field
| name | Description |
|---|---|
| back_link(String) | Backlink |
| checked_time(Integer) | check timestamp |
| contact(String) | Contact Information |
| id(Integer) | ID |
| link(String) | links |
| my_link(String) | my link |
| my_title(String) | my title |
| nofollow(Integer) | Is nofollow |
| remark(String) | Note |
| sort(Integer) | Sorting |
| status(Integer) | Status |
| Title(String) | Title |
IndexSetting
home page TDK
field
| name | Description |
|---|---|
| seo description(String) | SEO description |
| seo_keywords(String) | SEO keywords |
| seo title(String) | SEO title |
Module
model information
field
| name | Description |
|---|---|
| description(String) | description |
| id(Integer) | ID |
| is_system(Integer) | is system model |
| keywords(String) | Keywords |
| link(String) | links |
| name(String) | name |
| status(Integer) | Status |
| Table Name(String) | table name |
| Title(String) | Title |
| Title Name(String) | Title Name |
| URL Token(String) | URL identifier |
MultiLangSite
Multilingual Site Information
field
| name | Description |
|---|---|
| base_url(String) | Basic URL |
| id(Integer) | ID |
| is_current(Boolean) | Is the Current Site |
| language(String) | Language |
| language emoji(String) | language emoticon |
| language_icon(String) | language icon |
| language name(String) | Language Name |
| link(String) | links |
| name(String) | name |
| parent_id(Integer) | Parent ID |
| status(Boolean) | Status |
| sync_time(Integer) | timestamp of synchronization |
Nav
navigation information
field
| name | Description |
|---|---|
| description(String) | description |
| id(Integer) | ID |
| is_current(Boolean) | Is the current navigation |
| Level(Integer) | Level |
| link(String) | links |
| Logo(String) | Logo |
| nav_list(Nav) | Navigation list |
| nav_type(Integer) | Navigation type |
| page_id(Integer) | Page ID |
| parent_id(Integer) | Parent ID |
| sort(Integer) | Sorting |
| Spacer(String) | Separator |
| status(Integer) | Status |
| style(String) | style |
| sub_title(String) | sub_title |
| thumbnail(String) | Thumbnail |
| Title(String) | Title |
| type_id(Integer) | Type ID |
Page
Single page information
field
| name | Description |
|---|---|
| content(String) | content |
| description(String) | description |
| id(Integer) | ID |
| Images(String) | Image List |
| is_current(Boolean) | Is it the current page |
| keywords(String) | Keywords |
| link(String) | links |
| Logo(String) | Logo |
| seo title(String) | SEO title |
| status(Integer) | Status |
| thumbnail(String) | Thumbnail |
| Title(String) | Title |
| URL Token(String) | URL identifier |
PageMeta
Get the current page TDK information
field
| name | Description |
|---|---|
| canonical_url(String) | Standard URL |
| current_page(Integer) | Current page number |
| description(String) | description |
| Image(String) | Image |
| keywords(String) | Keywords |
| module_id(Integer) | Model ID |
| Nav Bar(Integer) | Navigation bar |
| page_id(Integer) | Page ID |
| page_name(String) | Page Name |
| params(JSON) | Parameter |
| status code(Integer) | Status code |
| Title(String) | Title |
| total_pages(Integer) | Total number of pages |
Range
Filter option range, used by price filter
field
| name | Description |
|---|---|
| Max(Integer) | Maximum value |
| min(Integer) | minimum |
| link(String) | links |
Review
product rating
field
| name | Description |
|---|---|
| archive_id(Integer) | Product ID |
| archive_sku_id(Integer) | product SKU ID |
| archive_title(String) | Product Title |
| avatar_url(String) | avatar_url |
| content(String) | content |
| created_time(Integer) | Timestamp of creation |
| email(String) | |
| id(Integer) | ID |
| Images(String) | Image List |
| IP(String) | IP address |
| order_id(String) | Order ID |
| Score(Integer) | rating |
| sku_title(String) | SKU title |
| status(Integer) | Status |
| user_id(Integer) | User ID |
| user_name(String) | Username |
Review List
Product Review List
field
| name | Description |
|---|---|
| items(Review) | Review List |
| page(Integer) | page number |
| Total(Integer) | Total |
Sku
Get product SKU information
field
| name | Description |
|---|---|
| currency(String) | Currency |
| currency symbol(String) | Currency Symbol |
| has_sku(Boolean) | Is there an SKU |
| id(Integer) | ID |
| maximum price(Integer) | Highest Price |
| minimum price(Integer) | Lowest Price |
| options(Archive option) | Options list |
| order count(Integer) | Order Quantity |
| price(Integer) | Price |
| quota used(Integer) | Used Quota |
| Skus(ArchiveSku) | SKU list |
| stock(Integer) | Inventory |
| thumbnail(String) | Thumbnail |
| Title(String) | Title |
| user limit(Integer) | Quantity Limit for Users |
| Wholesale rules(WholesaleRule) | List of wholesale rules |
SystemSetting
System settings
field
| name | Description |
|---|---|
| admin_url(String) | Administrator URL |
| ban_spider(Integer) | Prohibit crawling |
| base_url(String) | Basic URL |
| currency(String) | Currency |
| default_site(Boolean) | Default site |
| extra fields(ExtraField) | extended field list |
| favicon(String) | Website icon |
| language(String) | Language |
| mobile_url(String) | Mobile URL |
| site_close(Integer) | Site Closure |
| site_close_tips(String) | site closure notice |
| site copyright(String) | site copyright information |
| site icp number(String) | Site ICP Filing Number |
| site_logo(String) | Site Logo |
| site_name(String) | Site name |
| template_name(String) | Template Name |
| template_type(Integer) | Template Type |
| template_url(String) | Template URL |
Tag
Document Tag
field
| name | Description |
|---|---|
| category_id(Integer) | Category ID |
| category_title(String) | category title |
| content(String) | content |
| description(String) | description |
| extra(JSON) | Extended field |
| first_letter(String) | first_letter |
| id(Integer) | ID |
| keywords(String) | Keywords |
| link(String) | links |
| Logo(String) | Logo |
| seo title(String) | SEO title |
| status(Integer) | Status |
| template(String) | Template |
| thumbnail(String) | Thumbnail |
| Title(String) | Title |
| URL Token(String) | URL identifier |
TagList
Document Tag List
field
| name | Description |
|---|---|
| items(Tag) | Tag list |
| page(Integer) | page number |
| Total(Integer) | Total |
User
User Information
field
| name | Description |
|---|---|
| avatar_url(String) | avatar_url |
| balance(Integer) | Balance |
| email(String) | |
| email_verified(Boolean) | Email Verified |
| expire time(Integer) | expiration timestamp |
| extra(JSON) | Extended field |
| Full avatar URL(String) | Complete Avatar URL |
| group(UserGroup) | User group |
| group_id(Integer) | user group ID |
| id(Integer) | ID |
| introduce(String) | Introduction |
| Invite Code(String) | Invitation Code |
| is_retailer(Integer) | Are you a distributor |
| last login(Integer) | Last login timestamp |
| link(String) | links |
| parent_id(Integer) | Parent ID |
| phone(String) | Phone |
| real_name(String) | Real Name |
| status(Integer) | Status |
| token(String) | Login token |
| Total Reward(Integer) | Total reward earnings |
| URL Token(String) | URL identifier |
| user_name(String) | Username |
UserGroup
User group
field
| name | Description |
|---|---|
| description(String) | description |
| Favorable price(Integer) | Discount price |
| id(Integer) | ID |
| Level(Integer) | level |
| price(Integer) | Price |
| Setting(UserGroupSetting) | setting |
| status(Integer) | Status |
| Title(String) | User group name |
UserGroupSetting
Group settings
field
| name | Description |
|---|---|
| content_no_captcha(Boolean) | publish_content_no_captcha |
| content_no_verify(Boolean) | publish_content_no_verification |
| discount(Integer) | discount |
| expire_day(Integer) | Expiry Days |
| parent_reward(Integer) | Parent Reward (Second-level Distributor Reward) |
| share_reward(Integer) | Share Reward (Third-level Distributor Reward) |
WholesaleRule
wholesale rule
field
| name | Description |
|---|---|
| archive_id(Integer) | Product ID |
| created_time(Integer) | Timestamp of creation |
| discount_rate(Integer) | Discount Rate |
| id(Integer) | ID |
| max_quantity(Integer) | Maximum Quantity |
| min_quantity(Integer) | Minimum Quantity |
| sku_id(Integer) | SKU ID |
| updated_time(Integer) | update timestamp |
