Üksikasjalikele andmetele juurdepääs Shopify adminis JSON-i abil

JSON (lühend sõnast JavaScript Object Notation) on andmete salvestamise ja edastamise vorming, mida kasutatakse sageli andmete saatmisel serveritest veebilehtedele. Enamikul Shopify admini ressursilehtedel, näiteks lehtedel Tellimused, Tooted või Kliendid, pääsed JSON-i abil juurde üksikasjalikumatele andmetele.

Kuigi sa ei pea JSON-i abil tegema keerulisi arendustoiminguid, aitab Shopify adminis konkreetse ressursi JSON-failile juurdepääs koguda üksikasjalikumat teavet, lahendada probleeme ja teha tõrkeotsingut ise. Näiteks saad uurida toote JSON-faili, et leida selle variandi ID, mis võib olla vajalik teatud andmete migreerimise toimingute või teema koodi kohandamise jaoks. Teine näide on see, et saad vaadata tellimuse JSON-failist andmemuutujat, mida soovid kasutada automatiseeritud töövoo koostamisel rakenduses Shopify Flow.

JSON-it kasutavad enamasti arendajad, kuid isegi piiratud programmeerimisoskusega kasutajad saavad kasu sellest, kui õpivad leidma ja tõlgendama mõningast levinud JSON-teavet oma Shopify adminis.

JSON-faili ümbervormindamine

Toored JSON-andmed kuvatakse pika pesastatud muutujate ja sulgude jadana, mida on inimesel raske lugeda.

JSON-vormingu loetavamaks muutmiseks kaalu mõnda järgmistest võimalustest:

  • Installi oma brauserisse JSON-i vaatamise laiendus.
  • Kasuta ilusa printimise (pretty-print) võimekust, mis on enamikus tänapäevastes veebibrauserites vaikimisi saadaval:

Ekraanipilt toote JSON-failist, kus on kuvatud toote näidisteave. Seade „pretty-print“ märkeruut on aktiivne, mis on esile tõstetud lehe vasakus ülanurgas.

Juurdepääs JSON-failidele Shopify adminis

Shopify admin on keskne koht sinu ettevõtte kõigi aspektide haldamiseks ning on loodud kuvama vaikimisi ainult kõige kasulikumat ja asjakohasemat teavet. Lisateave, mida kogutakse alati, kui sinu adminis toiminguid tehakse, salvestatakse erinevate ressursilehtede failidesse .json. Neid lisaüksikasju sulle vaikimisi ei kuvata, sest selline teabe hulk oleks liiga suur, mittevajalik ja teeks admini kasutamise keeruliseks.

Enamiku äritoimingute jaoks saad oma poe teabele juurdepääsuks ja selle tõlgendamiseks kasutada Shopify olemasolevaid tööriistu. Siiski võib aeg-ajalt olla kasulik uurida konkreetset teavet teatud ressursside, näiteks toodete või tellimuste kohta, kui teed tõrkeotsingut selle kohta, miks või millal midagi juhtus.

Näide: juurdepääs tellimuse JSON-failile

Selles näites avad oma Shopify adminis tellimuse JSON-faili.

Sammud:

  1. Ava oma Shopify adminis Tellimused.

  2. Klõpsa loendis Tellimused mis tahes tellimust.

  3. Lisa brauseri aadressiribal URL-i lõppu .json. See sarnaneb järgmise näitega:

https://admin.shopify.com/store/{example-shop-name}/orders/12345678901234.json
  1. Vajuta sisestusklahvi Enter, et laadida leht uuesti JSON-vormingus.
  2. Valikuline: kui sinu brauserisse ei ole installitud JSON-i vaatamise laiendust, siis aktiveeri brauseris seade Pretty-print, et muuta JSON-fail kasutajasõbralikumaks. Lisateave JSON-faili ümbervormindamise kohta.

Märkad, et kuvatakse palju oodatud teavet tellimuse kohta, näiteks tellimusega seotud "currency" ja "line_items", kuid kaasatud on ka palju muud üksikasjalikku teavet, näiteks kliendi brauseri seansi "client_details" ajast, mil ta tellimuse esitas. Selline teave on kasulik üldiseks seansi jälgimiseks ja turundusplatvormi analüütika jaoks, kuid see ei ole vajalik tellimuse töötlemiseks ja täitmiseks.

Kindlate väljade kuvamine JSON-failis

Saad sundida JSON-faile kuvama ainult kindlaid välju, mis muudab teabe tõlgendamise lihtsamaks, kui tead konkreetseid atribuute, mida soovid kaasata. Lisa mis tahes JSON-faili URL-i lõppu brauseri aadressiribal ?fields= ning seejärel lisa komadega eraldatult soovitud atribuutide nimed, mida soovid kuvada, mis tahes järjekorras.

