Shopify (Independent Publisher) (Vorschau)
REST-Schnittstelle für Shopifys Händler, um ihre Bestellungen zu empfangen, zu verarbeiten und zu verwalten.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Microsoft Dynamics |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| bennettray@microsoft.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Ray Bennett (MSFT) |
| Webseite | https://www.shopify.com/ |
| Datenschutzrichtlinie | https://www.shopify.com/legal/privacy |
| Kategorien | Produktivität |
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| API-Schlüssel | securestring | Das Zugriffstoken für diese API. | Richtig |
| Store-URL | Schnur | Shopify Store-URL | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Aktualisiert eine Bestellung |
Aktualisiert eine Bestellung mit den bereitgestellten Informationen. |
| Ruft eine Kundenliste ab. |
Ruft eine Liste von Kunden ab, die den angegebenen Kriterien entsprechen |
| Ruft eine Liste von Bestellungen ab. |
Ruft eine Liste von Bestellungen ab, die den angegebenen Kriterien entsprechen |
| Stornieren einer Bestellung |
Stornieren sie eine Bestellung nach ID. |
Aktualisiert eine Bestellung
Aktualisiert eine Bestellung mit den bereitgestellten Informationen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Auftrags-ID
|
order_id | True | string |
ID der Bestellung, die aktualisiert wird. |
|
|
object |
Gibt zurück
Bestellung
- Body
- order
Ruft eine Kundenliste ab.
Ruft eine Liste von Kunden ab, die den angegebenen Kriterien entsprechen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kunden-IDs
|
ids | string |
Beschränken Sie die Ergebnisse auf Kunden, die durch eine durch Kommas getrennte Liste von IDs angegeben wurden. |
|
|
Seit ID
|
since_id | string |
Beschränken Sie die Ergebnisse nach der angegebenen ID. |
|
|
Erstellt bei Min.
|
created_at_min | string |
Kunden anzeigen, die nach einem angegebenen Datum erstellt wurden (Format: 2014-04-25T16:15:47-04:00). |
|
|
Erstellt bei max.
|
created_at_max | string |
Kunden anzeigen, die vor einem angegebenen Datum erstellt wurden (Format: 2014-04-25T16:15:47-04:00). |
|
|
Aktualisiert bei Min.
|
updated_at_min | string |
Kunden anzeigen, die nach einem angegebenen Datum zuletzt aktualisiert wurden (Format: 2014-04-25T16:15:47-04:00). |
|
|
Max. Aktualisiert
|
updated_at_max | string |
Kunden anzeigen, die zuletzt vor einem angegebenen Datum aktualisiert wurden (Format: 2014-04-25T16:15:47-04:00). |
|
|
Limit
|
limit | string |
Die maximale Anzahl der anzuzeigenden Ergebnisse. (Standard: 50)(maximal 250). |
|
|
Felder
|
fields | string |
Nur bestimmte Felder anzeigen, die durch eine durch Kommas getrennte Liste von Feldern angegeben werden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
customers
|
customers | array of customer |
Ruft eine Liste von Bestellungen ab.
Ruft eine Liste von Bestellungen ab, die den angegebenen Kriterien entsprechen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Bestell-IDs
|
ids | string |
Rufen Sie nur Bestellungen ab, die durch eine durch Kommas getrennte Liste von Bestell-IDs angegeben sind. |
|
|
Limit
|
limit | string |
Die maximale Anzahl der Ergebnisse, die auf einer Seite angezeigt werden sollen. |
|
|
Seit ID
|
since_id | string |
Bestellungen nach der angegebenen ID anzeigen. |
|
|
Erstellt bei Min.
|
created_at_min | string |
Bestellungen anzeigen, die am oder nach dem Datum erstellt wurden (Format: 2014-04-25T16:15:47-04:00). |
|
|
Erstellt bei max.
|
created_at_max | string |
Bestellungen anzeigen, die am oder vor dem Datum erstellt wurden (Format: 2014-04-25T16:15:47-04:00). |
|
|
Aktualisiert bei Min.
|
updated_at_min | string |
Bestellungen anzeigen, die zuletzt am oder nach datum aktualisiert wurden (Format: 2014-04-25T16:15:47-04:00). |
|
|
Max. Aktualisiert
|
updated_at_max | string |
Bestellungen anzeigen, die zuletzt am oder vor dem Datum aktualisiert wurden (Format: 2014-04-25T16:15:47-04:00). |
|
|
Verarbeitet in Min.
|
processed_at_min | string |
Bestellungen anzeigen, die nach oder nach dem Datum importiert wurden (Format: 2014-04-25T16:15:47-04:00). |
|
|
Max. verarbeitet
|
processed_at_max | string |
Bestellungen anzeigen, die zu oder vor dem Datum importiert wurden (Format: 2014-04-25T16:15:47-04:00). |
|
|
Attributions-App-ID
|
attribution_app_id | string |
Anzeigen von Bestellungen, die einer bestimmten App zugeordnet sind, angegeben durch die App-ID. |
|
|
Bestellstatus
|
status | string |
Filtern Sie Bestellungen nach ihrem Status. |
|
|
Finanzstatus
|
financial_status | string |
Filtern Sie Bestellungen nach ihrem Finanzstatus. |
|
|
Erfüllungsstatus
|
fulfillment_status | string |
Filtern Sie Bestellungen nach ihrem Erfüllungsstatus. |
|
|
Felder
|
fields | string |
Rufen Sie nur bestimmte Felder ab, die durch eine durch Kommas getrennte Liste von Feldern angegeben werden. |
|
|
Sequenzreihenfolge von Datensätzen
|
order | string |
Feld und Richtung für Sortierreihenfolgen. Um die Richtung anzugeben, fügen Sie am Ende des Abfrageparameters 'asc' oder 'desc' hinzu. Z. B. "order=updated_at asc". |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
orders
|
orders | array of order |
Stornieren einer Bestellung
Stornieren sie eine Bestellung nach ID.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Auftrags-ID
|
order_id | True | string |
ID der Bestellung, die storniert wird. |
|
Erstattung Der tatsächliche Betrag
|
amount | string |
Der Betrag, der erstattet werden soll. Bei Festlegung versucht Shopify, die Zahlung je nach Status zu stornieren oder zurückzuerstatten. Shopify erstattet über ein manuelles Gateway in Fällen, in denen die ursprüngliche Transaktion nicht in Shopify getätigt wurde. Rückerstattungen über ein manuelles Gateway werden als Rückerstattung auf Shopify aufgezeichnet, aber der Kunde wird nicht erstattet. |
|
|
Erstattungswährung
|
currency | string |
Die Währung der Rückerstattung, die ausgegeben wird, wenn die Bestellung storniert wird. Erforderlich für Bestellungen mit mehreren Währungen, wenn die Betragseigenschaft angegeben wird. |
|
|
Zurückbezahlte Artikel
|
restock | string |
Gibt an, ob Die Artikel zurück in den Bestand Ihres Stores zurückgepostet werden sollen. |
|
|
Bestellungsabbruchgrund
|
reason | string |
Der Grund für die Stornierung der Bestellung. Gültige Werte: Kunde, Bestand, Betrug, abgelehnt und andere. |
|
|
Stornierungs-E-Mail
|
string |
Gibt an, ob eine E-Mail an den Kunden gesendet werden soll, der sie über die Kündigung benachrichtigt. |
||
|
Erstattung
|
refund | string |
Die auszuführenden Erstattungstransaktionen. |
|
|
|
object |
Gibt zurück
Bestellung
- Body
- order
Definitionen
order
Bestellung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
Die ID der App, die die Bestellung erstellt hat. |
|
E-Mail
|
string |
Die E-Mail-Adresse des Kunden. |
|
|
closed_at
|
closed_at | string |
Datum und Uhrzeit (ISO 8601-Format) beim Schließen der Bestellung. Gibt NULL zurück, wenn die Reihenfolge nicht geschlossen ist. |
|
erstellt_am
|
created_at | string |
Der Drei-Buchstaben-Code (ISO 4217-Format) für die Shopwährung. |
|
updated_at
|
updated_at | string |
Datum und Uhrzeit (ISO 8601-Format) beim letzten Ändern der Bestellung. |
|
number
|
number | integer |
Die Position der Bestellung in der Anzahl der Bestellungen. Zahlen sind sequenziell und beginnen mit 1. |
|
Anmerkung
|
note | string |
Optionaler Hinweis, dass ein Shopbesitzer an die Bestellung anfügen kann. |
|
token
|
token | string |
Ein eindeutiger Wert beim Verweisen auf die Reihenfolge. |
|
Tor
|
gateway | string |
Das verwendete Zahlungsgateway. |
|
Test
|
test | boolean |
Gibt an, ob es sich um eine Testreihenfolge handelt. |
|
total_price
|
total_price | string |
Die Summe aller Artikelpreise, Rabatte, Versand, Steuern und Tipps in der Shopwährung. Muss positiv sein. |
|
subtotal_price
|
subtotal_price | string |
Der Preis der Bestellung in der Shopwährung nach Rabatten, aber vor Versand, Zöllen, Steuern und Tipps. |
|
total_weight
|
total_weight | integer |
Die Summe aller Linienartikelgewichte in Gramm. Die Summe wird nicht angepasst, da Elemente aus der Bestellung entfernt werden. |
|
total_tax
|
total_tax | string |
Die Summe aller Steuern, die auf die Bestellung in der Shopwährung angewendet wurden. Muss positiv sein. |
|
taxes_included
|
taxes_included | boolean |
Gibt an, ob Steuern in der Teilsumme der Bestellung enthalten sind. |
|
Währung
|
currency | string |
Der Drei-Buchstaben-Code (ISO 4217-Format) für die Shopwährung. |
|
financial_status
|
financial_status | string |
Der Status der Zahlungen, die der Bestellung zugeordnet sind. Kann nur festgelegt werden, wenn die Bestellung erstellt wird. |
|
bestätigt
|
confirmed | boolean |
Bestellung bestätigt. |
|
total_discounts
|
total_discounts | string |
Die Gesamtrabatte, die auf den Preis der Bestellung in der Shopwährung angewendet werden. |
|
total_line_items_price
|
total_line_items_price | string |
Die Summe aller Artikelpreise in der Shopwährung. |
|
cart_token
|
cart_token | string |
Ein eindeutiger Wert beim Verweisen auf den Warenkorb, der der Bestellung zugeordnet ist. |
|
buyer_accepts_marketing
|
buyer_accepts_marketing | boolean |
Ob der Kunde zustimmte, E-Mail-Updates aus dem Shop zu erhalten. |
|
name
|
name | string |
Der Auftragsname, der generiert wird, indem die order_number-Eigenschaft mit dem Bestellpräfix und Suffix kombiniert wird, die in den allgemeinen Einstellungen des Händlers festgelegt sind. |
|
referring_site
|
referring_site | string |
Die Website, auf der der Kunde auf einen Link zum Shop geklickt hat. |
|
landing_site
|
landing_site | string |
Die URL für die Seite, auf der der Käufer beim Betreten des Shops landete. |
|
cancelled_at
|
cancelled_at | string |
Das Datum und die Uhrzeit, zu dem die Bestellung storniert wurde. Gibt NULL zurück, wenn die Reihenfolge nicht abgebrochen wird. |
|
cancel_reason
|
cancel_reason | string |
Der Grund, warum die Bestellung storniert wurde. |
|
total_price_usd
|
total_price_usd | string |
Gesamtpreis usd. |
|
checkout_token
|
checkout_token | string |
Ein eindeutiger Wert beim Verweisen auf das Auschecken, das der Bestellung zugeordnet ist. |
|
reference
|
reference | string |
Bestellreferenz. |
|
user_id
|
user_id | integer |
Die ID des Benutzers meldete sich bei Shopify POS an, der die Bestellung verarbeitet hat, falls zutreffend. |
|
location_id
|
location_id | integer |
Die ID des physischen Standorts, an dem die Bestellung verarbeitet wurde. Wenn Sie auf den Standort anhand einer Bestellung verweisen müssen, verwenden Sie die FulfillmentOrder-Ressource. |
|
source_identifier
|
source_identifier | string |
Absenderkennung. |
|
source_url
|
source_url | string |
Quell-URL. |
|
processed_at
|
processed_at | string |
Datum und Uhrzeit (ISO 8601-Format) beim Verarbeiten einer Bestellung. |
|
device_id
|
device_id | string |
Die ID für das Gerät. |
|
phone
|
phone | string |
Die Telefonnummer des Kunden zum Empfangen von SMS-Benachrichtigungen. |
|
customer_locale
|
customer_locale | string |
Der Zwei- oder Drei-Buchstaben-Sprachcode, optional gefolgt von einem Regionsmodifizierer. |
|
app_id
|
app_id | integer |
Die ID der App, die die Bestellung erstellt hat. |
|
browser_ip
|
browser_ip | string |
Die IP-Adresse des Browsers, der vom Kunden verwendet wird, wenn er die Bestellung aufgegeben hat. |
|
landing_site_ref
|
landing_site_ref | string |
Zielwebsite-Referenz. |
|
order_number
|
order_number | integer |
Die Position der Bestellung in der Anzahl der Bestellungen ab 1001. |
|
discount_applications
|
discount_applications | discount_applications |
Die Beschreibung der Rabattanwendung, wie vom Händler oder dem Shopify-Skript definiert. |
|
discount_codes
|
discount_codes | discount_codes |
Eine Liste der Rabatte, die auf die Bestellung angewendet werden. |
|
note_attributes
|
note_attributes | note_attributes |
Zusätzliche Informationen, die der Bestellung hinzugefügt werden. |
|
payment_gateway_names
|
payment_gateway_names | payment_gateway_names |
Die Liste der Zahlungsgateways, die für die Bestellung verwendet werden. |
|
processing_method
|
processing_method | string |
Wie die Zahlung verarbeitet wurde. |
|
checkout_id
|
checkout_id | integer |
Auscheck-ID. |
|
source_name
|
source_name | string |
Wo die Bestellung entstanden ist. |
|
fulfillment_status
|
fulfillment_status | string |
Der Status der Bestellung in Bezug auf erfüllte Positionen. |
|
tax_lines
|
tax_lines | tax_lines |
Eine Liste der Steuerzeilenobjekte, von denen jede eine auf den Artikel angewendete Steuer enthält. |
|
tags
|
tags | string |
Tags, die an die Reihenfolge angefügt sind, formatiert als Zeichenfolge mit durch Trennzeichen getrennten Werten. Tags sind zusätzliche kurze Deskriptoren, die häufig zum Filtern und Suchen verwendet werden. |
|
contact_email
|
contact_email | string |
Kontakt-E-Mail. |
|
order_status_url
|
order_status_url | string |
Die URL, die auf die Bestellstatuswebseite verweist, falls zutreffend. |
|
presentment_currency
|
presentment_currency | string |
Die Aktuelle Währung, die zum Anzeigen der Preise für den Kunden verwendet wurde. |
|
total_line_items_price_set
|
total_line_items_price_set | subtotal_tax_discount_price_set | |
|
total_discounts_set
|
total_discounts_set | subtotal_tax_discount_price_set | |
|
total_shipping_price_set
|
total_shipping_price_set | subtotal_tax_discount_price_set | |
|
subtotal_price_set
|
subtotal_price_set | subtotal_tax_discount_price_set | |
|
total_price_set
|
total_price_set | subtotal_tax_discount_price_set | |
|
total_tax_set
|
total_tax_set | subtotal_tax_discount_price_set | |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Id der Graphql-API des Administrators. |
|
shipping_lines
|
shipping_lines | shipping_lines |
Details dazu, welche Versandmethode verwendet wird. |
|
billing_address
|
billing_address | billing_address |
Die Postanschrift, die der Zahlungsmethode zugeordnet ist. Diese Adresse ist ein optionales Feld, das für Bestellungen nicht verfügbar ist, für die keine Zahlungsmethode erforderlich ist. |
|
shipping_address
|
shipping_address | shipping_address |
Die Postanschrift, an die die Bestellung versandt wird. Diese Adresse ist optional und ist nicht für Bestellungen verfügbar, für die kein Versand erforderlich ist. |
|
client_details
|
client_details | client_detail |
Informationen über den Browser, den der Kunde bei der Bestellung verwendet hat. |
|
payment_details
|
payment_details | payment_detail |
Ein Objekt, das Informationen über die Zahlung enthält. |
|
Kunde
|
customer | customer |
Informationen zum Kunden. |
|
line_items
|
line_items | line_items | |
|
Erfüllungen
|
fulfillments | fulfillments |
Ein Array von Erfüllungen, die der Bestellung zugeordnet sind. |
|
Zurückzahlungen
|
refunds | refunds |
Zurückzahlungen |
Kunde
Informationen zum Kunden.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
Ein eindeutiger Bezeichner für den Kunden. |
|
E-Mail
|
string |
Die eindeutige E-Mail-Adresse des Kunden. Beim Versuch, mehreren Kunden dieselbe E-Mail-Adresse zuzuweisen, wird ein Fehler zurückgegeben. |
|
|
accepts_marketing
|
accepts_marketing | boolean |
Ob der Kunde zustimmte, Marketingmaterial per E-Mail zu erhalten. |
|
erstellt_am
|
created_at | string |
Datum und Uhrzeit (ISO 8601-Format) beim Erstellen des Kunden. |
|
updated_at
|
updated_at | string |
Datum und Uhrzeit (ISO 8601-Format), als die Kundeninformationen zuletzt aktualisiert wurden. |
|
first_name
|
first_name | string |
Der Vorname des Kunden. |
|
last_name
|
last_name | string |
Der Nachname des Kunden. |
|
orders_count
|
orders_count | integer |
Die Anzahl der Bestellungen, die diesem Kunden zugeordnet sind. |
|
Staat
|
state | string |
Der Status des Kundenkontos mit einem Shop. Standardwert: deaktiviert. |
|
total_spent
|
total_spent | string |
Der Gesamtbetrag des Geldes, das der Kunde im gesamten Bestellverlauf ausgegeben hat. |
|
last_order_id
|
last_order_id | integer |
Die ID der letzten Bestellung des Kunden. |
|
Anmerkung
|
note | string |
Eine Notiz zum Kunden. |
|
verified_email
|
verified_email | boolean |
Gibt an, ob der Kunde seine E-Mail-Adresse überprüft hat. |
|
multipass_identifier
|
multipass_identifier | string |
Ein eindeutiger Bezeichner für den Kunden, der mit der Multipass-Anmeldung verwendet wird. |
|
tax_exempt
|
tax_exempt | boolean |
Gibt an, ob der Kunde von der Zahlung von Steuern auf seine Bestellung befreit ist. Wenn true, werden Steuern nicht auf eine Bestellung beim Auschecken angewendet. Wenn falsch, werden Steuern beim Auschecken angewendet. |
|
phone
|
phone | string |
Die eindeutige Telefonnummer (E.164-Format) für diesen Kunden. Beim Versuch, mehrere Kunden dieselbe Telefonnummer zuzuweisen, wird ein Fehler zurückgegeben. |
|
tags
|
tags | string |
Tags, die der Shopbesitzer dem Kunden zugeordnet hat, formatiert als Zeichenfolge mit durch Trennzeichen getrennten Werten. Ein Kunde kann bis zu 250 Tags haben. Jedes Tag kann bis zu 255 Zeichen enthalten. |
|
last_order_name
|
last_order_name | string |
Der Name der letzten Bestellung des Kunden. Dies ist direkt mit dem Namensfeld in der Order-Ressource verknüpft. |
|
Währung
|
currency | string |
Der Drei-Buchstaben-Code (ISO 4217-Format) für die Währung, die der Kunde beim Bezahlen für seine letzte Bestellung verwendet hat. |
|
Adressen
|
addresses | addresses |
Eine Liste der zehn zuletzt aktualisierten Adressen für den Kunden. |
|
accepts_marketing_updated_at
|
accepts_marketing_updated_at | string |
Das Datum und die Uhrzeit (ISO 8601-Format), wenn der Kunde dem Empfang von Marketingmaterial per E-Mail zugestimmt oder widersprochen hat. |
|
marketing_opt_in_level
|
marketing_opt_in_level | string |
Die Opt-In-Ebene des Marketingabonnements, die der Kunde gegeben hat, als er zugestimmt hat, Marketingmaterial per E-Mail zu erhalten. |
|
tax_exemptions
|
tax_exemptions | array of |
Gibt an, ob der Kunde von der Zahlung bestimmter Steuern für seine Bestellung befreit ist. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Id der Graphql-API des Administrators. |
|
default_address
|
default_address | default_address |
default_address
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
Ein eindeutiger Bezeichner für die Adresse. |
|
Kunden_ID
|
customer_id | integer |
Ein eindeutiger Bezeichner für den Kunden. |
|
first_name
|
first_name | string |
Der Vorname des Kunden. |
|
last_name
|
last_name | string |
Der Nachname des Kunden. |
|
Firma
|
company | string |
Das Unternehmen des Kunden. |
|
Adresse1
|
address1 | string |
Die erste Zeile der Postanschrift des Kunden. |
|
adresse2
|
address2 | string |
Ein zusätzliches Feld für die Postanschrift des Kunden. |
|
city
|
city | string |
Die Stadt, die Stadt oder das Dorf des Kunden. |
|
Provinz
|
province | string |
Der Name der Region des Kunden. In der Regel eine Provinz, ein Staat oder eine Präfektur. |
|
country
|
country | string |
Das Land des Kunden. |
|
zip
|
zip | string |
Die Postleitzahl des Kunden, auch bekannt als Postleitzahl, Postleitzahl, Eircode usw. |
|
phone
|
phone | string |
Die Telefonnummer des Kunden unter dieser Adresse. |
|
name
|
name | string |
Die Vor- und Nachnamen des Kunden. |
|
province_code
|
province_code | string |
Der Zwei-Buchstaben-Code für die Region des Kunden. |
|
country_code
|
country_code | string |
Der Zwei-Buchstaben-Ländercode, der dem Land des Kunden entspricht. |
|
country_name
|
country_name | string |
Der normalisierte Landname des Kunden. |
|
Standardeinstellung
|
default | boolean |
Gibt "true" für jede Standardadresse zurück. |
shipping_address
Die Postanschrift, an die die Bestellung versandt wird. Diese Adresse ist optional und ist nicht für Bestellungen verfügbar, für die kein Versand erforderlich ist.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
first_name
|
first_name | string |
Der Vorname der Person, die der Lieferadresse zugeordnet ist. |
|
Adresse1
|
address1 | string |
Die Anschrift der Versandadresse. |
|
phone
|
phone | string |
Die Telefonnummer an der Versandadresse. |
|
city
|
city | string |
Die Stadt, Die Stadt oder das Dorf der Versandadresse. |
|
zip
|
zip | string |
Die Postleitzahl (z. B. Postleitzahl, Postleitzahl oder Eircode) der Versandadresse. |
|
Provinz
|
province | string |
Der Name der Region (z. B. Provinz, Bundesland oder Präfektur) der Versandadresse. |
|
country
|
country | string |
Der Name des Landes der Lieferadresse. |
|
last_name
|
last_name | string |
Der Nachname der Person, die der Versandadresse zugeordnet ist. |
|
adresse2
|
address2 | string |
Ein optionales zusätzliches Feld für die Straße der Versandadresse. |
|
Firma
|
company | string |
Die Firma der Person, die der Versandadresse zugeordnet ist. |
|
latitude
|
latitude | float |
Der Breitengrad der Versandadresse. |
|
longitude
|
longitude | float |
Der Längengrad der Versandadresse. |
|
name
|
name | string |
Der vollständige Name der Person, die der Zahlungsmethode zugeordnet ist. |
|
country_code
|
country_code | string |
Der Zwei-Buchstaben-Code (ISO 3166-1-Format) für das Land der Versandadresse. |
|
province_code
|
province_code | string |
Die Zwei-Buchstaben-Abkürzung der Region der Versandadresse. |
billing_address
Die Postanschrift, die der Zahlungsmethode zugeordnet ist. Diese Adresse ist ein optionales Feld, das für Bestellungen nicht verfügbar ist, für die keine Zahlungsmethode erforderlich ist.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
first_name
|
first_name | string |
Der Vorname der Person, die der Zahlungsmethode zugeordnet ist. |
|
Adresse1
|
address1 | string |
Die Anschrift der Rechnungsadresse. |
|
phone
|
phone | string |
Die Telefonnummer an der Rechnungsadresse. |
|
city
|
city | string |
Die Stadt, die Stadt oder das Dorf der Rechnungsadresse. |
|
zip
|
zip | string |
Die Postleitzahl (z. B. Postleitzahl, Postleitzahl oder Eircode) der Rechnungsadresse. |
|
Provinz
|
province | string |
Der Name der Region (z. B. Provinz, Bundesland oder Präfektur) der Rechnungsadresse. |
|
country
|
country | string |
Der Name des Landes der Rechnungsadresse. |
|
last_name
|
last_name | string |
Der Nachname der Person, die der Zahlungsmethode zugeordnet ist. |
|
adresse2
|
address2 | string |
Ein optionales zusätzliches Feld für die Adresse der Rechnungsadresse. |
|
Firma
|
company | string |
Das Unternehmen der Person, die der Rechnungsadresse zugeordnet ist. |
|
latitude
|
latitude | float |
Der Breitengrad der Rechnungsadresse. |
|
longitude
|
longitude | float |
Der Längengrad der Rechnungsadresse. |
|
name
|
name | string |
Der vollständige Name der Person, die der Zahlungsmethode zugeordnet ist. |
|
country_code
|
country_code | string |
Der Zwei-Buchstaben-Code (ISO 3166-1-Format) für das Land der Rechnungsadresse. |
|
province_code
|
province_code | string |
Die zweischreibende Abkürzung der Region der Rechnungsadresse. |
Adressen
Eine Liste der zehn zuletzt aktualisierten Adressen für den Kunden.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
default_address |
shipping_line
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
Ein global eindeutiger Bezeichner. |
|
title
|
title | string |
Der Titel der Versandmethode. |
|
Preis
|
price | string |
Der Preis dieser Versandmethode in der Shopwährung. |
|
Code
|
code | string |
Ein Verweis auf die Versandmethode. |
|
source
|
source | string |
Die Quelle der Versandmethode. |
|
phone
|
phone | string |
Die Telefonnummer an der Versandadresse. |
|
requested_fulfillment_service_id
|
requested_fulfillment_service_id | string |
Ein Verweis auf den Erfüllungsdienst, der für die Versandmethode angefordert wird. Vorhanden, wenn die Versandmethode die Verarbeitung durch einen Drittanbieter-Erfüllungsdienst erfordert; andernfalls null. |
|
delivery_category
|
delivery_category | string |
Lieferkategorie. |
|
carrier_identifier
|
carrier_identifier | string |
Ein Verweis auf den Netzbetreiberdienst, der den Tarif bereitgestellt hat. Vorhanden, als die Rate von einem Drittanbieterdienst berechnet wurde. |
|
discounted_price
|
discounted_price | string |
Der Preis der Versandmethode nach Abschlägen auf Zeilenebene wurde angewendet. Gibt keine Rabatte auf Einkaufswagen- oder Bestellebene an. |
|
price_set
|
price_set | subtotal_tax_discount_price_set | |
|
discounted_price_set
|
discounted_price_set | subtotal_tax_discount_price_set | |
|
discount_allocations
|
discount_allocations | array of |
Eine sortierte Liste der Beträge, die von Rabattanwendungen zugewiesen werden. |
|
tax_lines
|
tax_lines | tax_lines |
Eine Liste der Steuerzeilenobjekte, von denen jede eine auf den Artikel angewendete Steuer enthält. |
client_detail
Informationen über den Browser, den der Kunde bei der Bestellung verwendet hat.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
browser_ip
|
browser_ip | string |
Die IP-Adresse des Browsers. |
|
accept_language
|
accept_language | string |
Die Sprachen und Gebietsschemas, die der Browser versteht. |
|
user_agent
|
user_agent | string |
Details des Browserclients, einschließlich Software und Betriebssystemversionen. |
|
session_hash
|
session_hash | string |
Ein Hash der Sitzung. |
|
browser_width
|
browser_width | integer |
Die Bildschirmbreite des Browsers in Pixel, falls verfügbar. |
|
browser_height
|
browser_height | integer |
Die Bildschirmhöhe des Browsers in Pixel, falls verfügbar. |
payment_detail
Ein Objekt, das Informationen über die Zahlung enthält.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
credit_card_bin
|
credit_card_bin | string |
Die Ausstelleridentifikationsnummer (IIN), früher bekannt als Bankidentifikationsnummer (BIN), der Kreditkarte des Kunden. |
|
avs_result_code
|
avs_result_code | string |
Der Antwortcode aus dem Adressüberprüfungssystem (AVS). Der Code ist ein einzelner Buchstabe. |
|
cvv_result_code
|
cvv_result_code | string |
Der Antwortcode des Kreditkartenunternehmens gibt an, ob der Kunde den Kartensicherheitscode (Kartenüberprüfungswert) richtig eingegeben hat. Der Code ist ein einzelner Buchstabe oder eine leere Zeichenfolge. |
|
credit_card_number
|
credit_card_number | string |
Die Kreditkartennummer des Kunden, wobei die meisten der führenden Ziffern redigiert sind. |
|
credit_card_company
|
credit_card_company | string |
Der Name des Unternehmens, das die Kreditkarte des Kunden ausgestellt hat. |
subtotal_tax_discount_price_set
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Menge
|
shop_money.amount | string |
Der tatsächliche Betrag. |
|
currency_code
|
shop_money.currency_code | string |
Im ISO 4217-Format. |
|
Menge
|
presentment_money.amount | string |
Der tatsächliche Betrag. |
|
currency_code
|
presentment_money.currency_code | string |
Im ISO 4217-Format. |
line_item_property
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string |
Der Produktname. |
|
value
|
value | string |
Der Produktwert. |
line_item_properties
Eigenschaften.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
line_item_property |
Erfüllung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
Die ID für die Erfüllung. |
|
order_id
|
order_id | integer |
Der eindeutige numerische Bezeichner für die Reihenfolge. |
|
status
|
status | string |
Der Status der Erfüllung. |
|
erstellt_am
|
created_at | string |
Das Datum und die Uhrzeit, zu dem die Erfüllung erstellt wurde. |
|
Dienstleistung
|
service | string |
Der Typ des verwendeten Diensts. |
|
updated_at
|
updated_at | string |
Datum und Uhrzeit (ISO 8601-Format), als die Erfüllung zuletzt geändert wurde. |
|
tracking_company
|
tracking_company | string |
Der Name des Tracking-Unternehmens. |
|
shipment_status
|
shipment_status | string |
Der aktuelle Lieferstatus der Erfüllung. |
|
location_id
|
location_id | integer |
Der eindeutige Bezeichner des Standorts, für den die Erfüllung verarbeitet werden soll. |
|
tracking_number
|
tracking_number | string |
Eine Tracking-Nummer, die vom Versandunternehmen bereitgestellt wird. |
|
tracking_numbers
|
tracking_numbers | array of string |
Eine Liste der Nachverfolgungsnummern, die vom Versandunternehmen bereitgestellt werden. |
|
tracking_url
|
tracking_url | string |
Die URL der Nachverfolgungsseite für die Erfüllung. |
|
tracking_urls
|
tracking_urls | array of string |
Die URLs der Tracking-Seiten für die Erfüllung. |
|
Beleg
|
receipt | receipt |
Ein Textfeld, das Informationen zum Beleg bereitstellt. |
|
name
|
name | string |
Der eindeutig identifizierte Erfüllungsname. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Id der Graphql-API des Administrators. |
|
line_items
|
line_items | line_items |
Erfüllungen
Ein Array von Erfüllungen, die der Bestellung zugeordnet sind.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
fulfillment |
transaction
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
Die ID für die Transaktion. |
|
order_id
|
order_id | integer |
Die ID für die Bestellung, der die Transaktion zugeordnet ist. |
|
freundlich
|
kind | string |
Der Transaktionstyp. |
|
Tor
|
gateway | string |
Der Name des Gateways, über das die Transaktion ausgestellt wurde. |
|
status
|
status | string |
Der Status der Buchung. |
|
message
|
message | string |
Eine vom Zahlungsanbieter generierte Zeichenfolge mit zusätzlichen Informationen dazu, warum die Transaktion erfolgreich war oder fehlgeschlagen ist. |
|
erstellt_am
|
created_at | string |
Datum und Uhrzeit (ISO 8601-Format) beim Erstellen der Transaktion. |
|
Test
|
test | boolean |
Gibt an, ob es sich bei der Transaktion um eine Testtransaktion handelt. |
|
Autorisierung
|
authorization | string |
Der Autorisierungscode, der der Transaktion zugeordnet ist. |
|
location_id
|
location_id | string |
Die ID des physischen Standorts, an dem die Transaktion verarbeitet wurde. |
|
user_id
|
user_id | string |
Die ID für den Benutzer, der bei dem Shopify POS-Gerät angemeldet wurde, als die Bestellung verarbeitet wurde, falls zutreffend. |
|
parent_id
|
parent_id | integer |
Die ID einer zugeordneten Transaktion. |
|
processed_at
|
processed_at | string |
Datum und Uhrzeit (ISO 8601-Format) beim Verarbeiten einer Transaktion. |
|
device_id
|
device_id | string |
Die ID für das Gerät. |
|
error_code
|
error_code | string |
Ein standardisierter Fehlercode, unabhängig vom Zahlungsanbieter. |
|
source_name
|
source_name | string |
Der Ursprung der Transaktion. Dies wird von Shopify festgelegt und kann nicht außer Kraft gesetzt werden. |
|
Menge
|
amount | string |
Der Betrag, der in der Transaktion enthalten ist. |
|
Währung
|
currency | string |
Der Drei-Buchstaben-Code (ISO 4217-Format) für die Währung, die für die Zahlung verwendet wird. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Id der Graphql-API des Administrators. |
Transaktionen
Eine Liste der Transaktionen, die an der Rückerstattung beteiligt sind.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
transaction |
tax_line
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Preis
|
price | string |
Der Steuerbetrag, der in der Shopwährung in Rechnung gestellt werden soll. |
|
Rate
|
rate | float |
Der Steuersatz, der angewendet werden soll. |
|
title
|
title | string |
Der Name der Steuer. |
|
price_set
|
price_set | subtotal_tax_discount_price_set |
tax_lines
Eine Liste der Steuerzeilenobjekte, von denen jede eine auf den Artikel angewendete Steuer enthält.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
tax_line |
Zurückzahlungen
Zurückzahlungen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
refund |
Erstattung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
Der eindeutige Bezeichner für die Rückerstattung. |
|
order_id
|
order_id | integer |
Die ID der Bestellung, die für API-Zwecke verwendet wird. |
|
erstellt_am
|
created_at | string |
Datum und Uhrzeit (ISO 8601-Format) beim Erstellen der Rückerstattung. |
|
Anmerkung
|
note | string |
Eine optionale Notiz, die einer Rückerstattung zugeordnet ist. |
|
user_id
|
user_id | integer |
Der eindeutige Bezeichner des Benutzers, der die Rückerstattung ausgeführt hat. |
|
processed_at
|
processed_at | string |
Datum und Uhrzeit (ISO 8601-Format) beim Importieren der Rückerstattung. |
|
wiederauffüllen
|
restock | boolean |
Gibt an, ob die Positionen wieder zum Bestand des Stores hinzugefügt werden sollen. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Id der Graphql-API des Administrators. |
|
Transaktionen
|
transactions | transactions |
Eine Liste der Transaktionen, die an der Rückerstattung beteiligt sind. |
|
order_adjustments
|
order_adjustments | array of |
Eine Liste der an die Rückerstattung angefügten Bestellanpassungen. |
line_item
Eine Liste von Zeilenelementobjekten, die jeweils Informationen zu einem Element in der Reihenfolge enthalten.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | integer |
Die ID des Zeilenelements. |
|
variant_id
|
variant_id | integer |
Die ID der Produktvariante. |
|
title
|
title | string |
Der Titel des Produkts. |
|
Menge
|
quantity | integer |
Die Anzahl der gekauften Artikel. |
|
sku
|
sku | string |
SKU des Artikels (Lagerhaltungseinheit). |
|
variant_title
|
variant_title | string |
Der Titel der Produktvariante. |
|
Verkäufer
|
vendor | string |
Der Name des Lieferanten des Artikels. |
|
fulfillment_service
|
fulfillment_service | string |
Der Dienstanbieter, der das Element erfüllt. |
|
product_id
|
product_id | integer |
Die ID des Produkts, zu dem die Position gehört. |
|
requires_shipping
|
requires_shipping | boolean |
Gibt an, ob der Artikel versand erforderlich ist. |
|
steuerpflichtig
|
taxable | boolean |
Gibt an, ob der Artikel steuerpflichtig ist. |
|
gift_card
|
gift_card | boolean |
Gibt an, ob es sich bei dem Artikel um eine Geschenkkarte handelt. |
|
name
|
name | string |
Der Name der Produktvariante. |
|
variant_inventory_management
|
variant_inventory_management | string |
Der Name des Bestandsverwaltungsdiensts. |
|
Eigenschaften
|
properties | line_item_properties |
Eigenschaften. |
|
product_exists
|
product_exists | boolean |
Gibt an, ob das Produkt vorhanden ist. |
|
fulfillable_quantity
|
fulfillable_quantity | integer |
Der zu erfüllende Betrag. |
|
Gramm
|
grams | integer |
Das Gewicht des Artikels in Gramm. |
|
Preis
|
price | string |
Der Preis des Artikels vor Rabatten wurde in der Shopwährung angewendet. |
|
total_discount
|
total_discount | string |
Der Gesamtbetrag des Rabatts, der der Position in der Shopwährung zugeordnet ist. |
|
fulfillment_status
|
fulfillment_status | string |
Der Status einer Bestellung in Bezug auf die zu erfüllenden Positionen. |
|
price_set
|
price_set | subtotal_tax_discount_price_set | |
|
total_discount_set
|
total_discount_set | subtotal_tax_discount_price_set | |
|
discount_allocations
|
discount_allocations | array of |
Eine sortierte Liste der Beträge, die von Rabattanwendungen zugewiesen werden. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Id der Graphql-API des Administrators. |
|
tax_lines
|
tax_lines | tax_lines |
Eine Liste der Steuerzeilenobjekte, von denen jede eine auf den Artikel angewendete Steuer enthält. |
line_items
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
line_item |
Eine Liste von Zeilenelementobjekten, die jeweils Informationen zu einem Element in der Reihenfolge enthalten. |
shipping_lines
Details dazu, welche Versandmethode verwendet wird.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
shipping_line |
payment_gateway_names
Die Liste der Zahlungsgateways, die für die Bestellung verwendet werden.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
string |
note_attribute
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
name
|
name | string |
Notiz-Attributname. |
|
value
|
value | string |
Wert des Note-Attributs. |
note_attributes
Zusätzliche Informationen, die der Bestellung hinzugefügt werden.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
note_attribute |
discount_code
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Code
|
code | string |
Wenn die zugeordnete Rabattanwendung vom TypCode ist, gibt diese Eigenschaft den Rabattcode zurück, der beim Auschecken eingegeben wurde. |
|
Menge
|
amount | string |
Der Betrag, der von der Bestellsumme abgezogen wird. Wenn Sie eine Bestellung erstellen, ist dieser Wert der Prozentsatz oder der Geldbetrag, der abgezogen werden soll. |
|
type
|
type | string |
Die Art des Rabatts. |
discount_codes
Eine Liste der Rabatte, die auf die Bestellung angewendet werden.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
discount_code |
discount_application
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
type
|
type | string |
Der Rabattanwendungstyp. |
|
value
|
value | string |
Der Wert der Rabattanwendung als Dezimalzahl. Dies stellt die Absicht der Rabattanwendung dar. |
|
value_type
|
value_type | string |
Der Typ des Werts. |
|
allocation_method
|
allocation_method | string |
Die Methode, mit der der Rabattanwendungswert anspruchsberechtigten Zeilen zugeordnet wurde. |
|
target_selection
|
target_selection | string |
Die Zeilen in der Bestellung des Typs, der durch target_type definiert wird, dass der Rabatt zugewiesen wird. |
|
target_type
|
target_type | string |
Die Art der Zeile in der Bestellung, für die der Rabatt gilt. |
|
Code
|
code | string |
Der Rabattcode, der zum Anwenden des Rabatts verwendet wurde. Nur für Rabattcodeanwendungen verfügbar. |
discount_applications
Die Beschreibung der Rabattanwendung, wie vom Händler oder dem Shopify-Skript definiert.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
discount_application |
Beleg
Ein Textfeld, das Informationen zum Beleg bereitstellt.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Testfall
|
testcase | boolean |
Ob die Erfüllung ein Testfall war. |
|
Autorisierung
|
authorization | string |
Der Autorisierungscode. |