BigCommerce (Vorschau)

BigCommerce ist eine flexible, offene SaaS-Plattform. Stellen Sie eine Verbindung mit BigCommerce her, um Bestellungen, Produkte und zugehörige Informationen abzurufen.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung	Class	Regions
Logik-Apps	Norm	Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:      – Azure Government-Regionen      - Azure China-Regionen      - 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)
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)

Kontakt
Name	Microsoft Dynamics
URL	https://aka.ms/iomsupport
Email	iomdri@microsoft.com

Connectormetadaten
Herausgeber	Microsoft
Webseite	https://www.bigcommerce.com/
Datenschutzrichtlinie	https://www.bigcommerce.com/privacy/
Kategorien	Produktivität

Dieser Connector wurde speziell für die Integration des Big Commerce-Anbieters von Dynamics 365 Intelligent Order Management entwickelt.

Voraussetzungen

Ein BigCommerce-Entwicklerkonto und Testspeicher ist erforderlich. Wenn Sie keinen haben, können Sie ihn unter https://developer.bigcommerce.com/ Hinweis erstellen: Es wird empfohlen, diesen Connector speziell zum Einrichten des Dynamics 365 Intelligent Order Management BigCommerce-Anbieters zu verwenden.

So erhalten Sie Anmeldeinformationen

BigCommerce erfordert ein API-Token für die Authentifizierung. Sie können ein API-Token https://store-XYZ.mybigcommerce.com/manage/settings/auth/api-accounts generieren und verwenden, um den Connector zu konfigurieren. Hinweis: Das XYZ ist Ihr Speicherhashcode.

Erste Schritte mit Ihrem Connector

Konfigurieren Sie die Verbindung mit dem API-Token. Weitere Informationen zur API von BigCommerce finden Sie in der öffentlichen Dokumentation: https://developer.bigcommerce.com/api-docs

Bekannte Probleme und Einschränkungen

Details zu API-Rate-Grenzwerten finden Sie im folgenden Dokumentationsthema: https://developer.bigcommerce.com/api-docs/getting-started/best-practices#api-rate-limits Details zu den Plattformgrenzwerten finden Sie im folgenden Dokumentationsthema: https://developer.bigcommerce.com/api-docs/getting-started/best-practices#platform-limits

Dieser Connector wurde speziell für die Integration des BigCommerce-Anbieters von Dynamics 365 Intelligent Order Management entwickelt. Die Unterstützung für Anwendungsfälle außerhalb von Dynamics 365 Intelligent Order Management ist eingeschränkt.

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	Der API-Schlüssel für diese API	Richtig

Drosselungsgrenzwerte

Name	Aufrufe	Verlängerungszeitraum
API-Aufrufe pro Verbindung	100	60 Sekunden

Aktionen

Aktualisieren einer Bestellung	Aktualisiert eine Bestellung. Weitere Informationen zum Erstellen oder Aktualisieren von Bestellungen finden Sie unter "Orders Overview".
Alle Bestellungen abrufen	Ruft alle Bestellungen mithilfe der Filterabfrage ab.
Alle Kunden abrufen	Gibt eine Liste von Kunden zurück. Optionale Filterparameter können übergeben werden.
Artikel auflisten	Listet alle Bestellprodukte auf einer Bestellung mithilfe der Bestell-ID auf.
Bestellung abrufen	Ruft eine Bestellung mithilfe der Auftrags-ID ab.
Bestellversandadressen abrufen	Ruft alle Versandadressen in einer Bestellung mithilfe der Bestell-ID ab.
Produkt aktualisieren	Aktualisiert ein Produkt. felderRead-Only id date_created date_modified calculated_price base_variant_id
Produkt nach ID abrufen	Gibt ein einzelnes Produkt zurück. Optionale Parameter können übergeben werden.
Produkte abrufen	Gibt eine Liste der Produkte zurück. Optionale Filterparameter können übergeben werden.

Aktualisieren einer Bestellung

Vorgangs-ID:

UpdateAnOrder

Aktualisiert eine Bestellung. Weitere Informationen zum Erstellen oder Aktualisieren von Bestellungen finden Sie unter "Orders Overview".

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Speicherhash	store_hash	True	string	Der Speicherhashcode.
order_id	order_id	True	integer	ID der Bestellung
			object

Gibt zurück

Order-Objekt, das in Antworten zurückgegeben wird.

order_Resp

order_Resp

Alle Bestellungen abrufen

Vorgangs-ID:

GetAllOrders

Ruft alle Bestellungen mithilfe der Filterabfrage ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Speicherhash	store_hash	True	string	Der Speicherhashcode.
Min-ID	min_id		integer	Die Mindestreihenfolgen-ID.
Maximale Auftrags-ID	max_id		integer	Die maximale Auftrags-ID.
Min Gesamtsumme	min_total		number	Die Mindestreihenfolge im Float-Format.
Max. Summe	max_total		number	Die maximale Bestellsumme im Float-Format.
Kunden-ID	customer_id		integer	Kunden-ID der Bestellung.
Email	email		string	Die E-Mail des Kunden.
Status-ID	status_id		integer	Die Staus-ID der Bestellung.
Einkaufswagen-ID	cart_id		string	Die Einkaufswagen-ID der Bestellung.
Zahlungsmethode	payment_method		string	Die zahlungsmethode, die für die Bestellung verwendet wird.
Min. Erstellungsdatum	min_date_created		string	Das Mindestdatum, an dem die Bestellung in RFC-2822 oder ISO-8601 erstellt wurde. RFC-2822: 'Thu, 20 Apr 2017 11:32:00 -0400' ISO-8601: '2017-04-20T11:32:00.000-04:00'.
Max. Erstellungsdatum	max_date_created		string	Das maximale Datum, an dem die Bestellung in RFC-2822 oder ISO-8601 erstellt wurde. RFC-2822: 'Thu, 20 Apr 2017 11:32:00 -0400' ISO-8601: '2017-04-20T11:32:00.000-04:00'.
Min. Änderungsdatum	min_date_modified		string	Mindestdatum der Änderung der Reihenfolge in RFC-2822 oder ISO-8601. RFC-2822: 'Thu, 20 Apr 2017 11:32:00 -0400' ISO-8601: '2017-04-20T11:32:00.000-04:00'.
Max. Änderungsdatum	max_date_modified		string	Das maximale Datum, an dem die Reihenfolge in RFC-2822 oder ISO-8601 geändert wurde. RFC-2822: 'Thu, 20 Apr 2017 11:32:00 -0400' ISO-8601: '2017-04-20T11:32:00.000-04:00'.
Seite	page		number	Die Seite, die in der Antwort zurückgegeben werden soll.
Limit	limit		number	Anzahl der zurückzugebenden Ergebnisse.
Sortieren	sort		string	Feld und Richtung für Sortierreihenfolgen. Um die Richtung anzugeben, fügen Sie ":asc" oder ":d esc" am Ende des Abfrageparameters hinzu. Beispiel: "sort=date_created:desc".
Ist gelöscht	is_deleted		boolean	Wenn die Bestellung gelöscht oder archiviert wurde.
Kanal-ID	channel_id		boolean	Die Kanal-ID der Bestellung.

Gibt zurück

Die Liste "Bestellungen", die in Antworten zurückgegeben wurde.

Gegenstände

orderCollection_Resp

Alle Kunden abrufen

Vorgangs-ID:

GetCustomers

Gibt eine Liste von Kunden zurück. Optionale Filterparameter können übergeben werden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Speicherhash	store_hash	True	string	Der Speicherhashcode.
Elemente pro Seite.	limit		number	Anzahl der Elemente pro Seite. limit=50.
Filtert Elemente nach ID.	id:in		array	Filtert Elemente nach ID. id:in=4,5,6.
Filtert Elemente nach customer_group_id.	customer_group_id:in		array	Filtert Elemente nach customer_group_id. customer_group_id:in=5,6.
Filtert Elemente nach date_modified.	date_modified		date-time	Filtert Elemente nach date_modified. date_modified=2018-09-05T13:45:03.
Filtert Elemente nach minimalem date_modified.	date_modified:min		string	Filtert Elemente nach mininum date_modified. date_modified:min=2019-09-04T:00:00:00 oder date_modified:min=2019-09-04.
Filtert Elemente nach maximaler date_modified.	date_modified:max		date-time	Elemente nach maximaler date_modified date_modified:max=2018-09-05T13:45:03 oder date_modified:max=2019-09-04.
Gibt an, ob Kundenunterressourcen einbezogen werden sollen.	include		string	Gibt an, ob Kundenunterressourcen eingeschlossen werden sollen: addresses - Kundenadressen storecredit - Guthaben speichern attributes - Kundenattribute und Adressattribute formfields - Kunden- und Adressformularfelder include=addresses,storecredit,attributes,formfields.
Elemente sortieren.	sort		string	Sortieren Sie Elemente nach date_created, date_modified oder last_name:* date_created:asc - Erstellungsdatum, aufsteigend* date_created:desc - Erstellungsdatum, absteigend* - Nachname, aufsteigend* last_name:desclast_name:asc - Nachname, absteigend * date_modified:asc - Datum geändert, aufsteigend* date_modified:desc- Datum geändert, absteigend Beispiel: sort=last_name:asc.

Gibt zurück

Antwort auf Kundensammlung

CustomerCollectionResponse

Artikel auflisten

Vorgangs-ID:

GetAllOrderProducts

Listet alle Bestellprodukte auf einer Bestellung mithilfe der Bestell-ID auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Speicherhash	store_hash	True	string	Der Speicherhashcode.
Auftrags-ID	order_id	True	string	ID der Bestellung.
Seite	page		number	Die Seite, die in der Antwort zurückgegeben werden soll.
Limit	limit		number	Anzahl der zurückzugebenden Ergebnisse.

Gibt zurück

Bestellen Sie produkte, die in Antworten zurückgegeben wurden.

Gegenstände

orderProductsCollection_Resp

Bestellung abrufen

Vorgangs-ID:

GetAnOrder

Ruft eine Bestellung mithilfe der Auftrags-ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Speicherhash	store_hash	True	string	Der Speicherhashcode.
Auftrags-ID	order_id	True	string	ID der Bestellung.

Gibt zurück

Order-Objekt, das in Antworten zurückgegeben wird.

order_Resp

order_Resp

Bestellversandadressen abrufen

Vorgangs-ID:

GetAllOrderShippingAddresses

Ruft alle Versandadressen in einer Bestellung mithilfe der Bestell-ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Speicherhash	store_hash	True	string	Der Speicherhashcode.
Auftrags-ID	order_id	True	string	ID der Bestellung.
Seite	page		number	Die Seite, die in der Antwort zurückgegeben werden soll.
Limit	limit		number	Anzahl der zurückzugebenden Ergebnisse.

Gibt zurück

Versandadressen, die als Antwort zurückgegeben werden.

Gegenstände

orderShippingAddressCollection_Resp

Produkt aktualisieren

Vorgangs-ID:

UpdateProduct

Aktualisiert ein Produkt.

felderRead-Only

• id
• date_created
• date_modified
• calculated_price
• base_variant_id

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Speicherhash	store_hash	True	string	Der Speicherhashcode.
Produkt-ID	product_id	True	integer	Die ID der Product Ressource, zu der die Ressource gehört.
			object
Einschließen von Feldern	include_fields		string	Felder, die in eine durch Trennzeichen getrennte Liste eingeschlossen werden sollen. Die ID und die angegebenen Felder werden zurückgegeben.

Gibt zurück

ProductResponse

ProductResponse

Produkt nach ID abrufen

Vorgangs-ID:

GetProductById

