Mengakses data terperinci di admin Shopify Anda menggunakan JSON

JSON, singkatan dari JavaScript Object Notation, adalah format untuk menyimpan dan mentransfer data, yang sering digunakan ketika data dikirim dari server ke halaman web. Di sebagian besar halaman sumber daya di admin Shopify, seperti halaman Pesanan, Produk, atau Pelanggan, Anda dapat mengakses data yang lebih detail menggunakan JSON.

Meskipun Anda tidak diharuskan melakukan tugas pengembangan tingkat lanjut menggunakan JSON, kemampuan untuk mengakses file JSON untuk sumber daya tertentu di admin Shopify dapat membantu Anda mengumpulkan informasi yang lebih detail, atau memecahkan maupun menyelidiki masalah sendiri. Misalnya, Anda dapat meninjau file JSON suatu produk untuk menemukan ID variannya, yang mungkin diperlukan untuk tugas migrasi data atau kustomisasi kode tema tertentu. Sebagai contoh lain, Anda dapat mengacu pada file JSON pesanan untuk mengonfirmasi variabel data yang ingin Anda gunakan saat membangun alur kerja otomatis di Shopify Flow.

JSON paling sering digunakan oleh developer, tetapi bahkan pengguna dengan pengetahuan coding terbatas pun dapat memperoleh manfaat dengan mempelajari cara menemukan dan menafsirkan beberapa informasi JSON umum di admin Shopify mereka.

Di halaman ini

Memformat ulang file JSON

Data JSON mentah ditampilkan sebagai urutan panjang variabel dan tanda kurung yang bertumpuk, yang sulit dibaca oleh pengguna.

Agar format JSON lebih mudah dibaca, pertimbangkan salah satu opsi berikut:

Instal ekstensi penampil JSON di browser Anda.
Gunakan kapabilitas pretty-print yang tersedia secara default di sebagian besar browser web modern:

Screenshot file JSON produk dengan contoh informasi produk yang ditampilkan. Pengaturan kotak centang

Mengakses file JSON di admin Shopify Anda

Admin Shopify adalah pusat utama untuk mengelola semua aspek bisnis Anda, dan dirancang untuk menampilkan hanya informasi yang paling berguna dan relevan secara default. Informasi tambahan yang dikumpulkan setiap kali tindakan dilakukan di admin Anda disimpan dalam file .json dari halaman sumber daya yang berbeda. Detail tambahan ini tidak ditampilkan kepada Anda secara default karena jumlah informasi tersebut akan terlalu banyak dan tidak membantu, serta akan membuat admin Anda sulit digunakan.

Untuk sebagian besar tugas bisnis, Anda dapat menggunakan alat yang ada di Shopify untuk mengakses dan menafsirkan informasi toko Anda. Namun, terkadang ada baiknya Anda meninjau informasi spesifik tentang sumber daya tertentu, seperti produk atau pesanan, saat menyelesaikan masalah untuk mengetahui mengapa atau kapan sesuatu terjadi.

Contoh: Mengakses file JSON pesanan

Dalam contoh ini, Anda akan mengakses file JSON pesanan di admin Shopify Anda.

Langkah-langkah:

Dari admin Shopify, buka Pesanan.
Klik pesanan mana pun di daftar Pesanan.
Di bilah alamat browser, tambahkan .json di akhir alamat URL. Alamatnya akan serupa dengan contoh ini:

https://admin.shopify.com/store/{example-shop-name}/orders/12345678901234.json

Tekan Enter untuk memuat ulang halaman dalam format JSON.
Opsional: Jika Anda tidak memiliki ekstensi penampil JSON yang terinstal di browser, aktifkan setelan Pretty-print di browser Anda agar file JSON lebih mudah dibaca. Pelajari selengkapnya tentang memformat ulang file JSON.

Anda akan melihat bahwa banyak informasi yang diharapkan tentang pesanan ditampilkan, seperti "currency" dan "line_items" yang terkait dengan pesanan, tetapi banyak informasi terperinci lainnya juga disertakan, seperti "client_details" dari sesi browser pelanggan saat mereka membuat pesanan. Informasi semacam ini berguna untuk pelacakan sesi secara keseluruhan dan analitik platform pemasaran, tetapi tidak diperlukan bagi Anda untuk memproses dan memenuhi pesanan.

Menampilkan kolom spesifik dalam file JSON

Anda dapat memaksa file JSON untuk menampilkan kolom tertentu saja, yang dapat membuat informasi lebih mudah ditafsirkan saat Anda mengetahui properti tertentu yang ingin Anda sertakan. Di akhir URL file JSON mana pun di bilah alamat browser, tambahkan ?fields= lalu sertakan nama properti yang ingin Anda tampilkan, dalam urutan apa pun, yang dipisahkan oleh koma.

