Conas API Ceannaí Shoply a Úsáid

Ligeann API Ceannaí Shoply do cheannaí a gcuid sonraí Shoply féin a úsáid go slán in uirlisí tuairiscithe, sreafaí oibre tacaíochta, easpórtálacha sceidealaithe, agus feidhmchláir ghnó phríobháideacha.

Fíordheimhníonn gach comhtháthú le dintiúr inchúlghairthe, teoranta don siopa, a chruthaítear i Socruithe Shoply. Ní gá duit comhartha rochtana Shopify Admin API a roinnt, agus ní féidir le comhtháthú rochtain a fháil ach ar an siopa a d’eisigh a dhintiúr.

Cad Is Féidir Liom a Dhéanamh leis an Merchant API?

Is féidir leat an Merchant API a úsáid chun:

• Torthaí feidhmíochta laethúla, seachtainiúla nó míosúla a easpórtáil chuig scarbhileog nó stóras sonraí.
• Painéal príobháideach a thógáil do sheisiúin, comhráite, cuardaigh, cliceálacha táirge, imeachtaí cur leis an gcairt, ceannacháin, agus ioncam curtha i leith.
• Monatóireacht a dhéanamh ar ghníomhaíocht custaiméirí agus athruithe neamhghnácha ar rannpháirtíocht a aimsiú.
• Seisiúin chomhrá agus chuardaigh a athbhreithniú le haghaidh tacaíochta, marsantachta, agus obair ar cháilíocht freagraí.
• Amlíne chomhrá aonair a aisghabháil agus ceist chustaiméara á fiosrú.
• An t-eolas saincheaptha a úsáideann Shoply AI a chruthú, a nuashonrú, a liostú agus a scriosadh.
• Leathanach gréasáin seachtrach nó comhad PDF, téacs, nó Markdown uaslódáilte a chur leis an mbonn eolais.
• Sonraí imeachta UTC a ailíniú le crios ama áitiúil an tsiopa.

Déanann an treoir seo doiciméadú ar sheacht gcríochphointe. Is iad cúig cinn díobh na críochphointí céanna a úsáideann Shoply Admin → Analytics, agus bainistíonn dhá cheann an bonn eolais:

Is samplaí ionadaíocha iad na coirp fhreagartha thíos. Léireoidh do réimsí agus do luachanna an ghníomhaíocht a taifeadadh do do shiopa.

Ceanglas imlonnaithe: Ní mór fíordheimhniú rúin úinéara siopa a bheith imlonnaithe ar an bhfreastalaí API a nglaonn tú air. Má fhilleann rún bailí HTTP 403 le No access_token found, tá an freastalaí sin fós ag rith an tseanchóid fíordheimhnithe a ghlacann le comhartha rochtana amháin.

Conas a Chruthaím Rún API?

1. Oscail do phainéal riaracháin Shoply AI.
2. Téigh go Settings → Store owner API secret.
3. Cruthaigh rún agus tabhair ainm dó a shainaithníonn an comhtháthú, mar shampla Weekly reporting export.
4. Cóipeáil an rún nuair a thaispeántar é. Ní thaispeánann Shoply an luach gnáththéacs ach uair amháin.

Tá gach rún bailí ar feadh 90 lá. Is féidir rúin ar leith a bheith ag siopa do chomhtháthuithe ar leith, agus is féidir leat rún amháin a chúlghairm gan cur isteach ar na cinn eile.

Sábháil na luachanna seo mar athróga timpeallachta ar thaobh an fhreastalaí:

export SHOPLY_STORE_KEY="your-store.myshopify.com"
export SHOPLY_STORE_OWNER_API_SECRETE="shoply_owner_key_example123.secret-value"

Úsáid fearann buan myshopify.com an tsiopa le haghaidh SHOPLY_STORE_KEY, fiú má thugann siopadóirí cuairt ar fhearann saincheaptha de ghnáth.

Conas a Oibríonn Fíordheimhniú?

Seolann gach iarratas Merchant API ceanntásc Authorization a bhfuil teaghrán JSON mar luach aige:

{
  "store_key": "your-store.myshopify.com",
  "store_owner_api_secrete": "YOUR_STORE_OWNER_API_SECRET"
}

Is é store_owner_api_secrete an t-ainm réimse poiblí cruinn, lena n-áirítear a litriú stairiúil. Ní comhartha Bearer é seo. Cuir an teaghrán JSON iomlán go díreach sa cheanntásc Authorization.

Coinnigh an rún i gcód backend amháin. Ná cuir i URL, i mbundle brabhsálaí, i stór poiblí, in imeacht anailísíochta, nó i loga feidhmchláir é.

An Bhfuil Pacáistí Oifigiúla Python agus Node.js Ann?

Tá. Foilsíonn Shoply dhá phacáiste ar thaobh an fhreastalaí a chuireann an fíordheimhniú riachtanach leis go huathoibríoch agus a nochtann an Merchant API mar fheidhmeanna clóscríofa. Tá an dá phacáiste foinse oscailte faoin eagraíocht GitHub shoplyai-public.

Pacáiste Python

Tacaíonn an pacáiste shoply-merchant-api le Python 3.12 agus úsáideann sé samhlacha freagartha Pydantic v2. Suiteáil an leagan bioraithe 2.1.3:

python3.12 -m venv .venv
source .venv/bin/activate
python -m pip install "git+https://github.com/shoplyai-public/shoply-merchant-api.git@v2.1.3"

Aisghabh na seisiúin chomhrá agus chuardaigh is nua mar shamhlacha clóscríofa SessionSummary:

import os
 
from shoply_merchant_api import ShoplyMerchantClient
 
 
with ShoplyMerchantClient(
    store_key=os.environ["SHOPLY_STORE_KEY"],
    api_secret=os.environ["SHOPLY_STORE_OWNER_API_SECRETE"],
) as shoply:
    session_response = shoply.list_sessions(limit=40)
 
for conversation in session_response.data:
    print(conversation.customer_id, conversation.user_questions)

Soláthraíonn an pacáiste feidhmeanna freisin le haghaidh anailísíochta, comhaireamh gníomhaíochta, amlínte iomlána seisiúin, crios ama siopa, agus bainistíocht eolais. Féach ar a threoir cásanna úsáide gnó  agus tagairt API .

Pacáiste Node.js agus TypeScript

Soláthraíonn an stór shoply-merchant-api-js an pacáiste @shoplyai/merchant-api do Node.js 20 nó níos nuaí. Is pacáiste ESM é le dearbhuithe TypeScript ionsuite agus gan spleáchais ama rite. Suiteáil an leagan bioraithe 2.1.3 go díreach ó GitHub:

npm install "github:shoplyai-public/shoply-merchant-api-js#v2.1.3"

Aisghabh na seisiúin is nua céanna ó fhreastalaí Node.js:

import { ShoplyMerchantClient } from "@shoplyai/merchant-api";
 
const storeKey = process.env.SHOPLY_STORE_KEY;
const apiSecret = process.env.SHOPLY_STORE_OWNER_API_SECRETE;
if (!storeKey || !apiSecret) {
  throw new Error("SHOPLY_STORE_KEY and SHOPLY_STORE_OWNER_API_SECRETE are required");
}
 
const shoply = new ShoplyMerchantClient({
  storeKey,
  apiSecret,
});
 
const sessionResponse = await shoply.listSessions({ limit: 40 });
 
for (const conversation of sessionResponse.data) {
  console.log(conversation.customer_id, conversation.user_questions);
}

Clúdaíonn an pacáiste npm na críochphointí Merchant API céanna leis an bpacáiste Python. Féach ar a threoir cásanna úsáide gnó  agus tagairt API .

Tá an dá phacáiste le haghaidh seirbhísí backend iontaofa, jabanna sceidealaithe, agus uirlisí inmheánacha príobháideacha. Ná hiontráil ceachtar pacáiste i gcód siopa tosaigh ná ná nocht an rún API i bundle brabhsálaí.