Gibt ein einzelnes Produkt zurück. Optionale Parameter können übergeben werden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Speicherhash	store_hash	True	string	Der Speicherhashcode.
Produkt-ID	product_id	True	integer	Die ID der Product Ressource, zu der die Ressource gehört.
einschließen	include		string	Unterressourcen, die in ein Produkt eingeschlossen werden sollen, in einer durch Trennzeichen getrennten Liste. Wenn options oder modifiers verwendet wird, sind die Ergebnisse auf 10 pro Seite beschränkt.
include_fields	include_fields		string	Felder, die in eine durch Trennzeichen getrennte Liste eingeschlossen werden sollen. Die ID und die angegebenen Felder werden zurückgegeben.
exclude_fields	exclude_fields		string	Auszuschließende Felder in einer durch Trennzeichen getrennten Liste. Die angegebenen Felder werden von einer Antwort ausgeschlossen. Die ID kann nicht ausgeschlossen werden.

Gibt zurück

Name	Pfad	Typ	Beschreibung
product_Full	data	product_Full
Meta	meta	object	Leeres Metaobjekt; kann später verwendet werden.

Produkte abrufen

Vorgangs-ID:

GetProducts

Gibt eine Liste der Produkte zurück. Optionale Filterparameter können übergeben werden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Speicherhash	store_hash	True	string	Der Speicherhashcode.
Id	id		integer	Filtert Elemente nach ID.
name	name		string	Filtert Elemente nach Namen.
Upc	upc		string	Filtert Elemente nach UPC.
Preis	price		double	Filtert Artikel nach Preis.
weight	weight		double	Filtert Elemente nach Gewicht.
condition	condition		string	Filtert Elemente nach Bedingung.
brand_id	brand_id		integer	Filtert Elemente nach brand_id.
date_modified	date_modified		date-time	Filtern von Elementen nach date_modified.
date_modified:max	date_modified:max		string	Filtern von Elementen nach date_modified. Beispiel: date_modified:max=2020-06-15.
date_modified:min	date_modified:min		string	Filtern von Elementen nach date_modified. Beispiel: date_modified:min=2018-06-15.
date_last_imported	date_last_imported		date-time	Filtert Elemente nach date_last_imported.
date_last_imported:max	date_last_imported:max		string	Filtert Elemente nach date_last_imported. Beispiel: date_last_imported:max=2020-06-15.
date_last_imported:min	date_last_imported:min		string	Filtert Elemente nach date_last_imported. Beispiel: date_last_imported:min=2018-06-15.
is_visible	is_visible		boolean	Filtert Elemente basierend darauf, ob das Produkt derzeit auf der Storefront sichtbar ist.
is_featured	is_featured		string	Filtert Elemente nach is_featured. 0 für "true" 1 für "false".
is_free_shipping	is_free_shipping		integer	Filtert Elemente nach is_free_shipping.
inventory_level	inventory_level		integer	Filtert Elemente nach inventory_level.
inventory_level:in	inventory_level:in		integer	Bestandsebene
inventory_level:not_in	inventory_level:not_in		integer	Bestandsebene NICHT IN
inventory_level:min	inventory_level:min		integer	Min. Lagerbestand
inventory_level:max	inventory_level:max		integer	Max. Bestandsebene
inventory_level:greater	inventory_level:greater		integer	Lagerbestandsebene GRÖßER
inventory_level:less	inventory_level:less		integer	Lagerstand WENIGER
inventory_low	inventory_low		integer	Filtert Elemente nach inventory_low. Werte: 1, 0.
out_of_stock	out_of_stock		integer	Filtert Elemente nach out_of_stock. Um den Filter zu aktivieren, übergeben Sie out_of_stock=1.
total_sold	total_sold		integer	Filtert Elemente nach total_sold.
type	type		string	Filtern sie Elemente nach Typ.
categories	categories		integer	Filtert Elemente nach Kategorien. Wenn sich ein Produkt in mehr als einer Kategorie befindet, gibt die Verwendung dieser Abfrage das Produkt nicht zurück. Verwenden Sie stattdessen categories:in=12.
Schlüsselwort (keyword)	keyword		string	Filtern Sie Elemente nach Schlüsselwörtern, die in den namedescriptionFeldern oder sku im Markennamen enthalten sind.
keyword_context	keyword_context		string	Legen Sie den Kontext fest, der vom Suchalgorithmus verwendet wird, um Ergebnisse zurückzugeben, die auf die angegebene Gruppe ausgerichtet sind. Wird verwendet merchant , um Händler beim Durchsuchen ihres eigenen Katalogs zu unterstützen. Dient shopper zum Zurückgeben von Suchergebnissen mit Käufern.
status	status		integer	Filtert Elemente nach Status.
einschließen	include		string	Unterressourcen, die in ein Produkt eingeschlossen werden sollen, in einer durch Trennzeichen getrennten Liste. Wenn options oder modifiers verwendet wird, sind die Ergebnisse auf 10 pro Seite beschränkt.
include_fields	include_fields		string	Felder, die in eine durch Trennzeichen getrennte Liste eingeschlossen werden sollen. Die ID und die angegebenen Felder werden zurückgegeben.
exclude_fields	exclude_fields		string	Auszuschließende Felder in einer durch Trennzeichen getrennten Liste. Die angegebenen Felder werden von einer Antwort ausgeschlossen. Die ID kann nicht ausgeschlossen werden.
availability	availability		string	Filtert Elemente nach Verfügbarkeit. Werte sind: verfügbar, deaktiviert, Vorbestellung.
Seite	page		integer	Gibt die Seitenzahl in einer eingeschränkten (paginierten) Liste von Produkten an.
Grenze	limit		integer	Steuert die Anzahl der Elemente pro Seite in einer begrenzten (paginierten) Liste von Produkten.
direction	direction		string	Sortierrichtung. Zulässige Werte sind: asc, desc.
sort	sort		string	Feldname, nach dem sortiert werden soll. Hinweis: Da id neue Produkte hinzugefügt werden, können Sie dieses Feld verwenden, um nach Produkterstellungsdatum zu sortieren.
categories:in	categories:in		integer	Filtert Elemente nach Kategorien. Wird für Produkte in mehreren Kategorien verwendet. Beispiel: categories:in=12.

Gibt zurück

ProductCollectionResponse

ProductCollectionResponse

Definitionen

address_Full

Name	Pfad	Typ	Beschreibung
first_name	first_name	string	Der Vorname der Kundenadresse.
last_name	last_name	string	Der Nachname der Kundenadresse.
Firma	company	string	Die Firma der Kundenadresse.
Adresse1	address1	string	Die Adresse 1 Zeile.
adresse2	address2	string	Die Adresse 2 Zeile.
city	city	string	Die Stadt der Kundenadresse.
state_or_province	state_or_province	string	Der Name des Bundeslandes oder der Provinz
postal_code	postal_code	string	Die Postleitzahl der Kundenadresse.
country_code	country_code	string	Die Ländervorwahl der Kundenadresse.
phone	phone	string	Die Telefonnummer der Kundenadresse.
Adresstyp	address_type	string	Der Adresstyp. Wohn- oder Gewerbeimmobilien
Kunden_ID	customer_id	integer	Die Kunden-ID.
id	id	integer	Die eindeutige numerische ID der Adresse.
country	country	string	Der Name des Landes der Kundenadresse.

Einsteller

Der Typ des Anpassungers für den Preis oder die Gewichtung der Variante, wenn der Modifiziererwert im Storefront ausgewählt wird.

Der Typ des Anpassungers für den Preis oder die Gewichtung der Variante, wenn der Modifiziererwert im Storefront ausgewählt wird.

Einsteller

string

adjuster_Full

Anpassung für komplexe Regeln.

Name	Pfad	Typ	Beschreibung
Einsteller	adjuster	Adjuster	Der Typ des Anpassungers für den Preis oder die Gewichtung der Variante, wenn der Modifiziererwert im Storefront ausgewählt wird.
adjuster_value	adjuster_value	double	Der numerische Betrag, um den der Anpassunger entweder den Preis oder die Gewichtung der Variante ändert, wenn der Modifiziererwert im Storefront ausgewählt wird.

adjusters_Full

Name	Pfad	Typ	Beschreibung
adjuster_Full	price	adjuster_Full	Anpassung für komplexe Regeln.
adjuster_Full	weight	adjuster_Full	Anpassung für komplexe Regeln.
image_url	image_url	string	Die URL für ein Bild, das im Storefront angezeigt wird, wenn der Modifiziererwert ausgewählt ist. Grenzwert von 8 MB pro Datei.
Einkaufsdisabled	purchasing_disabled	PurchasingDisabled

attribute_Full

Name	Pfad	Typ	Beschreibung
attribute_id	attribute_id	integer	Attribut-ID
attribute_value	attribute_value	string	Attributwert
Kunden_ID	customer_id	integer	Kunden-ID
date_created	date_created	date-time	Das Datum, an dem das Kunden-Attribut erstellt wurde
date_modified	date_modified	date-time	Das Datum, an dem das Kunden-Attribut geändert wurde
id	id	integer	Attributwert-ID

billingAddress_Base

Abrechnungsadresseneigenschaften, die allen Anforderungen und Antworten gemeinsam sind.

Name	Pfad	Typ	Beschreibung
first_name	first_name	string
last_name	last_name	string
Firma	company	string
street_1	street_1	string	Straße (erste Zeile).
street_2	street_2	string	Straße (zweite Zeile).
city	city	string
Staat	state	string
zip	zip	string	Die Rechnungsadresse muss die Postleitzahl enthalten. Die Postleitzahl muss mindestens zwei Zeichen lang sein.
country	country	string
country_iso2	country_iso2	string	2-Buchstaben ISO Alpha-2-Code für das Land.
phone	phone	string	Telefonnummer des Empfängers.
E-Mail	email	string	E-Mail-Adresse des Empfängers.

billingAddress_Full

Erforderlich zum Erstellen einer Bestellung.

Name	Pfad	Typ	Beschreibung
billingAddress_Base	billingAddress	billingAddress_Base	Abrechnungsadresseneigenschaften, die allen Anforderungen und Antworten gemeinsam sind.
form_fields	form_fields	array of formFields

bulkPricingRule_Full

Allgemeine Eigenschaften der Massenpreisregel

Name	Pfad	Typ	Beschreibung
id	id	integer	Eindeutige ID der Massenpreisregel. Schreibgeschützt.
quantity_min	quantity_min	integer	Die mindeste inklusive Menge eines Produkts, um diese Regel zu erfüllen. Muss größer oder gleich Null sein. Erforderlich in /POST.
quantity_max	quantity_max	integer	Die maximale inklusive Menge eines Produkts, um diese Regel zu erfüllen. Muss größer als der quantity_min Wert sein – es sei denn, dieses Feld hat einen Wert von 0 (Null), in diesem Fall ist für diese Regel kein Maximum gebunden. Erforderlich in /POST.
type	type	string	Die Art der Anpassung, die vorgenommen wird. Werte: price - der Anpassungsbetrag pro Produkt; percent - die Anpassung als Prozentsatz des ursprünglichen Preises; fixed - der angepasste absolute Preis des Produkts. Erforderlich in /POST.
Menge	amount	integer	Der Rabatt kann ein fester Dollarbetrag oder ein Prozentsatz sein. Für einen festen Dollarbetrag geben Sie ihn als ganze Zahl ein, und die Antwort wird als ganze Zahl zurückgegeben. Geben Sie für den Prozentsatz den Betrag als Prozentsatz ein, der durch 100 dividiert wird, indem Sie das Zeichenfolgenformat verwenden. Beispiel: 10% Prozent wäre ".10". Die Antwort wird als ganze Zahl zurückgegeben. Erforderlich in /POST.

config_Full

Die Werte für die Optionskonfiguration können je nach dem erstellten Modifizierer variieren.