Näiteks tellimuse ID, klienditeabe, koguhinna ja siltide kuvamiseks lisa JSON-faili URL-i lõppu ?fields=id,customer,total_price,tags, nagu järgmises näites:

https://admin.shopify.com/store/{example-shop-name}/orders/12345678901234.json?fields=id,customer,total_price,tags

Muude JSON-ressursside kasutamine

Saad kasutada järgmisi JSON-ressursse, et kuvada Shopify adminis kindlat teavet:

  • Toodete arv: lisa loendi Tooted URL-i lõppu /count.json, et kuvada toodete koguarv. Täielik URL peaks olema järgmine:
https://admin.shopify.com/store/{example-shop-name}/products/count.json
  • Tehingud: lisa tellimuse lehe URL-i lõppu /transactions.json, et kuvada ainult tellimuse tehingu teavet. Lisateave ressursi Tehingud kohta.
  • Tellimuse täitmised: lisa tellimuse lehe URL-i lõppu /fulfillments.json, et kuvada ainult tellimuse täitmise teavet. Lisateave ressursi Tellimuse täitmine kohta.
  • Hüljatud ostukorvid: lisa poolelijäänud kassatehingu URL-i lõppu .json, et kuvada üksikasjalikku teavet poolelijäänud kassatehingu kohta. Lisateave ressursi Poolelijäänud kassatehing kohta.

Levinud JSON-atribuudid tõrkeotsingul

Järgmises tabelis on loetletud JSON-atribuudid, mida võid soovida vaadata eri ressursitüüpide tõrkeotsingu jaoks. Näiteks kui soovid kinnitada, millal konkreetne toode avaldati, saad uurida toote JSON-failist atribuuti published_at, mis kuvab kuupäeva ja kellaaja ISO 8601 vormingus.

Selles tabelis ei ole kõiki Shopify adminis salvestatud võimalikke JSON-ressursse ega -atribuute, seega vaata Shopify arendaja dokumentatsioonist, et leida mis tahes siin mainimata ressursi või atribuudi definitsioon.

