גישה לנתונים מפורטים במנהל של Shopify באמצעות JSON

JSON, קיצור של JavaScript Object Notation, הוא פורמט לאחסון ולהעברת נתונים, שמשמש לרוב כאשר נתונים נשלחים משרתים לדפי אינטרנט. ברוב דפי המשאבים במנהל של Shopify, כגון הדפים הזמנות, מוצרים או לקוחות, אפשר לגשת לנתונים מפורטים יותר באמצעות JSON.

אף שאינך נדרש לבצע משימות פיתוח מתקדמות באמצעות JSON, היכולת לגשת אל קובץ ה-JSON עבור משאב מסוים במנהל של Shopify יכולה לעזור לך לאסוף מידע מפורט יותר, או לפתור ולחקור בעיות בעצמך. לדוגמה, תוכל לסקור את קובץ ה-JSON של מוצר כדי למצוא את מזהה הגרסה שלו, שעשוי להידרש עבור משימות מסוימות של העברת נתונים או עבור התאמות אישיות של קוד ערכת הנושא. כדוגמה נוספת, תוכל לעיין בקובץ ה-JSON של הזמנה כדי לאמת את משתנה הנתונים שברצונך להשתמש בו בעת בניית זרימת עבודה אוטומטית ב-Shopify Flow.

השימוש ב-JSON נעשה לרוב על ידי מפתחים, אך גם משתמשים בעלי ידע מוגבל בקידוד יכולים להפיק תועלת מלמידה כיצד למצוא ולפרש מידע נפוץ מסוג JSON במנהל של Shopify.

עיצוב מחדש של קובץ JSON

נתוני JSON גולמיים מוצגים כרצף ארוך של משתנים מקוננים וסוגריים, שמהווים אתגר קריאה עבור משתמש אנושי.

כדי להפוך את פורמט ה-JSON לקריא יותר, אפשר לשקול את האפשרויות הבאות:

  • להתקין תוסף להצגת JSON בדפדפן שלך.
  • יש להשתמש ביכולת pretty-print, שזמינה כברירת מחדל ברוב דפדפני האינטרנט המודרניים:

צילום מסך של קובץ JSON של מוצר, המציג מידע לדוגמה על המוצר. ה-

גישה לקובצי JSON בלוח המנהל של Shopify

לוח המנהל של Shopify הוא המרכז לניהול כל היבטי העסק שלך, והוא מיועד להציג כברירת מחדל רק את המידע השימושי והרלוונטי ביותר. המידע הנוסף שנאסף בכל פעם שמתבצעות פעולות בלוח המנהל מאוחסן בקובצי .json של עמודי משאבים שונים. פרטים נוספים אלו אינם מוצגים לך כברירת מחדל, משום שכמות כזו של מידע עשויה להיות עמוסה מדי ולא מועילה, ותקשה על השימוש בלוח המנהל.

עבור רוב המשימות העסקיות, אפשר להשתמש בכלים הקיימים של Shopify כדי לגשת למידע של החנות שלך ולנתח אותו. עם זאת, לפעמים כדאי לעיין במידע ספציפי על משאבים מסוימים, כגון מוצרים או הזמנות, במהלך פתרון בעיות, כדי להבין מדוע או מתי משהו קרה.

דוגמה: גישה לקובץ ה-JSON של הזמנה

בדוגמה זו, תיגש לקובץ ה-JSON של הזמנה בלוח המנהל של Shopify.

שלבים:

  1. מלוח המנהל של Shopify, יש לעבור אל הזמנות.

  2. יש ללחוץ על הזמנה כלשהי ברשימה הזמנות.

  3. בשורת הכתובת של הדפדפן, יש להוסיף .json בסוף כתובת ה-URL. היא תיראה בדומה לדוגמה הזו:

https://admin.shopify.com/store/{example-shop-name}/orders/12345678901234.json
  1. יש ללחוץ על Enter כדי לטעון מחדש את העמוד בפורמט JSON.
  2. אופציונלי: אם לא מותקן בדפדפן שלך תוסף לתצוגת JSON, יש להפעיל את ההגדרה Pretty-print בדפדפן כדי להפוך את קובץ ה-JSON לידידותי יותר למשתמש. למידע נוסף על עיצוב מחדש של קובץ JSON.

אפשר להבחין שמוצג מידע צפוי רב על ההזמנה, כגון "currency" ו-"line_items" שמשויכים להזמנה, אך נכלל גם הרבה מידע מפורט אחר, כגון "client_details" מסשן הדפדפן של הלקוח כשהוא ביצע את ההזמנה. מידע מסוג זה מועיל למעקב כולל אחר סשנים ולניתוח של פלטפורמות שיווק, אך הוא אינו הכרחי עבורך כדי לעבד ולמלא את ההזמנה.

הצגת שדות ספציפיים בקובץ JSON

אפשר לאלץ קובצי JSON להציג רק שדות ספציפיים. הדבר יכול להקל על הבנת המידע כאשר יודעים אילו מאפיינים מסוימים רוצים לכלול. בסוף כל כתובת URL של קובץ JSON בשורת הכתובת של הדפדפן, יש להוסיף ?fields= ואז לכלול את שמות המאפיינים שברצונך להציג, בכל סדר שהוא, כשהם מופרדים בפסיק.

