Objects
About Objects
ObjectRepresents the resources you can access in GraphQL. An object can contain a set of fields, each with a specific type.
The GraphQL object type defines 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 data model of the API, defining the data structures and relationships that the client can retrieve.
In this system, the object type covers a variety of data structures such as content management, user information, product data, and comment systems, providing a unified data access interface for various business scenarios.
Object type classification
The object types in this system mainly include:
- Content-related objectFor example:Archive(Document Details),Archive List(Document List),Category(Classification information), etc.
- User-related ObjectsFor example:User(User information),UserGroup(User Group) et al.
- Product-Related ObjectsFor example:Sku(Product SKU information),ArchiveSku(Product specification SKU information) et al.
- System setting objectFor example:System Setting(System settings),Contact Setting(Contact Information) etc.
- Interactive Related ObjectFor example:Comment(Comments),Review(Product Reviews) etc.
Each object type lists its fields and field descriptions in detail, making it easy for the client to accurately obtain the required data.
Archive
Document details, including articles and products
Field
| Name | Description |
|---|---|
| allow_oversold(Boolean) | Support for overselling |
| amount(Int) | Amount |
| Canonical URL(String) | Standard URL |
| cart_id(Int) | Shopping Cart ID |
| category(Category) | category information |
| category_id(Int) | Category ID |
| category_ids(Int) | Category ID list |
| category_titles(String) | List of Category Titles |
| comment_count(Int) | Comment Count |
| content(String) | Content |
| Cost Price(Int) | Cost Price |
| created_time(Int) | Creation Timestamp |
| Description(String) | Description |
| extra(JSON) | Extended Field |
| Favorable Price(Int) | Discount Price |
| favorite_count(Int) | number_of_favorites |
| fixed_link(String) | fixed_link |
| flag(String) | icon |
| has_order_fields(Boolean) | Does the order field exist? |
| has_ordered(Boolean) | Has the order been placed? |
| has_password(Boolean) | Does the password exist? |
| has_pseudo(Int) | Does it have virtual sales? |
| id(Int) | Document ID |
| images(String) | Image list |
| is_favorite(Boolean) | Is it favorited? |
| is_free_shipping(Boolean) | Does it include free shipping? |
| is_wholesale(Boolean) | Does it support wholesale? |
| keyword_id(Int) | Keyword ID |
| Keywords(String) | Keywords |
| link(String) | linkage |
| Logo(String) | Logo |
| module_id(Int) | Model ID |
| module_name(String) | Model name |
| need_logistics(Boolean) | Whether logistics is needed |
| option_type(Int) | Option Type |
| Options(ArchiveOption) | Specification Option List |
| order_extra(JSON) | Order Extended Information |
| origin_amount(Int) | Original Amount |
| origin_id(Int) | Original ID |
| Original Price(Int) | Original Price |
| Origin Title(String) | Original Title |
| Origin URL(String) | Original URL |
| parent_id(Int) | Parent ID |
| password(String) | Password |
| password_valid(Boolean) | Is password valid |
| Price(Int) | price |
| quantity(Int) | Quantity |
| read_level(Int) | Reading Level |
| Review Count(Int) | Number of Reviews |
| SEO Title(String) | SEO title |
| sold_count(Int) | Number of Sales |
| sort(Int) | Sorting |
| Stock(Int) | inventory |
| tags(Tag) | tag list |
| template(String) | Template |
| Thumbnail(String) | Thumbnail |
| Title(String) | Title |
| type(String) | Type |
| updated_time(Int) | update timestamp |
| url_token(String) | URL identifier |
| user_id(Int) | User ID |
| video_url(String) | Video URL |
| views(Int) | View count |
| weight(Float) | Weight |
| Weight Unit(String) | Unit of Weight |
| wholesale_rule(WholesaleRule) | Wholesale Rule |
| wholesale_rules(WholesaleRule) | Wholesale Rule List |
Archive List
Documents, product list, transmission module_id=2
Field
| Name | Description |
|---|---|
| items(Archive) | Documents/ product list |
| page(Int) | page number |
| total(Int) | Total Count |
ArchiveOption
Product specifications name
Field
| Name | Description |
|---|---|
| archive_id(Int) | Product ID |
| created_time(Int) | Creation Timestamp |
| id(Int) | ID |
| is_main(Int) | Is the main option |
| sort(Int) | Sorting |
| Title(String) | Title |
| updated_time(Int) | update timestamp |
| Values(ArchiveOptionValue) | List of specifications |
ArchiveOptionValue
Product specification options
Field
| Name | Description |
|---|---|
| archive_id(Int) | Product ID |
| color(String) | Color |
| created_time(Int) | Creation Timestamp |
| id(Int) | ID |
| option_id(Int) | Option ID |
| Price(Int) | price |
| sort(Int) | Sorting |
| Title(String) | Title |
| updated_time(Int) | update timestamp |
ArchiveSku
Product Specification SKU Information
Field
| Name | Description |
|---|---|
| archive_id(Int) | Product ID |
| barcode(String) | Bar Code |
| Cost Price(Int) | Cost Price |
| created_time(Int) | Creation Timestamp |
| HS Code(String) | Customs Code |
| id(Int) | ID |
| Logo(String) | Logo |
| Original Price(Int) | Original Price |
| Price(Int) | price |
| sku(String) | SKU |
| sold_count(Int) | Number of Sales |
| Stock(Int) | inventory |
| symbol(String) | SKU Symbol |
| Thumbnail(String) | Thumbnail |
| Title(String) | Title |
| updated_time(Int) | update timestamp |
| weight(Int) | Weight |
| Weight Unit(Int) | Unit of Weight |
Banner Item
Home Banner
Field
| Name | Description |
|---|---|
| alt(String) | Alternative Text |
| Description(String) | Description |
| id(Int) | ID |
| link(String) | linkage |
| Logo(String) | Logo |
| type(String) | Type |
Category
Documents, Product Categories
Field
| Name | Description |
|---|---|
| archive_count(Int) | document/product quantity |
| content(String) | Content |
| Description(String) | Description |
| detail_template(String) | detail template |
| extra(JSON) | Extended Field |
| has_children(Boolean) | has child categories |
| id(Int) | ID |
| images(String) | Image list |
| is_current(Boolean) | Is this category |
| is_inherit(Int) | Is inherited |
| Keywords(String) | Keywords |
| link(String) | linkage |
| Logo(String) | Logo |
| module_id(Int) | Model ID |
| parent_id(Int) | Parent ID |
| SEO Title(String) | SEO title |
| sort(Int) | Sorting |
| spacer(String) | Spacer |
| status(Int) | Status |
| template(String) | Template |
| Thumbnail(String) | Thumbnail |
| Title(String) | Title |
| type(Int) | Type |
| url_token(String) | URL identifier |
Comment
Comment
Field
| Name | Description |
|---|---|
| Active(Boolean) | Whether active |
| archive_id(Int) | Document ID |
| content(String) | Comment content |
| created_time(Int) | Creation Timestamp |
| id(Int) | ID |
| IP(String) | IP Address |
| Item Title(String) | Document Title |
| Parent(Comment) | Parent Comment |
| parent_id(Int) | Parent ID |
| status(Int) | Status |
| to_uid(Int) | Target User ID |
| user_id(Int) | User ID |
| user_name(String) | Username |
| vote_count(Int) | Number of votes |
Comment List
Comment list
Field
| Name | Description |
|---|---|
| items(Comment) | Comment list |
| page(Int) | page number |
| total(Int) | Total Count |
Contact Setting
Contact information
Field
| Name | Description |
|---|---|
| address(String) | address |
| cellphone(String) | Phone number |
| email(String) | |
| extra_fields(ExtraField) | list of extended fields |
| 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 |
Custom Field
Custom fields
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) | Is required |
| type(String) | Type |
ExtraField
Document extended fields
Field
| Name | Description |
|---|---|
| content(String) | Content |
| name(String) | Name |
| remark(String) | [en] Note |
| type(String) | Type |
| value(JSON) | Value |
Filter Group
Document, Product Filter Group
Field
| Name | Description |
|---|---|
| Field Name(String) | Field Name |
| items(Filter Item) | Filter options list |
| name(String) | Name |
| Range(Range) | Scope |
Filter Item
Document, product filter options
Field
| Name | Description |
|---|---|
| is_current(Boolean) | Is the current item |
| label(String) | tags |
| link(String) | linkage |
| total(Int) | Total Count |
FriendLink
Friendship Link
Field
| Name | Description |
|---|---|
| Back Link(String) | Backlink |
| checked_time(Int) | timestamp check |
| contact(String) | Contact information |
| id(Int) | ID |
| link(String) | linkage |
| my_link(String) | my_link |
| my_title(String) | My Title |
| nofollow(Int) | Is nofollow |
| remark(String) | [en] Note |
| sort(Int) | Sorting |
| status(Int) | Status |
| Title(String) | Title |
IndexSetting
Home 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(Int) | ID |
| is_system(Int) | Is System Model |
| Keywords(String) | Keywords |
| link(String) | linkage |
| name(String) | Name |
| status(Int) | Status |
| table_name(String) | Table Name |
| Title(String) | Title |
| Title Name(String) | Title name |
| url_token(String) | URL identifier |
MultiLangSite
Multi-language site information
Field
| Name | Description |
|---|---|
| Base URL(String) | Basic URL |
| id(Int) | ID |
| is_current(Boolean) | Is Current Site |
| language(String) | Language |
| language_emoji(String) | Language Emoji |
| language_icon(String) | Language icon |
| Language name(String) | Language Name |
| link(String) | linkage |
| name(String) | Name |
| parent_id(Int) | Parent ID |
| status(Boolean) | Status |
| sync_time(Int) | Synchronize timestamp |
Nav
Navigation information
Field
| Name | Description |
|---|---|
| Description(String) | Description |
| id(Int) | ID |
| is_current(Boolean) | Is current navigation |
| level(Int) | Level |
| link(String) | linkage |
| Logo(String) | Logo |
| nav_list(Nav) | navigation_list |
| nav_type(Int) | navigation_type |
| page_id(Int) | Page ID |
| parent_id(Int) | Parent ID |
| sort(Int) | Sorting |
| spacer(String) | Spacer |
| status(Int) | Status |
| style(String) | style |
| sub_title(String) | sub_title |
| Thumbnail(String) | Thumbnail |
| Title(String) | Title |
| type_id(Int) | Type ID |
Page
Single Page Information
Field
| Name | Description |
|---|---|
| content(String) | Content |
| Description(String) | Description |
| id(Int) | ID |
| images(String) | Image list |
| is_current(Boolean) | Is Current Page |
| Keywords(String) | Keywords |
| link(String) | linkage |
| Logo(String) | Logo |
| SEO Title(String) | SEO title |
| status(Int) | Status |
| Thumbnail(String) | Thumbnail |
| Title(String) | Title |
| url_token(String) | URL identifier |
PageMeta
Get Current Page TDK Information
Field
| Name | Description |
|---|---|
| Canonical URL(String) | Standard URL |
| current_page(Int) | current page number |
| Description(String) | Description |
| image(String) | Image |
| Keywords(String) | Keywords |
| module_id(Int) | Model ID |
| navigation bar(Int) | navigation bar |
| page_id(Int) | Page ID |
| page name(String) | Page Name |
| Params(JSON) | Parameters |
| Status Code(Int) | Status Code |
| Title(String) | Title |
| Total Pages(Int) | Total number of pages |
Range
Filter option range, used in price filter
Field
| Name | Description |
|---|---|
| Max(Int) | Maximum value |
| Minimum(Int) | Minimum value |
Review
Product Review
Field
| Name | Description |
|---|---|
| archive_id(Int) | Product ID |
| archive_sku_id(Int) | Product SKU ID |
| archive_title(String) | Product Title |
| avatar_url(String) | Profile Picture URL |
| content(String) | Content |
| created_time(Int) | Creation Timestamp |
| email(String) | |
| id(Int) | ID |
| images(String) | Image list |
| IP(String) | IP Address |
| order_id(String) | Order ID |
| score(Int) | Rating |
| SKU Title(String) | Product Title |
| status(Int) | Status |
| user_id(Int) | User ID |
| user_name(String) | Username |
ReviewList
Product Reviews List
Field
| Name | Description |
|---|---|
| items(Review) | Rating list |
| page(Int) | page number |
| total(Int) | Total Count |
Sku
Retrieve product SKU information
Field
| Name | Description |
|---|---|
| Currency(String) | Currency |
| Currency symbol(String) | Currency Symbol |
| Has SKU(Boolean) | Is there an SKU |
| id(Int) | ID |
| max_price(Int) | Highest Price |
| min_price(Int) | Lowest Price |
| Options(ArchiveOption) | Option List |
| Order count(Int) | Order Quantity |
| Price(Int) | price |
| Quota used(Int) | Used Quota |
| skus(ArchiveSku) | SKU List |
| Stock(Int) | inventory |
| Thumbnail(String) | Thumbnail |
| Title(String) | Title |
| user_limit(Int) | User purchase limit |
| wholesale_rules(WholesaleRule) | Wholesale Rule List |
System Setting
System Settings
Field
| Name | Description |
|---|---|
| admin url(String) | Administrator URL |
| Ban Spider(Int) | Ban Spiders |
| Base URL(String) | Basic URL |
| Currency(String) | Currency |
| default_site(Boolean) | default_station |
| extra_fields(ExtraField) | list of extended fields |
| favicon(String) | website_icon |
| language(String) | Language |
| mobile_url(String) | Mobile End URL |
| Site Close(Int) | Site Closure |
| Site Closure Tips(String) | Site Closure Alert |
| site_copyright(String) | site_copyright |
| site_copyright(String) | site_copyright |
| site_copyright(String) | site Logo |
| site name(String) | Site Name |
| template name(String) | template name |
| template type(Int) | template type |
| template_url(String) | template URL |
Tag
Document Label
Field
| Name | Description |
|---|---|
| category_id(Int) | Category ID |
| category title(String) | Category Title |
| content(String) | Content |
| Description(String) | Description |
| extra(JSON) | Extended Field |
| first letter(String) | First Letter |
| id(Int) | ID |
| Keywords(String) | Keywords |
| link(String) | linkage |
| Logo(String) | Logo |
| SEO Title(String) | SEO title |
| status(Int) | 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(Int) | page number |
| total(Int) | Total Count |
User
User Information
Field
| Name | Description |
|---|---|
| avatar_url(String) | Profile Picture URL |
| balance(Int) | Balance |
| email(String) | |
| email_verified(Boolean) | Email Verified |
| Expire time(Int) | Expiration timestamp |
| extra(JSON) | Extended Field |
| Full Avatar URL(String) | Complete Avatar URL |
| group(UserGroup) | User Group |
| group_id(Int) | User Group ID |
| id(Int) | ID |
| introduce(String) | Introduction |
| Invite Code(String) | Invitation Code |
| is_retailer(Int) | Is Distributor |
| Last login(Int) | Last Login Timestamp |
| link(String) | linkage |
| parent_id(Int) | Parent ID |
| phone(String) | Phone |
| Real Name(String) | True Name |
| status(Int) | Status |
| token(String) | Login Token |
| Total Reward(Int) | Total Reward Earnings |
| url_token(String) | URL identifier |
| user_name(String) | Username |
UserGroup
User Group
Field
| Name | Description |
|---|---|
| Description(String) | Description |
| Favorable Price(Int) | Discount Price |
| id(Int) | ID |
| level(Int) | Level |
| Price(Int) | price |
| Setting(UserGroupSetting) | Set |
| status(Int) | Status |
| Title(String) | User Group Name |
UserGroupSetting
User Group Settings
Field
| Name | Description |
|---|---|
| content_no_captcha(Boolean) | Content published does not require captcha |
| content_no_verify(Boolean) | Content publication does not require verification |
| Discount(Int) | Discount |
| Expire Day(Int) | Days to Expire |
| Parent reward(Int) | Parent reward (second-level distributor reward) |
| Share reward(Int) | Share reward (third-level distributor reward) |
WholesaleRule
Wholesale Rule
Field
| Name | Description |
|---|---|
| archive_id(Int) | Product ID |
| created_time(Int) | Creation Timestamp |
| discount_rate(Int) | Discount rate |
| id(Int) | ID |
| max_quantity(Int) | maximum quantity |
| min_quantity(Int) | minimum quantity |
| sku_id(Int) | SKU ID |
| updated_time(Int) | update timestamp |
