Dapatkan data kontrak langganan

Di alur kerja yang menggunakan data kontrak langganan, Anda dapat menggunakan tindakan Dapatkan data kontrak langganan untuk mengambil informasi kontrak langganan dari toko Anda.

Konfigurasi

Kolom

Tindakan Dapatkan data kontrak langganan berisi kolom-kolom berikut, yang digunakan untuk membuat kueri:

Kolom yang digunakan dalam tindakan Dapatkan data.
KolomDeskripsi
Urutkan data menurutWajib diisi. Parameter yang digunakan untuk mengurutkan data yang dikembalikan oleh kueri pencarian.
Jumlah maksimum hasilWajib diisi. Jumlah maksimum hasil yang dapat dikembalikan oleh kueri pencarian yang Anda pilih. Anda dapat mengembalikan hingga 100 hasil sekaligus.
KueriWajib diisi. Pilih dari kueri umum atau pilih Lanjutan untuk membuat kueri Anda sendiri.

String Kueri

Ini adalah contoh kueri untuk mendapatkan kontrak langganan dengan status ACTIVE:

status: ACTIVE

Variabel status adalah filter yang tersedia di kueri Kontrak langganan dan dapat digunakan beberapa kali.

Saat membuat kueri data, ada baiknya Anda mengetahui:

  • Daftar filter yang tersedia
  • Kueri harus mengikuti sintaksis tertentu
  • Nilai kolom kueri tidak selalu didokumentasikan. Dalam beberapa kasus, nilainya dapat ditemukan dengan melihat dokumen API. Atau, Anda sering kali dapat menemukan nilai kolom di URL pada panel admin saat memfilter. Misalnya, untuk menemukan beberapa nilai kueri Pesanan, filter halaman Pesanan di panel admin, lalu periksa URL.
  • Anda dapat menjalankan atau menguji kueri di toko Anda dengan menggunakan aplikasi Shopify GraphiQL.
  • Perhatikan apa yang terjadi jika kueri Anda gagal. Sering kali, API akan mengembalikan semua hasil (bukan tidak sama sekali).

Data yang dikembalikan

Semua tindakan Dapatkan data mengembalikan daftar yang berisi 0 hingga 100 sumber daya. Tergantung pada kasus penggunaan Anda, Anda mungkin ingin menggunakan data ini dengan berbagai cara:

  • Jika Anda perlu menangani setiap item daftar satu per satu, misalnya untuk menambahkan tag ke setiap item, Anda dapat menggunakan tindakan Untuk setiap.
  • Jika Anda perlu mengagregasi data, seperti menghitung berapa banyak hasil yang dikembalikan, Anda dapat menggunakan tindakan Hitung atau Jumlahkan.
  • Jika Anda perlu menampilkan daftar sebagai output, misalnya mengirim email berisi semua item, Anda dapat menggunakan data yang dikembalikan secara langsung dalam tindakan berikutnya.

Untuk mengakses data yang dikembalikan dalam langkah-langkah setelah tindakan ini, gunakan variabel bernama Dapatkan data kontrak langganan, yang merupakan daftar kontrak langganan. Anda dapat menggunakan variabel ini dalam kondisi dan tindakan. Misalnya, Anda dapat mengirim daftar pesanan dalam tindakan Kirim email internal seperti ini:

{% for single_contract in GetSubscriptionContractData %}
* {{ single_contract.name }}
{% endfor %}

Pemicu

Anda dapat menggunakan tindakan ini di alur kerja apa pun, termasuk pemicu Waktu terjadwal. Dalam alur kerja yang menggunakan pemicu Waktu terjadwal, alur kerja dimulai pada waktu yang telah Anda tentukan, bukan sebagai akibat dari suatu peristiwa. Karena tidak ada peristiwa spesifik di toko Anda atau dari aplikasi yang memulai alur kerja, tidak ada data yang disertakan secara otomatis.

Referensi API