Name	Pfad	Typ	Beschreibung
default_value	default_value	string	(Datum, Text, multi_line_text, numbers_only_text) Der Standardwert. Wird in einer Datumsoption als ISO-8601-formatierte Zeichenfolge oder auf einer Textoption als Zeichenfolge angezeigt.
checked_by_default	checked_by_default	boolean	(Kontrollkästchen) Kennzeichnung zum Festlegen des Kontrollkästchens, das standardmäßig aktiviert werden soll.
checkbox_label	checkbox_label	string	(Kontrollkästchen) Beschriftung, die für die Kontrollkästchenoption angezeigt wird.
date_limited	date_limited	boolean	(Datum) Kennzeichnen, um die zulässigen Datumsangaben auf eine Datumsoption zu beschränken.
date_limit_mode	date_limit_mode	string	(Datum) Der Grenzwerttyp, der in eine Datumsoption eingegeben werden darf.
date_earliest_value	date_earliest_value	date	(Datum) Das früheste Datum, das in die Datumsoption eingegeben werden darf, als formatierte ISO-8601-Zeichenfolge.
date_latest_value	date_latest_value	date	(Datum) Das letzte Datum, das in die Datumsoption eingegeben werden darf, als formatierte ISO-8601-Zeichenfolge.
file_types_mode	file_types_mode	string	(Datei) Die Art der Einschränkung für die Dateitypen, die mit einer Dateiuploadoption hochgeladen werden können. Werte: specific - schränkt Uploads auf bestimmte Dateitypen ein; all - ermöglicht alle Dateitypen.
file_types_supported	file_types_supported	array of string	(Datei) Der Dateityp, der hochgeladen werden darf, wenn der file_type_option Wert auf specific. festgelegt ist. Werte: images - Ermöglicht das Hochladen von Bild-MIME-Typen (bmp, gif, , jpg, jpegjpe, jfifjif, jfi, wbmppng, , ). xbmtiff documents- Ermöglicht das Hochladen von DOKUMENT-MIME-Typen (txt, , , rtf, doc, xlsdocx, xlsx, accdb, ppsxppsmdbpptodppuboneodtpptxods, ). odgodfpdf other – Ermöglicht dateitypen, die file_types_other im Array definiert sind.
file_types_other	file_types_other	array of string	(Datei) Eine Liste anderer Dateitypen, die mit der Option "Dateiupload" zulässig sind.
file_max_size	file_max_size	integer	(Datei) Die maximale Größe für eine Datei, die mit der Dateiuploadoption verwendet werden kann. Dies wird weiterhin vom Server eingeschränkt.
text_characters_limited	text_characters_limited	boolean	(Text, multi_line_text) Kennzeichnen, um die Länge eines Texts oder einer mehrzeiligen Texteingabe zu überprüfen.
text_min_length	text_min_length	integer	(Text, multi_line_text) Die für eine Text- oder mehrzeilige Textoption zulässige Mindestlänge.
text_max_length	text_max_length	integer	(Text, multi_line_text) Die maximale Länge, die für eine Text- oder mehrzeilige Textoption zulässig ist.
text_lines_limited	text_lines_limited	boolean	(multi_line_text) Kennzeichnen, um die maximale Anzahl von Zeilen zu überprüfen, die für eine mehrzeilige Texteingabe zulässig sind.
text_max_lines	text_max_lines	integer	(multi_line_text) Die maximale Anzahl von Zeilen, die für eine mehrzeilige Texteingabe zulässig sind.
number_limited	number_limited	boolean	(numbers_only_text) Kennzeichnen, um den Wert einer Zahlenoption einzuschränken.
number_limit_mode	number_limit_mode	string	(numbers_only_text) Der Grenzwerttyp für Werte, die für eine Zahlenoption eingegeben wurden.
number_lowest_value	number_lowest_value	double	(numbers_only_text) Der niedrigste zulässige Wert für eine Zahlenoption, wenn number_limited "true" ist.
number_highest_value	number_highest_value	double	(numbers_only_text) Der höchste zulässige Wert für eine Zahlenoption, wenn number_limited "true" ist.
number_integers_only	number_integers_only	boolean	(numbers_only_text) Kennzeichnen, um die Eingabe für eine Zahlenoption nur auf ganze Zahlen zu beschränken.
product_list_adjusts_inventory	product_list_adjusts_inventory	boolean	(product_list, product_list_with_images) Kennzeichnung zum automatischen Anpassen des Inventars für ein in der Liste enthaltenes Produkt.
product_list_adjusts_pricing	product_list_adjusts_pricing	boolean	(product_list, product_list_with_images) Kennzeichnen Sie, um den Preis des optionalen Produkts zum Hauptpreis des Produkts hinzuzufügen.
product_list_shipping_calc	product_list_shipping_calc	string	(product_list, product_list_with_images) Wie Sie die Gewichts- und Paketabmessungen des optionalen Produkts in das Versandangebot einteilen. Werte: none - nicht anpassen; weight - Nur Versandgewicht verwenden; package - Gewicht und Abmessungen verwenden.

coupons_Resource

Name	Pfad	Typ	Beschreibung
URL	url	string	URL der Coupons für API-Anforderungen
resource	resource	string	Ressource der Coupons

customer_Full

Name	Pfad	Typ	Beschreibung
E-Mail	email	string	Die E-Mail des Kunden. Muss eindeutig sein.
first_name	first_name	string	Der Vorname des Kunden.
last_name	last_name	string	Der Nachname des Kunden.
Firma	company	string	Die Firma des Kunden.
phone	phone	string	Die Telefonnummer des Kunden.
registration_ip_address	registration_ip_address	string	Die IP-Adresse, von der dieser Kunde registriert wurde.
Notizen	notes	string	Der Kunde notiert.
tax_exempt_category	tax_exempt_category	string	Der Steuerbefreiungskategoriecode für den Kunden.
customer_group_id	customer_group_id	integer	ID der Gruppe, zu der dieser Kunde gehört.
id	id	integer	Die eindeutige numerische ID des Kunden.
date_modified	date_modified	date-time	Das Datum, an dem der Kunde geändert wurde.
date_created	date_created	date-time	Das Datum, an dem der Kunde erstellt wurde.
address_count	address_count	integer	Gesamtanzahl der Kundenadressen.
attribute_count	attribute_count	integer	Gesamtanzahl der Kundenattribute.
force_password_reset	authentication.force_password_reset	boolean	Wenn truedieser Kunde gezwungen wird, das Kennwort bei der nächsten Anmeldung zu ändern.
Adressen	addresses	array of address_Full	Array von Kundenadressen. Beschränkt auf 10.
attributes	attributes	array of attribute_Full	Array von Kundenattributen. Beschränkt auf 10.
store_credit_amounts	store_credit_amounts	CustomerStoredCreditAmounts	Store-Gutschrift.
accepts_product_review_abandoned_cart_emails	accepts_product_review_abandoned_cart_emails	boolean	Er bestimmt, ob der Kunde registriert ist, um entweder Produktüberprüfungen oder aufgegebene Einkaufswagen-E-Mails zu erhalten oder beide E-Mails zu erhalten.
customerChannelIds	channel_ids	customerChannelIds	Array von Kanal-IDs, auf die der Kunde Zugriff hat.

CustomerCollectionResponse

Name	Pfad	Typ	Beschreibung
Daten	data	array of customer_Full

customerChannelIds

Array von Kanal-IDs, auf die der Kunde Zugriff hat.

Name	Pfad	Typ	Beschreibung
Gegenstände		integer

CustomerStoredCreditAmounts

Store-Gutschrift.

Name	Pfad	Typ	Beschreibung
Menge	amount	float

customUrl_Full

Die benutzerdefinierte URL für das Produkt im Storefront.

Name	Pfad	Typ	Beschreibung
URL	url	string	Produkt-URL im Storefront.
is_customized	is_customized	boolean	Gibt zurück true , wenn die URL vom Standardstatus geändert wurde (die automatisch zugewiesene URL, die BigCommerce bereitstellt).

formFields

Schreibgeschützt. Wenn Sie über erforderliche Adressformularfelder verfügen, müssen sie als optional festgelegt werden, bevor Sie eine Bestellung über die API erstellen.

Name	Pfad	Typ	Beschreibung
name	name	string	Schreibgeschützt. Wenn Sie über erforderliche Adressformularfelder verfügen, müssen sie als optional festgelegt werden, bevor Sie eine Bestellung über die API erstellen.
value	value	string	Schreibgeschützt. Wenn Sie über erforderliche Adressformularfelder verfügen, müssen sie als optional festgelegt werden, bevor Sie eine Bestellung über die API erstellen.

Links

Paginierungslinks für die vorherigen und nächsten Teile der gesamten Sammlung.

Name	Pfad	Typ	Beschreibung
vorhergehend	previous	string	Link zur vorherigen Seite, die in der Antwort zurückgegeben wird.
aktuell	current	string	Link zur aktuellen Seite, die in der Antwort zurückgegeben wird.
nächster	next	string	Link zur nächsten Seite, die in der Antwort zurückgegeben wird.

metaCollection_Full

Daten zur Antwort, einschließlich Paginierung und Sammlungssummen.

Name	Pfad	Typ	Beschreibung
pagination_Full	pagination	pagination_Full	Daten zur Antwort, einschließlich Paginierung und Sammlungssummen.

order_Resp

Order-Objekt, das in Antworten zurückgegeben wird.

