Datenwörterbuch für die Shop-Migration

Das Datenwörterbuch für die Shop-Migration enthält Informationen über die Ressourcen Customer, Order und Product der REST-Admin-API. Es ist eine zusätzliche Referenz für erfahrene Partner, die Shops zu Shopify migrieren.

Customer Ressourceneigenschaften

In der folgenden Tabelle sind einige nützliche Informationen zu den Eigenschaften der Ressource Customer der REST-Admin-API aufgeführt.

Daten zu wichtigen Eigenschaften der Ressource "Customer" der REST-API
Eigenschaft Werte Beschreibung Datentyp Feldlänge Zugriff auf das Feld Wichtiges Pflichtfeld
accepts_marketing Standardwert: 0 Gibt an, ob der Kunde zugestimmt hat, Marketingmaterial zu erhalten. Boolescher Wert tinyint(1) J
accepts_marketing_
updated_at
Der Zeitpunkt (Datum und Uhrzeit im ISO 8601-Format), zu dem der Kunde dem Erhalt von Marketingmaterial per E-Mail zugestimmt oder den Erhalt abgelehnt hat. DateTime
Adressen Eine Liste von Adressen, die mit dem Kunden verknüpft sind. [{ Address }]
Währung Der aus drei Buchstaben bestehende Code im ISO 4217-Format für die Währung, die der Kunde bei der Bezahlung seiner letzten Bestellung verwendet hat. String Shop-Währung schreibgeschützt
created_at Standardwert: NULL Der Zeitpunkt (Datum und Uhrzeit im ISO 8601-Format), zu dem der Kunde zum Shop hinzugefügt wurde. DateTime datetime schreibgeschützt
default_address Die Standardadresse für den Kunden. { Address }
email Standardwert: NULL Die eindeutige E-Mail-Adresse des Kunden. String varchar(255)
first_name Standardwert: NULL Der Vorname des Kunden. String varchar(255)
id Standardwert: NULL Eine global eindeutige ID. (Dieser Wert wird automatisch erhöht.) Ganze Zahl bigint(20) J
last_name Standardwert: NULL Der Nachname des Kunden. String varchar(255)
last_order_id Standardwert: NULL Die ID der letzten Bestellung des Kunden. Ganze Zahl bigint(20) schreibgeschützt
last_order_name Standardwert: NULL Der Name der letzten Bestellung des Kunden. String schreibgeschützt
metafield Standardwert: NULL Gibt ein Metafeld nach Namensraum und Schlüssel zurück, der zur Ressource gehört. { Metafield }
marketing_opt_
in_level
  • null
  • single_opt_in
  • confirmed_opt_in
  • unknown
Standardwert: NULL
Die Aktivierungsstufe für Marketingabonnements (wie in der Richtlinie zu M3WGWG-Best Practices beschrieben), die der Kunde bei der Zustimmung für den Erhalt von Marketingmaterial per E-Mail gegeben hat. String, Enum
multipass_identifier Standardwert: NULL Eine eindeutige ID für den Kunden, die für den Multipass-Login verwendet wird. String varchar(255)
Hinweis Standardwert: NULL Eine Anmerkung zu diesem Kunden. String mediumtext
orders_count Standardwert: 0 Die Anzahl der Bestellungen, die von dem Kunden jemals im Shop getätigt wurden. Ganze Zahl int(11) schreibgeschützt
phone Standardwert: NULL Die eindeutige Telefonnummer (für den gesamten Shop, im Format E.164) für diesen Kunden. String varchar(255)
sms_marketing_
consent
Standardwert: NULL Der aktuelle Status des SMS-Marketings für die Telefonnummer des Kunden. String
state
  • disabled
  • invited
  • enabled
  • abgelehnt
