Conas Do Chatalóg a Uaslódáil le haghaidh SiteChat

A secure merchant key unlocks catalog upload APIs that send products and images into SiteChat search and chat

Má úsáideann tú SiteChat ar do shuíomh gréasáin féin (ní siopa Shopify é), is féidir leat taifid struchtúrtha táirgí a sheoladh chuig Shoply ionas gur féidir le siopadóirí iad a aimsiú i gcomhrá SiteChat agus i gcuardach táirgí.

Úsáideann na pointí deiridh seo an Settings → Store owner API secret céanna leis an gcuid eile den Shoply Merchant API, agus is féidir leis an leathanach Product Catalog i riarachán SiteChat iad a ghlaoch le do thócan rochtana riaracháin agus tú sínithe isteach. Leanann siopaí Shopify ar aghaidh ag sioncronú sonraí catalóige trí Shopify; níl na bealaí uaslódála seo ar fáil ach do chuntais SiteChat nach bhfuil catalóg Magento á sioncronú acu cheana féin.

I riarachán SiteChat, osclaíonn Product Catalog limistéar i stíl Shopify le Products, Collections, agus Inventory. Is féidir leat táirgí a chur leis nó a chur in eagar, CSV/Excel a iompórtáil, táirgí a ghrúpáil i mbailiúcháin láimhe, agus cainníochtaí stoic a choigeartú.

Cad iad na hAPIanna atá ar fáil?

APIModhA bhfeidhm
/merchant/products/batchPOSTCruthaigh nó cuir suas le 50 táirge in ionad go hiomlán in aon iarratas amháin
/merchant/productsPOSTCruthaigh táirge amháin nó cuir in ionad go hiomlán é
/merchant/productsGETLéigh siar táirge iompórtáilte amháin de réir source agus external_id
/merchant/productsPATCHNuashonraigh táirge amháin go páirteach (léamh-cumasc-scríobh)
/merchant/productsDELETECuir táirge i gcartlann bhog (status=archived)
/merchant/products/listGETTéigh trí tháirgí iompórtáilte de réir leathanaigh le haghaidh táblaí riaracháin
/merchant/products/imagesPOSTUaslódáil íomhá táirge agus faigh URL poiblí HTTPS
/merchant/collectionsGET / POSTLiostaigh nó cruthaigh bailiúcháin láimhe
/merchant/collections/{id}GET / PUT / DELETELéigh, cuir ceann amháin in ionad, nó cuir i gcartlann é
/merchant/inventoryGETLiostaigh sraitheanna stoic (cainníochtaí táirge agus athraitheacha)
/merchant/inventory/adjustPOSTSocraigh an chainníocht rianaithe do tháirge nó d’athraitheach

Iarrann sábhálacha táirge rathúla ar Shoply innéacs an tsiopa a atógáil. Go dtí go gcríochnaíonn an atógáil sin, tuairiscíonn freagraí index_status: "pending". Ansin taispeántar táirgí foilsithe san innéacs táirgí agus san eolas a úsáideann comhrá SiteChat araon.

Cé atá in ann na hAPIanna seo a úsáid?

  • Caithfidh do shiopa a bheith ina chuntas SiteChat (app_platform is SiteChat).
  • Diúltaítear eochracha siopa Shopify (lena n-áirítear aon fhearann *.myshopify.com).
  • Caithfidh fíordheimhniú rún bailí API úinéara siopa a úsáid nó tócan rochtana riaracháin SiteChat don store_key cruinn san iarratas.
  • Ní féidir le tócain Shopify Admin API na bealaí seo a ghlaoch.

Cruthaigh nó rothlaigh rún an úinéara ar an mbealach céanna le comhtháthuithe eile Merchant API: How to Use the Shoply Merchant API. I gconsól riaracháin SiteChat, oscail Product Catalog chun táirgí, bailiúcháin, agus fardal a bhainistiú—nó comhad CSV nó Excel a iompórtáil—gan an rún a bhainistiú tú féin.

Conas a Oibríonn Fíordheimhniú?

Ó chónascaire freastalaí

Glaoigh ar an API ó chúlra iontaofa thar HTTPS. Cuir teaghrán JSON sa cheanntásc Authorization:

json
{ "store_key": "YOUR_SITECHAT_STORE_KEY", "store_owner_api_secrete": "YOUR_STORE_OWNER_API_SECRET" }

Is é store_owner_api_secrete ainm poiblí na páirce, lena n-áirítear an litriú stairiúil. Glactar le store_owner_api_secret freisin. Ní tócan Bearer é seo.

Ó riarachán SiteChat

Seolann an leathanach Product Catalog do sheisiún riaracháin sínithe isteach ina ionad:

json
{ "store_key": "YOUR_SITECHAT_STORE_KEY", "admin_auth_token": "YOUR_SITECHAT_ACCESS_TOKEN" }

Glactar le access_token mar ailias do admin_auth_token.

Caithfidh paraiméadar fiosrúcháin store_key teacht leis an gceanntásc. Coinnigh rúin úinéara in athróga timpeallachta taobh an fhreastalaí amháin—ná cuir riamh iad i script aghaidh stórais, i URL, ná i stór poiblí.