Name	Pfad	Typ	Beschreibung
id	id	integer	Schreibgeschützt Die ID der Bestellung.
date_modified	date_modified	string	Ein schreibgeschützter Wert, der die letzte Änderung der Bestellung darstellt. Versuchen Sie nicht, diesen Wert in einem POST- oder PUT-Vorgang zu ändern oder festzulegen. RFC-2822
date_shipped	date_shipped	string	Ein schreibgeschützter Wert, der das Datum der Lieferung darstellt. Versuchen Sie nicht, diesen Wert in einem POST- oder PUT-Vorgang zu ändern oder festzulegen. RFC-2822
cart_id	cart_id	string	Die Einkaufswagen-ID, aus der diese Bestellung stammt, falls zutreffend. Korreliert mit der Cart-API. Dies ist ein READ-ONLY Feld; legen Oder ändern Sie den Wert in einer POST- oder PUT-Anforderung nicht.
status	status	string	Der Status enthält einen der Werte (Zeichenfolge, Optiona), die unter "Bestellstatus" definiert sind. Dieser Wert ist schreibgeschützt. Versuchen Sie nicht, diesen Wert in einem POST- oder PUT-Vorgang zu ändern oder festzulegen.
subtotal_tax	subtotal_tax	string	Ein schreibgeschützter Wert. Versuchen Sie nicht, diesen Wert in einem POST- oder PUT-Vorgang festzulegen oder zu ändern. (Float, Float-As-String, Integer)
shipping_cost_tax	shipping_cost_tax	string	Ein schreibgeschützter Wert. Versuchen Sie nicht, diesen Wert in einem POST- oder PUT-Vorgang zu ändern oder festzulegen. (Float, Float-As-String, Integer)
shipping_cost_tax_class_id	shipping_cost_tax_class_id	integer	Versandkostensteuerklasse. Ein schreibgeschützter Wert. Versuchen Sie nicht, diesen Wert in einem POST- oder PUT-Vorgang zu ändern oder festzulegen. (HINWEIS: Wert wird ignoriert, wenn die automatische Steuer im Store aktiviert ist.)
handling_cost_tax	handling_cost_tax	string	Ein schreibgeschützter Wert. Versuchen Sie nicht, diesen Wert in einem POST- oder PUT-Vorgang zu ändern oder festzulegen. (Float, Float-As-String, Integer)
handling_cost_tax_class_id	handling_cost_tax_class_id	integer	Ein schreibgeschützter Wert. Versuchen Sie nicht, diesen Wert in einem POST- oder PUT-Vorgang festzulegen oder zu ändern. (HINWEIS: Wert wird ignoriert, wenn die automatische Steuer im Store aktiviert ist.)
wrapping_cost_tax	wrapping_cost_tax	string	Ein schreibgeschützter Wert. Versuchen Sie nicht, diesen Wert in einem POST- oder PUT-Vorgang zu ändern oder festzulegen. (Float, Float-As-String, Integer)
wrapping_cost_tax_class_id	wrapping_cost_tax_class_id	integer	Ein schreibgeschützter Wert. Versuchen Sie nicht, diesen Wert in einem POST- oder PUT-Vorgang festzulegen oder zu ändern. (HINWEIS: Wert wird ignoriert, wenn die automatische Steuer im Store aktiviert ist.)
PaymentStatus	payment_status	PaymentStatus	Ein schreibgeschützter Wert. Versuchen Sie nicht, diesen Wert in einem POST- oder PUT-Vorgang festzulegen oder zu ändern.
store_credit_amount	store_credit_amount	string	Stellt die Store-Gutschrift dar, die der Käufer für diese einzelne Bestellung eingelöst hat. Dies ist ein schreibgeschützter Wert. Übergeben Sie keinen POST- oder PUT-Wert. (Float, Float-As-String, Integer)
gift_certificate_amount	gift_certificate_amount	string	Ein schreibgeschützter Wert. Übergeben Sie keinen POST- oder PUT-Wert. (Float, Float-As-String, Integer)
currency_id	currency_id	integer	Die Anzeigewährungs-ID. Kann sich von transaktionsaler Währung unterscheiden. Ein schreibgeschützter Wert. Übergeben Sie keinen POST- oder PUT-Wert.
currency_code	currency_code	string	Der Währungscode der Anzeigewährung, die zum Präsentieren von Preisen auf der Storefront verwendet wird. Ein schreibgeschützter Wert. Übergeben Sie keinen POST- oder PUT-Wert.
currency_exchange_rate	currency_exchange_rate	string	Der Wechselkurs zwischen der Standardwährung des Stores und der Anzeigewährung. Ein schreibgeschützter Wert. Übergeben Sie keinen POST- oder PUT-Wert. (Float, Float-As-String, Integer)
default_currency_id	default_currency_id	integer	Die Transaktionswährungs-ID. Ein schreibgeschützter Wert. Übergeben Sie keinen POST- oder PUT-Wert.
coupon_discount	coupon_discount	string	Ein schreibgeschützter Wert. Übergeben Sie keinen POST- oder PUT-Wert. (Float, Float-As-String, Integer)
shipping_address_count	shipping_address_count	double	Die Anzahl der Versandadressen, die dieser Transaktion zugeordnet sind. Ein schreibgeschützter Wert. Übergeben Sie keinen POST- oder PUT-Wert.
is_email_opt_in	is_email_opt_in	boolean	Gibt an, ob der Käufer ein Opt-In-Kontrollkästchen (auf der Checkout-Seite) zum Empfangen von E-Mails ausgewählt hat. Ein schreibgeschützter Wert. Übergeben Sie keinen POST- oder PUT-Wert.
order_source	order_source	string	Bestellungen, die über die Website des Stores übermittelt werden, enthalten einen www Wert. Bestellungen, die über die API übermittelt werden, werden auf external. Ein schreibgeschützter Wert. Übergeben Sie keinen POST- oder PUT-Wert.
products_Resource	products	products_Resource
shippingAddress_Resource	shipping_addresses	shippingAddress_Resource
coupons_Resource	coupons	coupons_Resource
status_id	status_id	integer	Die Staus-ID der Bestellung.
base_handling_cost	base_handling_cost	string	Der Wert der Kosten für die Basisbehandlung. (Float, Float-As-String, Integer)
base_shipping_cost	base_shipping_cost	string	Der Wert der Basisversandkosten. (Float, Float-As-String, Integer)
base_wrapping_cost	base_wrapping_cost	string	Der Wert der Basisumbruchkosten. (Float, Float-As-String, Integer)
billingAddress_Full	billing_address	billingAddress_Full	Erforderlich zum Erstellen einer Bestellung.
channel_id	channel_id	integer	Zeigt an, wo die Bestellung stammt. Die channel_id wird standardmäßig auf 1 festgelegt.
Kunden_ID	customer_id	double
customer_message	customer_message	string	Nachricht, dass der Kunde während des Auscheckens (Zahl, optional) -o das Order Comments Feld eingegeben hat.
date_created	date_created	string	Das Datum, an dem diese Bestellung erstellt wurde. Wenn nicht angegeben, wird standardmäßig die aktuelle Uhrzeit verwendet. Das Datum sollte im RFC 2822-Format vorliegen.
default_currency_code	default_currency_code	string	Der Währungscode der Transaktionswährung, in der der Käufer zahlt; Schreibbar, wenn mehrere Währungen aktiviert sind.
discount_amount	discount_amount	string	Betrag des Rabatts für diese Transaktion. (Float, Float-As-String, Integer)
ebay_order_id	ebay_order_id	string	Wenn die Bestellung über eBay aufgegeben wurde, wird die eBay-Bestellnummer eingeschlossen. Andernfalls lautet 0der Wert .
external_id	external_id	string	ID der Reihenfolge in einem anderen System. Beispielsweise die Amazon-Bestell-ID, wenn es sich um eine Amazon-Bestellung handelt. Dieses Feld kann in einem /POST-Element aktualisiert werden, aber die Verwendung eines /PUT zum Aktualisieren der Reihenfolge gibt einen Fehler von 400 zurück. Das Feld "external_id" kann nicht geschrieben werden. Entfernen Sie sie bitte aus Ihrer Anforderung, bevor Sie es erneut versuchen. Sie kann nicht einmal überschrieben werden.
external_source	external_source	string	Für Bestellungen, die über die API übermittelt oder geändert wurden, können Sie optional einen Wert übergeben, der zum Generieren der Bestellung verwendet wird. Beispiel: POS. Andernfalls ist der Wert null.
geoip_country	geoip_country	string	Der vollständige Name des Landes, in dem der Kunde den Kauf getätigt hat, basierend auf der IP.
geoip_country_iso2	geoip_country_iso2	string	Das Land, in dem der Kunde den Kauf getätigt hat, im ISO2-Format basierend auf der IP.
handling_cost_ex_tax	handling_cost_ex_tax	string	Der Wert der Bearbeitungskosten, ausgenommen Steuern. (Float, Float-As-String, Integer)
handling_cost_inc_tax	handling_cost_inc_tax	string	Der Wert der Bearbeitungskosten, einschließlich Steuern. (Float, Float-As-String, Integer)
ip_address	ip_address	string	IP-Adresse des Kunden, falls bekannt.
is_deleted	is_deleted	boolean	Gibt an, ob die Bestellung gelöscht wurde (archiviert). Auf "true" festgelegt, um eine Reihenfolge zu archivieren.
items_shipped	items_shipped	double	Die Anzahl der Artikel, die versandt wurden.
items_total	items_total	double	Die Gesamtanzahl der Elemente in der Reihenfolge.
order_is_digital	order_is_digital	boolean	Ob dies ein Auftrag für digitale Produkte ist.
PaymentMethod	payment_method	PaymentMethod	Die Zahlungsmethode für diese Bestellung. Dies kann eine der folgenden Sein: Manual, , Credit Card, cash, Test Payment Gateway, usw.
payment_provider_id	payment_provider_id	string	Die externe Transaktions-ID/Zahlungs-ID innerhalb des Zahlungsanbieters dieses Auftrags (wenn ein Zahlungsanbieter verwendet wurde).
refunded_amount	refunded_amount	string	Der Betrag, der von dieser Transaktion erstattet wurde. (Float, Float-As-String, Integer)
shipping_cost_ex_tax	shipping_cost_ex_tax	string	Der Wert der Versandkosten ohne Steuern. (Float, Float-As-String, Integer)
shipping_cost_inc_tax	shipping_cost_inc_tax	string	Der Wert der Versandkosten, einschließlich Steuern. (Float, Float-As-String, Integer)
staff_notes	staff_notes	string	Alle zusätzlichen Hinweise für Mitarbeiter.
subtotal_ex_tax	subtotal_ex_tax	string	Überschreiben des Werts für Teilergebnisse ohne Steuern. Wenn angegeben, ist das Feld subtotal_inc_tax ebenfalls erforderlich. (Float, Float-As-String, Integer)
subtotal_inc_tax	subtotal_inc_tax	string	Überschreiben des Werts für Teilergebnisse einschließlich Steuern. Wenn angegeben, ist das Feld subtotal_ex_tax ebenfalls erforderlich. (Float, Float-As-String, Integer)
TaxProviderId	tax_provider_id	TaxProviderId	BasicTaxProvider – Steuern werden manuell festgelegt. AvaTaxProvider – Dies gilt für den Zeitpunkt, an dem der Steueranbieter auf "automatisch" festgelegt wurde und die Bestellung nicht von der API erstellt wurde. Wird für Avalara verwendet. "" (leer) – Wenn der Steueranbieter unbekannt ist. Dazu gehören ältere Bestellungen und Bestellungen, die zuvor über die API erstellt wurden. Dies kann beim Erstellen einer Bestellung mithilfe eines POST festgelegt werden.
customer_locale	customer_locale	string	Gebietsschema des Kunden
total_ex_tax	total_ex_tax	string	Überschreiben Sie den Wert für die Summe ohne Steuern. Wenn angegeben, ist das Feld total_inc_tax ebenfalls erforderlich. (Float, Float-As-String, Integer)
total_inc_tax	total_inc_tax	string	Überschreiben Sie den Wert für die Summe, einschließlich Steuern. Wenn angegeben, ist das Feld total_ex_tax ebenfalls erforderlich. (Float, Float-As-String, Integer)
wrapping_cost_ex_tax	wrapping_cost_ex_tax	string	Der Wert der Umbruchkosten ohne Steuern. (Float, Float-As-String, Integer)
wrapping_cost_inc_tax	wrapping_cost_inc_tax	string	Der Wert der Umbruchkosten, einschließlich Steuern. (Float, Float-As-String, Integer)

orderCollection_Resp

Die Liste "Bestellungen", die in Antworten zurückgegeben wurde.

Name	Pfad	Typ	Beschreibung
order_Resp		order_Resp	Order-Objekt, das in Antworten zurückgegeben wird.

orderProduct_Resp

Bestellprodukt, das in Antworten zurückgegeben wurde.