An Féidir Liom Glaoch ar an HTTP API Gan Phacáiste?

Is féidir. Fanann an Merchant API ina ghnáth-API HTTPS. Úsáideann na samplaí Python íseal-leibhéil thíos Requests ionas gur féidir leat an conradh sreinge iomlán a fheiceáil nó comhtháthú ó theanga eile.

Suiteáil Requests mura bhfuil sé san áireamh i do thimpeallacht cheana féin:

python -m pip install requests

Cuireann an cúntóir thíos eochair an tsiopa agus an ceanntásc fíordheimhnithe le gach iarratas:

import json
import os
from typing import Any
 
import requests
 
BASE_URL = "https://api.shoplyai.ai"
STORE_KEY = os.environ["SHOPLY_STORE_KEY"]
STORE_OWNER_API_SECRETE = os.environ["SHOPLY_STORE_OWNER_API_SECRETE"]
 
session = requests.Session()
session.headers.update({
    "Authorization": json.dumps({
        "store_key": STORE_KEY,
        "store_owner_api_secrete": STORE_OWNER_API_SECRETE,
    })
})
 
 
def shoply_get(api_name: str, **params: Any) -> dict[str, Any]:
    """Call one store-scoped Shoply API and surface HTTP or API-level errors."""
    response = session.get(
        f"{BASE_URL}/{api_name}",
        params={"store_key": STORE_KEY, **params},
        timeout=30,
    )
    response.raise_for_status()
 
    payload = response.json()
    if payload.get("error") is not None or payload.get("statusCode") not in (None, 200):
        raise RuntimeError(payload.get("error", "Shoply API request failed"))
    return payload
 
 
def shoply_post(
    api_name: str,
    payload: dict[str, Any] | None = None,
    **params: Any,
) -> dict[str, Any]:
    """Write store-scoped data and surface HTTP or API-level errors."""
    response = session.post(
        f"{BASE_URL}/{api_name}",
        params={"store_key": STORE_KEY, **params},
        json=payload,
        timeout=60,
    )
    response.raise_for_status()
 
    result = response.json()
    if result.get("error") is not None or result.get("statusCode") not in (None, 200):
        raise RuntimeError(result.get("error", "Shoply API request failed"))
    return result

Úsáideann na samplaí thíos an cliant comhroinnte seo. Cuireann an dá chúntóir eochair an tsiopa fíordheimhnithe leis go huathoibríoch.

An Féidir Liom Eolas Shoply AI a Bhainistiú Tríd an API?

Is féidir. Úsáideann admin_store_knowledge GET chun eolas a aisghabháil agus POST chun é a chruthú, a nuashonrú, a scriosadh, nó a athchraobháil. Nuashonraíonn POST a úsáideann ID eolais atá ann cheana an iontráil sin; cruthaíonn úsáid ID nua ceann nua.

Sula ndéanann tú nuashonruithe a uathoibriú, pleanáil eolas úsáideach siopa leis na samplaí inár dtreoir oiliúna.

Is féidir le scríbhinní eolais freagraí a thaispeántar do shiopadóirí a athrú. Úsáid rún tiomnaithe don chóras a bhainistíonn eolas, bailíochtaigh an t-ábhar sula seoltar é, agus ná nocht an dintiúr seo a bhfuil cumas scríofa aige i JavaScript an tsiopa tosaigh.

Liostaigh an tEolas atá Ann Cheana

knowledge_payload = shoply_get(
    "admin_store_knowledge",
    knowledge_id_to_retrieve="_ALL_",
)
 
for knowledge_id, knowledge in knowledge_payload["data"].items():
    print(knowledge_id, knowledge.get("title"))

Sampla Freagartha

{
  "data": {
    "knowledge::shipping-policy": {
      "title": "Shipping policy",
      "text": "Orders leave our warehouse within two business days.",
      "epoch_edit": 1787211246
    }
  }
}

Cruthaigh nó Nuashonraigh Eolas Téacs Saincheaptha

