Lähetä Admin API -pyyntö
Lähetä Admin API -pyyntötoiminto lähettää mutaation Shopify GraphQL Admin API:lle. Tämän ansiosta voit suorittaa lähes minkä tahansa toiminnon, jonka API sallii Flow'n kautta.
Tällä sivulla
Kentät
Lähetä Admin API -pyyntö ‑toiminto sisältää seuraavat kentät:
Kenttä | Kuvaus |
---|---|
Muunto | Pakollinen. Shopify GraphQL Admin -mutaatio, jolle haluat lähettää kutsun. Mutaatio on API, joka toteuttaa toiminnon tai päivittää tietoja. |
Mutaation syötteet | Pakollinen. Tiedot (JSON-muodossa), jotka sinun on lähetettävä osana mutaatiopyyntöä. Jokainen mutaatio edellyttää eri tietojoukkoa, joka on kuvailtu kunkin mutaation linkissä. Voit luoda tarvittavan JSON-tiedoston käyttämällä Liquidia tai Suorita koodi -toimintoa. |
Käynnistimet
Lähetä Admin API -pyyntötoimintoa voidaan käyttää missä tahansa työnkulussa minkä tahansa käynnistimen kanssa, kunhan työnkulussa on mutaation syötteiden muodostamisessa tarvittavat tiedot.
Esimerkit
Esimerkki 1: Tuotteelle käytettävän mallin päivittäminen
Tässä esimerkissä käytetään Send Admin API -pyyntötoimintoa kutsumaan productUpdate
-muuntoa tuotteessa käytetyn mallin päivittämiseksi.
id
-kenttä on pakollinen, ja sen on oltava kelvollinen tuotteen GID. Tässä sille asetetaan {{product.id}}
-liquid-muuttuja. Esimerkissä oletetaan, että työnkulussa on käynnistin, joka tuo tuoteobjektin.
Tuotteeseen sovellettavan mallin nimi ontemplateSuffix
. Jos esimerkiksi haluat käyttää pre-order
-mallia, aseta templateSuffixin arvoksi pre-order
.
{
"input": {
"templateSuffix": "pre-order",
"id": "{{product.id}}"
}
}
Esimerkki 2: Asiakkaan verovapautuksen tilan päivitys
Tässä esimerkissä käytetään Send Admin API -pyyntötoimintoa kutsumaan customerUpdate
-muuntoa asiakkaan verovapautuksen tilan päivittämiseksi.
Kenttä id
on pakollinen, ja sen on oltava kelvollinen asiakaan GID. Tässä sille asetetaan {{order.customer.id}}
-Liquid-muuttuja. Esimerkki olettaa, että työnkulussa on käynnistin, joka tuo tilausobjektin.
Kenttä taxExempt
on boolean-arvo, joka ilmaisee, onko asiakas vapautettu verosta. Tässä esimerkissä sen arvoksi asetetaan true
.
{
"input": {
"id": "{{order.customer.id}}",
"taxExempt": true
}
}
Esimerkki 3: Asiakkaan alueen päivittäminen
Tässä esimerkissä käytetään Send Admin API -pyyntötoimintoa kutsumaan customerUpdate
-muuntoa asiakkaan kielialueen päivittämiseksi.
id
-kenttä on pakollinen, ja sen on oltava kelvollinen asiakkaan GID. Tässä sille asetetaan {{customer.id}}
-liquid-muuttuja. Esimerkissä oletetaan, että työnkulussa on käynnistin, joka tuo asiakasobjektin.
Kenttä locale
on merkkijono, joka edustaa asiakkaan aluetta. Tässä esimerkissä sen arvoksi asetetaan en
.
{
"input": {
"id": "{{customer.id}}",
"locale": "en"
}
}
Rajoitukset
Lähetä Admin API -pyyntötoimintoon liittyy seuraavia rajoituksia:
- Toiminto ei palauta tietoja Flow-toimintaympäristöön mutaation seurauksena.
- Toiminto ei tue GraphQL-kyselyjä, ainoastaan mutaatioita.
- Toiminto ei tue asynkronisia mutaatioita tai mutaatioita, jotka palauttavat
Job
-tyypin. - Toiminto ei tue tiettyjä sovelluksia koskevia muutoksia, kuten tilausten ja alennusten muutoksia.
- Toiminto näyttää luettelon
Mutations
Mutation inputs
yhdestä Shopify API -versiosta, joka on tällä hetkellä2024-01
. - Kun API-versio päivitetään ja päivityksessä on häiriötä aiheuttava muutos, tämä toiminto voi epäonnistua, jos käytät tätä kenttää.