לדוגמה, כדי להציג את המזהה (ID) של ההזמנה, פרטי הלקוח, המחיר הכולל והתגים, יש להוסיף ?fields=id,customer,total_price,tags לסוף כתובת ה-URL של קובץ ה-JSON, כפי שמוצג בדוגמה הבאה:

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

שימוש במשאבי JSON אחרים

אפשר להשתמש במשאבי ה-JSON הבאים כדי להציג מידע ספציפי בלוח המנהל של Shopify:

https://admin.shopify.com/store/{example-shop-name}/products/count.json
  • עסקאות: יש להוסיף /transactions.json לסוף כתובת ה-URL של עמוד ההזמנה כדי להציג רק את מידע העסקאות של ההזמנה. למידע נוסף על משאב העסקאות.
  • מילויי הזמנות: יש להוסיף /fulfillments.json לסוף כתובת ה-URL של עמוד ההזמנה כדי להציג רק מידע על מילוי ההזמנה. למידע נוסף על משאב מילוי ההזמנות.
  • תשלומים נטושים: יש להוסיף .json לסוף כתובת ה-URL של התשלום הנטוש כדי להציג מידע מפורט על התשלום הנטוש. למידע נוסף על משאב התשלומים הנטושים.

מאפייני JSON נפוצים לפתרון בעיות

הטבלה הבאה מפרטת מאפייני JSON שכדאי לעיין בהם כסיוע לפתרון בעיות בסוגי משאבים שונים. לדוגמה, אם ברצונך לוודא מתי פורסם מוצר מסוים, אפשר לבדוק בקובץ ה-JSON של המוצר את המאפיין published_at, שמציג את התאריך והשעה בפורמט ISO 8601.

טבלה זו אינה כוללת את כל משאבי או מאפייני ה-JSON האפשריים המאוחסנים בלוח המנהל של Shopify, ולכן יש לעיין בתיעוד המפתחים של Shopify עבור הגדרות של כל משאב או מאפיין שלא נכללים כאן.

