Referensi API

Kontak

Kontak pembeli yang digabung lintas toko, lengkap dengan statistik pesanan.

List contacts

GET/v1/contacts

Contacts with order stats, most recent first.

Scope:contacts:read

Query parameter

qstringopsional
panjang maks 100
labelstringopsional
panjang maks 40
limitintegeropsional
min 1 · maks 200
offsetintegeropsional
min 0

Response200 · application/json

itemsarray<ContactSummary>wajib
Tampilkan 6 atribut turunan
- idstringwajib
  format: uuid
- displayNamestringwajibnullable
- labelsarray<string>wajib
- channelsarray<string>wajib
- statsContactStatswajib
  Tampilkan 5 atribut turunan
  - ordersintegerwajib
    Non-cancelled orders.
  - totalSpendstring (decimal)wajib
    Decimal string with two fraction digits.
  - currencystringwajib
  - returnsintegerwajib
  - lastOrderAtstringwajibnullable
    format: date-time
- createdAtstringwajib
  format: date-time

Contoh request · curl

curl "https://api.comnethub.app/v1/contacts?limit=20" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

List contact labels

GET/v1/contacts/labels

Labels in use on contacts.

Scope:contacts:read

Response200 · application/json

itemsarray<string>wajib

Contoh request · curl

curl "https://api.comnethub.app/v1/contacts/labels" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

Get contact

GET/v1/contacts/{contactId}

Contact with identities, orders, and conversations.

Scope:contacts:read

Path parameter

contactIdstringwajib
format: uuid

Response200 · application/json

idstringwajib
format: uuid
displayNamestringwajibnullable
labelsarray<string>wajib
channelsarray<string>wajib
statsContactStatswajib
Tampilkan 5 atribut turunan
- ordersintegerwajib
  Non-cancelled orders.
- totalSpendstring (decimal)wajib
  Decimal string with two fraction digits.
- currencystringwajib
- returnsintegerwajib
- lastOrderAtstringwajibnullable
  format: date-time
createdAtstringwajib
format: date-time
notesstringwajibnullable
identitiesarray<ContactIdentity>wajib
Tampilkan 3 atribut turunan
- channelstringwajib
  tiktok, shopee; later whatsapp, instagram.
- externalIdstringwajib
- displayNamestringwajibnullable
ordersarray<ChatBuyerOrder>wajib
Latest 50.
Tampilkan 7 atribut turunan
- orderIdstringwajib
  format: uuid
- externalOrderIdstringwajib
- statusstringwajib
- marketplaceStatusstringwajibnullable
- totalstring (decimal)wajib
  Decimal string with two fraction digits.
- currencystringwajib
- placedAtstringwajib
  format: date-time
conversationsarray<ChatConversation>wajib
Tampilkan 22 atribut turunan
- contactIdstringwajibnullable
  format: uuid
- assignedUserIdstringwajibnullable
  format: uuid
- labelsarray<string>wajib
- waitingSincestringwajibnullable
  Oldest unanswered buyer message; null when the shop spoke last.
  format: date-time
- latebooleanwajib
  Waiting longer than the tenant's response target.
- idstringwajib
  format: uuid
- storeIdstringwajib
  format: uuid
- storeNamestringwajib
- marketplacestringwajib
  Salah satu dari:tiktokshopeelazadatokopedia
- externalConversationIdstringwajib
- buyerNamestringwajibnullable
- buyerAvatarstringwajibnullable
- canSendbooleanwajib
  False when the marketplace does not allow the shop to message this buyer.
- unreadCountintegerwajib
- lastMessageAtstringwajibnullable
  format: date-time
- lastMessagePreviewstringwajibnullable
- lastMessageRolestringwajibnullable
  Salah satu dari:buyershopagentsystemrobot
- statusstringwajib
  Salah satu dari:openresolved
- needsHumanbooleanwajib
- handoffReasonstringwajibnullable
- agentPausedbooleanwajib
- hasDraftbooleanwajib

Contoh request · curl

curl "https://api.comnethub.app/v1/contacts/$CONTACT_ID" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

Update contact

PATCH/v1/contacts/{contactId}

Rename, label, or annotate a contact.

Scope:contacts:write

Path parameter

contactIdstringwajib
format: uuid

Request bodyapplication/json

displayNamestringopsionalnullable
panjang maks 100
labelsarray<string>opsional
item maks 20
notesstringopsionalnullable
panjang maks 4000

Response200 · application/json

idstringwajib
format: uuid
displayNamestringwajibnullable
labelsarray<string>wajib
channelsarray<string>wajib
statsContactStatswajib
Tampilkan 5 atribut turunan
- ordersintegerwajib
  Non-cancelled orders.
- totalSpendstring (decimal)wajib
  Decimal string with two fraction digits.
- currencystringwajib
- returnsintegerwajib
- lastOrderAtstringwajibnullable
  format: date-time
createdAtstringwajib
format: date-time

Contoh request · curl

curl -X PATCH "https://api.comnethub.app/v1/contacts/$CONTACT_ID" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "displayName": "string",
  "labels": [
    "string"
  ],
  "notes": "string"
}'