Roghnaigh ID eolais cobhsaí, uathúil. Athúsáid an ID céanna nuair a nuashonraíonn tú an iontráil sin.

from time import time
 
knowledge_id = "knowledge::shipping-policy"
result = shoply_post(
    "admin_store_knowledge",
    {
        knowledge_id: {
            "title": "Shipping policy",
            "text": (
                "Orders leave our warehouse within two business days. "
                "Standard delivery normally takes three to five business days."
            ),
            "epoch_edit": int(time()),
        }
    },
)
 
print(result)

Sampla Freagartha

{
  "statusCode": 200
}

Ciallaíonn freagra rathúil gur sábháladh an t-eolas. Féadfaidh innéacsú cuardaigh cúpla nóiméad a ghlacadh, mar sin seans nach mbeidh freagra nua le feiceáil láithreach. Má thuairiscíonn an API gur sábháladh an t-ábhar ach go bhfuil moill ar an innéacsú, deimhnigh an iontráil stóráilte le GET sula ndéanann tú iarracht eile ar an scríobh.

Cuir Leathanach Gréasáin Seachtrach Leis

Úsáid ID a thosaíonn le external_url::. Cuir an URL iomlán http:// nó https:// i text.

from time import time
 
result = shoply_post(
    "admin_store_knowledge",
    {
        "external_url::returns-policy": {
            "title": "Returns and exchanges",
            "text": "https://www.example.com/policies/returns",
            "epoch_edit": int(time()),
        }
    },
)

Uaslódáil agus Cláraigh Comhad Eolais

Ní mór do chomhaid eolais a bheith i bhformáid PDF, TXT, nó Markdown agus a bheith níos lú ná 5 MB. Uaslódáil an comhad ar dtús, ansin sábháil an suíomh príobháideach S3 a thugtar ar ais mar iontráil eolais.

from pathlib import Path
from time import time
 
file_path = Path("shipping-policy.md")
with file_path.open("rb") as file_handle:
    upload_response = session.post(
        f"{BASE_URL}/user_generated_file",
        params={"store_key": STORE_KEY, "folder": "knowledge_file"},
        files={"file": (file_path.name, file_handle, "text/markdown")},
        timeout=60,
    )
 
upload_response.raise_for_status()
uploaded = upload_response.json()
if uploaded.get("statusCode") != 200:
    raise RuntimeError(uploaded.get("error", "Knowledge file upload failed"))
 
shoply_post(
    "admin_store_knowledge",
    {
        "knowledge_file::shipping-policy": {
            "title": "Shipping policy document",
            "text": uploaded["file_url"],
            "epoch_edit": int(time()),
        }
    },
)

Sampla Freagartha Uaslódála

{
  "message": "File uploaded successfully",
  "statusCode": 200,
  "file_url": "s3://shoplystores/your-store.myshopify.com/uploads/shipping-policy.md"
}

Caith le file_url mar shuíomh príobháideach teimhneach a thugann Shoply ar ais. Ná tóg ná ná hathraigh é tú féin.

Scrios Eolas

Tá an scriosadh buan. Aisghabh na hiontrálacha reatha ar dtús agus seol ach na IDanna beachta atá beartaithe agat a bhaint.

result = shoply_post(
    "admin_store_knowledge",
    {
        "knowledge_ids_to_delete": [
            "knowledge::shipping-policy",
            "external_url::returns-policy",
            "knowledge_file::shipping-policy",
        ]
    },
)

Iarr Athchraobháil Suímh Ghréasáin

Úsáid athchraobháil tar éis d’ábhar ar shuíomh gréasáin an cheannaí athrú. De ghnáth ní gá í tar éis gach nuashonrú téacs saincheaptha.

result = shoply_post(
    "admin_store_knowledge",
    re_crawl_ind="true",
)

Cásanna Úsáide Gnó

