Pratinjau data API yang digunakan di Shopify Flow
Sebagian besar alur kerja mengakses data dari toko Anda, sehingga Anda dapat menggunakannya dalam kondisi dan tindakan. Shopify Flow mengakses data toko dengan memanggil GraphQL Admin API, yang memberi Anda akses ke hampir semua bidang di API.
Saat membuat alur kerja, Anda akan sering menemukan nama dan deskripsi bidang berdasarkan API, tetapi Anda mungkin perlu mengetahui nilai dari data tersebut. Misalnya, Anda mungkin ingin mengetahui nama aplikasi untuk pesanan yang dibuat dari draf pesanan. Selain itu, Anda mungkin ingin memastikan bahwa alur kerja Anda menghasilkan data yang Anda harapkan, atau dalam format yang Anda harapkan.
Untuk meninjau nilai data, Anda memiliki beberapa opsi di Shopify Flow.
Di halaman ini
Temukan bidang di admin Shopify
Dalam sebagian besar kasus, Anda dapat menemukan data dengan melihat di admin Shopify. Misalnya, product.title tercantum di halaman Produk.
Dapatkan data sampel
Saat Anda membuat alur kerja, Anda bisa mendapatkan data sampel langsung di editor Flow. Karena data Flow berasal dari peristiwa, untuk mendapatkan data sampel yang akurat, Anda harus mulai dengan memilih peristiwa yang relevan:
- Di editor Flow, buka tindakan tempat Anda ingin menggunakan data dan klik Tambahkan variabel. Atau, dalam suatu kondisi, klik Tambahkan kriteria.
- Klik Konfigurasikan data sampel.
- Flow menampilkan peristiwa sebelumnya berdasarkan pemicu alur kerja. Klik Segarkan peristiwa untuk mengambil peristiwa dari eksekusi terbaru, atau klik Mulai dengarkan peristiwa langsung, lalu picu peristiwa secara manual di Admin atau aplikasi yang relevan (untuk pemicu berbasis aplikasi).
- Setelah peristiwa terjadi, Flow akan menampilkan detail tentang peristiwa tersebut. Pilih peristiwa yang ingin Anda gunakan untuk mendapatkan data sampel. Klik Gunakan peristiwa pemicu ini.
- Kini, saat Anda menjelajahi peristiwa, data sampel akan ditampilkan untuk setiap variabel.
Keterbatasan:
- Karena keterbatasan ruang, untuk data dalam daftar, Flow hanya akan menampilkan data dari item pertama dalam daftar.
- Flow akan menyimpan hingga 5 peristiwa sekaligus, per alur kerja.
- Flow tidak dapat mengambil peristiwa dari eksekusi terbaru untuk beberapa pemicu, seperti Waktu terjadwal, Entri metaobjek dibuat, Pelanggan bergabung dengan segmen, atau Pelanggan keluar dari segmen.
Gunakan bidang dalam alur kerja langsung
Anda dapat menggunakan bidang dalam alur kerja dengan aman dengan memanfaatkan tindakan Output log. Saat Anda menjalankan alur kerja, tindakan Output log akan mencetak output variabel dan teks apa pun ke halaman Riwayat Eksekusi. Anda juga dapat menggunakan tindakan notifikasi seperti Kirim email internal.
Langkah-langkah untuk menggunakan Output log:
- Pilih pemicu yang dapat dipicu secara manual.
- Tambahkan tindakan Output log ke alur kerja dan hubungkan ke pemicu.
- Dalam konfigurasi Output log, klik Tambahkan variabel untuk menambahkan variabel yang ingin Anda periksa ke bagian Output.
- Setelah selesai, klik Aktifkan alur kerja.
- Picu alur kerja, baik dengan menjalankannya secara manual maupun dengan menyebabkan pemicu aktif. Misalnya, jika Anda menggunakan pemicu Pesanan dibuat, buatlah pesanan uji coba.
- Setelah alur kerja berjalan, periksa log aktivitas untuk melihat variabel.
Lihat halaman JSON sumber daya
Sebagian besar halaman sumber daya di admin Shopify, seperti halaman Pesanan, Produk, atau Pelanggan, memungkinkan Anda melihat data yang menyajikan halaman tersebut. Penamaan dan format data ini tidak persis sama dengan yang digunakan Shopify Flow, tetapi nilainya cocok dengan yang ada di GraphQL Admin API. Untuk meninjau data, tambahkan .json ke URL.
Misalnya, buka pesanan dengan membuka halaman Pesanan di admin Shopify dan mengeklik pesanan. Di alamat halaman pada bilah alamat browser Anda, ubah alamat dari:
https://https://admin.shopify.com/store/<shopname>/orders/3804849891234
Menjadi berikut:
https://https://admin.shopify.com/store/<shopname>/orders/3804849891234.json
Gunakan GraphiQL atau alat API pihak ketiga
Anda dapat langsung membuat kueri API menggunakan alat API pihak ketiga seperti Postman atau alat gratis yang disediakan Shopify, GraphiQL. Opsi ini memberikan hasil yang paling akurat, tetapi memerlukan pemahaman tentang cara membuat kueri GraphQL.
Untuk GraphiQL, Shopify menawarkan penjelajah GraphiQL berbasis web dengan data umum dan aplikasi GraphiQL. Dengan GraphiQL, Anda dapat membuat kueri GraphQL yang sama persis dengan nama bidang di Shopify Flow. Nilainya juga akan sama persis dengan toko Anda jika Anda menggunakan aplikasi tersebut.
Dengan menggunakan alat ini, Anda dapat menentukan dengan tepat data apa yang digunakan oleh Shopify Flow, dengan data toko Anda yang sebenarnya. Misalnya, Anda membuat kueri berikut:
{
orders(first:5, reverse:true) {
nodes {
createdAt
app {
name
}
channelInformation {
app {
title
}
}
}
}
}Dalam hasil berikut, variabel order / app / name menampilkan nama aplikasi untuk pesanan tersebut. Dalam kasus ini, pesanan dibuat dari aplikasi draf pesanan, sehingga nilainya adalah Draft Orders. Informasi saluran hanya tersedia untuk aplikasi Point of Sale.
{
"data": {
"orders": {
"nodes": [
{
"createdAt": "2023-04-10T12:32:41Z",
"app": {
"name": "Draft Orders"
},
"channelInformation": null
},
{
"createdAt": "2023-04-10T12:29:12Z",
"app": {
"name": "Draft Orders"
},
"channelInformation": null
},
{
"createdAt": "2023-03-17T20:23:10Z",
"app": {
"name": "Draft Orders"
},
"channelInformation": null
},
{
"createdAt": "2023-03-17T20:20:53Z",
"app": {
"name": "Draft Orders"
},
"channelInformation": null
},
{
"createdAt": "2023-03-17T15:45:15Z",
"app": {
"name": "Point of Sale"
},
"channelInformation": {
"app": {
"title": "Point of Sale"
}
}
}
]
}
}