Admin API વિનંતી મોકલો
Admin API વિનંતી મોકલો ઍક્શન તમારા સ્ટોરમાં ફેરફારો કરવા માટે GraphQL Admin API માં મોટાભાગના મ્યુટેશનનો ઉપયોગ કરી શકે છે, જેમાં Flow માં ઍક્શન તરીકે હજી સુધી ઉપલબ્ધ ન હોય તેવા મ્યુટેશનનો સમાવેશ થાય છે.
ફીલ્ડ્સ
Admin API વિનંતી મોકલો ઍક્શનમાં નીચેના ફીલ્ડ્સ સામેલ છે.
| ફીલ્ડ | વર્ણન |
|---|---|
| મ્યુટેશન | આવશ્યક છે. Shopify GraphQL ઍડમિન મ્યુટેશન જેને તમે કૉલ કરવા માગો છો. મ્યુટેશન એ એક API છે જે કોઈ ક્રિયા કરે છે અથવા ડેટા અપડેટ કરે છે. |
| મ્યુટેશન ઇનપુટ | આવશ્યક છે. તમારી મ્યુટેશન વિનંતીના ભાગ રૂપે તમારે જે ડેટા (JSON માં) મોકલવાની જરૂર છે. દરેક મ્યુટેશન માટે અલગ ડેટાના સેટની જરૂર પડે છે, જે દરેક મ્યુટેશન માટે પ્રદાન કરેલી લિંકમાં દસ્તાવેજીકૃત થયેલ છે. જરૂરી JSON બનાવવા માટે, તમે Liquid અથવા કોડ રન કરો ક્રિયાનો ઉપયોગ કરી શકો છો. |
ટ્રિગર
જ્યાં સુધી વર્કફ્લો મ્યુટેશન ઇનપુટ બનાવવા માટે જરૂરી ડેટા પ્રદાન કરે, ત્યાં સુધી કોઈપણ ટ્રિગર સાથે કોઈપણ વર્કફ્લોમાં Admin API વિનંતી મોકલો ક્રિયાનો ઉપયોગ કરી શકાય છે.
ઉદાહરણો
ઉદાહરણ 1: પ્રોડક્ટ માટે ઉપયોગમાં લેવાતું ટેમ્પ્લેટ અપડેટ કરો
આ ઉદાહરણમાં, અમે પ્રોડક્ટ માટે ઉપયોગમાં લેવાતું ટેમ્પ્લેટ અપડેટ કરવા માટે productUpdate મ્યુટેશનને કૉલ કરવા માટે Admin API વિનંતી મોકલો ક્રિયાનો ઉપયોગ કરીશું.
id ફીલ્ડ આવશ્યક છે અને તે માન્ય પ્રોડક્ટ GID હોવું જોઈએ. અહીં, અમે તેને {{product.id}} લિક્વિડ ચલ સાથે સેટ કરીએ છીએ. આ એમ માની લે છે કે તમારા વર્કફ્લોમાં એક ટ્રિગર છે જે પ્રોડક્ટ ઑબ્જેક્ટ પ્રદાન કરે છે.
templateSuffix એ ટેમ્પ્લેટનું નામ છે જેને તમે પ્રોડક્ટ પર લાગુ કરવા માગો છો. ઉદાહરણ તરીકે, જો તમે pre-order ટેમ્પ્લેટ લાગુ કરવા માગતા હો, તો તમે templateSuffix ને pre-order પર સેટ કરશો.
{
"input": {
"templateSuffix": "pre-order",
"id": "{{product.id}}"
}
}ઉદાહરણ 2: ગ્રાહકની કર મુક્તિનું સ્ટેટસ અપડેટ કરો
આ ઉદાહરણમાં, અમે ગ્રાહકની કર મુક્તિનું સ્ટેટસ અપડેટ કરવા માટે customerUpdate મ્યુટેશનને કૉલ કરવા Admin API વિનંતી મોકલો ક્રિયાનો ઉપયોગ કરીશું.
id ફીલ્ડ આવશ્યક છે અને તે માન્ય ગ્રાહક GID હોવું જોઈએ. અહીં, અમે તેને {{order.customer.id}} લિક્વિડ ચલ સાથે સેટ કરીએ છીએ. આ એમ માની લે છે કે તમારા વર્કફ્લોમાં એક ટ્રિગર છે જે ઑર્ડર ઑબ્જેક્ટ પ્રદાન કરે છે.
taxExempt ફીલ્ડ એક બુલિયન છે જે ગ્રાહક કરમુક્ત છે કે નહીં તે સૂચવે છે. આ ઉદાહરણમાં, અમે તેને true પર સેટ કરીએ છીએ.
{
"input": {
"id": "{{order.customer.id}}",
"taxExempt": true
}
}ઉદાહરણ 3: ગ્રાહકનું લોકેલ અપડેટ કરો
આ ઉદાહરણમાં, અમે ગ્રાહકનું લોકેલ અપડેટ કરવા માટે customerUpdate મ્યુટેશનને કૉલ કરવા Admin API વિનંતી મોકલો ક્રિયાનો ઉપયોગ કરીશું.
id ફીલ્ડ આવશ્યક છે અને તે માન્ય ગ્રાહક GID હોવું જોઈએ. અહીં, અમે તેને {{customer.id}} લિક્વિડ ચલ સાથે સેટ કરીએ છીએ. આ એમ માની લે છે કે તમારા વર્કફ્લોમાં એક ટ્રિગર છે જે ગ્રાહક ઑબ્જેક્ટ પ્રદાન કરે છે.
locale ફીલ્ડ એ એક સ્ટ્રિંગ છે જે ગ્રાહકના લોકેલને રજૂ કરે છે. આ ઉદાહરણમાં, અમે તેને en પર સેટ કરીએ છીએ.
{
"input": {
"id": "{{customer.id}}",
"locale": "en"
}
}Liquid ટિપ્સ
Flow json લિક્વિડ ફિલ્ટરને સપોર્ટ કરે છે જે ઇનપુટ બનાવવામાં ઉપયોગી થઈ શકે છે. નીચેના તમામ ઉદાહરણો customerUpdate મ્યુટેશનનો ઉપયોગ કરે છે અને એમ માની લે છે કે તમારા વર્કફ્લોમાં એક ટ્રિગર છે જે ગ્રાહક ઑબ્જેક્ટ પ્રદાન કરે છે.
સ્ટ્રિંગ સાથે કાર્ય કરવું
નીચેનું ઉદાહરણ ગ્રાહક વિશેની નોંધ અપડેટ કરે છે:
{% assign revisedNote = customer.note | append: " Hello from Flow!" %}
{
"input": {
"id": "{{ customer.id }}",
"note": {{ revisedNote | json }},
}
}યોગ્ય JSON સુનિશ્ચિત કરવા માટે json ફિલ્ટર સ્ટ્રિંગને એસ્કેપ કરે છે. આના પરિણામે વર્કફ્લો રન થયા પછી નીચેનું JSON બને છે:
{
"input": {
"id": "gid://shopify/Customer/1234",
"note": "Had a \"great experience\" with their latest order. Hello from Flow!",
}
}ઍરે સાથે કાર્ય કરવું
ઍરે ઉદાહરણ
json ફિલ્ટર લિક્વિડ ઍરેને JSON ઍરેમાં રૂપાંતરિત કરે છે. નીચેનું ઉદાહરણ લિક્વિડ ઍરે પ્રદાન કરવામાં આવે ત્યારે JSON ઍરે આઉટપુટ કરે છે:
{% assign tags = "tag1,tag2,tag3" | split: "," %}
{
"input": {
"id": "{{ customer.id }}",
"tags": {{ tags | json }}
}
}આના પરિણામે વર્કફ્લો રન થયા પછી નીચેનું JSON બને છે:
{
"input": {
"id": "gid://shopify/Customer/1234",
"tags": ["tag1","tag2","tag3"]
}
}For લૂપ ઉદાહરણ
નીચેનું ઉદાહરણ અલ્પવિરામ દ્વારા અલગ કરીને, ઍરેના ઘટકોને આઉટપુટ કરવા માટે લૂપનો ઉપયોગ કરે છે:
{% assign tags = "tag1,tag2,tag3" | split: "," %}
{
"input": {
"id": "{{ customer.id }}",
"tags": [
{% for tag in tags %}
"{{ tag }}"{% unless forloop.last %},{% endunless %}
{% endfor %}
]
}
}જ્યારે વર્કફ્લો રન થાય છે ત્યારે આના પરિણામે નીચેનું JSON બને છે:
{
"input": {
"id": "gid://shopify/Customer/1234",
"tags": [
"tag1",
"tag2",
"tag3"
]
}
}મેપ ઉદાહરણ
ઑબ્જેક્ટના ઍરેમાંથી ચોક્કસ પ્રોપર્ટીનો ઍરે મેળવવા માટે map ફિલ્ટરનો ઉપયોગ કરી શકાય છે. નીચેના ઉદાહરણમાં, ગ્રાહકના સરનામાના ઍરેમાંથી city પ્રોપર્ટીઝનો ઍરે કાઢવામાં આવ્યો છે:
{
"input": {
"id": "{{ customer.id }}",
"tags": {{ customer.addresses | map: "city" | json }}
}
}આના પરિણામે વર્કફ્લો રન થયા પછી નીચેનું JSON બને છે:
{
"input": {
"id": "gid://shopify/Customer/1234",
"tags": ["Ottawa","Toronto"]
}
}મર્યાદાઓ
Admin API વિનંતી મોકલો ક્રિયાની નીચે મુજબની મર્યાદાઓ છે:
- ક્રિયા Flow દ્વારા ઉપયોગમાં લેવાતા Admin API વર્ઝનમાંથી
MutationsઅનેMutation inputsની સૂચિ પ્રદર્શિત કરશે. - જ્યારે નવા API વર્ઝન રિલીઝ કરવામાં આવે છે, જો આ ક્રિયા એવા મ્યુટેશન અથવા ફીલ્ડનો ઉપયોગ કરતી હોય જેને બદલવામાં આવ્યાં હોય અથવા નાપસંદ કરવામાં આવ્યાં હોય, તો તે નિષ્ફળ થઈ શકે છે.
- ક્રિયા GraphQL ક્વેરીને સપોર્ટ કરતી નથી, માત્ર મ્યુટેશનને સપોર્ટ કરે છે.
- ક્રિયા નાપસંદ કરવામાં આવેલા મ્યુટેશનને સપોર્ટ કરતી નથી.
- ક્રિયા અમુક ઍપ માટે વિશિષ્ટ હોય તેવા કેટલાક મ્યુટેશનને સપોર્ટ કરતી નથી, જેમાં કેટલાક સબ્સ્ક્રિપ્શન, માર્કેટિંગ પ્રવૃત્તિ અને ડિસ્કાઉન્ટ મ્યુટેશન શામેલ છે.
- ક્રિયા અસિંક્રોનસ મ્યુટેશન અથવા
Jobપ્રકાર રિટર્ન કરતા મ્યુટેશનને સપોર્ટ કરતી નથી. - ક્રિયા એવા મ્યુટેશનને સપોર્ટ કરતી નથી જે નોડ ઇન્ટરફેસને અમલમાં મૂકતા નથી.
ટેમ્પ્લેટ
નવા ઑર્ડરમાં મફત (100% ડિસ્કાઉન્ટવાળી) આઇટમ ઉમેરો
જો આઇટમ સ્ટૉકમાં હોય તો આ ટેમ્પ્લેટ નવા ઑર્ડરમાં મફત, ડિસ્કાઉન્ટવાળી આઇટમ ઉમેરે છે. તે ઇન્વેન્ટરી તપાસે છે, 100% ડિસ્કાઉન્ટ લાગુ કરે છે અને ગ્રાહકને સૂચિત કર્યા વિના ઑર્ડરને અપડેટ કરે છે. આ ઑટોમેશન આના માટે ઉપયોગી થશે (1) તેમના ઑર્ડરમાં મફત સરપ્રાઇઝ આઇટમ સામેલ કરીને ગ્રાહકનો સંતોષ વધારવો, (2) ઑર્ડરમાં મફત નમૂનાઓ તરીકે ઉમેરીને નવી અથવા ઓછી જાણીતી પ્રોડક્ટ્સનો પ્રચાર કરવો અથવા (3) મફત આઇટમનો સમાવેશ અને ડિસ્કાઉન્ટ ઑટોમેટ કરીને પ્રમોશનને સુવ્યવસ્થિત કરવા. ટેમ્પ્લેટ જુઓ
કંપની એકાઉન્ટ વિનંતીઓ દ્વારા બનાવવામાં આવેલ કંપનીઓ માટે ઑર્ડરિંગની મંજૂરી આપો
જ્યારે કંપની એકાઉન્ટની વિનંતી દ્વારા કંપની બનાવવામાં આવે, ત્યારે ઑર્ડરિંગ પરવાનગી અસાઇન કરો. ટેમ્પ્લેટ જુઓ
જ્યારે વેરિઅન્ટ આઉટ ઑફ સ્ટૉક હોય અથવા ફરીથી સ્ટૉકમાં આવે, ત્યારે પ્રોડક્ટનું ટેમ્પ્લેટ બદલો
પ્રોડક્ટના વેરિઅન્ટ્સ માટેની ઇન્વેન્ટરીના આધારે પ્રોડક્ટનું ટેમ્પ્લેટ અપડેટ કરો. આ વર્કફ્લો તમને ઇન સ્ટૉક (સ્ટોરનું ડિફૉલ્ટ ટેમ્પ્લેટ), આઉટ ઑફ સ્ટૉક અને જ્યારે એક કે તેથી વધુ વેરિઅન્ટ આઉટ ઑફ સ્ટૉક હોય, તેના ટેમ્પ્લેટ્સ વચ્ચે સ્વિચ કરવાની મંજૂરી આપે છે. ટેમ્પ્લેટ જુઓ
ઑર્ડરમાંની કોઈપણ ડિજિટલ આઇટમ પૂર્ણ કરો
એવી કોઈપણ આઇટમ કે જેને ભૌતિક ડિલિવરીની જરૂર ન હોય તેને પૂર્ણ કરે છે, જેમ કે ડિજિટલ આઇટમ્સ અથવા એવી આઇટમ જે SKU ની સૂચિ સાથે મેળ ખાતી હોય. તે નવા ઑર્ડર માટે દરેક ફુલફિલમેન્ટ લોકેશન ('ફુલફિલમેન્ટ ઑર્ડર') માટે એકવાર રન થાય છે. ટેમ્પ્લેટ જુઓ