bash
export SHOPLY_STORE_KEY="your-sitechat-store-key" export SHOPLY_STORE_OWNER_API_SECRETE="shoply_owner_key_example123.secret-value"

Conas a Uaslódálaim Táirgí?

POST https://api.shoplyai.ai/merchant/products/batch?store_key=YOUR_SITECHAT_STORE_KEY

json
{ "source": "woocommerce-main", "products": [ { "external_id": "123", "title": "Trail shoes", "description": "Water-resistant hiking shoes.", "url": "https://example.com/products/trail-shoes", "currency": "USD", "price": "49.95", "original_price": "59.95", "available": true, "status": "published", "images": ["https://example.com/images/trail-shoes.jpg"], "categories": ["Footwear"], "metafields": {"material": "Leather"}, "variants": [ { "external_id": "124", "title": "Brown / 42", "sku": "TRAIL-BR-42", "price": "49.95", "available": true, "metafields": {"color": "Brown", "size": "42"} } ] } ] }

Réimsí agus rialacha riachtanacha

  • Réimsí táirge riachtanacha: external_id, title, url, currency, price, agus available. Réamhshocraítear status mar published.
  • Fardal roghnach: socraigh tracks_inventory mar true agus quantity neamh-dhiúltach ar an táirge nó ar an athraitheach. Ansin díorthaíonn Shoply infhaighteacht ón stoc (quantity > 0) agus stórálann sé total_inventory do liostaí riaracháin.
  • Ainmníonn source an nasc catalóige (ní gá gur ardán é). Úsáid ainm cobhsaí mar woocommerce-main. Carachtair cheadaithe: litreacha beaga, uimhreacha, folínte, agus fleiscíní; suas le 64 carachtar. Réamhshocraítear source mar admin do tháirgí a chruthaítear le foirm sa riarachán.
  • Is é aitheantas táirge an teaglaim de shiopa, source, agus external ID. Is hathsholáthairtí iomlána iad batch agus POST singil, ní paistí: glantar réimsí roghnacha a fhágtar ar lár. Úsáid PATCH le haghaidh nuashonruithe páirteacha.
  • Bíonn idir 1 agus 50 táirge i mbaisceanna agus uasmhéid 2,000,000 beart iarratais. Tá JSON bailíochtaithe gach táirge teoranta do 128,000 beart, agus uasmhéid 250 athraitheach ann.
  • Is fearr teaghráin deachúlacha a úsáid do phraghsanna. Cód trí litir i gceannlitreacha é airgeadra.
  • Caithfidh URLanna táirgí agus íomhánna a bheith ina HTTP(S). Ní fhaigheann an t-iompórtáil na URLanna sin duit.
  • Úsáid metafields poiblí le haghaidh sonraíochtaí táirgí inchuardaithe (analóg SiteChat de metafields táirge Shopify). Caithfidh luachanna a bheith ina ngnáth-theaghráin. Glactar leis an seanréimse attributes mar ailias freisin. Ní thacaítear a thuilleadh le metadata príobháideach táirge.
  • Fágtar táirgí draft agus archived as an gcéad innéacs foilsithe eile. Fanann táirgí foilsithe atá díolta amach innéacsaithe agus faisnéis infhaighteachta ceangailte leo.
  • Stórálann bailiúcháin láimhe teideal, cur síos, stádas, agus liosta de bhallraíochtaí táirgí (source + external_id). Ní thacaítear le bailiúcháin chliste/bhunaithe ar rialacha sa leagan seo.

Sampla freagartha ratha

json
{ "results": [ { "external_id": "123", "product_id": "sitechat_product::woocommerce-main::<sha256-of-external-id>", "status": "stored" } ], "index_status": "pending", "index_revision": 1 }

Bailíochtaíonn Shoply an t-iarratas iomlán sula scríobhann sé. Féadfaidh HTTP 200 roinnt torthaí failed a liostú fós le error: "storage_error". Scrúdaigh gach toradh agus bain triail eile as na táirgí ar theip orthu. Más é request_failed an index_status, d’éirigh leis an stóráil ach níor sceidealaíodh an hinnéacsú—bain triail eile as na táirgí stóráilte sin freisin.

Sampla Python

python
import json import os import requests store_key = os.environ["SHOPLY_STORE_KEY"] headers = { "Authorization": json.dumps({ "store_key": store_key, "store_owner_api_secrete": os.environ["SHOPLY_STORE_OWNER_API_SECRETE"], }) } response = requests.post( "https://api.shoplyai.ai/merchant/products/batch", params={"store_key": store_key}, headers=headers, json={ "source": "custom", "products": [{ "external_id": "123", "title": "Trail shoes", "url": "https://example.com/products/trail-shoes", "currency": "USD", "price": "49.95", "available": True, }], }, timeout=60, ) response.raise_for_status() result = response.json() failed = [item["external_id"] for item in result["results"] if item["status"] != "stored"] if failed: raise RuntimeError(f"Products need retry: {failed}") if result["index_status"] == "request_failed": raise RuntimeError("Products saved, but retry the batch to request indexing")