Name	Pfad	Typ	Beschreibung
id	id	integer	Numerische ID dieses Produkts innerhalb dieser Bestellung.
order_id	order_id	integer	Numerische ID der zugeordneten Reihenfolge.
product_id	product_id	integer	Numerische ID des Produkts.
order_address_id	order_address_id	integer	Numerische ID der zugeordneten Bestelladresse.
name	name	string	Alias für name_customer – Der Produktname, der kunden im Store angezeigt wird.
sku	sku	string	Benutzerdefinierter Produktcode/Lagerhaltungseinheit (SKU).
type	type	string	Produkttyp.
base_price	base_price	string	Der Grundpreis des Produkts. (Float, Float-As-String, Integer).
price_ex_tax	price_ex_tax	string	Der Preis des Produkts ohne Steuern. (Float, Float-As-String, Integer).
price_inc_tax	price_inc_tax	string	Der Preis des Produkts einschließlich Steuern. (Float, Float-As-String, Integer).
price_tax	price_tax	string	Steuerbetrag, der auf ein einzelnes Produkt angewendet wird. Die Preissteuer wird wie folgt berechnet: "price_tax = price_inc_tax - price_ex_tax" (Float, Float-As-String, Integer).
base_total	base_total	string	Grundpreis insgesamt. (Float, Float-As-String, Integer).
total_ex_tax	total_ex_tax	string	Grundpreis ohne Steuern. (Float, Float-As-String, Integer).
total_inc_tax	total_inc_tax	string	Grundpreis einschließlich Steuern. (Float, Float-As-String, Integer).
total_tax	total_tax	string	Auf Produkte angewendete Gesamtsteuer. Wenn die Menge beispielsweise 2 ist, beträgt der Grundpreis 5 und der Steuersatz 10%. price_tax beträgt 50 $, und total_tax beträgt 1,00 $. Wenn ein manueller Rabatt angewendet wird, wird total_tax wie folgt kalkuliert: "(price_ex_tax - Rabatt)*tax_rate=total_tax" (Float, Float-As-String, Integer).
Menge	quantity	number	Menge des bestellten Produkts.
base_cost_price	base_cost_price	string	Der Kostenpreis des Produkts. Dies kann mithilfe der Katalog-API festgelegt werden. (Float, Float-As-String, Integer) Schreibgeschützt.
cost_price_inc_tax	cost_price_inc_tax	string	Der Preis des Produkts einschließlich Steuern. (Float, Float-As-String, Integer) Die Kosten Ihrer Produkte für Sie; Dies wird kunden nie angezeigt, kann aber für Buchhaltungszwecke verwendet werden. Schreibgeschützt.
cost_price_ex_tax	cost_price_ex_tax	string	Der Preis der Produkte ohne Steuern. (Float, Float-As-String, Integer) Die Kosten Ihrer Produkte für Sie; Dies wird kunden nie angezeigt, kann aber für Buchhaltungszwecke verwendet werden. Schreibgeschützt.
weight	weight	string	Gewicht des Produkts. (Float, Float-As-String, Integer).
cost_price_tax	cost_price_tax	string	Auf den Kostenpreis des Produkts angewendete Steuer. (Float, Float-As-String, Integer) Die Kosten Ihrer Produkte für Sie; Dies wird kunden nie angezeigt, kann aber für Buchhaltungszwecke verwendet werden. Schreibgeschützt.
is_refunded	is_refunded	boolean	Gibt an, ob das Produkt erstattet wurde.
refunded_amount	refunded_amount	string	Der Betrag, der von dieser Transaktion erstattet wurde. (Float, Float-As-String, Integer).
return_id	return_id	number	Numerische ID für die Rückerstattung.
wrapping_name	wrapping_name	string	Name der Geschenkumbruchoption.
base_wrapping_cost	base_wrapping_cost	string	Der Wert der Basisumbruchkosten. (Float, Float-As-String, Integer).
wrapping_cost_ex_tax	wrapping_cost_ex_tax	string	Der Wert der Umbruchkosten ohne Steuern. (Float, Float-As-String, Integer).
wrapping_cost_inc_tax	wrapping_cost_inc_tax	string	Der Wert der Umbruchkosten, einschließlich Steuern. (Float, Float-As-String, Integer).
wrapping_cost_tax	wrapping_cost_tax	string	Steuer auf Geschenkverpackungsoption angewendet. (Float, Float-As-String, Integer).
wrapping_message	wrapping_message	string	Nachricht zur zugehörigen Geschenkumbruchoption.
quantity_shipped	quantity_shipped	number	Die Menge dieses Artikels wurde versandt.
event_name	event_name	string	Name des Werbeereignisses/Lieferdatums.
event_date	event_date	date	Datum des Werbeereignisses/der geplanten Lieferung.
fixed_shipping_cost	fixed_shipping_cost	string	Feste Versandkosten für dieses Produkt. (Float, Float-As-String, Integer).
ebay_item_id	ebay_item_id	string	Artikel-ID für dieses Produkt auf eBay.
ebay_transaction_id	ebay_transaction_id	string	Transaktions-ID für dieses Produkt auf eBay.
option_set_id	option_set_id	integer	Numerische ID des Optionssatzes, der auf das Produkt angewendet wird.
parent_order_product_id	parent_order_product_id	integer	ID eines übergeordneten Produkts.
is_bundled_product	is_bundled_product	boolean	Ob dieses Produkt mit anderen Produkten gebündelt ist.
bin_picking_number	bin_picking_number	string	Bin pick number for the physical product.
applied_discounts	applied_discounts	array of object	Array von Objekten, die Rabatte enthalten, die auf das Produkt angewendet werden.
id	applied_discounts.id	string	Name des Coupons, der auf die Bestellung angewendet wurde.
Menge	applied_discounts.amount	string	Betrag des Rabatts. (Float, Float-As-String, Integer).
name	applied_discounts.name	string	Name des Coupons. Manual Discount beim Erstellen eines manuellen Rabatts.
Code	applied_discounts.code	string	Couponcode. Beim Erstellen eines manuellen Rabatts ist kein Code vorhanden.
target	applied_discounts.target	string	Bestimmt, ob der Rabatt auf Der Bestell- oder Produktebene angewendet wurde. Schreibgeschützt.
product_options	product_options	array of object	Array von Produktoptionsobjekten.
id	product_options.id	integer	Die eindeutige numerische ID der Option; erhöht sequenziell.
option_id	product_options.option_id	integer	Numerische ID der zugeordneten Option.
order_product_id	product_options.order_product_id	integer	Produkt-ID bestellen.
product_option_id	product_options.product_option_id	integer	Produktoptions-ID.
display_name	product_options.display_name	string	Alias für display_name_customer. Der Name der Produktoption, der dem Kunden im Storefront angezeigt wird.
display_value	product_options.display_value	string	Alias für display_value_customer. Der Wert der Produktoption, der kunden im Storefront angezeigt wird.
value	product_options.value	string	Dieser Wert wird verwendet, um auf den Upload der Kundendatei zuzugreifen.
type	product_options.type	string	Optionstyp.
name	product_options.name	string	Der Name der Option, wie intern verwendet. Muss eindeutig sein.
display_style	product_options.display_style	string	Wie sie im Store angezeigt wird. Beispiele sind Dropdown-, Optionsfelder oder Rechtecke.
display_name_customer	product_options.display_name_customer	string	Der Name der Produktoption, der kunden im Storefront angezeigt wird.
display_name_merchant	product_options.display_name_merchant	string	Der Produktoptionsname, der dem Händler in der Systemsteuerung angezeigt wird.
display_value_customer	product_options.display_value_customer	string	Der Wert der Produktoption, der kunden im Storefront angezeigt wird.
display_value_merchant	product_options.display_value_merchant	string	Der Wert der Produktoption, der dem Händler in der Systemsteuerung angezeigt wird.
external_id	external_id	string	ID der Reihenfolge in einem anderen System. Beispielsweise die Amazon-Bestell-ID, wenn es sich um eine Amazon-Bestellung handelt. Dieses Feld kann in einem /POST-Element aktualisiert werden, aber die Verwendung eines /PUT zum Aktualisieren der Reihenfolge gibt einen Fehler von 400 zurück. Das Feld "external_id" kann nicht geschrieben werden. Entfernen Sie sie bitte aus Ihrer Anforderung, bevor Sie es erneut versuchen. Sie kann nicht einmal überschrieben werden.
Upc	upc	string	Universeller Produktcode. Kann für benutzerdefinierte Produkte und Katalogprodukte geschrieben werden.
variant_id	variant_id	integer	Produkte variant_id. PUT oder POST. Dieses Feld ist für benutzerdefinierte Produkte nicht verfügbar.
name_customer	name_customer	string	Der Produktname, der kunden im Storefront angezeigt wird.
name_merchant	name_merchant	string	Der Produktname, der dem Händler in der Systemsteuerung angezeigt wird.

orderProductsCollection_Resp

Bestellen Sie produkte, die in Antworten zurückgegeben wurden.

Name	Pfad	Typ	Beschreibung
orderProduct_Resp		orderProduct_Resp	Bestellprodukt, das in Antworten zurückgegeben wurde.

orderShippingAddress_Resp

Bestellversandadresse, die als Antwort zurückgegeben wurde.

Name	Pfad	Typ	Beschreibung
id	id	integer	ID dieser Versandadresse.
order_id	order_id	integer	ID der Bestellung.
items_total	items_total	number	Die Gesamtanzahl der Elemente in der Reihenfolge.
items_shipped	items_shipped	number	Die Anzahl der Artikel, die versandt wurden.
base_cost	base_cost	string	Der Basiswert der Artikel der Bestellung. (Float, Float-As-String, Integer).
cost_ex_tax	cost_ex_tax	string	Der Wert der Artikel der Bestellung, ausgenommen Steuern. (Float, Float-As-String, Integer).
cost_inc_tax	cost_inc_tax	string	Der Wert der Artikel der Bestellung, einschließlich Steuern. (Float, Float-As-String, Integer).
cost_tax	cost_tax	string	Der Steuerbetrag für die Bestellung. (Float, Float-As-String, Integer).
cost_tax_class_id	cost_tax_class_id	integer	Die ID der auf das Produkt angewendeten Steuerklasse. (HINWEIS: Wert wird ignoriert, wenn die automatische Steuer aktiviert ist).
handling_cost_ex_tax	handling_cost_ex_tax	string	Die Bearbeitungsgebühr ohne Steuern. (Float, Float-As-String, Integer).
handling_cost_inc_tax	handling_cost_inc_tax	string	Die Bearbeitungsgebühr, einschließlich Steuern. (Float, Float-As-String, Integer).
handling_cost_tax	handling_cost_tax	string
handling_cost_tax_class_id	handling_cost_tax_class_id	integer	Ein schreibgeschützter Wert. Versuchen Sie nicht, diesen Wert in einem POST- oder PUT-Vorgang festzulegen oder zu ändern. (HINWEIS: Wert wird ignoriert, wenn die automatische Steuer im Store aktiviert ist).
shipping_zone_id	shipping_zone_id	number	Numerische ID der Versandzone.
shipping_zone_name	shipping_zone_name	string	Name der Versandzone.
form_fields	form_fields	array of formFields
shippingQuotes_Resource	shipping_quotes	shippingQuotes_Resource
shippingAddress_Base	shipping_addresses	shippingAddress_Base	Versandadresseneigenschaften, die für alle Anforderungen und Antworten gemeinsam sind.

orderShippingAddressCollection_Resp

Versandadressen, die als Antwort zurückgegeben werden.

Name	Pfad	Typ	Beschreibung
orderShippingAddress_Resp		orderShippingAddress_Resp	Bestellversandadresse, die als Antwort zurückgegeben wurde.

pagination_Full

Daten zur Antwort, einschließlich Paginierung und Sammlungssummen.

Name	Pfad	Typ	Beschreibung
gesamt	total	integer	Gesamtanzahl der Elemente im Resultset.
count	count	integer	Gesamtanzahl der Elemente in der Sammlungsantwort.
per_page	per_page	integer	Die Menge der in der Sammlung pro Seite zurückgegebenen Elemente, gesteuert durch den Limit-Parameter.
current_page	current_page	integer	Die Seite, auf der Sie sich derzeit in der Sammlung befinden.
total_pages	total_pages	integer	Die Gesamtanzahl der Seiten in der Auflistung.
Links	links	Links	Paginierungslinks für die vorherigen und nächsten Teile der gesamten Sammlung.

product_Base

