Dokumentation für die Verwendung der API
UTF-8.application/json.
{
"error": "You may only perform 2 requests for this action every 10 seconds.",
"maxRequests": 2,
"timespanInSeconds": 10,
"waitSecondsUntilNextRequest": 8
}
{
"error": "Maximum number of calls for license 'Demo' reached.",
"maximumCalls": 100,
"callsCount": 101
}
Stellt die Verbindung zu einer E-Commerce-Plattform her und gibt ein Token zurück
application/x-www-form-urlencoded gesendet werden.| Parameter | Beispiel | Beschreibung |
|---|---|---|
| applicationId | Postman |
Schlüssel-Name der aufrufenden Anwendung. Entnehmen Sie diese Angabe Ihrer Lizenz. |
| licenseId | 55ff7975-91a5-45ed-8b93-8fd05f90b761 |
GUID Entnehmen Sie diese Angabe Ihrer Lizenz |
| serialNumber | 99999999999999 |
Seriennummer Entnehmen Sie diese Angabe Ihrer Lizenz |
| platform | Shopware6 |
Geben Sie die E-Commerce-Plattform an mit der die Verbindung hergestellt werden soll. Diese muss in der Lizenz freigeschaltet sein. |
| configJson | { "Url": "https://example.com", "AccessKey": "874KJHJFG876876JHBHGFHZ", "SecretAccessKey": "MvUnwLMrYKRqRMEo02Dhe2Gnb7y2YGkHACVvNJlWdl2mEStYY8O" } |
Verbindungsparameter für die jeweilige E-Commerce-Plattform - diese sind abhängig von der verwendeten Plattform im JSON-Format |
| withNativeData | true |
(optional) Wenn dieser Parameter auf true gestellt ist, werden die Original-Daten-Objekte der E-Commerce-Plattformen mit in die Daten eingebettet (Im Feld "Native")(Mögliche Werte: true, false) |
Plattform-Kürzel (Parameter platform): Gambio
Anleitung für die Einrichtung des API-Zugangs in Gambio
| Parameter | Beispiel | Beschreibung |
|---|---|---|
| Url | "https://example.com" |
URL zu dem Gambio-Online-Shop |
| Username | "admin@example.com" |
Benutzername zu dem Gambio-Online-Shop (typischerweise ein Administrator-Benutzer) |
| Password | "admin-secret123" |
Passwort zu dem Benutzernamen |
{
"Url": "https://example.com",
"Username": "admin@example.com",
"Password": "admin-secret123"
}
Plattform-Kürzel (Parameter platform): Shopify
Anleitung für die Einrichtung des API-Zugangs in Shopify
Die Verbindung zu Shopify befindet sich noch im Beta-Stadium. Möglicherweise funktionieren noch nicht alle Endpunkte vollständig. Darüber hinaus können aktuell nur die folgenden Endpunkte in Verbindung mit Shopify verwendet werden.
| Parameter | Beispiel | Beschreibung |
|---|---|---|
| Url | "https://meinshop.myshopify.com" |
URL zu dem Shopify-Online-Shop (Wichtig: MyShopify-Adresse) |
| AccessToken | "shpat_34...7ba" |
In Shopify erstelltes Zugriffstoken |
{
"Url": "https://meinshop.myshopify.com",
"AccessToken": "shpat_34...7ba",
}
Plattform-Kürzel (Parameter platform): Shopware5
Anleitung für die Einrichtung des API-Zugangs in Shopware 5
| Parameter | Beispiel | Beschreibung |
|---|---|---|
| Url | "https://example.com" |
URL zu dem Shopware-Online-Shop |
| Username | "admin" |
Benutzername zu dem Shopware-Online-Shop |
| ApiKey | "MvUnwLMrYKRqRMEo02Dh...vNJlWdl2mEStYY8O" |
API-Schlüssel zu dem Benutzernamen |
{
"Url": "https://example.com",
"Username": "admin",
"ApiKey": "MvUnwLMrYKRqRMEo02Dh...vNJlWdl2mEStYY8O"
}
Plattform-Kürzel (Parameter platform): Shopware6
Anleitung für die Einrichtung des API-Zugangs in Shopware 6
| Parameter | Beispiel | Beschreibung |
|---|---|---|
| Url | "https://example.com" |
URL zu dem Shopware-Online-Shop |
| AccessKey | "874KJHJFG8...76JHBHGFHZ" |
In Shopware 6 erstellte Zugangs-ID |
| SecretAccessKey | "MvUnwLMrYKRqRMEo02Dh...vNJlWdl2mEStYY8O" |
In Shopware 6 erstellter Sicherheitsschlüssel |
| ApiVersion | 3 |
(optional) Die verwendete API-Version Mögliche Werte:
Dieser Parameter ist nötig von Shopware Version 6.1 bis 6.3 |
| EnrichOrderWithProductData | true |
(optional) Produktdaten zu jeder Position laden, im Feld "nativeProduct") (Standardwert: false) |
| UseManufacturerNumberAsSku | true |
(optional) Hersteller-Artikelnummer vorrangig als Artikelnummer verwenden (number) (Standardwert: false) |
| RecalcInventoryUpdateByAvailableStock | true |
(optional) Bei der Aktualisierung von Beständen den im Shop reservierten Bestand automatisch dem übertragenen Bestand hinzufügen (addieren) (Standardwert: false) |
| PriorizeNetPrices | true |
(optional) Für das Auslesen und Speichern von Preisen Netto- statt Bruttopreise nutzen (Standardwert: false) |
| DefaultPriceGroupCode | "Alle Kunden der Standard-Kundengruppe" |
(optional) Für Speichern von Staffel-Preisen, die ohne GroupCode übergeben werden, wird automatisch dieser GroupCode eingesetzt (Standardwert: null) |
{
"Url": "https://example.com",
"AccessKey": "874KJHJFG8...76JHBHGFHZ",
"SecretAccessKey": "MvUnwLMrYKRqRMEo02Dh...vNJlWdl2mEStYY8O",
"ApiVersion": 3,
"EnrichOrderWithProductData": true,
"UseManufacturerNumberAsSku": true,
"RecalcInventoryUpdateByAvailableStock": true,
"PriorizeNetPrices": true,
"DefaultPriceGroupCode": "Alle Kunden der Standard-Kundengruppe"
}
Plattform-Kürzel (Parameter platform): WooCommerce
Anleitung für die Einrichtung des API-Zugangs in WooCommerce
| Parameter | Beispiel | Beschreibung |
|---|---|---|
| Url | "https://example.com" |
URL zu dem WooCommerce-Online-Shop |
| ConsumerKey | "ck_jllrbstm2euhdou...psfp6le4gxxhs" |
In WooCommerce erstellter Schlüssel |
| ConsumerSecret | "cs_cawl3ld5i0tgbox...c9mcbt2a1yajm" |
In WooCommerce erstelltes Geheimnis |
| AddCredentialsToUri | true |
(optional) Bei Verbindungsproblemen kann dieser Parameter auf true gestellt werden, um die Anmelde-Parameter in die URL zu integrieren. |
| DefaultTaxCountry | "DE" |
(optional) Länder-Einstellung zur Berechnung der Umsatzsteuer für Bestell-Positionen als ISO-Ländercode (Standard-Wert "DE") |
{
"Url": "https://example.com",
"ConsumerKey": "ck_jllrbstm2euhdou...psfp6le4gxxhs",
"ConsumerSecret": "cs_cawl3ld5i0tgbox...c9mcbt2a1yajm",
"AddCredentialsToUri": true,
"DefaultTaxCountry": "DE"
}
Plattform-Kürzel (Parameter platform): epages
| Parameter | Beispiel | Beschreibung |
|---|---|---|
| Url | "https://12345678.shop.strato.de/rs/shops" |
URL zu dem epages-Online-Shop bei dem jeweiligen Provider (in dem Beispiel wurde Stato benutzt) |
| ShopID | "12345678" |
Vom Provider vergebene Shop-ID |
| AccessToken | "mWwImuZYh...wDSEVCJJL" |
Im epages-Shop erstellter Zugriffsschlüssel (Access Token) |
{
"Url": "https://12345678.shop.strato.de/rs/shops",
"ShopID": "12345678",
"AccessToken": "mWwImuZYh...wDSEVCJJL"
}
{
"token_type": "Bearer",
"expires_in": 59.999995738333332,
"access_token": "eyJhbGciOi...7bXlwpiSvms0"
}
HTTP 400 - Bad Request
{
"error": "Connecting to platform \"...\" error: ..."
}
Empfangen von Bestellungen als absteigend nach Bestell-Datum sortierte Liste
| Parameter | Beispiel | Beschreibung |
|---|---|---|
| limit | &limit=50 |
(optional) Die maximale Anzahl Datensätze, die pro Seite abgerufen werden sollen Der Standardwert und die maximale Anzahl an Datensätzen werden durch die verwendete E-Commerce-Plattform bestimmt. |
| page | &page=3 |
(optional) Die Seite des Ergebnisses (Standard-Wert "1") |
| lastId | &lastId=325 |
(optional) Nur Bestellungen seit der letzten ID abrufen Wenn dieser Parameter nicht angegeben wird, werden alle Bestellungen abgerufen |
| state | &state[0]=Open&state[1]=Processing&state[2]=Closed |
(optional) Filtern von bestimmten Status als Auflistung (Array) Mögliche Werte:
Wenn dieser Parameter nicht angegeben wird, werden alle Bestellungen abgerufen. |
Abruf einer einzigen Bestellung
| Parameter | Beispiel | Beschreibung |
|---|---|---|
| id | /97c05101bd6c4252918422db89bca541 |
Eindeutige ID der Bestellung |
{
"data": {
Order
}
}
Abschließen einer Bestellung
| Parameter | Beispiel | Beschreibung |
|---|---|---|
| id | /97c05101bd6c4252918422db89bca541/fulfill |
Eindeutige ID der Bestellung |
Es muss ein Fulfillment-Objekt übergeben werden.
{
"data":{
"shippingService": "DHL",
"trackingCode": "JJD98967890809765098",
"shippingDate": "2019-09-05T00:00:00+02:00",
"newState": "Processing",
"status": "in_progress"
}
}
Abrufen von Lagerbeständen als Liste
| Parameter | Beispiel | Beschreibung |
|---|---|---|
| limit | &limit=50 |
Die maximale Anzahl Datensätze, die pro Seite abgerufen werden sollen Der Standardwert und die maximale Anzahl an Datensätzen werden durch die verwendete E-Commerce-Plattform bestimmt. |
| page | &page=3 |
Die Seite des Ergebnisses |
Aktualisieren von Lagerbeständen als Liste
Es müssen Inventory-Objekte übergeben werden.
{
"data": [
{
"identifier": 57,
"inStock": 255
},
{
"identifier": 40,
"inStock": 250
}
]
}
Abrufen von Artikel-Listenpreise als Liste
| Parameter | Beispiel | Beschreibung |
|---|---|---|
| sku | &sku=8776545 |
Preise nur für eine Artikelnummer anzeigen |
| limit | &limit=50 |
Die maximale Anzahl Datensätze, die pro Seite abgerufen werden sollen Der Standardwert und die maximale Anzahl an Datensätzen werden durch die verwendete E-Commerce-Plattform bestimmt. |
| page | &page=3 |
Die Seite des Ergebnisses |
Aktualisieren von Artikel-Listenpreisen als Liste
Es müssen Artikel-Listenpreis-Objekte übergeben werden.
{
"data": [
{
"identifier": "8776546",
"priceGroups": [
{
"price": 39.90,
"scales": [
{
"fromQuantity": 5,
"price": 38.29
},
{
"fromQuantity": 8,
"price": 38.19
}
]
}
]
},
{
"identifier": "E78690",
"priceGroups": [
{
"price": 999.20
},
{
"groupCode": "Reseller",
"price": 799.20
}
]
}
]
}
Abruf von statistischen Daten zu den übertragenen Datensätzen und Anzahl der Transaktionen (Telemetrie) für die eigene Lizenz
| Parameter | Beispiel | Beschreibung |
|---|---|---|
| year | year=2020 |
Jahr für das die monatlichen Daten berechnet werden sollen |
| month | month=3 |
Monat für den die monatlichen Daten berechnet werden sollen |
Es wird ein Telemetry-Objekt zurückgegeben
{
"productSerial": "99999999999999",
"month": 3,
"year": 2020,
"monthsRequestsCount": 2567,
"monthsItemsCount": 4598,
"requestCountSum": 7609,
"itemsCountSum": 14657
}
Token mit allen Eigenschaften
| Feld | Beschreibung |
|---|---|
| token_type |
Token-Typ - derzeit immer Bearer |
| expires_in |
Gültigkeit des Tokens in Minuten |
| platform |
Das zu verwendendende Token |
Bestellung mit allen Eigenschaften
| Feld | Beschreibung |
|---|---|
| identifier |
Eindeutige ID für die Bestellung |
| native |
Enthält die kompletten Rohdaten der Bestellung (abhängig vom Shop-System) ( |
| platform |
Plattform-Code der E-Commerce-Plattform |
| number |
Nummer der Bestellung innerhalb des Shop-Systems (in der Regel fortlaufend) |
| orderDate |
Datum und Uhrzeit, wann die Bestellung aufgegeben wurde |
| customerName |
Name des Bestellers, in der Regel Vorname- und Nachname aber auch Firma möglich |
|
Name des Bestellers |
|
| netAmount |
Gesamtsumme netto |
| amount |
Gesamtsumme brutto |
| shippingTermsCode |
Spezifischer Shop-Code der Versandart |
| shippingTermsName |
Bezeichnung der Versandart im Shop |
| shippingCosts |
Versandkosten brutto |
| shippingCostsNet |
Versandkosten netto |
| paymentTermsCode |
Spezifischer Shop-Code der Zahlungsart |
| paymentTermsName |
Bezeichnung der Zahlungsart im Shop |
| paymentTransactionCode |
Transaktions-Nummer für Zahlungen über Zahlungsanbieter (wie z. B. PayPal) |
| notes |
Bemerkungen zur Bestellung seitens des Bestellers |
| currencyCode |
Währungs-Kürzel für Geldbeträge |
| state |
Status der Bestellung
|
| isPaid |
|
| vatNumber |
Steuer-Identifikationsnummer (z. B. bei Firmen) |
| shippingTrackingCode |
Verfolgungsnummer des Paketdienstes |
| shippingService |
Code des Paketdienstes |
| status |
Shop-Spezifischer Status der Bestellung (abhängig von der E-Commerce-Plattform) |
| shopName |
Name des Shops (z. B. bei mandantenfähigen Shop-Systemen) |
| positions |
Positionen der Bestellung als Auflistung (Array) mit folgenden Eigenschaften:
Mögliche Positions-Arten
|
| billingAddress |
Rechnungs-Adresse mit folgenden Eigenschaften:
|
| shippingAddress |
Liefer-Adresse mit folgenden Eigenschaften:
|
Bestellabschluss mit allen Eigenschaften
| Feld | Beschreibung |
|---|---|
| shippingService |
Paketdienst-Kürzel |
| trackingCode |
Sendungsverfolgungs-Nummer |
| shippingDate |
Datum und Uhrzeit, wann die Bestellung versendet wurde |
| newState POST: Pflichtfeld |
Geänderter Status der Bestellung Status der Bestellung
|
| status |
Nativer Status im Shop-System |
Lagerbestand mit allen Eigenschaften
| Feld | Beschreibung |
|---|---|
| identifier PUT: Pflichtfeld |
Eindeutige ID des Lagerbestands-Datensatzes |
| native |
Enthält die kompletten Rohdaten des Lagerbestands-Datensatzes (abhängig vom Shop-System) ( |
| platform |
Plattform-Code der E-Commerce-Plattform |
| inStock PUT: Pflichtfeld |
Absolute verfügbare Bestandsmenge |
| restockTimeDays |
Wiederbeschaffungszeit in Tagen (Dezeit nur mit Shopware 6 nutzbar) |
| productSku |
Artikelnummer |
| productName |
Artikelbezeichnung (Nur vorhanden, wenn bei der Bestands-Abfrage vom Shop vorhanden) |
Artikel-Listenpreis mit allen Eigenschaften
| Feld | Beschreibung |
|---|---|
| identifier PUT: Pflichtfeld |
Eindeutige ID des Artikel-Listenpreis-Datensatzes |
| native |
Enthält die kompletten Rohdaten des Artikel-Listenpreis-Datensatzes (abhängig vom Shop-System) ( |
| platform |
Plattform-Code der E-Commerce-Plattform |
| productName |
Bezeichnung des Artikels |
| variantName |
Bezeichnung der Variante |
| priceGroups PUT: Pflichtfeld |
Preis-Gruppen mit folgenden Eigenschaften:
|
Informationen für die Anzahl der durch die Lizenz genutzten Transaktionen.
| Feld | Beschreibung |
|---|---|
| productSerial |
Seriennummer der aktuellen Lizenz |
| month |
Monat für den die Berechnungen erfolgt sind (z. B. 1 = Januar, 3 = März, 12 = Dezember) |
| year |
Jahr für das die Berechnungen erfolgt sind |
| monthsRequestsCount |
Anzahl der Transaktionen für den angegebenen Monat |
| monthsItemsCount |
Anzahl der Datensätze für den angegebenen Monat (Dieser Wert ist höher als |
| requestCountSum |
Anzahl aller Transaktionen |
| itemsCountSum |
Anzahl aller Datensätze |