• Treoir maidir le loingseoireacht, tuairisceáin, barántas, méideanna, nó cúram táirge a shioncronú ó chóras ábhair inmheánach.
• Faisnéis feachtais shealadaigh nó saoire a fhoilsiú gan í a chóipeáil de láimh isteach i Shoply Admin.
• Leathanach gréasáin polasaí nó cáipéis cheadaithe a chur leis an mbonn eolais mar chuid de shreabhadh oibre imlonnaithe.
• Treoir atá as dáta a bhaint chomh luath agus a chríochnaíonn polasaí nó cur chun cinn.

Samplaí den Merchant API

1. Aisghabh Anailísíocht Feidhmíochta

Cumhachtaíonn admin_store_analytics an tábla Analytics → Summary. Tugann sé seisiúin, comhráite, cuardaigh, cliceálacha, imeachtaí cur leis an gcairt, ceannacháin, agus ioncam curtha i leith ar ais.

Críochphointe

GET https://api.shoplyai.ai/admin_store_analytics

Paraiméadair Iarratais

Úsáideann tuarascálacha míosúla stair mhíosúil stóráilte Shoply agus ní theastaíonn teorainneacha dáta uathu.

Sampla Python

daily_report = shoply_get(
    "admin_store_analytics",
    report_type="daily",
    start_date="20260801",
    end_date="20260820",
)
 
for row in daily_report["data"]:
    print(row["date"], row["sessions"], row["purchases"], row["revenue"])
 
print("Totals:", daily_report["totals"])
 
# Weekly rows use the Monday of each week as their date label.
weekly_report = shoply_get(
    "admin_store_analytics",
    report_type="weekly",
    start_date="20260701",
    end_date="20260820",
)
 
# Monthly requests do not need start_date or end_date.
monthly_report = shoply_get("admin_store_analytics", report_type="monthly")

Sampla Freagartha

{
  "data": [
    {
      "date": "20260820",
      "sessions": 42,
      "chats": 18,
      "searches": 24,
      "clicks": 11,
      "add_to_cart": 5,
      "purchases": 2,
      "revenue": "$168.00",
      "revenue_usd": "$168.00"
    }
  ],
  "totals": {
    "date": "totals",
    "sessions": 42,
    "chats": 18,
    "searches": 24,
    "clicks": 11,
    "add_to_cart": 5,
    "purchases": 2,
    "revenue": "$168.00",
    "revenue_usd": "$168.00"
  },
  "report_type": "daily"
}

D’fhéadfadh níos mó ná airgeadra amháin a bheith in ioncam. Caith le revenue mar théacs taispeána. Úsáid revenue_usd nuair is gá duit an luach USD normalaithe a thaispeánann Shoply.

Cásanna Úsáide Gnó

• Achoimre laethúil tionchair díolacháin a sheoladh chuig an gceannaí nó chuig an bhfoireann ríomhthráchtála.
• Cuardaigh, cliceálacha táirge, imeachtaí cur leis an gcairt, agus ceannacháin a chur i gcomparáid chun titim amach sa tollán a aimsiú.
• Painéal faisnéise gnó seachtainiúil nó míosúil a chothú gan leathanach Shoply Admin a scrapeáil.
• Ioncam curtha i leith a rianú le himeacht ama agus é a chur i gcomparáid le hathruithe marsantachta nó feachtais.

2. Aisghabh Crios Ama an tSiopa

Soláthraíonn admin_get_store_metadata an suaitheantas crios ama a thaispeántar in Analytics → Chat & Search History. Úsáideann an leathanach é chun gníomhaíocht UTC a aistriú go ham áitiúil an tsiopa.

Críochphointe

GET https://api.shoplyai.ai/admin_get_store_metadata

Paraiméadair Iarratais

Sampla Python

timezone_payload = shoply_get(
    "admin_get_store_metadata",
    metadata_key="time_zone",
)
 
timezone = timezone_payload["data"]
print(timezone["ianaTimezone"], timezone["timezoneOffsetMinutes"])

Sampla Freagartha

{
  "data": {
    "ianaTimezone": "America/Los_Angeles",
    "timezoneOffset": -7,
    "timezoneOffsetMinutes": -420
  },
  "statusCode": 200
}