Name	Pfad	Typ	Beschreibung
name	name	string	Der Produktname.
type	type	string	Der Produkttyp. Einer von: physical - eine physische Lagereinheit, digital - ein digitaler Download.
sku	sku	string	Benutzerdefinierter Produktcode/Lagerhaltungseinheit (SKU).
Beschreibung	description	string	Die Produktbeschreibung, die HTML-Formatierung enthalten kann.
weight	weight	double	Gewicht des Produkts, das bei der Berechnung der Versandkosten verwendet werden kann. Dies basiert auf der im Store festgelegten Einheit.
width	width	double	Breite des Produkts, die bei der Berechnung der Versandkosten verwendet werden kann.
Tiefe	depth	double	Tiefe des Produkts, das bei der Berechnung der Versandkosten verwendet werden kann.
height	height	double	Höhe des Produkts, das bei der Berechnung der Versandkosten verwendet werden kann.
Preis	price	double	Der Preis des Produkts. Der Preis sollte basierend auf den Store-Einstellungen Steuern enthalten oder ausschließen.
cost_price	cost_price	double	Der Kostenpreis des Produkts. Nur für Referenz gespeichert; sie wird nicht verwendet oder an einer beliebigen Stelle im Store angezeigt.
retail_price	retail_price	double	Die Einzelhandelskosten des Produkts. Bei Eingabe wird der Verkaufspreis auf der Produktseite angezeigt.
sale_price	sale_price	double	Bei Eingabe wird der Verkaufspreis anstelle des Werts im Preisfeld verwendet, wenn die Kosten des Produkts berechnet werden.
map_price	map_price	double	Mindestpreis für angekündigte Preise
tax_class_id	tax_class_id	integer	Die ID der auf das Produkt angewendeten Steuerklasse. (HINWEIS: Wert wird ignoriert, wenn die automatische Steuer aktiviert ist.)
product_tax_code	product_tax_code	string	Akzeptiert AvaTax System Tax Codes, die Produkte und Dienstleistungen identifizieren, die in spezielle Mehrwertsteuerkategorien fallen. Durch die Verwendung dieser Codes können Händler, die die Avalara Premium-Integration von BigCommerce abonnieren, Mehrwertsteuern genauer berechnen. Stores ohne Avalara Premium ignorieren den Code bei der Berechnung der Mehrwertsteuer. Übergeben Sie nicht mehr als einen Code. Bei den Codes wird die Groß-/Kleinschreibung beachtet. Ausführliche Informationen finden Sie in der Dokumentation von Avalara.
categories	categories	array of integer	Ein Array von IDs für die Kategorien, zu denen dieses Produkt gehört. Wenn ein Produkt aktualisiert wird, werden alle Produktkategorien überschrieben, wenn ein Array von Kategorien bereitgestellt wird. Akzeptiert nicht mehr als 1.000 ID-Werte.
brand_id	brand_id	integer	Ein Produkt kann während eines Produkts /PUT oder /POST zu einer vorhandenen Marke hinzugefügt werden.
inventory_level	inventory_level	integer	Aktuelle Bestandsebene des Produkts. Die einfache Bestandsverfolgung muss aktiviert sein (siehe Feld inventory_tracking ), damit dies wirksam wird.
inventory_warning_level	inventory_warning_level	integer	Warnstufe des Inventars für das Produkt. Wenn die Bestandsstufe des Produkts unter die Warnstufe fällt, wird der Besitzer des Stores informiert. Die einfache Bestandsverfolgung muss aktiviert sein (siehe Feld inventory_tracking ), damit dies wirksam wird.
inventory_tracking	inventory_tracking	string	Der Typ der Bestandsnachverfolgung für das Produkt. Werte sind: none - Lagerbestände werden nicht nachverfolgt; product - Lagerbestände werden mithilfe der inventory_level Felder nachverfolgt inventory_warning_level ; variant - Lagerbestände werden basierend auf Varianten nachverfolgt, die ihre eigenen Warn- und Bestandsniveaus beibehalten.
fixed_cost_shipping_price	fixed_cost_shipping_price	double	Fixversandkosten für das Produkt. Wenn dieser Wert definiert ist, wird dieser Wert während des Auscheckens anstelle der normalen Versandkostenberechnung verwendet.
is_free_shipping	is_free_shipping	boolean	Kennzeichnung, die verwendet wird, um anzugeben, ob das Produkt kostenlos versandt. Ist truedie Versandkosten für das Produkt null.
is_visible	is_visible	boolean	Kennzeichnen, um zu bestimmen, ob das Produkt für Kunden angezeigt werden soll, die im Store surfen. Wenn truedas Produkt angezeigt wird. Wenn falsedas Produkt ausgeblendet wird, wird es aus der Ansicht ausgeblendet.
is_featured	is_featured	boolean	Kennzeichnen Sie, um zu bestimmen, ob das Produkt beim Anzeigen des featured products Stores im Panel enthalten sein soll.
related_products	related_products	array of integer	Ein Array von IDs für die zugehörigen Produkte.
Garantie	warranty	string	Garantieinformationen, die auf der Produktseite angezeigt werden. Kann HTML-Formatierung enthalten.
bin_picking_number	bin_picking_number	string	Die BIN-Auswahlnummer für das Produkt.
layout_file	layout_file	string	Die Layoutvorlagendatei, die zum Rendern dieser Produktkategorie verwendet wird. Dieses Feld ist nur für Stores mit angewendetem Blueprint-Design schreibbar.
Upc	upc	string	Der UPC-Code des Produkts, der in Feeds für Einkaufsvergleichswebsites und Integrationen externer Kanäle verwendet wird.
search_keywords	search_keywords	string	Eine durch Trennzeichen getrennte Liste von Schlüsselwörtern, die beim Durchsuchen des Stores verwendet werden können, um das Produkt zu finden.
availability	availability	string	Verfügbarkeit des Produkts. Verfügbarkeitsoptionen sind: available - das Produkt kann auf der Storefront erworben werden; disabled - das Produkt wird in der Storefront aufgeführt, kann aber nicht gekauft werden; preorder - das Produkt wird für Vorbestellungen aufgeführt.
availability_description	availability_description	string	Verfügbarkeitstext, der auf der Checkout-Seite unter dem Produkttitel angezeigt wird. Teilt dem Kunden mit, wie lange es normalerweise dauert, um dieses Produkt zu versenden, z. B. "In der Regel in 24 Stunden.".
gift_wrapping_options_type	gift_wrapping_options_type	string	Art der Geschenkumbruchoptionen. Werte: any - alle Geschenkumbruchoptionen im Geschäft zulassen; none - Geschenkumbruch auf dem Produkt nicht zulassen; list – geben Sie eine Liste der IDs im gift_wrapping_options_list Feld an.
gift_wrapping_options_list	gift_wrapping_options_list	array of integer	Eine Liste der Geschenkumbruchoptions-IDs.
sort_order	sort_order	integer	Priorität für dieses Produkt, wenn es in Produktlisten auf Kategorieseiten und in Suchergebnissen enthalten ist. Untere ganze Zahlen platzieren das Produkt näher am Anfang der Ergebnisse.
condition	condition	string	Die Produktbedingung. Wird auf der Produktseite angezeigt, wenn der is_condition_shown Wert des Felds lautet true. Mögliche Werte: New, Used, Refurbished.
is_condition_shown	is_condition_shown	boolean	Kennzeichen, das verwendet wird, um zu bestimmen, ob der Produktzustand dem Kunden auf der Produktseite angezeigt wird.
order_quantity_minimum	order_quantity_minimum	integer	Die Mindestmenge, die eine Bestellung enthalten muss, um berechtigt zu sein, dieses Produkt zu kaufen.
order_quantity_maximum	order_quantity_maximum	integer	Die maximale Menge, die eine Bestellung beim Kauf des Produkts enthalten kann.
page_title	page_title	string	Benutzerdefinierter Titel für die Produktseite. Wenn sie nicht definiert ist, wird der Produktname als Metatitel verwendet.
meta_keywords	meta_keywords	array of string	Benutzerdefinierte Metastichwörter für die Produktseite. Wenn sie nicht definiert ist, werden die Standardstichwörter des Stores verwendet.
meta_description	meta_description	string	Benutzerdefinierte Metabeschreibung für die Produktseite. Wenn sie nicht definiert ist, wird die Standardmetabeschreibung des Speichers verwendet.
view_count	view_count	integer	Die Häufigkeit, mit der das Produkt angezeigt wurde.
preorder_release_date	preorder_release_date	date-time	Veröffentlichungsdatum der Vorbestellung. Details zum Festlegen der Verfügbarkeit eines Produkts zur Annahme von Vorbestellungen finden Sie im availability Feld.
preorder_message	preorder_message	string	Benutzerdefinierte Meldung vom erwarteten Datum, die auf der Produktseite angezeigt werden soll. Wenn nicht definiert, wird die Nachricht standardmäßig für die storeweite Einstellung festgelegt. Kann den %%DATE%% Platzhalter enthalten, der für das Veröffentlichungsdatum ersetzt wird.
is_preorder_only	is_preorder_only	boolean	Wenn dieser Wert auf "true" festgelegt ist, wird der Vorbestellungsstatus automatisch entfernt. Wenn dieser Wert auf "false" festgelegt ist, wird der Vorbestellungsstatus am Veröffentlichungsdatum nicht entfernt. Sie muss entweder in der Systemsteuerung oder mithilfe der API manuell geändert werden. Verwenden des API-Satzes availability auf available.
is_price_hidden	is_price_hidden	boolean	False standardmäßig, das angibt, dass der Preis dieses Produkts auf der Produktseite angezeigt werden soll. Wenn dieser wert festgelegt trueist, wird der Preis ausgeblendet. (HINWEIS: Damit der Wert erfolgreich festgelegt is_price_hiddentruewerden disabledkann, muss der availability Wert .)
price_hidden_label	price_hidden_label	string	Standardmäßig eine leere Zeichenfolge. Ist is_price_hidden dies trueder Wert, wird anstelle des Preises der Wert price_hidden_label angezeigt. (HINWEIS: Zum erfolgreichen Festlegen eines nicht leeren Zeichenfolgenwerts mit is_price_hidden festgelegtem trueWert muss der availability Wert . disabled)
customUrl_Full	custom_url	customUrl_Full	Die benutzerdefinierte URL für das Produkt im Storefront.
open_graph_type	open_graph_type	string	Der Typ des Produkts, standardmäßig auf product.
open_graph_title	open_graph_title	string	Der Titel des Produkts, wenn nicht angegeben, wird stattdessen der Produktname verwendet.
open_graph_description	open_graph_description	string	Beschreibung, die für das Produkt verwendet werden soll, wenn nicht angegeben, wird stattdessen die meta_description verwendet.
open_graph_use_meta_description	open_graph_use_meta_description	boolean	Kennzeichnen Sie das Kennzeichen, um festzustellen, ob produktbeschreibung oder open graph description verwendet wird.
open_graph_use_product_name	open_graph_use_product_name	boolean	Kennzeichnen Sie das Kennzeichen, um zu ermitteln, ob der Produktname oder der Geöffnete Graph-Name verwendet wird.
open_graph_use_image	open_graph_use_image	boolean	Kennzeichnen Sie das Kennzeichen, um zu ermitteln, ob produkt- oder open graph-Bild verwendet wird.
brand_name oder brand_id	brand_name or brand_id	string	Die Marke kann während einer Produkt-PUT- oder POST-Anforderung erstellt werden. Wenn die Marke bereits vorhanden ist, wird das Produkt hinzugefügt. Wenn nicht die Marke erstellt und das Produkt hinzugefügt wird. Wenn Sie sie verwenden brand_name , wird eine Fuzzy-Übereinstimmung ausgeführt und die Marke hinzugefügt. eg. "Common Good" und "Common Good" sind identisch. Der Markenname wird nicht als Teil einer Produktantwort zurückgegeben. Nur die brand_id.
gtin	gtin	string	Global Trade Item Number
mpn	mpn	string	Herstellerteilnummer
reviews_rating_sum	reviews_rating_sum	integer	Die Gesamtbewertung für das Produkt.
reviews_count	reviews_count	integer	Die Häufigkeit, mit der das Produkt bewertet wurde.
total_sold	total_sold	integer	Die Gesamtmenge des verkauften Produkts.
custom_fields	custom_fields	array of productCustomField_Put
bulk_pricing_rules	bulk_pricing_rules	array of bulkPricingRule_Full
images	images	array of productImage_Full
videos	videos	array of productVideo_Full

product_Full

Name	Pfad	Typ	Beschreibung
product_Base	schema	product_Base
date_created	date_created	date-time	Das Datum, an dem das Produkt erstellt wurde.
date_modified	date_modified	date-time	Das Datum, an dem das Produkt geändert wurde.
id	id	integer	ID des Produkts. Schreibgeschützt.
base_variant_id	base_variant_id	integer	Der eindeutige Bezeichner der Basisvariante, die einem einfachen Produkt zugeordnet ist. Dieser Wert gilt null für komplexe Produkte.
calculated_price	calculated_price	double	Der Preis des Produkts, wie auf der Storefront zu sehen. Er ist gleich dem sale_price, wenn festgelegt, und wenn price es kein sale_price.
options	options	array of productOption_Base
Modifizierer	modifiers	array of productModifier_Full
option_set_id	option_set_id	integer	Gibt an, dass sich das Produkt in einem Option Set (Legacy V2-Konzept) befindet.
option_set_display	option_set_display	string	Legacy-Vorlageneinstellung, die steuert, ob die Option auf der Seite oder unterhalb des Produktbilds und der Beschreibung angezeigt wird.
productVariant_Full	variants	productVariant_Full