Standardwert: disabled
Der Status des Kundenkontos für den Shop. String, Enum varchar(255) schreibgeschützt
tags Standardwert: NULL Eine durch Kommas getrennte Liste mit bis zu 250 Tags, die dem Kunden hinzugefügt wurden. String 255 pro Tag
tax_exempt Standardwert: 0 Die Angabe, ob der Kunde für seine Bestellungen von Steuern befreit ist. Boolescher Wert tinyint(1) J
tax_exemptions Eine vollständige Liste der Werte findest du im Abschnitt zur Ressource Customer. Die Liste der Steuerbefreiungen, die für den Kunden gelten. String
total_spent Standardwert: 0 Die in der Shop-Währung aufgeführte Gesamtsumme, die von dem Kunden für alle jemals getätigten Bestellungen ausgegeben wurde. Bei Verwendung von mehreren Währungen wird der angezeigte Betrag ohne Wechselkurs in der Standardwährung angezeigt. Nummer decimal(21,3) schreibgeschützt
updated_at Der Zeitpunkt (Datum und Uhrzeit), zu dem der Kunde zuletzt aktualisiert wurde. Basiert auf der Zeitzone des Shops. DateTime datetime schreibgeschützt
verified_email Standardwert: 1 Gibt an, ob der Kunde seine E-Mail-Adresse verifiziert hat. Die Standardeinstellung ist "true", wenn der Kunde über den Shopify-Adminbereich oder die API erstellt wird. Boolescher Wert tinyint(1) schreibgeschützt

CustomerAddress Ressourceneigenschaften

Die folgende Tabelle enthält einige nützliche Informationen zu den Eigenschaften der Ressource CustomerAddress der REST-Admin-API. Es gibt keine wichtigen Pflichtfelder für diese Ressource.

Daten zu wichtigen Eigenschaften der Ressource "CustomerAddress" der REST-API
Eigenschaft Werte Beschreibung Datentyp Feldlänge Zugriff auf das Feld
address1 Standardwert: NULL Die Postanschrift des Kunden. 100 pro Kundenkonto. String varchar(255)
address2 Standardwert: NULL Ein zusätzliches Feld für die Postanschrift des Kunden. String varchar(255)
city Standardwert: NULL Die Stadt oder der Ort des Kunden. String varchar(255)
company Standardwert: NULL Das Unternehmen des Kunden. String varchar(255)
country Standardwert: NULL Das Land des Kunden String varchar(255)
first_name Standardwert: NULL Der Vorname des Kunden. String varchar(255)
country_code Der aus zwei Buchstaben bestehende Ländercode, der dem Land des Kunden entspricht. String schreibgeschützt
country_name Der normalisierte Ländername des Kunden. String
last_name Standardwert: NULL Der Nachname des Kunden. String varchar(255)
name Vor- und Nachname des Kunden. String
phone Standardwert: NULL Die Telefonnummer des Kunden an dieser Adresse. String varchar(255)
province Standardwert: NULL Der Name der Region des Kunden. In der Regel eine Provinz, ein Bundesstaat/Bundesland oder eine Präfektur. String varchar(255)
province_code Der aus zwei Buchstaben bestehende Code für die Region des Kunden. String schreibgeschützt
zip Standardwert: NULL Die Postleitzahl des Kunden, auch als PLZ oder ähnliches bezeichnet. String varchar(255)

Order Ressourceneigenschaften

In der folgenden Tabelle sind einige nützliche Informationen zu den Eigenschaften der Ressource Order der REST-Admin-API aufgeführt.

Daten zu wichtigen Eigenschaften der Ressource "Order" der REST-API
Eigenschaft Werte Beschreibung Datentyp Feldlänge Zugriff auf das Feld Wichtiges Pflichtfeld
app_id Standardwert: NULL Die ID der App, mit der die Bestellung erstellt wurde. integer bigint(20) schreibgeschützt
billing_address Standardwert: NULL Die mit der Zahlungsmethode verknüpfte Postanschrift. Diese Adresse ist ein optionales Feld, das nicht für Bestellungen verfügbar ist, für die keine Zahlungsmethode erforderlich ist. integer bigint(20)
browser_ip Die IP-Adresse des Browsers, die vom Kunden bei der Bestellung verwendet wurde. Sowohl IPv4 als auch IPv6 werden unterstützt. String varchar(255) schreibgeschützt
buyer_accepts_marketing Standardwert: 0 Gibt an, ob der Kunde zugestimmt hat, E-Mail-Updates vom Shop zu erhalten. boolean tinyint(1)
cancel_reason
  • customer
  • fraud
  • Inventar
  • abgelehnt
  • other
Standardwert: NULL
Der Grund, warum die Bestellung storniert wurde. String varchar(255)
cancelled_at Standardwert: NULL Der Zeitpunkt (Datum und Uhrzeit), zu dem die Bestellung storniert wurde. Gibt "null" zurück, wenn die Bestellung nicht storniert wurde. date datetime schreibgeschützt
cart_token Standardwert: NULL Ein eindeutiger Wert beim Verweisen auf den Warenkorb, der der Bestellung zugeordnet ist. String varchar(255) schreibgeschützt
checkout_token Standardwert: NULL Ein eindeutiger Wert beim Verweisen auf den Checkout, der der Bestellung zugeordnet ist. String varchar(64) schreibgeschützt
client_details
  • accept_language
  • browser_height
  • browser_ip
  • browser_width
  • session_hash
  • user_agent