Conas a Dhearbhaím Táirge Iompórtáilte?

GET https://api.shoplyai.ai/merchant/products?store_key=YOUR_SITECHAT_STORE_KEY&source=woocommerce-main&external_id=123

Úsáid an ceanntásc Authorization céanna. Áirítear sa fhreagra schema_version, updated_at, index_status, agus an product normalaithe. Filleann taifid atá ar iarraidh HTTP 404.

Tar éis don innéacsóir cúlra atógáil a fhoilsiú, éiríonn stádas léimh siar in aghaidh an táirge mar indexed, excluded (do tháirgí dréachta nó cartlannaithe), nó limit_exceeded. Úsáid GET /merchant/products/list le haghaidh liostú riaracháin. Cuir i gcartlann bhog le DELETE /merchant/products (nó socraigh status mar archived / draft) chun táirge a choinneáil amach as an gcéad innéacs foilsithe eile; níl scriosadh crua sa leagan seo.

python
record = requests.get( "https://api.shoplyai.ai/merchant/products", params={ "store_key": store_key, "source": "woocommerce-main", "external_id": "123", }, headers=headers, timeout=30, ) record.raise_for_status() print(record.json()["index_status"], record.json()["product"]["title"])

An Féidir Liom Íomhánna Táirge a Uaslódáil?

Is féidir. Má tá íomhá ar fáil cheana féin ag URL buan poiblí HTTPS, cuir an URL sin i liosta images an táirge nó i réimse image athraithigh. Oibríonn URLanna poiblí HTTPS S3. Ní oibríonn cosáin amh s3:// ná URLanna sínithe gearrthréimhseacha.

Chun go n-óstálfaidh Shoply an comhad, uaslódáil bearta amh na híomhá ó do chúlra:

text
POST https://api.shoplyai.ai/merchant/products/images?store_key=YOUR_SITECHAT_STORE_KEY Content-Type: image/png

Seol bearta amh an chomhaid, ní JSON, base64, ná sonraí foirme multipart. Glactar le JPEG, PNG, agus WebP, suas le 10 MiB agus 20 milliún picteilín. Ní thacaítear le híomhánna beoite. Tiontaíonn Shoply an íomhá go WebP agus baintear meiteashonraí leabaithe.

python
with open("trail-shoes.png", "rb") as image_file: response = requests.post( "https://api.shoplyai.ai/merchant/products/images", params={"store_key": store_key}, headers={**headers, "Content-Type": "image/png"}, data=image_file, timeout=60, ) response.raise_for_status() image_url = response.json()["url"]

Filleann HTTP 201 url, content_type, size_bytes, width, agus height. Ní cheanglaíonn uaslódáil íomhá amháin í le táirge ná ní iarrann sí innéacsú. Cuir an URL a fuarthas isteach i dtáirge iomlán agus cuir isteach arís é trí /merchant/products/batch.

Má uaslódáiltear an íomhá chéanna arís don chuntas céanna, athúsáidtear a URL. Faigheann íomhá athraithe URL nua. Níl pointe deiridh scriosta íomhá sa leagan seo.

Cathain a Thaispeántar Táirgí i gComhrá agus sa Chuardach?

Tar éis sábháil bhaisce rathúil, iarrann Shoply atógáil innéacs cúlra. Tuairiscíonn freagraí index_status: "pending" go dtí go bhfoilseoidh an t-oibrí an t-innéacs nua. Níl aon ráthaíocht ama chríochnaithe sheasta ann.

  • Téann táirgí foilsithe isteach sa chuardach táirgí agus san eolas a úsáideann comhrá SiteChat araon.
  • Fágtar táirgí dréachta agus cartlannaithe ar lár ag an gcéad atógáil eile.
  • Murar sceidealaíodh an hinnéacsú (index_status: "request_failed"), bain triail eile as an mbaisc do na táirgí a stóráladh go rathúil cheana féin.

Cad iad na hEarráidí ar Chóir Dom a Bheith Ag Súil Leo?

Stádas HTTPBrí
403Rún ar iarraidh, neamhbhailí, imithe in éag, nó cúlghairthe; siopa mícheart; nó cuntas neamh-SiteChat
404Níl an táirge iompórtáilte iarrtha ann
413Sáraíonn an t-iarratas nó an íomhá an teorainn méide
415D’úsáid uaslódáil íomhá Content-Type gan tacaíocht
422Réimsí neamhbhailí, aitheantais dhúblacha, íomhánna beoite nó ró-mhóra, nó sáruithe ar theorainneacha an mhúnla
503Teip shealadach stórála

Imíonn rúin in éag tar éis 90 lá. Cruthaigh ceann ionaid in Settings → Store owner API secret sula rachaidh sé in éag, agus cúlghair aon rún nach bhfuil de dhíth ort a thuilleadh. Is féidir leis an rún céanna pointí deiridh anailíse, comhráite, agus eolais atá doiciméadaithe sa Merchant API guide a ghlaoch freisin.

Chun cabhair a fháil le comhtháthú, déan teagmháil le Shoply AI.