Cásanna Úsáide Gnó

• Gníomhaíocht UTC a ghrúpáil sna laethanta féilire áitiúla céanna a fheiceann an ceannaí in Analytics.
• Easpórtálacha laethúla a sceidealú tar éis do lá áitiúil an tsiopa críochnú.
• Tuarascálacha a lipéadú le crios ama IANA gan débhrí cosúil le America/Los_Angeles.

Féadfaidh fritháirimh crios ama athrú de bharr rialacha coigilte solas lae. B’fhearr ianaTimezone a úsáid nuair a thacaíonn do chóras tuairiscithe leis seachas fritháireamh uimhriúil amháin a shábháil go buan.

3. Aisghabh Comhaireamh Gníomhaíochta

Tugann query_api_usage_count gníomhaíocht siopa ar ais grúpáilte de réir dáta UTC nó an nóiméid bhunaidh UTC. Is é freisin foinse na cairte gníomhaíochta in Analytics → Chat & Search History.

Críochphointe

GET https://api.shoplyai.ai/query_api_usage_count

Paraiméadair Iarratais

Sampla Python

activity = shoply_get(
    "query_api_usage_count",
    start_dt_utc="2026-08-01 00:00:00",
    end_dt_utc="2026-08-20 23:59:59",
    groupby="utc_date",
)
 
for row in activity["data"]:
    print(row)

Sampla Freagartha

{
  "data": [
    {
      "utc_date": "2026-08-20",
      "QA": 18,
      "CHAT": 18,
      "SEARCH": 20,
      "CACHED_SEARCH": 4,
      "PRODUCT_SEARCH": 22,
      "CLICK": 11,
      "ADD_TO_CART": 5,
      "CHECKOUT": 2
    }
  ]
}

Áirítear sna sraitheanna na cuntair ghníomhaíochta atá ar fáil don tréimhse sin, amhail ceisteanna comhrá, cuardaigh, cliceálacha, imeachtaí cur leis an gcairt, agus imeachtaí seiceáil amach. D’fhéadfadh cuntair gan aon ghníomhaíocht a bheith in easnamh seachas a bheith socraithe go nialas.

Cásanna Úsáide Gnó

• Cairt ghníomhaíochta uair an chloig nó laethúil a thógáil cosúil leis an gceann in Chat & Search History.
• Borrtha tráchta neamhghnácha nó titeann tobanna i rannpháirtíocht custaiméirí a bhrath.
• Toirt chuardaigh táirgí a chur i gcomparáid le cliceálacha, imeachtaí cur leis an gcairt, agus seiceáil amach.
• Meastachán a dhéanamh ar cathain ba chóir d’fhoirne tacaíochta agus marsantachta na tréimhsí is gnóthaí a athbhreithniú.

4. Aisghabh Achoimrí Seisiúin Chomhrá agus Chuardaigh

Tugann query_sessionized_chat taifead dlúth amháin ar ais do gach seisiún custaiméara. Cumhachtaíonn sé an liosta seisiún in Analytics → Chat & Search History freisin.

Críochphointe

GET https://api.shoplyai.ai/query_sessionized_chat

Paraiméadair Iarratais

Aisghabh na 40 Seisiún is Déanaí

summary_payload = shoply_get(
    "query_sessionized_chat",
    start_dt_utc="undefined",
    end_dt_utc="undefined",
    num_sessions=40,
    ScanIndexForward="false",
)
 
sessions = summary_payload["data"]
for conversation in sessions:
    print(conversation["customer_id"], conversation.get("user_questions", ""))

Aisghabh Seisiúin i Raon UTC

summary_payload = shoply_get(
    "query_sessionized_chat",
    start_dt_utc="2026-08-20 00:00:00",
    end_dt_utc="2026-08-20 23:59:59",
    ScanIndexForward="false",
)

Nuair atá an dá theorainn ama i láthair, tugann an API seisiúin sa raon iomlán ar ais; ní chuireann num_sessions teorainn leis an bhfiosrú teorannaithe sin.