Informationen über den Browser, den der Kunde bei seiner Bestellung verwendet hat:

accept_language: Die Sprachen und Sprachvarianten/Gebietsschemas, die der Browser versteht.
browser_height: Die Höhe des Browserbildschirms in Pixeln, falls vorhanden.
browser_ip: Die IP-Adresse des Browsers.
browser_width: Die Breite des Browserbildschirms in Pixeln, falls vorhanden.
session_hash: Ein Hashwert der Sitzung.
user_agent: Details zum Browser-Client, einschließlich Software- und Betriebsversionen.
object schreibgeschützt
closed_at Standardwert: NULL Der Zeitpunkt (Datum und Uhrzeit im ISO 8601-Format), zu dem die Bestellung geschlossen wurde. Gibt "null" zurück, wenn die Bestellung nicht geschlossen wurde. date datetime schreibgeschützt
created_at Standardwert: NULL Der automatisch generierte Zeitpunkt (Datum und Uhrzeit im ISO 8601-Format), zu dem die Bestellung in Shopify erstellt wurde. Der Wert für diese Eigenschaft kann nicht geändert werden. date datetime(6) schreibgeschützt
Währung Standardwert: NULL Der aus drei Buchstaben bestehende Code (ISO 4217-Format) für die Shop-Währung. String char(3)
current_subtotal_price Die aktuelle Zwischensumme der Bestellung in der Shop-Währung. Der Wert dieses Feldes spiegelt Bestelländerungen, Rückgaben und Rückerstattungen wider. String varchar(255) schreibgeschützt
current_subtotal_price_set Die aktuelle Zwischensumme der Bestellung in der Shop- und Darstellungswährung. Die Werte der Beträge für dieses Feld spiegeln Bestelländerungen, Rückgaben und Rückerstattungen wider. object schreibgeschützt
current_total_discounts Die aktuellen Rabatte insgesamt für die Bestellung in der Shop-Währung. Der Wert dieses Feldes spiegelt Bestelländerungen, Rückgaben und Rückerstattungen wider. String varchar(255) schreibgeschützt
current_total_discounts_set Die aktuellen Rabatte insgesamt für die Bestellung in der Shop- und Darstellungswährung. Die Werte der Beträge für dieses Feld spiegeln Bestelländerungen, Rückgaben und Rückerstattungen wider. object schreibgeschützt
current_total_duties_set Die aktuellen, insgesamt erhobenen Zollgebühren für die Bestellung in der Shop- und Darstellungswährung. Die Werte der Beträge für dieses Feld spiegeln Bestelländerungen, Rückgaben und Rückerstattungen wider. object schreibgeschützt
current_total_price Der aktuelle Gesamtpreis der Bestellung in der Shop-Währung. Der Wert dieses Feldes spiegelt Bestelländerungen, Rückgaben und Rückerstattungen wider. String varchar(255) schreibgeschützt
current_total_price_set Der aktuelle Gesamtpreis der Bestellung in der Shop- und Darstellungswährung. Die Werte der Beträge für dieses Feld spiegeln Bestelländerungen, Rückgaben und Rückerstattungen wider. object schreibgeschützt
current_total_tax Die aktuellen erhobenen Gesamtsteuern für die Bestellung in der Shop-Währung. Der Wert dieses Feldes spiegelt Bestelländerungen, Rückgaben oder Rückerstattungen wider. String varchar(255) schreibgeschützt
current_total_tax_set Die aktuellen erhobenen Gesamtsteuern für die Bestellung in der Shop- und Darstellungswährung. Die Werte der Beträge für dieses Feld spiegeln Bestelländerungen, Rückgaben und Rückerstattungen wider. object schreibgeschützt
customer Standardwert: NULL Informationen über den Kunden. Die Bestellung muss nicht unbedingt mit einem Kunden verbunden sein und Apps sollten nicht vom Vorhandensein eines Kundenobjekts abhängen. Dieser Wert kann "null" sein, wenn die Bestellung über Shopify POS erstellt wurde. integer bigint(20)
customer_locale Standardwert: NULL Der zwei- oder dreistellige Sprachcode, optional gefolgt von einem Regions-Modifikator. String varchar(255) schreibgeschützt
discount_applications Eine geordnete Liste von gestapelten Rabatt-Anwendungen.