ProductCollectionResponse

Name	Pfad	Typ	Beschreibung
Daten	data	array of product_Full
metaCollection_Full	meta	metaCollection_Full	Daten zur Antwort, einschließlich Paginierung und Sammlungssummen.

productCustomField_Put

Ruft benutzerdefinierte Felder ab, die einem Produkt zugeordnet sind. Auf diese Weise können Sie zusätzliche Informationen angeben, die auf der Seite des Produkts angezeigt werden, z. B. die ISBN eines Buchs oder das Veröffentlichungsdatum einer DVD.

Name	Pfad	Typ	Beschreibung
id	id	integer	Die eindeutige numerische ID des benutzerdefinierten Felds; erhöht sequenziell. Erforderlich zum Aktualisieren eines vorhandenen benutzerdefinierten Felds in /PUT-Anforderung. Read-Only
name	name	string	Der Name des Felds, das auf der Storefront, Bestellungen usw. angezeigt wird. Erforderlich für /POST
value	value	string	Der Name des Felds, das auf der Storefront, Bestellungen usw. angezeigt wird. Erforderlich für /POST

productImage_Full

Allgemeine ProductImage-Eigenschaften.

Name	Pfad	Typ	Beschreibung
image_file	image_file	string	Der lokale Pfad zur ursprünglichen Bilddatei, die in BigCommerce hochgeladen wurde.
is_thumbnail	is_thumbnail	boolean	Kennzeichnen Sie die Kennzeichnung, ob das Bild als Miniaturansicht des Produkts verwendet wird.
sort_order	sort_order	integer	Die Reihenfolge, in der das Bild auf der Produktseite angezeigt wird. Höhere ganze Zahlen weisen dem Bild eine niedrigere Priorität zu. Wenn beim Aktualisieren das Bild eine niedrigere Priorität erhält, werden sort_orderalle Bilder mit demselben sort_order oder größer als der neue sort_order Wert des Bilds neu angeordnet.
Beschreibung	description	string	Die Beschreibung für das Bild.
image_url	image_url	string	Muss ein vollqualifizierter URL-Pfad sein, einschließlich des Protokolls. Grenzwert von 8 MB pro Datei.
id	id	integer	Die eindeutige numerische ID des Bilds; erhöht sequenziell.
product_id	product_id	integer	Der eindeutige numerische Bezeichner für das Produkt, dem das Bild zugeordnet ist.
url_zoom	url_zoom	string	Die Zoom-URL für dieses Bild. Dies wird standardmäßig als Zoombild auf Produktseiten verwendet, wenn Zoombilder aktiviert sind.
url_standard	url_standard	string	Die Standard-URL für dieses Bild. Standardmäßig wird dies für Produktseitenbilder verwendet.
url_thumbnail	url_thumbnail	string	Die Miniaturansichts-URL für dieses Bild. Standardmäßig ist dies die Bildgröße, die auf der Kategorieseite und in Seitenbereichen verwendet wird.
url_tiny	url_tiny	string	Die winzige URL für dieses Bild. Standardmäßig ist dies die Bildgröße, die für Miniaturansichten unter dem Produktbild auf einer Produktseite verwendet wird.
date_modified	date_modified	date-time	Das Datum, an dem das Produktbild geändert wurde.

productModifier_Base

Allgemeine Modifizierereigenschaften.

Name	Pfad	Typ	Beschreibung
type	type	string	BigCommerce-API, die bestimmt, wie sie auf der Storefront angezeigt wird. Zulässige Werte: date, , checkbox, file, numbers_only_texttextproduct_list_with_imagesproduct_listradio_buttonsmulti_line_textrectanglesdropdown. swatch Erforderlich in einer /POST.
required	required	boolean	Gibt an, ob diese Änderung erforderlich ist oder nicht beim Auschecken. Erforderlich in einer /POST.
sort_order	sort_order	integer	Die Reihenfolge, in der die Modifizierer auf der Produktdetailseite angezeigt werden.
config_Full	config	config_Full	Die Werte für die Optionskonfiguration können je nach dem erstellten Modifizierer variieren.
display_name	display_name	string	Der Name der Option, die im Storefront angezeigt wird.

productModifier_Full

Produktmodifizierer

Name	Pfad	Typ	Beschreibung
productModifier_Base	schema	productModifier_Base	Allgemeine Modifizierereigenschaften.
id	id	integer	Die eindeutige numerische ID des Modifizierers; erhöht sequenziell.
product_id	product_id	integer	Die eindeutige numerische ID des Produkts, zu dem die Option gehört.
name	name	string	Der name der eindeutigen Option. Automatisch generiert aus dem Anzeigenamen, einem Zeitstempel und der Produkt-ID.
option_values	option_values	array of productModifierOptionValue_Full

productModifierOptionValue_Full

Produktmodifer option_value.

Name	Pfad	Typ	Beschreibung
is_default	is_default	boolean	Das Kennzeichen für die Vorauswahl eines Werts als Standard im Storefront. Dieses Feld wird für Farbmusteroptionen/Modifizierer nicht unterstützt.
label	label	string	Der Text, der den Wert im Storefront identifiziert. Erforderlich in einer /POST.
sort_order	sort_order	integer	Die Reihenfolge, in der der Wert auf der Produktseite angezeigt wird. Erforderlich in einer /POST.
value_data	value_data	object	Zusätzliche Daten, die den Wert beschreiben, basierend auf dem Typ der Option oder Modifizierer, mit dem der Wert verknüpft ist. Die swatch Typoption kann ein Array von colors, mit bis zu drei Hexadezimalfarbschlüsseln oder einem image_urlVollständigbild-URL-Pfad einschließlich Protokoll akzeptieren. Für die product list Typoption ist eine product_id. Für die checkbox Typoption ist ein boolesches Flag erforderlich, das aufgerufen checked_valuewird, um zu bestimmen, welcher Wert als aktivierter Zustand angesehen wird. Wenn keine Daten verfügbar sind, wird zurückgegeben null.
adjusters_Full	adjusters	adjusters_Full
id	id	integer	Die eindeutige numerische ID des Werts; erhöht sequenziell.
option_id	option_id	integer

productOption_Base

Allgemeine Optionseigenschaften.

Name	Pfad	Typ	Beschreibung
id	id	integer	Die eindeutige numerische ID der Option wird sequenziell erhöht.
product_id	product_id	integer	Die eindeutige numerische ID des Produkts, zu dem die Option gehört.
display_name	display_name	string	Der Name der Option, die im Storefront angezeigt wird.
type	type	string	Die Art der Option, die bestimmt, wie sie im Storefront angezeigt wird. Zulässige Werte: radio_buttons, , rectangles, dropdownproduct_list, , . swatchproduct_list_with_images Zur Referenz sind die ehemaligen v2-API-Werte: RB = radio_buttons, RT = Rechtecke, S = Dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
productOptionConfig_Full	config	productOptionConfig_Full	Die Werte für die Optionskonfiguration können je nach dem erstellten Modifizierer variieren.
sort_order	sort_order	integer	Reihenfolge, in der die Option im Storefront angezeigt wird.
productOptionOptionValue_Full	option_values	productOptionOptionValue_Full	Produktoption option_value.

productOptionConfig_Full

Die Werte für die Optionskonfiguration können je nach dem erstellten Modifizierer variieren.

Name	Pfad	Typ	Beschreibung
default_value	default_value	string	(Datum, Text, multi_line_text, numbers_only_text) Der Standardwert. Wird in einer Datumsoption als ISO-8601-formatierte Zeichenfolge oder auf einer Textoption als Zeichenfolge angezeigt.
checked_by_default	checked_by_default	boolean	(Kontrollkästchen) Kennzeichnung zum Festlegen des Kontrollkästchens, das standardmäßig aktiviert werden soll.
checkbox_label	checkbox_label	string	(Kontrollkästchen) Beschriftung, die für die Kontrollkästchenoption angezeigt wird.
date_limited	date_limited	boolean	(Datum) Kennzeichnen, um die zulässigen Datumsangaben auf eine Datumsoption zu beschränken.
date_limit_mode	date_limit_mode	string	(Datum) Der Grenzwerttyp, der in eine Datumsoption eingegeben werden darf.
date_earliest_value	date_earliest_value	date	(Datum) Das früheste Datum, das in die Datumsoption eingegeben werden darf, als formatierte ISO-8601-Zeichenfolge.
date_latest_value	date_latest_value	date	(Datum) Das letzte Datum, das in die Datumsoption eingegeben werden darf, als formatierte ISO-8601-Zeichenfolge.
file_types_mode	file_types_mode	string	(Datei) Die Art der Einschränkung für die Dateitypen, die mit einer Dateiuploadoption hochgeladen werden können. Werte: specific - schränkt Uploads auf bestimmte Dateitypen ein; all - ermöglicht alle Dateitypen.
file_types_supported	file_types_supported	array of string	(Datei) Der Dateityp, der hochgeladen werden darf, wenn der file_type_option Wert auf specific. festgelegt ist. Werte: images - Ermöglicht das Hochladen von Bild-MIME-Typen (bmp, gif, , jpg, jpegjpe, jfifjif, jfi, wbmppng, , ). xbmtiff documents- Ermöglicht das Hochladen von DOKUMENT-MIME-Typen (txt, , , rtf, doc, xlsdocx, xlsx, accdb, ppsxppsmdbpptodppuboneodtpptxods, ). odgodfpdf other – Ermöglicht dateitypen, die file_types_other im Array definiert sind.
file_types_other	file_types_other	array of string	(Datei) Eine Liste anderer Dateitypen, die mit der Option "Dateiupload" zulässig sind.
file_max_size	file_max_size	integer	(Datei) Die maximale Größe für eine Datei, die mit der Dateiuploadoption verwendet werden kann. Dies wird weiterhin vom Server eingeschränkt.
text_characters_limited	text_characters_limited	boolean	(Text, multi_line_text) Kennzeichnen, um die Länge eines Texts oder einer mehrzeiligen Texteingabe zu überprüfen.
text_min_length	text_min_length	integer	(Text, multi_line_text) Die für eine Text- oder mehrzeilige Textoption zulässige Mindestlänge.
text_max_length	text_max_length	integer	(Text, multi_line_text) Die maximale Länge, die für eine Text- oder mehrzeilige Textoption zulässig ist.
text_lines_limited	text_lines_limited	boolean	(multi_line_text) Kennzeichnen, um die maximale Anzahl von Zeilen zu überprüfen, die für eine mehrzeilige Texteingabe zulässig sind.
text_max_lines	text_max_lines	integer	(multi_line_text) Die maximale Anzahl von Zeilen, die für eine mehrzeilige Texteingabe zulässig sind.
number_limited	number_limited	boolean	(numbers_only_text) Kennzeichnen, um den Wert einer Zahlenoption einzuschränken.
number_limit_mode	number_limit_mode	string	(numbers_only_text) Der Grenzwerttyp für Werte, die für eine Zahlenoption eingegeben wurden.
number_lowest_value	number_lowest_value	double	(numbers_only_text) Der niedrigste zulässige Wert für eine Zahlenoption, wenn number_limited "true" ist.
number_highest_value	number_highest_value	double	(numbers_only_text) Der höchste zulässige Wert für eine Zahlenoption, wenn number_limited "true" ist.
number_integers_only	number_integers_only	boolean	(numbers_only_text) Kennzeichnen, um die Eingabe für eine Zahlenoption nur auf ganze Zahlen zu beschränken.
product_list_adjusts_inventory	product_list_adjusts_inventory	boolean	(product_list, product_list_with_images) Kennzeichnung zum automatischen Anpassen des Inventars für ein in der Liste enthaltenes Produkt.
product_list_adjusts_pricing	product_list_adjusts_pricing	boolean	(product_list, product_list_with_images) Kennzeichnen Sie, um den Preis des optionalen Produkts zum Hauptpreis des Produkts hinzuzufügen.
product_list_shipping_calc	product_list_shipping_calc	string	(product_list, product_list_with_images) Wie Sie die Gewichts- und Paketabmessungen des optionalen Produkts in das Versandangebot einteilen. Werte: none - nicht anpassen; weight - Nur Versandgewicht verwenden; package - Gewicht und Abmessungen verwenden.

