انتقل إلى المحتوى
SeekGist
اللغة: English
القائمة
كل مجموعات الواجهة

Team

Members, roles, invites.

8 نقاط وصول. أسماء نقاط الوصول وأوصافها مأخوذة من ملف OpenAPI، لذلك تظهر بالإنجليزية.

GET/v1/team/members

Team Members List

يحتاج إلى مفتاح أو جلسة في لوحة التحكم

الردود

PATCH/v1/team/members/{membership_id}

Team Members Update

يحتاج إلى مفتاح أو جلسة في لوحة التحكم

المعاملات

الاسمالموضعالنوعإلزاميالوصف
membership_idpathstringنعم

جسم الطلب application/json MemberUpdate

الاسمالنوعإلزاميالوصف
role"owner" | "admin" | "editor" | "viewer"نعم

الردود

DELETE/v1/team/members/{membership_id}

Team Members Remove

يحتاج إلى مفتاح أو جلسة في لوحة التحكم

المعاملات

الاسمالموضعالنوعإلزاميالوصف
membership_idpathstringنعم

الردود

GET/v1/team/invites

Team Invites List

يحتاج إلى مفتاح أو جلسة في لوحة التحكم

الردود

POST/v1/team/invites

Team Invites Create

يحتاج إلى مفتاح أو جلسة في لوحة التحكم

جسم الطلب application/json InviteCreate

الاسمالنوعإلزاميالوصف
emailstring (email)نعم
role"admin" | "editor" | "viewer"نعم

الردود

DELETE/v1/team/invites/{invite_id}

Team Invites Revoke

يحتاج إلى مفتاح أو جلسة في لوحة التحكم

المعاملات

الاسمالموضعالنوعإلزاميالوصف
invite_idpathstringنعم

الردود

POST/v1/team/invites/lookup

Invite page: the store and role of a valid invite token (no sign-in)

لا يحتاج إلى مفتاح

جسم الطلب application/json TokenRequest

الاسمالنوعإلزاميالوصف
tokenstringنعمmin length 20 · max length 200

الردود

POST/v1/team/invites/accept

Team Invites Accept

يحتاج إلى مفتاح أو جلسة في لوحة التحكم

جسم الطلب application/json TokenRequest

الاسمالنوعإلزاميالوصف
tokenstringنعمmin length 20 · max length 200

الردود

أشكال البيانات في هذه الصفحة

MemberOut

الاسمالنوعإلزاميالوصف
idstringنعم
user_idstringنعم
emailstringنعم
namestring | nullنعم
role"owner" | "admin" | "editor" | "viewer"نعم
created_atstring (date-time)نعم

MemberUpdate

الاسمالنوعإلزاميالوصف
role"owner" | "admin" | "editor" | "viewer"نعم

Deleted

الاسمالنوعإلزاميالوصف
deletedbooleanلاdefault true
idstringنعم

InviteOut

الاسمالنوعإلزاميالوصف
idstringنعم
emailstringنعم
role"owner" | "admin" | "editor" | "viewer"نعم
expires_atstring (date-time)نعم
created_atstring (date-time)نعم

InviteCreate

الاسمالنوعإلزاميالوصف
emailstring (email)نعم
role"admin" | "editor" | "viewer"نعم

TokenRequest

الاسمالنوعإلزاميالوصف
tokenstringنعمmin length 20 · max length 200

InviteLookup

What the invite page shows before sign-in (m17). Only for a valid, unused invite token.

الاسمالنوعإلزاميالوصف
store_namestringنعم
inviter_display_namestring | nullلاThe inviter's name; never their email. None when they set no name.
role"admin" | "editor" | "viewer"نعم
expires_atstring (date-time)نعم
email_maskedstringنعمThe invited address, masked: "s***@example.com".

TenantOut

الاسمالنوعإلزاميالوصف
idstringنعم
slugstringنعم
namestringنعم
status"pending_payment" | "trialing" | "active" | "past_due" | "suspended" | "canceled" | "deleted"نعمpending_payment = a store without a plan: before its free trial or first payment, or after its free trial ended unpaid (see billing_state)
plan_codestring | nullنعمThe store's plan. null = no plan yet (billing_state trial_available, no_trial or trial_ended).
billing_state"trial_available" | "no_trial" | "trialing" | "trial_ended" | "paid" | "exempt"لاtrial_available: no plan; the 14-day free trial (no card) starts with the first search made with a public key. no_trial: no plan, and the owner already used the free trial on a store: choose a plan to go live. trialing: the free trial runs until trial_ends_at. trial_ended: the free trial ended unpaid; public keys answer 402 until a plan is chosen. paid: the store has a paid plan (see status). exempt: an internal store that billing never stops.default "paid"
default_localestringنعم
localesstring[]نعم
currencystringنعم
vertical"general" | "electronics" | "fashion" | "beauty" | "grocery" | "home" | "toys" | "health" | "sports" | "books"لاStore type: picks the word lists search uses. `general` = many kinds of products: the shared words of every store type, without words two types read differently. Set it with PATCH /v1/settings {"vertical": ...}.default "general"
vertical_source"default" | "auto" | "owner"لاWhere `vertical` came from: default (not set), auto (SeekGist guessed it from the catalog; checked again on full syncs), owner (chosen in settings; never changed by the guess).default "default"
auto_detailVerticalGuess | nullلاThe last catalog check, when source is auto.
trial_ends_atstring (date-time) | nullلا
syncSyncHealthلا
created_atstring (date-time)نعم

VerticalGuess

The catalog check behind an automatic store type (`vertical_source: auto`).

الاسمالنوعإلزاميالوصف
vertical"general" | "electronics" | "fashion" | "beauty" | "grocery" | "home" | "toys" | "health" | "sports" | "books"نعمWhat the check decided: a store type, or general (no clear winner).
leading"general" | "electronics" | "fashion" | "beauty" | "grocery" | "home" | "toys" | "health" | "sports" | "books" | nullلاThe most common store type among the products.
sharenumberنعمShare (0..1) of the checked products with a type that have the leading type.
products_checkedintegerنعم
products_decidedintegerنعمChecked products whose category or name points to one store type.
checked_atstring (date-time) | nullلا

SyncHealth

The store's automatic product sync: when the last one came, and whether it has stopped.

الاسمالنوعإلزاميالوصف
last_sync_atstring (date-time) | nullلاThe last automatic product sync: POST /v1/products/batch with a secret key (store modules, SDKs, your own server), a store app webhook or a connector pull sync. Dashboard file imports do not count.
last_full_sync_atstring (date-time) | nullلاThe last full sync (POST /v1/products/batch with sync_complete: true).
stalebooleanلاtrue: the store has done a full sync, but no automatic sync came for more than 26 hours (its daily job has probably stopped). Never true for a store without a full sync.default false