Die Eigenschaft "discount_applications" umfasst drei Typen: "discount_code", "manual" und "script". Alle drei Typen haben eine einheitliche Struktur und einige typspezifische Attribute.
array schreibgeschützt
discount_codes Eine Liste der Rabatte, die auf die Bestellung angewendet werden. array
email Die E-Mail-Adresse des Kunden. varchar(255)
estimated_taxes Gibt an, ob die Steuern für die Bestellung geschätzt werden. Zwischen dem Zeitpunkt, zu dem ein Kunde eine Bestellung aufgibt, und dem Versandzeitpunkt der Bestellung können sich viele Faktoren ändern. Dies kann sich auf die Berechnung der Steuern auswirken. Diese Eigenschaft gibt "false" zurück, wenn Steuern für die Bestellung final sind und keinen Änderungen unterliegen. boolean tinyint(1)
financial_status
  • ausstehend
  • authorized
  • partially_paid
  • Bezahlt
  • partially_refunded
  • refunded
Standardwert: NULL
Der Status der mit der Bestellung verbundenen Zahlungen. Kann nur beim Erstellen der entsprechenden Bestellung festgelegt werden. String varchar(255) schreibgeschützt
fulfillment_status
  • ausgeführt
  • nicht ausgeführt
  • null
  • Teilweise
  • restocked
Standardwert: unfulfilled
Der Status der Bestellung in Bezug auf die ausgeführten Positionen. String varchar(255)
fulfillments Ein Array von Fulfillments, die der Bestellung zugeordnet sind. array
id Standardwert: NULL Die ID der Bestellung, die für API-Operationen verwendet wird. Diese Eigenschaft unterscheidet sich von der Eigenschaft "order_number", bei der es sich um die ID handelt, die vom Shop-Inhaber und Kunden verwendet wird. integer bigint(20) schreibgeschützt
landing_site Standardwert: NULL Die URL für die Seite, auf der der Käufer beim Besuch des Shops gelandet ist. String varchar(4096) schreibgeschützt
line_items Eine Liste von Artikelobjekten, die jeweils Informationen zu einem Artikel in der Bestellung enthalten. array J
location_id Standardwert: NULL Die ID des physischen Standorts, an dem die Bestellung bearbeitet wurde. Wenn du einen Verweis zwischen einem Standort und einer Bestellung benötigst, verwende die Ressource "FulfillmentOrder". integer bigint(20)
name Standardwert: NULL Der Bestellname, der generiert wird, indem die Eigenschaft "order_number" mit dem Bestell-Präfix und -Suffix kombiniert wird, die in den allgemeinen Einstellungen des Händlers festgelegt sind. Diese Eigenschaft unterscheidet sich von der Eigenschaft "id", bei der es sich um die ID der Bestellung handelt, die von der API verwendet wird. Dieses Feld kann auch von der API als beliebiger String-Wert festgelegt werden. String varchar(255)
Hinweis Standardwert: NULL Eine optionale Notiz, die ein Shop-Inhaber einer Bestellung hinzufügen kann. String
note_attributes Standardwert: NULL Zusätzliche Informationen, die der Bestellung hinzugefügt werden. Wird im Abschnitt "Zusätzliche Details" einer Detailseite einer bestimmten Bestellung angezeigt. Jeder Array-Eintrag muss einen Hashwert mit Namen und Wertschlüsseln enthalten. String
Zahl Standardwert: NULL Die Position der Bestellung bei den vorhandenen Bestellungen im Shop. Die Nummern weisen eine fortlaufende Nummerierung auf, die bei 1 beginnt. integer int(11) schreibgeschützt
order_number Die Position der Bestellung bei den vorhandenen Bestellungen im Shop beginnend bei 1001. Bestellnummern sind fortlaufende Nummern. integer bigint(20) schreibgeschützt
order_status_url Die URL, die gegebenenfalls auf die Webseite mit dem Bestellstatus verweist. String varchar(255) schreibgeschützt
original_total_duties_set Die ursprünglichen, insgesamt erhobenen Zollgebühren für die Bestellung in der Shop- und Darstellungswährung. object schreibgeschützt
payment_gateway_names Standardwert: NULL Die Liste der für die Bestellung verwendeten Zahlungs-Gateways.
varchar(255) schreibgeschützt
payment_terms Standardwert: NULL Die Geschäftsbedingungen, in deren Rahmen eine Zahlung verarbeitet werden sollte. object bigint(20) schreibgeschützt
phone Standardwert: NULL Die Telefonnummer des Kunden für den Empfang von SMS-Benachrichtigungen. String varchar(255)
presentment_currency Standardwert: NULL Die Darstellungswährung, die verwendet wurde, um dem Kunden Preise anzuzeigen. String char(3)
processed_at Standardwert: NULL Der Zeitpunkt (Datum und Uhrzeit im ISO 8601-Format), zu dem eine Bestellung bearbeitet wurde. Dieser Wert ist das Datum, das auf deinen Bestellungen angezeigt und in den Analyseberichten verwendet wird. Wenn du Bestellungen aus einer App oder einer anderen Plattform importierst, kannst du den Wert für "processed_at" auf ein Datum und eine Uhrzeit in der Vergangenheit setzen, um so dem Erstellungszeitpunkt der ursprüngliche Bestellung zu entsprechen. date datetime(6)
processing_method
  • Bezahlung
  • Direkt
  • manuell
  • Offsite
  • Express
  • Kostenlos