Misalnya, untuk menampilkan ID pesanan, informasi pelanggan, harga total, dan tag, tambahkan ?fields=id,customer,total_price,tags di akhir URL file JSON, seperti dalam contoh berikut:

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

Menggunakan sumber daya JSON lain

Anda dapat menggunakan sumber daya JSON berikut untuk menampilkan informasi spesifik di admin Shopify Anda:

Jumlah produk: Tambahkan /count.json ke akhir URL daftar Produk untuk menampilkan jumlah total produk. URL lengkapnya akan menjadi:

https://admin.shopify.com/store/{example-shop-name}/products/count.json

Transaksi: Tambahkan /transactions.json ke akhir URL halaman pesanan untuk menampilkan informasi transaksi pesanan saja. Pelajari selengkapnya tentang sumber daya Transaksi.
Pemenuhan: Tambahkan /fulfillments.json ke akhir URL halaman pesanan untuk menampilkan informasi pemenuhan pesanan saja. Pelajari selengkapnya tentang sumber daya Pemenuhan.
Checkout yang ditinggalkan: Tambahkan .json ke akhir URL checkout yang ditinggalkan untuk menampilkan informasi detail tentang checkout yang ditinggalkan. Pelajari selengkapnya tentang sumber daya Checkout yang ditinggalkan.

Properti JSON umum untuk penyelesaian masalah

Tabel berikut mencantumkan properti JSON yang mungkin ingin Anda rujuk untuk bantuan penyelesaian masalah dengan berbagai jenis sumber daya. Misalnya, jika Anda ingin mengonfirmasi kapan produk tertentu dipublikasikan, Anda dapat meninjau file JSON produk untuk properti published_at, yang menampilkan tanggal dan waktu dalam format ISO 8601.

Tabel ini tidak mencakup setiap kemungkinan sumber daya atau properti JSON yang disimpan di admin Shopify, jadi bacalah Dokumentasi Developer Shopify untuk definisi sumber daya atau properti apa pun yang tidak tercantum di sini.

Mencantumkan beberapa contoh sumber daya admin dan properti umum yang terkait dengannya, termasuk definisi tentang kegunaannya saat menyelesaikan masalah.
Sumber daya	Properti JSON	Definisi
Produk	`"product": { "created_at"`	Waktu dan tanggal saat produk pertama kali dibuat.
	`"product": { "published_at"`	Waktu dan tanggal saat status produk diatur ke Aktif.
	`"product": { "updated_at"`	Waktu dan tanggal terbaru saat produk diperbarui. Ini dapat mencakup perubahan pada deskripsi produk, judul, atau informasi SEO, serta pembaruan otomatis seperti perubahan inventaris saat produk dibeli.
Varian	`"product": { "variants": [ { "created_at"`	Waktu dan tanggal saat varian pertama kali dibuat. Ini bisa berbeda dari tanggal dan waktu saat produk secara keseluruhan dibuat.
	`"product": { "variants": [ { "updated_at"`	Waktu dan tanggal terbaru saat varian diperbarui. Ini bisa berbeda dari tanggal dan waktu saat produk secara keseluruhan terakhir diperbarui.
	`"product": { "variants": [ { "inventory_quantity"`	Nilai database saat ini dan yang dapat diakses pelanggan untuk pembelian. Ini bisa menjadi nilai negatif jika inventaris varian tidak dilacak, atau jika diatur untuk penjualan melebihi stok.
	`"product": { "variants": [ { "old_inventory_quantity"`	Nilai database sebelum tanggal `updated_at` terakhir varian.
Pesanan	`"order": { "line_items": [ { "requires_shipping"`	Ditampilkan sebagai `true` atau `false`. Ini menunjukkan pengaturan pengiriman produk atau varian pada saat pesanan dibuat.
	`"order": { "line_items": [ { "taxable"`	Ditampilkan sebagai `true` atau `false`. Ini menunjukkan cara produk atau varian diatur untuk mengenakan pajak pada saat pesanan dibuat.
	`"order": { "line_items": [ { "variant_inventory_management"`	Ditampilkan sebagai `shopify`, `amazon_marketplace_web`, `null`, atau nilai pihak ketiga, bergantung pada layanan pemenuhan mana yang diatur untuk melacak inventaris produk. Nilai `null` berarti produk tidak sedang dilacak pada saat pesanan dibuat.
	`"order": { "line_items": [ { "fulfillable_quantity"`	Menampilkan berapa banyak inventaris yang masih dicadangkan oleh sistem untuk menyelesaikan pesanan. Jumlah ini tidak sama dengan inventaris varian saat ini.
	`"order": { "line_items": [ { "quantity"`	Jumlah produk atau varian yang dibeli.
	`"order": { "line_items": [ { "tax_lines"`	Di Amerika Serikat, ini menampilkan nilai negara bagian, county, dan kota. Jika tidak ada baris pajak yang ditampilkan tetapi pajak dikenakan pada pesanan, maka ini berarti pajak tersebut dikenakan pada biaya pengiriman.