Loetleb mõned admini ressursside näited ja nendega seotud levinumad atribuudid, sealhulgas selgitused, milleks neid saab tõrkeotsingul kasutada.
RessurssJSON-i atribuutSelgitus
Toode
"product": {
  "created_at"
Kellaaeg ja kuupäev, millal toode algselt loodi.
"product": {
  "published_at"
Kellaaeg ja kuupäev, millal toote olekuks määrati Aktiivne.
"product": {
  "updated_at"
Viimane kellaaeg ja kuupäev, millal toodet uuendati. See võib hõlmata muudatusi tootekirjelduses, pealkirjas või SEO andmetes, aga ka automaatseid uuendusi, näiteks laoseisu muutumist toote ostmisel.
Variant
"product": {
  "variants": [
    {
    "created_at"
Kellaaeg ja kuupäev, millal variant algselt loodi. See võib erineda kellaajast ja kuupäevast, millal põhitoode loodi.
"product": {
  "variants": [
    {
    "updated_at"
Viimane kellaaeg ja kuupäev, millal varianti uuendati. See võib erineda põhitoote viimase uuendamise kellaajast ja kuupäevast.
"product": {
  "variants": [
    {
    "inventory_quantity"
Praegune andmebaasi väärtus ja see, mis on klientidele ostmiseks saadaval. See väärtus võib olla negatiivne, kui variandi laoseisu ei jälgita või kui on lubatud ülemüük.
"product": {
  "variants": [
    {
    "old_inventory_quantity"
Andmebaasi väärtus enne variandi viimast updated_at kuupäeva.
Tellimus
"order": {
   "line_items": [
    {
    "requires_shipping"
Kuvatakse kui true või false. See näitab toote või variandi tarneseadeid tellimuse esitamise hetkel.
"order": {
   "line_items": [
    {
    "taxable"
Kuvatakse kui true või false. See näitab, kas toode või variant oli tellimuse esitamise hetkel maksustatav.
"order": {
   "line_items": [
    {
    "variant_inventory_management"
Kuvatakse vastavalt shopify, amazon_marketplace_web, null või kolmanda osapoole väärtusena olenevalt sellest, milline tellimuste täitmise teenus on määratud toote laoseisu jälgima. Väärtus null tähendab, et toodet tellimuse esitamise hetkel ei jälgitud.
"order": {
   "line_items": [
    {
    "fulfillable_quantity"
Kuvab, kui suure osa laoseisust on süsteem tellimuse täitmiseks reserveerinud. See ei võrdu variandi praeguse laoseisuga.
"order": {
   "line_items": [
    {
    "quantity"
Ostetud toodete või variantide arv.
"order": {
   "line_items": [
    {
    "tax_lines"
Ameerika Ühendriikide puhul kuvatakse siin osariigi, maakonna ja omavalitsuse väärtused. Kui maksuridu ei kuvata, kuid tellimusele lisandus maks, tähendab see, et maks arvestati tarnekulult.
Klient
"customer": {
  "created_at"
Kellaaeg ja kuupäev, millal klient algselt loodi.
"customer": {
  "updated_at"
Viimane kellaaeg ja kuupäev, millal kliendiprofiili uuendati.

Metaväljad JSON-is

Metaväljad on paindlik viis lisada Shopify ressursile (näiteks toodetele või kollektsioonidele) täiendavat kohandatud teavet. Metaväljade abil talletatavate andmete hulka kuuluvad näiteks tootespetsifikatsioonid, suuruste tabelid, allalaaditavad dokumendid, väljalaskekuupäevad, pildid ja detailinumbrid. Lisateave metaväljade kasutamise kohta.

Toetatud ressursilehe URL-i lõppu saab lisada /metafields.json, et kuvada selle ressursiga seotud metaväljad. Järgmisest tabelist leiad näiteid ressurssidest ja URL-ivormingutest, mida kasutada metavälja teabe kuvamiseks JSON-is.

Loetleb mõned admini ressursside näited koos JSON-metaväljade faili näidis-URL-iga.
Ressursitüübi näideURL-i näide
Kollektsioonhttps://admin.shopify.com/store/{your-store-name}/collections/{collection-id}/metafields.json
Klienthttps://admin.shopify.com/store/{your-store-name}/customers/{customer-id}/metafields.json
Tellimushttps://admin.shopify.com/store/{your-store-name}/orders/{order-id}/metafields.json
Lehthttps://admin.shopify.com/store/{your-store-name}/pages/{page-id}/metafields.json
Toodehttps://admin.shopify.com/store/{your-store-name}/products/{product-id}/metafields.json
Varianthttps://admin.shopify.com/store/{your-store-name}/products/{product-id}/variants/{variant-id}/metafields.json
Tootepilthttps://admin.shopify.com/store/{your-store-name}/metafields.json?metafield[owner_id]={id}&metafield[owner_resource]=product_image

Märkus. Tootepildi metavälju saab lisada ainult API kaudu. Asenda {id} ja teised URL-is olevad kohatäited oma API päringute tegelike väärtustega.

Poodhttps://admin.shopify.com/store/{your-store-name}/metafields.json

Täieliku loendi ressurssidest, millel võivad olla metaväljad, ja iga ressursitüübi jaoks talletatavate atribuutide spetsiifilised tüübid leiad Shopify arendaja dokumentatsiooni artiklist Metavälja JSON-i ressurss.

Sündmused JSON-is

Teatud Shopify ressursid loovad sündmusi, kui teatud toimingud on lõpule viidud, näiteks blogipostituse loomine, tellimuse täitmine või toote lisamine.

Toetatud ressursilehe URL-i lõppu saab lisada /events.json, et kuvada selle ressursiga seotud sündmused. Järgmisest tabelist leiad näiteid ressurssidest ja URL-ivormingutest, mida kasutada sündmuse teabe kuvamiseks JSON-is.

Loetleb mõned admini ressursside näited koos JSON-sündmuste faili näidis-URL-iga.
Ressursitüübi näideURL-i näide
Tellimushttps://admin.shopify.com/store/{your-store-name}/orders/{order-id}/events.json

See fail loetleb sündmuste atribuudi author (autor), mis annab teada, millised kasutajad tegid teatud toiminguid, näiteks kes või mis toote avaldas.

Toodehttps://admin.shopify.com/store/{your-store-name}/products/{product-id}/events.json

See fail loetleb sündmuste atribuudi author (autor), mis annab teada, millised kasutajad tegid teatud toiminguid, näiteks kes või mis märkis makse makstuks.

Poodhttps://admin.shopify.com/store/{your-store-name}/events.json?limit=250

Selles URL-ivormingus kuvatakse sinu poes toimunud 250 viimast sündmust. Sündmused võivad muuhulgas hõlmata toote loomist või uuendamist, lehtede kustutamist ja variantide uuendamist.

Täieliku loendi ressurssidest, mis võivad sündmusi luua, ja spetsiifilistest sündmustest, mis iga ressursitüübi puhul luuakse, leiad Shopify arendaja dokumentatsiooni artiklist Sündmuse JSON-i ressurss.