Gibt an, wie die Zahlung verarbeitet wurde. String varchar(255) schreibgeschützt
referring_site Standardwert: NULL Die Website, auf der der Kunde auf einen Link zum Shop geklickt hat. String varchar(4096)
Rückerstattungen Eine Liste der Rückerstattungen, die für die Bestellung gewährt wurden. array schreibgeschützt
shipping_address Standardwert: NULL Die Postanschrift des Ortes, an den die Bestellung versendet wird. Diese Adresse ist ein optionales Feld und ist nicht für Bestellungen verfügbar, für die kein Versand erforderlich ist. integer bigint(20)
shipping_lines Ein Array von Objekten, die jeweils eine verwendete Versandart angeben. array
source_name Standardwert: NULL Gibt an, woher die Bestellung stammt. Kann nur während der Bestellerstellung festgelegt und anschließend nicht mehr bearbeitet werden. Werte für Shopify-Kanäle sind geschützt und können nicht von anderen API-Clients zugewiesen werden: web, pos, shopify_draft_order, iphone und android. Bestellungen, die über die API erstellt wurden, kannst du jeden anderen beliebigen String deiner Wahl zuordnen. Ist kein Wert angegeben, wird neuen Bestellungen der Wert der ID deiner App zugewiesen. String varchar(255)
subtotal_price Der Preis der Bestellung in der Shop-Währung nach Abzug von Rabatten, jedoch vor Versand, Zollgebühren, Steuern und Trinkgeldern. integer bigint(20)
subtotal_price_set Die Zwischensumme der Bestellung in der Shop- und Darstellungswährung nach Abzug von Rabatten, jedoch vor Versand, Zollgebühren, Steuern und Trinkgeldern. object
tags Tags, die an die Bestellung angehängt und als String mit durch Kommas getrennten Werten formatiert sind. Tags sind zusätzliche kurze Deskriptoren, die häufig zum Filtern und Suchen verwendet werden. Jedes einzelne Tag ist auf 40 Zeichen begrenzt. String varchar(4096)
tax_lines Ein Array von Steuerpositionsobjekten, die jeweils eine für die Bestellung geltende Steuer enthalten. Jedes Objekt hat folgende Eigenschaften:

Wenn du eine Bestellung über die API erstellst, können Steuerpositionen für die Bestellung oder die Artikel angegeben werden, jedoch nicht für beides. Für die Bestellung angegebene Steuerpositionen werden auf die steuerpflichtigen Artikel in der erstellten Bestellung aufgeteilt.
array
taxes_included
  • true
  • false
Standardwert: 0
Gibt an, ob Steuern in der Zwischensumme der Bestellung enthalten sind. boolean tinyint(1)
Test
  • true
  • false