productOptionOptionValue_Full

Produktoption option_value.

Name	Pfad	Typ	Beschreibung
is_default	is_default	boolean	Das Kennzeichen für die Vorauswahl eines Werts als Standard im Storefront. Dieses Feld wird für Farbmusteroptionen/Modifizierer nicht unterstützt.
label	label	string	Der Text, der den Wert im Storefront identifiziert. Erforderlich in einer /POST.
sort_order	sort_order	integer	Die Reihenfolge, in der der Wert auf der Produktseite angezeigt wird. Erforderlich in einer /POST.
value_data	value_data	object	Zusätzliche Daten, die den Wert beschreiben, basierend auf dem Typ der Option oder Modifizierer, mit dem der Wert verknüpft ist. Die swatch Typoption kann ein Array von colors, mit bis zu drei Hexadezimalfarbschlüsseln oder einem image_urlVollständigbild-URL-Pfad einschließlich Protokoll akzeptieren. Für die product list Typoption ist eine product_id. Für die checkbox Typoption ist ein boolesches Flag erforderlich, das aufgerufen checked_valuewird, um zu bestimmen, welcher Wert als aktivierter Zustand angesehen wird. Wenn keine Daten verfügbar sind, wird zurückgegeben null.
id	id	integer	Die eindeutige numerische ID des Werts; erhöht sequenziell.

ProductResponse

Name	Pfad	Typ	Beschreibung
product_Full	data	product_Full
meta	meta	object	Leeres Metaobjekt; kann später verwendet werden.

products_Resource

Name	Pfad	Typ	Beschreibung
URL	url	string
resource	resource	string

productVariant_Full

Name	Pfad	Typ	Beschreibung
cost_price	cost_price	double	Der Kostenpreis der Variante. Nicht betroffen von Preislistenpreisen.
Preis	price	double	Der Grundpreis dieser Variante auf der Storefront. Wenn eine Preislisten-ID verwendet wird, wird der Preislistenwert verwendet. Wenn keine Preislisten-ID verwendet wird und dieser Wert lautet null, wird der Standardpreis des Produkts (im Feld "Produktressource price " festgelegt) als Grundpreis verwendet.
sale_price	sale_price	double	Der Verkaufspreis dieser Variante am Storefront. Wenn eine Preislisten-ID verwendet wird, wird der Preislistenwert verwendet. Wenn keine Preislisten-ID verwendet wird und dieser Wert null ist, wird der Verkaufspreis des Produkts (im Feld "Produktressource price " festgelegt) als Verkaufspreis verwendet.
retail_price	retail_price	double	Der Einzelhandelspreis dieser Variante am Storefront. Wenn eine Preislisten-ID verwendet wird, wird der Preislistenwert verwendet. Wenn keine Preislisten-ID verwendet wird und dieser Wert null ist, wird der Einzelhandelspreis des Produkts (im Feld "Produktressource price " festgelegt) als Einzelhandelspreis verwendet.
weight	weight	double	Die Grundgewichtung dieser Variante auf der Storefront. Wenn dieser Wert null ist, wird die Standardgewichtung des Produkts (im Gewichtsfeld "Produktressource") als Basisgewichtung verwendet.
width	width	double	Breite der Variante, die bei der Berechnung der Versandkosten verwendet werden kann. Wenn dieser Wert lautet null, wird die Standardbreite des Produkts (im Feld "Produktressource width ") als Basisbreite verwendet.
height	height	double	Höhe der Variante, die bei der Berechnung der Versandkosten verwendet werden kann. Wenn dieser Wert lautet null, wird die Standardhöhe des Produkts (im Feld "Produktressource height " festgelegt) als Basishöhe verwendet.
Tiefe	depth	double	Tiefe der Variante, die bei der Berechnung der Versandkosten verwendet werden kann. Wenn dieser Wert lautet null, wird die Standardtiefe des Produkts (im Feld "Produktressource depth " festgelegt) als Basistiefe verwendet.
is_free_shipping	is_free_shipping	boolean	Kennzeichnung, die verwendet wird, um anzugeben, ob die Variante über einen kostenlosen Versand verfügt. Ist truedie Versandkosten für die Variante null.
fixed_cost_shipping_price	fixed_cost_shipping_price	double	Fixversandkosten für die Variante. Wenn dieser Wert definiert ist, wird dieser Wert während des Auscheckens anstelle der normalen Versandkostenberechnung verwendet.
purchasing_disabled	purchasing_disabled	boolean	Wenn truediese Variante auf der Storefront nicht bearbeitbar ist.
purchasing_disabled_message	purchasing_disabled_message	string	Wenn purchasing_disabled dies der Fall ist true, sollte diese Meldung im Storefront angezeigt werden, wenn die Variante ausgewählt ist.
Upc	upc	string	Der UPC-Code, der in Feeds für Shoppingvergleichswebsites und Integrationen externer Kanäle verwendet wird.
inventory_level	inventory_level	integer	Lagerbestandsebene für die Variante, die verwendet wird, wenn die inventory_tracking des Produkts auf variantfestgelegt ist.
inventory_warning_level	inventory_warning_level	integer	Wenn die Variante auf diese Bestandsebene trifft, wird sie als niedrig eingestuft.
bin_picking_number	bin_picking_number	string	Gibt an, wo sich die Variante in einem Lager befindet.
mpn	mpn	string	Die Herstellerteilnummer (MPN) für die Variante.
id	id	integer
product_id	product_id	integer
sku	sku	string
sku_id	sku_id	integer	Schreibgeschützter Verweis auf die SKU-ID der v2-API. Null, wenn es sich um eine Basisvariante handelt.
option_values	option_values	array of productVariantOptionValue_Full	Array von Options- und Optionswerten-IDs, aus denen diese Variante besteht. Wird leer sein, wenn die Variante die Basisvariante des Produkts ist.
calculated_price	calculated_price	double	Der Preis der Variante, wie auf der Storefront zu sehen. Dieser Preis berücksichtigt sale_price alle Preisanpassungsregeln, die für diese Variante gelten.
calculated_weight	calculated_weight	double

productVariantOptionValue_Full

Name	Pfad	Typ	Beschreibung
option_display_name	option_display_name	string	Der Name der Option.
label	label	string	Die Bezeichnung des Optionswerts.
id	id	integer	option_value ID.
option_id	option_id	integer	option ID.

productVideo_Base

Das Modell für einen POST zum Erstellen eines Videos auf einem Produkt.

Name	Pfad	Typ	Beschreibung
title	title	string	Der Titel für das Video. Wenn sie leer gelassen werden, wird dies entsprechend den Daten auf einer Hostwebsite ausgefüllt.
Beschreibung	description	string	Die Beschreibung für das Video. Wenn sie leer gelassen werden, wird dies entsprechend den Daten auf einer Hostwebsite ausgefüllt.
sort_order	sort_order	integer	Die Reihenfolge, in der das Video auf der Produktseite angezeigt wird. Höhere ganze Zahlen weisen dem Video eine niedrigere Priorität zu. Wenn beim Aktualisieren das Video eine niedrigere Priorität erhält, werden sort_orderalle Videos mit demselben sort_order oder größer als der neue sort_order Wert des Videos neu angeordnet.
type	type	string	Der Videotyp (ein kurzer Name einer Hostwebsite).
video_id	video_id	string	Die ID des Videos auf einer Hostwebsite.

productVideo_Full

Ein Produktvideomodell.

Name	Pfad	Typ	Beschreibung
productVideo_Base	schema	productVideo_Base	Das Modell für einen POST zum Erstellen eines Videos auf einem Produkt.
id	id	integer	Die eindeutige numerische ID des Produktvideos; erhöht sequenziell.
product_id	product_id	integer	Der eindeutige numerische Bezeichner für das Produkt, dem das Bild zugeordnet ist.
length	length	string	Länge des Videos. Dies wird entsprechend den Daten auf einer Hostwebsite ausgefüllt.

Einkaufsdisabled

Name	Pfad	Typ	Beschreibung
status	status	boolean	Kennzeichnen Sie, ob der Modifiziererwert den Einkauf deaktiviert, wenn er auf der Storefront ausgewählt ist. Dies kann zum vorübergehenden Deaktivieren eines bestimmten Modifiziererwerts verwendet werden.
message	message	string	Die Meldung, die im Storefront angezeigt wird, wenn der Status "Kauf deaktiviert" lautet true.

shippingAddress_Base

Versandadresseneigenschaften, die für alle Anforderungen und Antworten gemeinsam sind.

Name	Pfad	Typ	Beschreibung
first_name	first_name	string
last_name	last_name	string
Firma	company	string
street_1	street_1	string	Straße (erste Zeile).
street_2	street_2	string	Straße (zweite Zeile).
city	city	string
Staat	state	string
zip	zip	string	Postleitzahl als Zeichenfolge.
country	country	string
country_iso2	country_iso2	string	2-Buchstaben ISO Alpha-2-Code für das Land.
phone	phone	string	Telefonnummer des Empfängers.
E-Mail	email	string	E-Mail-Adresse des Empfängers.
shipping_method	shipping_method	string	Textcode zur Identifizierung des BigCommerce-Versandmoduls, das vom Kunden ausgewählt wurde.

shippingAddress_Resource

Name	Pfad	Typ	Beschreibung
URL	url	string	URL der Versandadresse für API-Anforderungen
resource	resource	string

shippingQuotes_Resource

Name	Pfad	Typ	Beschreibung
URL	url	string	Diese URL gibt einen 204 für Versandangebote zurück. Um Versandangebote zurückzugeben:'/shipping_addresses/shipping_address_id/shipping_quotes'.
resource	resource	string	Diese URL gibt einen 204 für Versandangebote zurück. Um Versandangebote zurückzugeben:'/shipping_addresses/shipping_address_id/shipping_quotes'.

PaymentStatus

Ein schreibgeschützter Wert. Versuchen Sie nicht, diesen Wert in einem POST- oder PUT-Vorgang festzulegen oder zu ändern.

Ein schreibgeschützter Wert. Versuchen Sie nicht, diesen Wert in einem POST- oder PUT-Vorgang festzulegen oder zu ändern.

PaymentStatus

string

PaymentMethod

Die Zahlungsmethode für diese Bestellung. Dies kann eine der folgenden Sein: Manual, , Credit Card, cash, Test Payment Gateway, usw.

Die Zahlungsmethode für diese Bestellung. Dies kann eine der folgenden Sein: Manual, , Credit Card, cash, Test Payment Gateway, usw.

PaymentMethod

string

TaxProviderId

BasicTaxProvider – Steuern werden manuell festgelegt.

AvaTaxProvider – Dies gilt für den Zeitpunkt, an dem der Steueranbieter auf "automatisch" festgelegt wurde und die Bestellung nicht von der API erstellt wurde. Wird für Avalara verwendet.

"" (leer) – Wenn der Steueranbieter unbekannt ist. Dazu gehören ältere Bestellungen und Bestellungen, die zuvor über die API erstellt wurden. Dies kann beim Erstellen einer Bestellung mithilfe eines POST festgelegt werden.

BasicTaxProvider – Steuern werden manuell festgelegt.

AvaTaxProvider – Dies gilt für den Zeitpunkt, an dem der Steueranbieter auf "automatisch" festgelegt wurde und die Bestellung nicht von der API erstellt wurde. Wird für Avalara verwendet.

"" (leer) – Wenn der Steueranbieter unbekannt ist. Dazu gehören ältere Bestellungen und Bestellungen, die zuvor über die API erstellt wurden. Dies kann beim Erstellen einer Bestellung mithilfe eines POST festgelegt werden.

TaxProviderId

string