Sampla Freagartha

{
  "data": [
    {
      "customer_id": "customer-or-session-id",
      "user_questions": "Do you have this in blue?\nWhen will it ship?",
      "start_timestamp_ms": 1787184000000,
      "end_timestamp_ms": 1787184065000,
      "session_types": "product information, click",
      "customer_email": null,
      "customer_info": {},
      "sentiment": "positive",
      "num_questions": 2,
      "num_searches": 1,
      "num_clicks": 1
    }
  ]
}

Athraíonn réimsí roghnacha de réir seisiúin. Coinnigh customer_id, start_timestamp_ms, agus end_timestamp_ms má tá sé beartaithe agat an amlínte iomlán a aisghabháil.

Cásanna Úsáide Gnó

• Sampla de chomhráite le déanaí a athbhreithniú le haghaidh cáilíocht freagraí agus oiliúint tacaíochta.
• Ceisteanna custaiméirí athfhillteacha a aimsiú ar cheart dóibh tionchar a imirt ar chóip táirgí nó ar Cheisteanna Coitianta.
• Seisiúin ard-rúin a aithint ina bhfuil cuardaigh, cliceálacha táirge, nó gníomhartha siopadóireachta eile.
• Sraith amháin in aghaidh an tseisiúin a easpórtáil le haghaidh anailíse treochta agus an t-ualach níos mó ar leibhéal imeachtaí a sheachaint.

5. Aisghabh Seisiún Iomlán Amháin

Cuir achoimre roghnaithe ar aghaidh chuig query_log_visualization chun a imeachtaí custaiméara, AI, cuardaigh, agus tráchtála a aisghabháil.

Críochphointe

GET https://api.shoplyai.ai/query_log_visualization

Paraiméadair Iarratais

Sampla Python

from datetime import datetime, timezone
 
 
def utc_from_milliseconds(timestamp_ms: int) -> str:
    """Format a Shoply millisecond timestamp for the history API."""
    value = datetime.fromtimestamp(timestamp_ms / 1000, tz=timezone.utc)
    return value.strftime("%Y-%m-%d %H:%M:%S")
 
 
selected = sessions[0]
timeline_payload = shoply_get(
    "query_log_visualization",
    date_time_utc_start=utc_from_milliseconds(selected["start_timestamp_ms"]),
    date_time_utc_end=utc_from_milliseconds(selected["end_timestamp_ms"]),
    session_id=selected["customer_id"],
    start_timestamp_ms=selected["start_timestamp_ms"],
)
 
for event in timeline_payload["data"]:
    print(event.get("server_timestamp_ms"), event.get("action_type"))

Sampla Freagartha

{
  "data": [
    {
      "action_type": "QA",
      "session_id": "customer-or-session-id",
      "utc_date_time": "2026-08-20 00:00:00",
      "start_timestamp_ms": 1787184000000,
      "server_timestamp_ms": 1787184000123,
      "Q": {
        "question": "Do you have this in blue?",
        "question_context": {}
      },
      "task_id": "task-id",
      "list_tokens": [
        {
          "data_type": "LLMOutput",
          "data": "Yes. These blue options are currently available."
        }
      ],
      "dict_search_results": {}
    }
  ]
}

D’fhéadfadh ceisteanna custaiméirí, freagraí AI, torthaí cuardaigh, cliceálacha táirge, imeachtaí cur leis an gcairt, imeachtaí seiceáil amach, agus rannpháirtíocht ghníomhaire daonna a bheith san amlínte. Úsáid server_timestamp_ms chun cineálacha measctha imeachtaí a ordú. D’fhéadfadh níos lú réimsí a bheith i dtaifid níos sine.

Cásanna Úsáide Gnó