Standardwert: 0
Gibt an, ob dies eine Testbestellung ist. boolean tinyint(1) schreibgeschützt
token Standardwert: NULL Ein eindeutiger Wert beim Verweisen auf die Bestellung. String varchar(32) schreibgeschützt
total_discounts Standardwert: 0 Der Gesamtrabatt in der Shop-Währung, der auf den Preis der Bestellung angewendet wird. String decimal(21,3)
total_discounts_set Die Gesamtrabatt in der Shop- und Darstellungswährung, der auf den Preis der Bestellung angewendet wird. object
total_line_items_price Standardwert: 0 Die Summe aller Artikelpreise in der Shop-Währung. String decimal(21,3)
total_line_items_price_set Die Summe aller Artikelpreise in der Shop- und Darstellungswährung. object
total_outstanding Standardwert: 0 Der ausstehende Gesamtbetrag der Bestellung in der Shop-Währung. String decimal(21,3)
total_price Standardwert: 0 Die Summe aller Artikelpreise, Rabatte, Versandkosten, Steuern und Trinkgelder in der Shop-Währung. Muss ein positiver Wert sein. String decimal(21,3)
total_price_set Der Gesamtpreis der Bestellung in der Shop- und Darstellungswährung. object
total_shipping_price_set Die Gesamtversandkosten der Bestellung ohne Rabatte und Rückgaben in der Shop- und Darstellungswährung. Wenn "taxes_included" auf "true" gesetzt ist, enthält "total_shipping_price_set" Steuern. object
total_tax Standardwert: 0 Die Summe aller Steuern in der Shop-Währung, die auf die Bestellung angewendet werden. Muss ein positiver Wert sein. String decimal(21,3)
total_tax_set Die Gesamtsteuern in der Shop- und Darstellungswährung, die auf die Bestellung angewendet werden. object
total_tip_received Die Summe aller Trinkgelder in der Bestellung in der Shop-Währung. integer bigint(20) schreibgeschützt
total_weight Standardwert: 0 Das Gesamtgewicht aller Artikel in Gramm. Die Summe wird beim Entfernen von Artikeln aus der Bestellung nicht angepasst. integer bigint(20) unsigned
updated_at Der Zeitpunkt (Datum und Uhrzeit im ISO 8601-Format), zu dem die Bestellung storniert wurde. date datetime(6) schreibgeschützt
user_id Standardwert: NULL Die ID des bei Shopify POS eingeloggten Benutzers, der die Bestellung bearbeitet hat (falls zutreffend). integer bigint(20)

Product Ressourceneigenschaften

In der folgenden Tabelle sind einige nützliche Informationen zu den Eigenschaften der Ressource Product der REST-Admin-API aufgeführt.

Daten zu wichtigen Eigenschaften der Ressource "Product" der REST-API
Eigenschaft Werte Beschreibung Datentyp Feldlänge Zugriff auf das Feld Wichtiges Pflichtfeld
body_html Standardwert: NULL Eine Beschreibung des Produkts. Unterstützt die HTML-Formatierung. String mediumtext
created_at Standardwert: NULL Der Zeitpunkt (Datum und Uhrzeit im ISO 8601-Format), zu dem das Produkt erstellt wurde. date datetime schreibgeschützt
handle Standardwert: NULL String varchar(255)
id Standardwert: NULL Eine 64-Bit-Ganzzahl (unsigned), die als eindeutige ID für das Produkt verwendet wird. Jede ID ist im Shopify-System eindeutig. Es gibt keine Produkte mit derselben ID, auch wenn sie aus unterschiedlichen Shops stammen. integer bigint(20) schreibgeschützt J
Bilder Eine Liste von Produktbildobjekten, die jeweils ein mit dem Produkt verknüpftes Bild darstellen. [{ product_image }]
Optionen Die benutzerdefinierten Produkteigenschaften, z. B. Größe, Farbe und Material. Jedes Produkt kann bis zu drei Optionen haben und jeder Optionswert kann bis zu 255 Zeichen lang sein. Produktvarianten bestehen aus einer Kombination aus Optionswerten. Optionen können nicht ohne Werte erstellt werden. Um neue Optionen zu erstellen, muss außerdem eine Variante mit einem zugehörigen Optionswert erstellt werden. array
product_type Standardwert: NULL Eine Kategorisierung für das Produkt, das zum Filtern und Suchen von Produkten verwendet wird. String varchar(255)
published_at Standardwert: NULL Der Zeitpunkt (Datum und Uhrzeit im ISO 8601-Format), zu dem das Produkt veröffentlicht wurde. Kann auf "null" gesetzt werden, um die Veröffentlichung des Produkts über den Onlineshop-Kanal rückgängig zu machen. date datetime
published_scope
  • web
  • global
Gibt an, ob das Produkt im Point of Sale-Vertriebskanal veröffentlicht wird. String
Status
  • aktiv
  • archiviert
  • draft