Pelanggan	`"customer": { "created_at"`	Waktu dan tanggal saat pelanggan pertama kali dibuat.
Pelanggan	`"customer": { "updated_at"`	Waktu dan tanggal terbaru saat profil pelanggan diperbarui.

Metafield dalam JSON

Metafield adalah cara fleksibel untuk melampirkan informasi kustom tambahan ke sumber daya Shopify, seperti produk atau koleksi. Beberapa contoh data yang disimpan menggunakan metafield mencakup spesifikasi produk, tabel ukuran, dokumen yang dapat diunduh, tanggal rilis, gambar, atau nomor komponen. Pelajari selengkapnya tentang menggunakan metafield.

Anda dapat menambahkan /metafields.json di akhir URL halaman sumber daya yang didukung untuk menampilkan metafield yang terkait dengan sumber daya tersebut. Lihat tabel berikut untuk mengetahui beberapa contoh sumber daya dan format URL yang dapat digunakan untuk menampilkan informasi metafield menggunakan JSON.

Mencantumkan beberapa contoh sumber daya admin beserta contoh URL file metafield JSON.
Contoh jenis sumber daya	Contoh URL
Koleksi cerdas	`https://admin.shopify.com/store/{your-store-name}/collections/{collection-id}/metafields.json`
Pelanggan	`https://admin.shopify.com/store/{your-store-name}/customers/{customer-id}/metafields.json`
Pesanan	`https://admin.shopify.com/store/{your-store-name}/orders/{order-id}/metafields.json`
Halaman	`https://admin.shopify.com/store/{your-store-name}/pages/{page-id}/metafields.json`
Produk	`https://admin.shopify.com/store/{your-store-name}/products/{product-id}/metafields.json`
Varian	`https://admin.shopify.com/store/{your-store-name}/products/{product-id}/variants/{variant-id}/metafields.json`
Foto produk	`https://admin.shopify.com/store/{your-store-name}/metafields.json?metafield[owner_id]={id}&metafield[owner_resource]=product_image` Catatan: Metafield gambar produk hanya dapat ditambahkan melalui API. Ganti `{id}` dan placeholder lain di URL dengan nilai aktual dari kueri API Anda.
Toko	`https://admin.shopify.com/store/{your-store-name}/metafields.json`

Untuk daftar lengkap sumber daya yang dapat memiliki metafield, dan jenis properti spesifik yang disimpan untuk setiap jenis sumber daya, bacalah sumber daya JSON Metafield di Dokumentasi Developer Shopify.

Event dalam JSON

Event dibuat oleh beberapa sumber daya Shopify saat tindakan tertentu selesai, seperti pembuatan postingan blog, pemenuhan pesanan, atau penambahan produk.

Anda dapat menambahkan /events.json di akhir URL halaman sumber daya yang didukung untuk menampilkan event yang terkait dengan sumber daya tersebut. Lihat tabel berikut untuk mengetahui beberapa contoh sumber daya dan format URL yang dapat digunakan untuk menampilkan informasi event menggunakan JSON.

Mencantumkan beberapa contoh sumber daya admin beserta contoh URL file event JSON.
Contoh jenis sumber daya	Contoh URL
Pesanan	`https://admin.shopify.com/store/{your-store-name}/orders/{order-id}/events.json` File ini mencantumkan `author` event, yang memberi tahu Anda pengguna mana yang menyelesaikan tindakan tertentu, seperti siapa atau apa yang memublikasikan produk.
Produk	`https://admin.shopify.com/store/{your-store-name}/products/{product-id}/events.json` File ini mencantumkan `author` event, yang memberi tahu Anda pengguna mana yang menyelesaikan tindakan tertentu, seperti siapa atau apa yang menandai pembayaran sebagai lunas.
Toko	`https://admin.shopify.com/store/{your-store-name}/events.json?limit=250` Format URL ini menampilkan 250 event terbaru yang terjadi di toko Anda. Event dapat mencakup tetapi tidak terbatas pada pembuatan atau pembaruan produk, penghapusan halaman, dan pembaruan varian.

Untuk daftar lengkap sumber daya yang dapat membuat acara, dan acara spesifik yang dibuat untuk setiap jenis sumber daya, bacalah sumber daya JSON Acara di Dokumentasi Developer Shopify.