• Iniúchadh cruinn a dhéanamh ar an méid a d’iarr custaiméir agus ar an méid a d’fhreagair Shoply le linn fiosrúcháin tacaíochta.
• Cáilíocht freagraí a athbhreithniú in éineacht leis na torthaí cuardaigh agus na táirgí a taispeánadh don siopadóir.
• An turas a atógáil ón gceist go dtí cliceáil, cur leis an gcairt, nó seiceáil amach.
• Seisiún amháin a thuairiscigh custaiméir a dhiagnóisiú gan cuardach a dhéanamh trí stair neamhghaolmhar.

An Féidir Liom Rún Amháin a Úsáid do Gach API?

Is féidir. Tá store_owner_api_secrete bailí teoranta do shiopa amháin agus oibríonn sé ar fud na gcríochphointí Merchant API thuas. I gcás cuntas SiteChat, fíordheimhníonn an rún céanna APIanna uaslódála catalóige freisin. Le haghaidh oibríochtaí níos sábháilte, úsáid rúin ainmnithe ar leith do chórais éagsúla — mar shampla, ceann do easpórtáil sonraí oíche agus ceann eile do phainéal inmheánach.

Má scoirtear comhtháthú amháin nó má chuirtear i mbaol é, cúlghairm a rún amháin i Socruithe Shoply. Leanfaidh na comhtháthuithe eile ag obair.

Cad Ba Chóir Dom a Bheith ar Eolas Faoi Dhul in Éag, Príobháideachas, agus Earráidí?

Freisin athbhreithnigh foinsí sonraí agus príobháideachas Shoply chun tuiscint a fháil ar an bhfaisnéis atá ar fáil do fhreagraí custaiméirí.

• Téann rúin API úinéara siopa in éag tar éis 90 lá. Cruthaigh ceann athsholáthair agus nuashonraigh an comhtháthú roimh a dháta éaga.
• Is é 90 lá tréimhse chaighdeánach choinneála staire comhrá agus cuardaigh Shoply freisin. Is beartais ar leith iad éag rúin agus coinneáil sonraí.
• D’fhéadfadh sonraí pearsanta a bheith i bhfreagraí staire, lena n-áirítear aitheantóirí custaiméirí, seoltaí ríomhphoist, suíomh garbh, ceisteanna, agus gníomhaíocht siopadóireachta. Stóráil agus próiseáil iad de réir do bheartais phríobháideachais agus an dlí is infheidhme.
• Ciallaíonn HTTP 403 go bhfuil an rún ar iarraidh, neamhbhailí, imithe in éag, cúlghairthe, nó gur le siopa eile é.
• De ghnáth ciallaíonn HTTP 422 go bhfuil paraiméadar iarratais riachtanach ar iarraidh nó go bhfuil an t-ainm mícheart air.
• Ciallaíonn HTTP 500 nó freagra le statusCode: 500 gur shroich an t-iarratas Shoply ach nárbh fhéidir é a chomhlánú. Déan iarracht arís ar theipeanna sealadacha le backoff agus déan teagmháil linn má leanann an earráid.
• Úsáid raonta teoranta UTC le haghaidh easpórtálacha agus jabanna athfhillteacha ionas go bhfanfaidh freagraí inbhainistithe.

An Cuid den Merchant API é Cuardach Táirgí?

Tá fíordheimhniú agus conradh iarratais difriúil ag API cuardaigh táirgí poiblí Shoply. Féach Conas Rochtain a Fháil ar Shoply AI Search Tríd an API más mian leat torthaí cuardaigh táirgí d’eispéireas os comhair siopadóirí seachas do shonraí príobháideacha ceannaí.

An Féidir le Ceannaithe SiteChat Catalóg Táirgí a Uaslódáil?

Is féidir. Is féidir le cuntais SiteChat táirgí struchtúrtha agus íomhánna táirgí a uaslódáil leis an rún API úinéara siopa céanna. Déantar doiciméadú ar na críochphointí catalóige sin ar leithligh in Conas Do Chatalóg a Uaslódáil do SiteChat. Leanann siopaí Shopify ag sioncronú táirgí trí Shopify agus ní úsáideann siad na bealaí uaslódála sin.

Le haghaidh cabhrach le comhtháthú, déan teagmháil le Shoply AI.