Standard: aktiv
Der Status des Produkts. String varchar(32)
tags Ein String mit durch Kommas getrennten Tags, die zum Filtern und Suchen verwendet werden. Ein Produkt kann bis zu 250 Tags haben. Jedes Tag kann bis zu 255 Zeichen enthalten. String
template_suffix Standardwert: NULL Das Suffix der Liquid-Vorlage, das für die Produktseite verwendet wird. Wenn diese Eigenschaft angegeben ist, verwendet die Produktseite eine Vorlage namens "product.suffix.liquid", wobei "suffix" der Wert dieser Eigenschaft ist. Wenn diese Eigenschaft "" oder "null" ist, verwendet die Produktseite die Standardvorlage "product.liquid". String varchar(255)
title Standardwert: NULL Der Name für das Produkt. String varchar(255)
updated_at Standardwert: NULL Der Zeitpunkt (Datum und Uhrzeit im ISO 8601-Format), zu dem das Produkt zuletzt geändert wurde. Der Wert "updated_at" eines Produkts kann sich aus verschiedenen Gründen ändern. Wenn z. B. eine Bestellung für ein Produkt aufgegeben wird, für das die Inventarverfolgung eingerichtet ist, wird die Inventaranpassung als Aktualisierung gezählt. date datetime schreibgeschützt
Varianten Ein Array von Produktvarianten, die jeweils eine andere Version des Produkts darstellen. Die Eigenschaft "position" ist schreibgeschützt. Die Position der Varianten wird durch die Reihenfolge angegeben, in der sie aufgelistet sind. array
Anbieter Standardwert: NULL Der Name des Lieferanten des Produkts. String varchar(255)

ProductImage Ressourceneigenschaften

Die folgende Tabellen enthält einige nützliche Informationen zu den Eigenschaften der Ressource ProductImage der REST-Admin-API. Es gibt keine schreibgeschützten oder wichtigen Pflichtfelder für diese Ressource.

Daten zu wichtigen Eigenschaften der Ressource "ProductImage" der REST-API
Eigenschaft Werte Beschreibung Datentyp Feldlänge
created_at Standardwert: NULL Der Zeitpunkt (Datum und Uhrzeit), zu dem das Produktbild erstellt wurde. Die API gibt diesen Wert im ISO 8601-Format zurück. date datetime
height Standardwert: NULL Die beim Upload eines Bildes ermittelte Höhe des Bildes. smallint(4) unsigned
id Standardwert: NULL Eine eindeutige numerische ID für das Produktbild. (auto_increment) integer bigint(20)
position Standardwert: 0 Die Reihenfolge der Produktbilder in der Liste. Das erste Produktbild befindet sich an Position 1 und ist das "Hauptbild" für das Produkt. smallint(5) unsigned
product_id Standardwert: NULL Die ID des Produkts, das dem Bild zugeordnet ist. bigint(20)
src Gibt die Position des Produktbildes an. Dieser Parameter unterstützt URL-Filter, mit denen du geänderte Kopien des Bildes abrufen kannst. Füge beispielsweise "_small" zum Dateinamen hinzu, um eine skalierte Kopie des Bildes mit einer Auflösung von 100 x 100 px abzurufen (z. B. ipod-nano_small.png). Wenn du "_2048x2048" hinzufügst, kannst du eine Kopie des Bildes mit einer Auflösung von 2048 x 2048 px abrufen (z. B. ipod-nano_2048x2048.png).
updated_at Standardwert: NULL Der Zeitpunkt (Datum und Uhrzeit), zu dem das Produktbild zuletzt geändert wurde. Die API gibt diesen Wert im ISO 8601-Format zurück. date datetime
variant_ids Ein Array von Varianten-IDs, die dem Bild zugeordnet sind.
width Standardwert: NULL Die beim Upload eines Bildes ermittelte Breite des Bildes. smallint(4) unsigned

ProductVariant Ressourceneigenschaften

Die folgende Tabelle enthält einige nützliche Informationen zu den Eigenschaften der Ressource ProductVariant der REST-Admin-API. Es gibt keine wichtigen Pflichtfelder für diese Ressource.

Daten zu wichtigen Eigenschaften der Ressource "ProductVariant" der REST-API
Eigenschaft Werte Beschreibung Datentyp Feldlänge Zugriff auf das Feld
Barcode Standardwert: NULL Die Barcode, UPC oder die ISBN-Nummer für das Produkt. varchar(255)
compare_at_price Standardwert: NULL Der ursprüngliche Preis des Artikels vor einer Anpassung oder einem Verkauf. decimal(20,2)
created_at Standardwert: NULL Der Zeitpunkt (Datum und Uhrzeit im ISO 8601-Format), zu dem die Produktvariante erstellt wurde. date datetime
fulfillment_service
  • manuell
  • { handle of fulfillment service }