רשימה של כמה משאבים לדוגמה בלוח המנהל והמאפיינים הנפוצים המשויכים אליהם, כולל הגדרות שמסבירות למה הם עשויים לשמש במהלך פתרון בעיות.
משאבמאפיין JSONהגדרה
מוצר
"product": {
  "created_at"
התאריך והשעה שבהם המוצר נוצר לראשונה.
"product": {
  "published_at"
התאריך והשעה שבהם הסטטוס של המוצר הוגדר כ-פעיל.
"product": {
  "updated_at"
התאריך והשעה העדכניים ביותר שבהם המוצר עודכן. נתון זה יכול לכלול שינויים בתיאור המוצר, בכותרת או במידע ה-SEO, וכן עדכונים אוטומטיים כגון שינויים במערכת המלאי כאשר מוצר נרכש.
גרסה
"product": {
  "variants": [
    {
    "created_at"
התאריך והשעה שבהם הגרסה נוצרה לראשונה. מידע זה יכול להיות שונה מהתאריך והשעה שבהם נוצר המוצר הכללי.
"product": {
  "variants": [
    {
    "updated_at"
התאריך והשעה העדכניים ביותר שבהם הגרסה עודכנה. מידע זה יכול להיות שונה מהתאריך והשעה שבהם המוצר הכללי עודכן לאחרונה.
"product": {
  "variants": [
    {
    "inventory_quantity"
הערך הנוכחי במסד הנתונים ומה שזמין ללקוחות לרכישה. נתון זה יכול להיות בערך שלילי אם לא מתבצע מעקב אחר מערכת המלאי של הגרסה, או אם היא מוגדרת למכור יתר על המידה.
"product": {
  "variants": [
    {
    "old_inventory_quantity"
הערך במסד הנתונים לפני תאריך ה-updated_at האחרון של הגרסה.
הזמנה
"order": {
   "line_items": [
    {
    "requires_shipping"
מוצג כ-true או false. נתון זה מציין את הגדרות השילוח של המוצר או הגרסה במועד ביצוע ההזמנה.
"order": {
   "line_items": [
    {
    "taxable"
מוצג כ-true או false. נתון זה מציין כיצד המוצר או הגרסה הוגדרו לחיוב מס במועד ביצוע ההזמנה.
"order": {
   "line_items": [
    {
    "variant_inventory_management"
מוצג כ-shopify, amazon_marketplace_web, null או כערך של צד שלישי, בהתאם לשירות למילוי הזמנות שמוגדר לעקוב אחר מערכת המלאי של המוצר. ערך של null אומר שלא התבצע מעקב אחר המוצר במועד ההזמנה.
"order": {
   "line_items": [
    {
    "fulfillable_quantity"
מציג איזו כמות ממערכת המלאי עדיין שמורה במערכת כדי להשלים את ההזמנה. נתון זה אינו שווה לנתוני מערכת המלאי הנוכחיים של הגרסה.
"order": {
   "line_items": [
    {
    "quantity"
מספר המוצרים או הגרסאות שנרכשו.
"order": {
   "line_items": [
    {
    "tax_lines"
בארצות הברית, מוצגים כאן ערכים של מדינה, מחוז ועיר. אם לא מוצגות שורות מס אך נגבה מס על ההזמנה, המשמעות היא שהמס נגבה על עלות השילוח.
לקוח
"customer": {
  "created_at"
התאריך והשעה שבהם הלקוח נוצר לראשונה.
"customer": {
  "updated_at"
התאריך והשעה העדכניים ביותר שבהם פרופיל הלקוח עודכן.

מטא שדות ב-JSON

מטא שדות הם דרך גמישה לצרף מידע מותאם אישית נוסף למשאב ב-Shopify, כמו מוצרים או אוספים. דוגמאות לנתונים המאוחסנים באמצעות מטא שדות כוללות מפרטי מוצרים, טבלאות מידות, מסמכים להורדה, תאריכי השקה, תמונות או מספרי חלקים. למידע נוסף על שימוש במטא שדות.

אפשר להוסיף /metafields.json בסוף כתובת URL של דף משאב נתמך, כדי להציג את המטא שדות שמשויכים לאותו משאב. אפשר לעיין בטבלה הבאה לקבלת דוגמאות של משאבים ופורמטים של כתובות URL שבהם ניתן להשתמש כדי להציג מידע על מטא שדות באמצעות JSON.

רשימה של כמה משאבי מנהל לדוגמה, יחד עם כתובת URL לדוגמה של קובץ מטא שדות מסוג JSON.
סוג משאב לדוגמהכתובת URL לדוגמה
אוסףhttps://admin.shopify.com/store/{your-store-name}/collections/{collection-id}/metafields.json
לקוחhttps://admin.shopify.com/store/{your-store-name}/customers/{customer-id}/metafields.json
הזמנהhttps://admin.shopify.com/store/{your-store-name}/orders/{order-id}/metafields.json
דףhttps://admin.shopify.com/store/{your-store-name}/pages/{page-id}/metafields.json
מוצרhttps://admin.shopify.com/store/{your-store-name}/products/{product-id}/metafields.json
גרסהhttps://admin.shopify.com/store/{your-store-name}/products/{product-id}/variants/{variant-id}/metafields.json
תמונת מוצרhttps://admin.shopify.com/store/{your-store-name}/metafields.json?metafield[owner_id]={id}&metafield[owner_resource]=product_image

הערה: אפשר להוסיף מטא שדות של תמונת מוצר רק דרך ה-API. יש להחליף את {id} ואת שאר מצייני המקום שבכתובת ה-URL בערכים האמיתיים משאילתות ה-API שלך.

חנותhttps://admin.shopify.com/store/{your-store-name}/metafields.json

לרשימה המלאה של משאבים שיכולים לכלול מטא שדות, ולסוגי המאפיינים הספציפיים שמאוחסנים עבור כל סוג משאב, אפשר לעיין ב-משאב JSON של מטא שדות ב-dev docs של Shopify.

Events ב-JSON

Events נוצרים על ידי משאבים מסוימים ב-Shopify כאשר פעולות מסוימות מושלמות, כמו יצירה של פוסט בבלוג, מילוי הזמנה או הוספה של מוצר.

אפשר להוסיף /events.json בסוף כתובת URL של דף משאב נתמך, כדי להציג את ה-Events שמשויכים לאותו משאב. אפשר לעיין בטבלה הבאה לקבלת דוגמאות של משאבים ופורמטים של כתובות URL שבהם ניתן להשתמש כדי להציג מידע על Events באמצעות JSON.

רשימה של כמה משאבי מנהל לדוגמה, יחד עם כתובת URL לדוגמה של קובץ Events מסוג JSON.
סוג משאב לדוגמהכתובת URL לדוגמה
הזמנהhttps://admin.shopify.com/store/{your-store-name}/orders/{order-id}/events.json

קובץ זה מפרט את ה-author של ה-Events, ומיידע אותך אילו משתמשים ביצעו פעולות מסוימות, למשל מי או מה פרסם מוצר.

מוצרhttps://admin.shopify.com/store/{your-store-name}/products/{product-id}/events.json

קובץ זה מפרט את ה-author של ה-Events, ומיידע אותך אילו משתמשים ביצעו פעולות מסוימות, למשל מי או מה סימן תשלום כשולם.

חנותhttps://admin.shopify.com/store/{your-store-name}/events.json?limit=250

פורמט זה של כתובת URL מציג את 250 ה-Events האחרונים שהתרחשו בחנות שלך. ה-Events יכולים לכלול (בין היתר) יצירה או עדכונים של מוצרים, מחיקות דפים ועדכוני גרסאות.

לרשימה המלאה של משאבים שיכולים ליצור Events, ול-Events הספציפיים שנוצרים עבור כל סוג משאב, אפשר לעיין ב-משאב JSON של Events ב-dev docs של Shopify.