Standardwert: manual
Der mit der Produktvariante verknüpfte Fulfillmentdienst. varchar(255)
Gramm Das Gewicht der Produktvariante in Gramm.
id Standardwert: NULL Die eindeutige numerische ID für die Produktvariante. Dieser Wert wird automatisch erhöht. bigint(20)
image_id Standardwert: NULL Die eindeutige numerische ID für das Bild eines Produkts. Das Bild muss mit demselben Produkt wie die Variante verknüpft sein. bigint(20)
inventory_item_id Die eindeutige ID für den Inventarartikel, der in der Inventar-API zur Abfrage von Inventarinformationen verwendet wird.
inventory_management
  • Shopify
  • null
  • { handle of fulfillment service }
  • Standardwert: NULL
    Der Fulfillmentdienst, der die Anzahl der Artikel auf Lager für die Produktvariante verfolgt. varchar(255)
    inventory_policy
    • deny
    • continue
    Standardwert: deny
    Ob Kunden eine Bestellung für die Produktvariante aufgeben dürfen, wenn diese nicht vorrätig ist. varchar(40)
    inventory_quantity Standardwert: 1 Eine Zusammenfassung des Inventars an allen Standorten. Verwende die Ressource "InventoryLevel", um das Inventar an einem bestimmten Standort anzupassen. int(11) schreibgeschützt
    option Die benutzerdefinierten Eigenschaften, die ein Shop-Inhaber zum Definieren von Produktvarianten verwendet. Du kannst drei Optionen für eine Produktvariante definieren: option1, option2, option3. Standardwert: Default Title. Das Feld "title" ist eine Verknüpfung der Felder "option1", "option2" und "option3". Wenn du diese Felder aktualisierst, wird auch das Feld "title" aktualisiert.
    position Standardwert: 0 Die Reihenfolge der Produktvarianten in der Liste der Produktvarianten. Die erste Position in der Liste ist 1. Die Position der Varianten wird durch die Reihenfolge angegeben, in der sie aufgelistet sind. smallint(5) unsigned schreibgeschützt
    presentment_prices Eine Liste der Darstellungspreise und Vergleichspreise der Variante in allen aktivierten Darstellungswährungen des Shops. Jedes Objekt des Typs "price" hat folgende Eigenschaften:
    -currency_code: Der aus drei Buchstaben bestehende Code (ISO 4217-Format) für eine der aktivierten Darstellungswährungen des Shops.
    -amount: Der Preis oder Vergleichspreis der Variante in der Darstellungswährung.
    Erfordert den Header 'X-Shopify-Api-Features': 'include-presentment-prices'.
    schreibgeschützt
    Preis Standardwert: 0 Der Preis der Produktvariante. decimal(20,2)
    product_id Standardwert: NULL Die eindeutige numerische ID des Produkts. bigint(20)
    requires_shipping Standardwert: 1 Diese Eigenschaft ist veraltet. Verwende stattdessen die Eigenschaft "requires_shipping" in der Ressource "InventoryItem". boolean tinyint(1)
    Artikelnummer Eine eindeutige ID für die Produktvariante im Shop. Erforderlich, um eine Verbindung zu einem FulfillmentService herzustellen. varchar(255)
    tax_code Dieser Parameter gilt nur für Shops, in denen die Avalara AvaTax-App installiert ist. Gibt den Avalara-Steuercode für die Produktvariante an.
    Steuerpflichtig Standardwert: 1 Ob eine Steuer erhoben wird, wenn die Produktvariante verkauft wird. boolean tinyint(1)
    title Der Titel der Produktvariante. Das Feld "title" ist eine Verknüpfung der Felder "option1", "option2" und "option3". Du kannst den Titel nur mithilfe der Optionsfelder aktualisieren. varchar(255) schreibgeschützt
    updated_at Standardwert: NULL Der Zeitpunkt (Datum und Uhrzeit), zu dem die Produktvariante zuletzt geändert wurde. Dieser Wert wird im ISO 8601-Format zurückgegeben. date datetime
    weight Das Gewicht der Produktvariante in der durch "weight_unit" angegebenen Gewichtseinheit.
    weight_unit
    • g
    • kg
    • oz
    • lb
    Standardwert: NULL
    Die Maßeinheit für das Gewicht der Produktvariante. Wenn du keinen Wert für "weight_unit" angibst, wird die Standardmaßeinheit des Shops verwendet. varchar(2)