Lieferantendokumentation

Füttern Sie Ihre App und rufen Sie Bestellungen über die API ab

Verbinden Sie Ihre ERP-, E-Commerce-Plattform, POS- oder Business-Software mit SellViaApp. Senden Sie Kategorien, Produkte und Preise und rufen Sie dann bestätigte Shop-Bestellungen als JSON ab.

Basis-URLhttps://api.sellviaapp.com/

Erforderliche HeaderX-API-Key + Bearer

Maschinenlesbarer Vertrag · JSONOpenAPI 3.1 · Download ↓ Maschinenlesbarer Vertrag · YAMLOpenAPI 3.1 · Download ↓ Unterstützung der Entwicklerapi@sellviaapp.com

Schnellstart

Authentifizieren, eine Route auswählen, testen.

Rufen Sie den X-API-Key ab und erstellen Sie den Bearer-Token unter Dashboard → API. Geben Sie beide unten ein. Wählen Sie dann bei einem Endpunkt „Testen · Generieren“, um die Antwort und Beispielcode für cURL, PHP 8 oder JavaScript zu erhalten.

X-API-Key

Bearer token

Anmeldeinformationen unvollständigGeben Sie die X-API-Key und Bearer Token zur Vorbereitung eines Tests.

Anmeldeinformationen bleiben nur für diese Seite im Speicher. Für einen kundenbezogenen Vorgang fügen Sie customer_id hinzu.

Keep in mindHTTPS + JSON · beide Anmeldeinformationen serverseitig beibehalten · niemals Token an die Unterstützung senden.

Real time

Verbinden Sie SellViaApp mit jedem HTTPS-fähigen System.

Ein Webhook informiert Ihr ERP, CRM oder anderes System über wichtige Änderungen. Das betrifft Produkte, Kunden, Warenkörbe, Bestellungen, Dokumente und Einstellungen. Das vollständige Objekt können Sie bei Bedarf über die API abrufen.

Erstellen Sie das Ziel

Geben Sie in Dashboard → Webhooks eine HTTPS-URL ein und wählen Sie Ereignisse aus. Das Geheimnis wird einmal gezeigt.

Überprüfung der Unterschrift

Berechnen Sie HMAC-SHA256 über timestamp.delivery_id.raw_body und vergleichen Sie es mit X-SellViaApp-Signature.

Schnell anerkennen

Geben Sie HTTP 2xx zurück, deduplizieren Sie mit X-SellViaApp-Event-Id und verarbeiten Sie dann im Hintergrund.

Zuverlässige LieferungBis zu acht Versuche mit progressiven Verzögerungen. Ein wiederholt fehlgeschlagenes Ziel wird automatisch angehalten, und jede Lieferung bleibt im Dashboard sichtbar und wiederholbar.

payload = timestamp + "." + delivery_id + "." + raw_body
expected = "v1=" + HMAC_SHA256(payload, signing_secret)

Endpunkte

Kunden

Erstellen und Verwalten von Kundenkonten für jeden Shop.

5 routes

POST /customer/add API-Schlüssel

Erstellen Sie einen Kunden und generieren Sie den Lieferanten-Login.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

nom String Erforderlich

Nachname des Kunden.

prenom String Erforderlich

Vorname des Kunden.

email E-Mail-E-Mail-Adresse Erforderlich

E-Mail einzigartig innerhalb des Lieferanten.

denomination String Optional

Name des Unternehmens, fakultativ.

password String Erforderlich

Mindestens acht Zeichen.

address String Optional

Postanschrift.

zipcode String Optional

Postal code.

city String Optional

City.

country String Optional

Country.

phone String Optional

Phone number.

cellphone String Optional

Mobiltelefonnummer.

vat_number String Optional

VAT number.

language String Optional

ISO-Sprachcode mit zwei Buchstaben.

Output

Mögliche Ergebnisse

201Ressourcen geschaffen

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /customer/list Schlüssel + Träger

Liste oder Filter autorisierter Kundeninformationen.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

page Ganzzahl Optional

Seitenzahl, beginnend bei 1.

per_page Ganzzahl Optional

Anzahl der Ergebnisse pro Seite.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /customer/me Schlüssel + Träger

Holen Sie sich das angemeldete Kundenprofil ab.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /customer/update Schlüssel + Träger

Aktualisierungsprofil, Sprache, Typ, E-Mail oder Passwort.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

first_name String Optional

First name.

last_name String Optional

Last name.

company String Optional

Company name.

email E-Mail-E-Mail-Adresse Optional

Neue E-Mail-Adresse, einzigartig im Shop.

address String Optional

Postanschrift.

zipcode String Optional

Postal code.

city String Optional

City.

country String Optional

Country.

phone String Optional

Phone number.

cellphone String Optional

Mobiltelefonnummer.

vat_number String Optional

VAT number.

language String Optional

ISO-Sprachcode mit zwei Buchstaben.

account_type enum Optional

company | individual

notifications_enabled Boolestan Optional

Mobile Benachrichtigungen zulassen.

password String Optional

Neues Passwort, mindestens acht Zeichen.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /customer/deleteaccount Schlüssel + Träger

Deaktivieren Sie das Kundenkonto im aktiven Shop.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Endpunkte

Katalog

Kategorien, Produkte, Bilder, Preise, Lager, Promotionen und Favoriten.

28 routes

GET /fam1/list Schlüssel + Träger

Primäre Kategorien auflisten.

Input

Verfügbare Parameter

URL query

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /fam1/add Schlüssel + Träger

Erstellen Sie eine primäre Kategorie.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

name String Erforderlich

Name der sichtbaren Kategorie.

external_key String Optional

Stabile Kennung aus Ihrer Software.

sort_order Ganzzahl Optional

Anzeigereihenfolge, beginnend bei 1.

image_url url Optional

HTTPS Image URL.

Output

Mögliche Ergebnisse

201Ressourcen geschaffen

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /fam1/update Schlüssel + Träger

Aktualisieren Sie eine primäre Kategorie.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Identifikator der zu aktualisierenden Kategorie.

name String Erforderlich

Name der sichtbaren Kategorie.

external_key String Optional

Stabile Kennung aus Ihrer Software.

sort_order Ganzzahl Optional

Anzeigereihenfolge, beginnend bei 1.

image_url url Optional

HTTPS Image URL.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /fam1/delete Schlüssel + Träger

Verstecken Sie eine primäre Kategorie.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Identifikator der zu verbergenden Kategorie.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /fam2/list Schlüssel + Träger

Unterkategorien auflisten.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

category_id Ganzzahl Optional

Beschränken Sie die Ergebnisse auf eine primäre Kategorie.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /fam2/add Schlüssel + Träger

Erstellen Sie eine Unterkategorie.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

category_id Ganzzahl Erforderlich

Kennung der primären Kategorie des Mutterunternehmens.

name String Erforderlich

Name der sichtbaren Kategorie.

external_key String Optional

Stabile Kennung aus Ihrer Software.

sort_order Ganzzahl Optional

Anzeigereihenfolge, beginnend bei 1.

image_url url Optional

HTTPS Image URL.

Output

Mögliche Ergebnisse

201Ressourcen geschaffen

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /fam2/update Schlüssel + Träger

Aktualisieren Sie eine Unterkategorie.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Kennung der zu aktualisierenden Unterkategorie.

name String Erforderlich

Name der sichtbaren Kategorie.

external_key String Optional

Stabile Kennung aus Ihrer Software.

sort_order Ganzzahl Optional

Anzeigereihenfolge, beginnend bei 1.

image_url url Optional

HTTPS Image URL.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /fam2/delete Schlüssel + Träger

Verstecken Sie eine Unterkategorie.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Kennung der zu verbergenden Unterkategorie.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /product/list Schlüssel + Träger

Liste und Suche nach Produkten mit Paginierung.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

page Ganzzahl Optional

Seitenzahl, beginnend bei 1.

per_page Ganzzahl Optional

Anzahl der Ergebnisse pro Seite.

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

search String Optional

Suche nach Code, Name oder Beschreibung.

category_id Ganzzahl Optional

Filter für die Hauptkategorie.

subcategory_id Ganzzahl Optional

Filter der Unterkategorie.

price_group String Optional

Kundenpreisgruppe.

favorites Boolestan Optional

Nur Favoriten zurückgeben.

promotions Boolestan Optional

Geben Sie nur aktive Promotions zurück.

new Boolestan Optional

Nur neue Produkte zurückgeben.

progressive Boolestan Optional

Schnelle Paginierung ohne Berechnung der Gesamtzählung.

group_variants Boolestan Optional

Gruppieren Sie Varianten unter den Mutterprodukt- und Rückgabekombinationen. Optionen werden ebenfalls zurückgegeben.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /product/variants Schlüssel + Träger

Suchen Sie die Variantengruppen und Kombinationen eines Produkts ab.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

product_id Ganzzahl Erforderlich

Kennung des Mutterprodukts.

groups array Optional

Nur POST: vollständige Liste von 0–3 Gruppen {name, values[]}. Ein leeres Array entfernt Varianten.

combinations array Optional

Nur POST: alle Kombinationen in Gruppenreihenfolge, jeweils mit Auswahl[], Sku, Preis und Lager. Maximal 100.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /product/variants Schlüssel + Träger

Ersetzen Sie die Variantengruppen und Kombinationen eines Produkts.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

product_id Ganzzahl Erforderlich

Kennung des Mutterprodukts.

groups array Optional

Nur POST: vollständige Liste von 0–3 Gruppen {name, values[]}. Ein leeres Array entfernt Varianten.

combinations array Optional

Nur POST: alle Kombinationen in Gruppenreihenfolge, jeweils mit Auswahl[], Sku, Preis und Lager. Maximal 100.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /product/options Schlüssel + Träger

Suchen Sie die Optionsgruppen eines Produkts und optionale Extras ab.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

product_id Ganzzahl Erforderlich

Kennung des Mutterprodukts.

groups array Optional

POST only: complete list of 0–10 groups {id, name, selection_mode, options[]}. An empty array removes options.

groups[].options[] array Optional

Für jede Option: vorhandene ID oder 0, Name, Preis, quantity_mode (single oder quantity), max_quantity (1 oder 2–50) und optional unit_label. Ein Bild kann mit image_base64 (JPEG/PNG/WebP, 1 MB) hinzugefügt oder mit remove_photo entfernt werden.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /product/options Schlüssel + Träger

Ersetzen Sie die Optionsgruppen eines Produkts und optionale Extras.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

product_id Ganzzahl Erforderlich

Kennung des Mutterprodukts.

groups array Optional

POST only: complete list of 0–10 groups {id, name, selection_mode, options[]}. An empty array removes options.

groups[].options[] array Optional

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /product/image Signierte URL

Servieren Sie ein signiertes, cachefähiges Produktbild.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

supplier String Erforderlich

Public Shop Suffix.

id Ganzzahl Erforderlich

Produktkennung.

slot Ganzzahl Optional

Bildschlitz von 1 bis 5.

signature String Erforderlich

Signed-Link-Signatur nach Produkt / Liste zurückgegeben.

variant enum Optional

small | thumb | large

Output

Mögliche Ergebnisse

200Binärbild mit seinem MIME-Typ

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Ungültiger signierter Link

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

200 Der Körper enthält direkt das Binärbild und der Content-Type-Header zeigt sein Format an.

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /product/add Schlüssel + Träger

Erstellen Sie ein Produkt.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

code String Erforderlich

Produktcode einzigartig im Shop.

name String Erforderlich

Name in der App angezeigt.

description String Optional

Ausführliche Produktbeschreibung.

base_price Dezimalzahl Optional

Verkaufspreis ohne Steuern gemäß Ihrer Konfiguration.

vat_rate Dezimalzahl Optional

MwSt.-Satz, z. B. 21.

category_id Ganzzahl Optional

Primäre Kategoriekennung.

subcategory_id Ganzzahl Optional

Unterkategoriekennung.

external_key String Optional

Stabile Identifikator aus Ihrem ERP.

unit String Optional

Einheitscode, z. B. pc.

unit_name String Optional

Name der vom Menschen lesbaren Einheit.

image_url url Optional

HTTPS URL des Hauptbildes.

is_new Boolestan Optional

Markieren Sie das Produkt als neu.

active Boolestan Optional

Kontrolliert die Produktsichtbarkeit.

action_type enum Optional

cart | auction | inquiry

auction.start_price Dezimalzahl Optional

Erforderlicher Startpreis, wenn action_type eine Auktion ist.

auction.buy_now_price Dezimalzahl Optional

Optionaler Kaufpreis.

auction.minimum_increment Dezimalzahl Optional

Fakultative Mindestgebotszunahme.

auction.starts_at datetime Optional

Optional Start als ISO 8601 mit Zeitzone.

auction.ends_at datetime Optional

Optionales Ende als ISO 8601 mit Zeitzone.

auction.hide_after_end Boolestan Optional

Verstecken Sie das Produkt nach Ablauf; erfordert ends_at.

auction.terms String Optional

Auktionsspezifische Begriffe, maximal 5.000 Zeichen.

inquiry.prompt String Optional

Informationsanforderungsaufforderung, maximal 1.000 Zeichen.

Output

Mögliche Ergebnisse

201Ressourcen geschaffen

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /product/update Schlüssel + Träger

Aktualisieren Sie ein Produkt.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Identifier des zu aktualisierenden Produkts.

code String Erforderlich

Produktcode einzigartig im Shop.

name String Erforderlich

Name in der App angezeigt.

description String Optional

Ausführliche Produktbeschreibung.

base_price Dezimalzahl Optional

Verkaufspreis ohne Steuern gemäß Ihrer Konfiguration.

vat_rate Dezimalzahl Optional

MwSt.-Satz, z. B. 21.

category_id Ganzzahl Optional

Primäre Kategoriekennung.

subcategory_id Ganzzahl Optional

Unterkategoriekennung.

external_key String Optional

Stabile Identifikator aus Ihrem ERP.

unit String Optional

Einheitscode, z. B. pc.

unit_name String Optional

Name der vom Menschen lesbaren Einheit.

image_url url Optional

HTTPS URL des Hauptbildes.

is_new Boolestan Optional

Markieren Sie das Produkt als neu.

active Boolestan Optional

Kontrolliert die Produktsichtbarkeit.

action_type enum Optional

cart | auction | inquiry

auction.start_price Dezimalzahl Optional

Erforderlicher Startpreis, wenn action_type eine Auktion ist.

auction.buy_now_price Dezimalzahl Optional

Optionaler Kaufpreis.

auction.minimum_increment Dezimalzahl Optional

Fakultative Mindestgebotszunahme.

auction.starts_at datetime Optional

Optional Start als ISO 8601 mit Zeitzone.

auction.ends_at datetime Optional

Optionales Ende als ISO 8601 mit Zeitzone.

auction.hide_after_end Boolestan Optional

Verstecken Sie das Produkt nach Ablauf; erfordert ends_at.

auction.terms String Optional

Auktionsspezifische Begriffe, maximal 5.000 Zeichen.

inquiry.prompt String Optional

Informationsanforderungsaufforderung, maximal 1.000 Zeichen.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /product/action Schlüssel + Träger

Rufen Sie einen Produktaktionstyp und dessen Einstellungen ab.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

product_id Ganzzahl Erforderlich

Identifikator der abzurufenden Produktaktion.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PUT /product/action/configure Schlüssel + Träger

Konfigurieren Sie den direkten Kauf, die Auktion oder die Informationsanfrage und deren Einstellungen.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

product_id Ganzzahl Erforderlich

Identifikator des zu konfigurierenden Produkts.

action_type enum Erforderlich

cart | auction | inquiry

auction.start_price Dezimalzahl Optional

Erforderlicher Startpreis für die Auktion.

auction.buy_now_price Dezimalzahl Optional

Optionaler Kaufpreis.

auction.minimum_increment Dezimalzahl Optional

Fakultative Mindestzunahme.

auction.starts_at datetime Optional

Optional Start als ISO 8601 mit Zeitzone.

auction.ends_at datetime Optional

Optionales Ende als ISO 8601 mit Zeitzone.

auction.hide_after_end Boolestan Optional

Verstecken Sie das Produkt nach dem Enddatum.

auction.terms String Optional

Begriffe, maximal 5.000 Zeichen.

inquiry.prompt String Optional

Optionale Eingabeaufforderung, maximal 1.000 Zeichen.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /product/delete Schlüssel + Träger

Verstecken Sie ein Produkt.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Kennung des zu verbergenden Produkts.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /product/favoris Schlüssel + Träger

Hinzufügen oder Entfernen eines Produkts von Favoriten.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

product_id Ganzzahl Erforderlich

Produktkennung.

favorite Boolestan Optional

Wahr hinzuzufügen, falsch zu entfernen; schaltet den Zustand um, wenn er ausgelassen wird.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /product/auction Schlüssel + Träger

Rufen Sie einen Auktionsstaat und anonymisierte Gebotshistorie ab.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

product_id Ganzzahl Erforderlich

Kennung des Auktionsprodukts.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /product/auction/bid Schlüssel + Träger

Geben Sie ein Gebot mit atomarer Mindestbetragsvalidierung ab.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

product_id Ganzzahl Erforderlich

Kennung des Auktionsprodukts.

amount Dezimalzahl Erforderlich

Gebotsbetrag, mindestens das Minimum, das vom Server zurückgegeben wird.

Output

Mögliche Ergebnisse

201Ressourcen geschaffen

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /product/auction/buy-now Schlüssel + Träger

Jetzt kaufen und atomar die Auktion schließen.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

product_id Ganzzahl Erforderlich

Identifikator des Produkts mit Kauf jetzt aktiviert.

Output

Mögliche Ergebnisse

201Ressourcen geschaffen

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /product/inquiry Schlüssel + Träger

Senden Sie eine Informationsanfrage, die mit einem Produkt verknüpft ist.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

product_id Ganzzahl Erforderlich

Kennung des betreffenden Produkts.

message String Erforderlich

Kundenfrage, 5 bis 5.000 Zeichen.

name String Optional

Kontaktname; Standardwerte für das angemeldete Profil.

email E-Mail-E-Mail-Adresse Optional

E-Mail beantworten; entweder E-Mail oder Telefon ist erforderlich.

phone String Optional

Antworte telefon; entweder e-mail oder telefon ist erforderlich.

Output

Mögliche Ergebnisse

201Ressourcen geschaffen

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /price/list Schlüssel + Träger

Listenpreise für die Kundengruppe, die auf den Produktverkaufspreis zurückgehen.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

product_id Ganzzahl Optional

Begrenzen Sie die Ergebnisse auf ein Produkt.

price_group String Optional

Preisgruppe, standardmäßig bis 01.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /mark/list Schlüssel + Träger

Verfügbare Marken auflisten.

Input

Verfügbare Parameter

URL query

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /size/list Schlüssel + Träger

Liste der verfügbaren Größen auf.

Input

Verfügbare Parameter

URL query

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /libweb/list Schlüssel + Träger

Listen Sie Web-Referenzetiketten auf, die auf Katalogetiketten zurückgreifen.

Input

Verfügbare Parameter

URL query

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Endpunkte

Warenkorb und Bestellungen

Verwalten Sie den Warenkorb und bestätigen Sie eine Bestellung atomar.

14 routes

GET /order/list Schlüssel + Träger

Listen Sie jede bestätigte Bestellung mit Paginierung auf.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

page Ganzzahl Optional

Seitenzahl, beginnend bei 1.

per_page Ganzzahl Optional

Anzahl der Ergebnisse pro Seite.

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

guid String Optional

Filtern Sie eine bestätigte Bestellung von GUID.

from_date Datum Optional

Filtern Sie ab diesem Datum mit YYYY-MM-DD.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /order/delete Schlüssel + Träger

Löschen und löschen Sie den aktuellen Warenkorb.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /order/total Schlüssel + Träger

Berechnen Sie den Warenkorb Zwischensumme, Mehrwertsteuer und Gesamtwert.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /promotion/validate Schlüssel + Träger

Validieren Sie einen Promotion-Code gegen den aktuellen Warenkorb auf dem Server und berechnen Sie Netto-, Mehrwertsteuer- und Gesamtrabatte.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

promotion_code String Erforderlich

Code mit 3 bis 64 Buchstaben, Zahlen, Bindestrichen oder Unterstrichen. Der Server prüft Daten, Nutzungslimit und Berechtigung.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Promotion code validated",
    "data": {
        "promotion": {
            "id": 12,
            "code": "WELCOME10",
            "name": "Welcome offer",
            "discount_type": "percent",
            "discount_value": 10,
            "scope": "all",
            "currency": "EUR",
            "currency_symbol": "€",
            "eligible_item_count": 2,
            "original_product_total": 60.5,
            "discount_net": 5,
            "discount_tax": 1.05,
            "discount_total": 6.05,
            "subtotal": 45,
            "vat_total": 9.45,
            "product_total": 54.45
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /loyalty/summary Schlüssel + Träger

Holen Sie sich das Treueprogramm, die Kundenbilanz und den verfügbaren Rabattwert ab.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /loyalty/history Schlüssel + Träger

Listen Sie die Verdienst-, Rücknahme-, Korrektur- und Ablaufhistorie des Kunden auf.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /loyalty/quote Schlüssel + Träger

Berechnen Sie serverseitig, wie viele Punkte gegen den aktuellen Warenkorb eingelöst werden können.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

loyalty_points Ganzzahl Erforderlich

Anzahl der Punkte, die der Kunde einlösen möchte.

delivery_mode enum Erforderlich

pickup | delivery

delivery_country String Optional

Land, in dem die Versandkosten neu berechnet wurden.

promotion_code String Optional

Optionaler Aktionscode, der vor dem Treuerabatt angewendet wurde.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /order/shipping/quote Schlüssel + Träger

Berechnen Sie Versandgebühren aus dem Warenkorb, Erfüllungsmodus und Land.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

delivery_mode enum Erforderlich

pickup | delivery

delivery_country String Optional

Zweistelliger ISO-Code oder Name des Lieferlandes.

promotion_code String Optional

Optionaler Code; das Angebot berechnet den Rabatt vor Versandkosten neu.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Shipping fee calculated",
    "data": {
        "delivery_mode": "delivery",
        "country_code": "BE",
        "shipping_mode": "country_rules",
        "shipping_fee": 6.9,
        "free_shipping": false,
        "free_shipping_from": 75,
        "amount_until_free": 25,
        "product_total": 50,
        "total": 56.9,
        "rule": "country:BE",
        "currency": "EUR",
        "currency_symbol": "€"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /order/count/line Schlüssel + Träger

Zählen Sie Linien im Wagen.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /order/sendtomegawin Schlüssel + Träger

Confirm the order, delivery and, in multi-site mode, the chosen stock location.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

order_guid Uuid Optional

GUID des Warenkorbs zu bestätigen.

delivery_mode enum Erforderlich

pickup | delivery

delivery_address String Optional

Für die Lieferung erforderlich.

stock_site_id Ganzzahl Optional

Customer-selected location in multi-site mode. Without this field, the server automatically assigns a location able to fulfil the entire cart for older apps.

delivery_country String Optional

Zweistelliger ISO-Code oder Ländername, der zur Berechnung des Preises verwendet wird.

delivery_date Datum Optional

JJJJ-MM-TT

delivery_comment String Optional

Anweisungen zur Erfüllung.

language String Optional

Transaktionale E-Mail-Sprache.

promotion_code String Optional

Optionaler Code, während der Bestätigung atomar verlängert und eingelöst.

loyalty_points Ganzzahl Optional

Punkte zu erlösen; Balance und Regeln werden revalidiert und atomar belastet.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /orderline/add Schlüssel + Träger

Fügen Sie ein Produkt und eine Menge in den Warenkorb.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

product_id Ganzzahl Erforderlich

Identifikator des hinzuzufügenden Produkts.

quantity Dezimalzahl Erforderlich

Menge strikt größer als Null.

Output

Mögliche Ergebnisse

201Ressourcen geschaffen

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /orderline/list Schlüssel + Träger

Abrufen von aktuellen Wagenleitungen.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /orderline/update Schlüssel + Träger

Aktualisieren Sie eine Zeilenmenge.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

item_id Ganzzahl Erforderlich

Straßenbahnkennung.

quantity Dezimalzahl Erforderlich

Quantität; Null entfernt die Linie.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /orderline/delete Schlüssel + Träger

Entfernen Sie eine Linie aus dem Warenkorb.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

item_id Ganzzahl Erforderlich

Kennung der zu entfernenden Zeile.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Endpunkte

Kundenzahlungen

Wählen sie die bezahlung bei lieferung oder öffnen sie eine sichere stripe-zahlung und rufen sie dann den server-verifizierten status ab.

4 routes

GET /payment/config Schlüssel + Träger

Rufen Sie die aktivierten Stripe-Zahlungsmethoden und den für die App ausgewählten Stripe-Kontoanbieter ab.

Input

Verfügbare Parameter

URL query

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /payment/checkout/create Schlüssel + Träger

Erstellen oder Wiederaufnahme einer Stripe Checkout-Seite für eine unbezahlte Bestellung oder Buchung, die dem angemeldeten Kunden gehört. Eine noch veränderliche Pay-on-Delivery-Option wird sicher ersetzt.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

purpose_type enum Erforderlich

order | booking

purpose_id Ganzzahl Erforderlich

Identifikator der bestätigten Bestellung oder der vom Kunden bestätigten Buchung.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /payment/pay-later Schlüssel + Träger

Buchen sie die bezahlung bei der lieferung auf oder ersetzen sie eine noch offene stripe-zahlung, nachdem die sitzung sicher überprüft und abgelaufen ist.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

purpose_type enum Erforderlich

order | booking

purpose_id Ganzzahl Erforderlich

Autorisierte Bestellung oder Buchungskennung.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /payment/status Schlüssel + Träger

Abrufen eines Zahlungsstatus; nur der signierte Stripe-Webhook kann ihn als bezahlt bestätigen.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

reference String Optional

SellViaApp Zahlungsreferenz. Geben Sie ansonsten purpose_type und purpose_id an.

purpose_type enum Optional

order | booking

purpose_id Ganzzahl Optional

Bezahlter Objektbezeichner.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Endpunkte

Dokumente

Rechnungen, Schätzungen, Bestellungen und deren Linien.

8 routes

POST /document/add Schlüssel + Träger

Erstellen Sie ein Dokument, das mit dem Kunden verknüpft ist.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

doc_type String Optional

invoice | estimate | purchase_order

doc_number String Optional

Dokumentnummer; automatisch generiert, wenn bei der Erstellung weggelassen.

doc_date Datum Optional

JJJJ-MM-TT

due_date Datum Optional

JJJJ-MM-TT

payment_method String Optional

Zahlungsmethode.

remark String Optional

Freiform Bemerkung.

Output

Mögliche Ergebnisse

201Ressourcen geschaffen

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /document/list Schlüssel + Träger

Listen oder filtern Sie Dokumente.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

doc_type String Optional

Filtern nach Dokumenttyp.

guid Uuid Optional

Filtern nach Dokument GUID.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /document/update Schlüssel + Träger

Aktualisieren Sie ein Dokument, das von GUID identifiziert wurde.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

document_guid Uuid Erforderlich

GUID des zu aktualisierenden Dokuments.

doc_type String Optional

invoice | estimate | purchase_order

doc_number String Optional

Dokumentnummer; automatisch generiert, wenn bei der Erstellung weggelassen.

doc_date Datum Optional

JJJJ-MM-TT

due_date Datum Optional

JJJJ-MM-TT

payment_method String Optional

Zahlungsmethode.

remark String Optional

Freiform Bemerkung.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /document/delete Schlüssel + Träger

Löschen Sie ein Dokument und seine Zeilen.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

document_guid Uuid Erforderlich

GUID des zu löschenden Dokuments.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /documentline/add Schlüssel + Träger

Fügen Sie eine Zeile hinzu und berechnen Sie das Dokument neu.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

document_guid Uuid Erforderlich

Dokument GUID.

text String Optional

Streckenbeschreibung.

quantity Dezimalzahl Optional

Menge, Standard 1.

unit_price Dezimalzahl Optional

Stückpreis ohne Mehrwertsteuer.

vat_rate Dezimalzahl Optional

MwSt.-Satz, Standard 21.

discount_percentage Dezimalzahl Optional

Prozentsatz des Rabatts.

product_code String Optional

zugehöriger Produktcode.

product_id Ganzzahl Optional

Assoziierte Produktkennung.

packages Dezimalzahl Optional

Anzahl der Packungen.

Output

Mögliche Ergebnisse

201Ressourcen geschaffen

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /documentline/list Schlüssel + Träger

Holen Sie ein Dokument mit allen seinen Zeilen ab.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

guid Uuid Erforderlich

GUID des Dokuments, dessen Zeilen abgerufen werden müssen.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /documentline/update Schlüssel + Träger

Aktualisieren Sie eine Zeile, die von GUID identifiziert wurde.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

document_guid Uuid Erforderlich

Dokument GUID.

line_guid Uuid Erforderlich

GUID der Linie zu aktualisieren.

text String Optional

Streckenbeschreibung.

quantity Dezimalzahl Optional

Menge, Standard 1.

unit_price Dezimalzahl Optional

Stückpreis ohne Mehrwertsteuer.

vat_rate Dezimalzahl Optional

MwSt.-Satz, Standard 21.

discount_percentage Dezimalzahl Optional

Prozentsatz des Rabatts.

product_code String Optional

zugehöriger Produktcode.

product_id Ganzzahl Optional

Assoziierte Produktkennung.

packages Dezimalzahl Optional

Anzahl der Packungen.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /documentline/delete Schlüssel + Träger

Löschen Sie eine Zeile und berechnen Sie die Gesamtsumme neu.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

document_guid Uuid Erforderlich

Dokument GUID.

line_guid Uuid Erforderlich

GUID der Zeile zu löschen.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Endpunkte

Echtzeit-Webhooks

Erhalten Sie automatisch SellViaApp-Änderungen in Ihrem ERP-, CRM-, Automatisierungs- oder Business-Service.

10 routes

GET /webhooks/events Schlüssel + Träger

Listen Sie alle verfügbaren Veranstaltungen und die Vertragsversion auf.

Input

Verfügbare Parameter

URL query

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /webhooks/endpoints/list Schlüssel + Träger

Listen Sie Ziele, Status und Zähler auf.

Input

Verfügbare Parameter

URL query

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /webhooks/endpoints/create Schlüssel + Träger

Erstellen Sie ein HTTPS-Ziel und erhalten Sie einmal das Signaturgeheimnis.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

label String Erforderlich

Interne Bezeichnung für dieses Ziel.

target_url url Erforderlich

Öffentliche HTTPS-URL auf Port 443. Private Netzwerke und Redirects werden abgelehnt.

events array Erforderlich

Genaue Ereignisse, eine Gruppe wie Produkt.*, oder alle mit *.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /webhooks/endpoints/update Schlüssel + Träger

Aktualisieren Sie das Ziel, Ereignisse oder Pause Lieferung.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Bestimmungsortkennung.

label String Optional

New label.

target_url url Optional

New HTTPS URL.

events array Optional

Neue Veranstaltungsauswahl.

status enum Optional

active | paused

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /webhooks/endpoints/delete Schlüssel + Träger

Soft-Löschen Sie ein Ziel.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Bestimmungsortkennung.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /webhooks/endpoints/rotate-secret Schlüssel + Träger

Ersetzen Sie das HMAC-Geheimnis und enthüllen Sie es einmal.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Bestimmungsortkennung.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /webhooks/deliveries/list Schlüssel + Träger

Überprüfen Sie Lieferungen, Antworten, Fehler und Versuche.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

page Ganzzahl Optional

Seitenzahl, beginnend bei 1.

per_page Ganzzahl Optional

Anzahl der Ergebnisse pro Seite.

status enum Optional

pending | processing | retry | delivered | failed

endpoint_id Ganzzahl Optional

Beschränken Sie die Ergebnisse auf ein Ziel.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /webhooks/deliveries/retry Schlüssel + Träger

Wiederholen Sie eine Lieferung, ohne die anderen zu wiederholen.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Interne Lieferkennung.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /webhooks/test Schlüssel + Träger

Emittieren und liefern Sie eine signierte Testveranstaltung.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

endpoint_id Ganzzahl Erforderlich

Bestimmungsort für die Prüfung.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /webhooks/stats Schlüssel + Träger

Holen Sie sich die letzten dreißig Tage der Lieferung Metriken.

Input

Verfügbare Parameter

URL query

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Endpunkte

Benachrichtigungen und Integrationen

Mobile Benachrichtigungen und externe Synchronisation.

64 routes

GET /admin/notification/sendtomobile Schlüssel + Träger

Mobile Benachrichtigungen abrufen.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /admin/notification/setdelivery Schlüssel + Träger

Markieren Sie eine Benachrichtigung als geliefert.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

customer_id Ganzzahl Optional

Erforderlich nur mit einem Integrationstoken, wenn die Operation auf einen bestimmten Kunden abzielt.

guid String Erforderlich

Benachrichtigung GUID-Token.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /push/device/register Schlüssel + Träger

Verbinden Sie eine mobile Installation mit diesem Kundenkonto für Firebase Push.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

installation_id String Erforderlich

Stabile zufällige Installations-ID (48 Hexzeichen).

fid String Erforderlich

Firebase Installation ID von der App zur Verfügung gestellt.

platform enum Erforderlich

android | ios

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /push/device/unregister Schlüssel + Träger

Entfernen Sie diesen Shop aus Push-Benachrichtigungen auf diesem Gerät.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

installation_id String Erforderlich

Installation zum Abmelden für dieses Konto.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /push/notification/ack Schlüssel + Träger

Bestätigen Sie eine Benachrichtigung, die in der App beobachtet oder vom Kunden geöffnet wurde.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

installation_id String Erforderlich

Anlage zur Bestätigung der Meldung.

guid String Erforderlich

Benachrichtigungs-ID für diesen Shop.

event enum Erforderlich

received | opened

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /woocommerce/categories/sync Schlüssel + Träger

Batch-Sync WooCommerce Kategorien und Unterkategorien.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 500 Kategorien. Jedes Objekt verwendet external_id, name und für eine Unterkategorie parent_external_id.

items[].external_id String Erforderlich

Stabile WooCommerce Kennung.

items[].name String Erforderlich

Visible name.

items[].parent_external_id String Optional

Kennung der Mutterkategorie.

items[].sort_order Ganzzahl Optional

Display order.

items[].images array Optional

Bis zu fünf HTTPS URLs.

items[].active Boolestan Optional

falsche Archive der Kategorie.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /woocommerce/products/sync Schlüssel + Träger

Sync Produkte, Variationen, Bilder, Preise, Mehrwertsteuer, Lager und Sichtbarkeit.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 250 Produkte oder Variationen pro Charge.

items[].external_id String Erforderlich

Stabile WooCommerce-Kennung, die für die Deduplizierung verwendet wird.

items[].type enum Optional

simple | variable | variation

items[].parent_external_id String Optional

Elternprodukt für eine Variation.

items[].sku String Optional

SKU; ein Fallback-Code wird generiert, wenn er weggelassen wird.

items[].name String Erforderlich

Product name.

items[].description String Optional

Produktbeschreibung.

items[].regular_price Dezimalzahl Optional

Regular price.

items[].sale_price Dezimalzahl Optional

Sale price.

items[].date_on_sale_from Datum Optional

ISO 8601 Verkaufsstart.

items[].date_on_sale_to Datum Optional

Verkauf nach ISO 8601.

items[].vat_rate Dezimalzahl Optional

MwSt.-Satz.

items[].stock_quantity Ganzzahl Optional

Verfügbarer Bestand.

items[].category_external_id String Optional

Synchronisierte primäre Kategorie.

items[].subcategory_external_id String Optional

Synchronisierte Unterkategorie.

items[].images array Optional

Bis zu fünf HTTPS-Bilder.

items[].attributes array Optional

WooCommerce Variationsattribute.

items[].active Boolestan Optional

Sichtbarkeit in SellViaApp.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /woocommerce/customers/sync Schlüssel + Träger

Erstellen oder aktualisieren Sie WooCommerce Kundenkonten ohne E-Mail zu senden.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 250 Kundenkonten pro Batch. Es wird keine E-Mail verschickt.

items[].external_id String Erforderlich

Stabile WooCommerce Benutzerkennung.

items[].username String Erforderlich

WooCommerce Benutzername genau in client.login gespeichert.

items[].email E-Mail-E-Mail-Adresse Optional

E-Mail-Adresse des Kunden, die für die Deduplizierung verwendet wird.

items[].first_name String Optional

Vorname des Kunden.

items[].last_name String Optional

Nachname des Kunden.

items[].company String Optional

Firmen- oder Firmenname.

items[].phone String Optional

Phone number.

items[].vat_number String Optional

VAT number.

items[].language iso-639-1 Optional

Zwei-Buchstaben-Sprache; Englisch standardmäßig.

items[].billing object Optional

Vollständige WooCommerce Rechnungsadresse.

items[].shipping object Optional

Lieferadresse, die in Synchronisationsmetadaten gespeichert wird.

items[].active Boolestan Optional

Konto aktiver Zustand.

items[].send_email Boolestan Optional

Muss falsch bleiben. Diese Route sendet niemals E-Mails.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /woocommerce/products/inventory Schlüssel + Träger

Aktualisieren Sie schnell nur Preise, Promotionen, Aktien oder Sichtbarkeit.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 500 leichte Updates.

items[].external_id String Erforderlich

Zuvor synchronisiertes Produkt.

items[].stock_quantity Ganzzahl Optional

New quantity.

items[].regular_price Dezimalzahl Optional

Neuer regulärer Preis.

items[].sale_price Dezimalzahl Optional

Neuer Verkaufspreis.

items[].active Boolestan Optional

Neue Sichtbarkeit.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /woocommerce/products/archive Schlüssel + Träger

Batch-archive löschte WooCommerce-Produkte ohne Änderung der Bestellungen.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

entity_type enum Optional

product | category | subcategory

items array Erforderlich

Liste von bis zu 500 externen Identifiern.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /woocommerce/orders/feed Schlüssel + Träger

Retrieve bestätigte Aufträge mit Cursor-basierter Abstimmung.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

cursor String Optional

Der undurchsichtige Cursor wurde von der vorherigen Antwort zurückgegeben.

updated_since datetime Optional

Startdatum nach ISO 8601.

limit Ganzzahl Optional

1 bis 100 Bestellungen.

unacknowledged_only Boolestan Optional

Defaults to true, um Duplikate zu verhindern.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /woocommerce/orders/acknowledge Schlüssel + Träger

Bestätigen Sie, dass eine Bestellung in WooCommerce importiert wurde.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bestellungen, die von WooCommerce verarbeitet werden.

items[].order_guid String Erforderlich

SellViaApp GUID wird vom Feed zurückgegeben.

items[].external_order_id String Optional

Auftragskennung WooCommerce.

items[].status enum Erforderlich

imported | failed | ignored

items[].error String Optional

Erklärung, wenn der Import fehlgeschlagen ist.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /woocommerce/webhooks/subscribe Schlüssel + Träger

Registrieren Sie einen signierten HTTPS WooCommerce Webhook.

Input

JSON-Body

NameArt der ArtRequirementBeschreibung

target_url url Erforderlich

Öffentliche HTTPS-URL; private Netzwerke werden abgelehnt.

events array Optional

order.created | order.updated | order.cancelled | *

Output

201Ressourcen geschaffen

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /woocommerce/webhooks/list Schlüssel + Träger

Liste aktive WooCommerce Webhooks auf.

Input

Verfügbare Parameter

URL query

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /woocommerce/webhooks/delete Schlüssel + Träger

Deaktivieren Sie einen WooCommerce Webhook.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Webhook-Kennung.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /woocommerce/webhooks/process Schlüssel + Träger

Verarbeiten Sie ausstehende Webhook-Lieferungen mit automatischen Wiederholungen.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

limit Ganzzahl Optional

Maximale Lieferungen an den Prozess.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /woocommerce/sync/logs Schlüssel + Träger

Sehen Sie sich das technische Synchronisationsprotokoll an.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

page Ganzzahl Optional

Seitenzahl, beginnend bei 1.

per_page Ganzzahl Optional

Anzahl der Ergebnisse pro Seite.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/categories/sync Schlüssel + Träger

Sync Shopify Kollektionen und Produkttypen.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 500 Kollektionen oder Produkttypen.

items[].external_id String Erforderlich

Stabile Shopify GID.

items[].name String Erforderlich

Visible name.

items[].parent_external_id String Optional

Elternsammlung für einen Produkttyp.

items[].images array Optional

HTTPS URLs.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/categories/archive Schlüssel + Träger

Archivieren Sie eine gelöschte Shopify Sammlung.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

GIDs von gelöschten Sammlungen.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/products/sync Schlüssel + Träger

Sync Shopify Produkte, Varianten, Bilder, Preise, Inventar und Sichtbarkeit.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 250 Shopify Varianten pro Batch.

items[].external_id String Erforderlich

Variant GID.

items[].parent_external_id String Optional

GID des Mutterprodukts.

items[].sku String Optional

SKU

items[].name String Erforderlich

Produkt- und Variantentitel.

items[].regular_price Dezimalzahl Optional

Regular oder Vergleichspreis.

items[].sale_price Dezimalzahl Optional

Aktiver Verkaufspreis.

items[].stock_quantity Ganzzahl Optional

Verfügbare Menge.

items[].images array Optional

Bis zu fünf HTTPS-Bilder.

items[].active Boolestan Optional

SellViaApp Sichtbarkeit.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /shopify/products/inventory Schlüssel + Träger

Aktualisieren Sie schnell Shopify Preise, Inventar oder Sichtbarkeit.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 500 leichte Updates.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/products/archive Schlüssel + Träger

Archivieren Sie Shopify-Varianten nach Bezeichner.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Variante GIDs zum Archivieren.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/products/archive-parent Schlüssel + Träger

Archivieren Sie jede Variante eines gelöschten Shopify-Produkts.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 100 Mutterprodukt-GIDs.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/customers/sync Schlüssel + Träger

Synchronisieren Sie Shopify-Kunden ohne E-Mail zu senden.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 250 Kunden; es wird keine E-Mail verschickt.

items[].external_id String Erforderlich

Shopify Kunde GID.

items[].username String Erforderlich

Benutzername in SellViaApp verwendet.

items[].email E-Mail-E-Mail-Adresse Optional

Kunden-E-Mail.

items[].send_email Boolestan Optional

Muss falsch bleiben.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/customers/redact Schlüssel + Träger

Redact Kundendaten von Shopify angefordert.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Optional

Kunden GIDs zum Redact.

all Boolestan Optional

Redacts alle Shopify Kunden für Shop / Redact.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /shopify/orders/feed Schlüssel + Träger

Abrufen von SellViaApp Bestellungen, die noch nicht in Shopify importiert wurden.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

cursor String Optional

Opaque cursor.

limit Ganzzahl Optional

1–100

unacknowledged_only Boolestan Optional

Echt empfohlen.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/orders/acknowledge Schlüssel + Träger

Bestätigen Sie einen Shopify-Bestellimport.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Importierte Bestellungen.

items[].order_guid String Erforderlich

SellViaApp GUID.

items[].external_order_id String Optional

Erstellt Shopify GID.

items[].status enum Erforderlich

imported | failed | ignored

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/webhooks/subscribe Schlüssel + Träger

Registrieren Sie den signierten SellViaApp Webhook für Shopify.

Input

JSON-Body

NameArt der ArtRequirementBeschreibung

target_url url Erforderlich

Connector HTTPS URL.

events array Optional

order.created | order.updated | order.cancelled | *

Output

201Ressourcen geschaffen

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /shopify/webhooks/list Schlüssel + Träger

Liste Shopify Connector Webhooks.

Input

Verfügbare Parameter

URL query

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /shopify/webhooks/delete Schlüssel + Träger

Deaktivieren Sie einen Shopify Webhook.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Webhook ID

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /shopify/webhooks/process Schlüssel + Träger

Wiederholen Sie die ausstehenden Shopify-Benachrichtigungen.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

limit Ganzzahl Optional

Maximum count.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /shopify/account Schlüssel + Träger

Identifizieren Sie den Shop und rufen Sie sein mobiles Testkonto ab.

Input

Verfügbare Parameter

URL query

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /shopify/sync/logs Schlüssel + Träger

Zeigen Sie Shopify-Protokolle isoliert von WooCommerce an.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

page Ganzzahl Optional

Seitenzahl, beginnend bei 1.

per_page Ganzzahl Optional

Anzahl der Ergebnisse pro Seite.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/connect öffentlich

Verbinden Sie eine Wix-Instanz mit einem bestehenden SellViaApp-Dashboard-Konto.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

email E-Mail-E-Mail-Adresse Erforderlich

E-Mail wurde verwendet, um sich im SellViaApp Dashboard anzumelden.

password String Erforderlich

Einmal verifiziert und nie vom Connector gespeichert.

instance_id String Erforderlich

Stabile Wix Installationskennung.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /wix/account Schlüssel + Träger

Identifizieren Sie das mit Wix verbundene SellViaApp-Konto und sein mobiles Testkonto.

Input

Verfügbare Parameter

URL query

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/disconnect Schlüssel + Träger

Widerrufen Sie das Connector-Token und trennen Sie Wix.

Input

Verfügbare Parameter

JSON-Body

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/categories/sync Schlüssel + Träger

Kategorien oder Kollektionen von Wix Stores V1/V3 synchronisieren.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 500 Wix Kategorien oder Kollektionen pro Batch.

items[].external_id String Erforderlich

Stabile Wix Kennung.

items[].name String Erforderlich

Name in der App angezeigt.

items[].parent_external_id String Optional

Kennung der Mutterkategorie.

items[].image url Optional

HTTPS Präsentationsbild.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/products/sync Schlüssel + Träger

Synchronisieren Sie Wix-Produkte mit Bildern, Preisen, Inventar und Sichtbarkeit.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 250 Wix Produkte oder Varianten pro Charge.

items[].external_id String Erforderlich

Wix Produkt- oder Variantenkennung.

items[].parent_external_id String Optional

Mutterprodukt einer Variante.

items[].sku String Optional

SKU

items[].name String Erforderlich

Product title.

items[].regular_price Dezimalzahl Optional

Regular price.

items[].sale_price Dezimalzahl Optional

Aktiver Verkaufspreis.

items[].stock_quantity Ganzzahl Optional

Verfügbarer Bestand.

items[].images array Optional

Bis zu fünf HTTPS-Bilder.

items[].visible Boolestan Optional

Sichtbarkeit in SellViaApp.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /wix/products/inventory Schlüssel + Träger

Aktualisieren Sie schnell Wix Preise, Inventar oder Sichtbarkeit.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Lightweight Preis, Inventar oder Sichtbarkeit Updates.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/products/archive Schlüssel + Träger

Archiv gelöscht Wix Produkte.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

entity_type enum Optional

product | category | subcategory

items array Erforderlich

Externe Wix-Identifikatoren zum Archivieren.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/customers/sync Schlüssel + Träger

Synchronisieren Sie Wix Kontakte ohne E-Mail zu senden.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 250 Kontakte; es wird keine SellViaApp E-Mail gesendet.

items[].external_id String Erforderlich

Wix Kontaktkennung.

items[].username String Erforderlich

E-Mail oder Fallback-Benutzername.

items[].active Boolestan Optional

Dies gilt für synchronisierte Kontakte.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/customers/redact Schlüssel + Träger

Redact einen oder mehrere synchronisierte Wix Kontakte.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

all Boolestan Optional

Redact alle Kontakte, die aus Wix stammen.

items array Optional

Externe Wix-IDs, die anonymisiert werden sollen, wenn all auf false gesetzt ist.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/privacy/shop-redact Schlüssel + Träger

Entfernen Sie Wix-origin-Daten nach der Deinstallation.

Input

Verfügbare Parameter

JSON-Body

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /wix/orders/feed Schlüssel + Träger

Lesen Sie SellViaApp Befehle zum Abgleich mit Wix.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

cursor String Optional

Der undurchsichtige Cursor der vorherigen Seite.

updated_since datetime Optional

Fakultativ ISO 8601 Datum.

limit Ganzzahl Optional

1–100

unacknowledged_only Boolestan Optional

Defaults to true, um Duplikate zu verhindern.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/orders/acknowledge Schlüssel + Träger

Notieren Sie das Ergebnis eines Wix-Auftragsabgleichs.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Abstimmungsergebnisse.

items[].order_guid String Erforderlich

SellViaApp Order GUID.

items[].external_order_id String Optional

Linked Wix Order Identifier.

items[].status enum Erforderlich

imported | failed | ignored

items[].error String Optional

Lesbarer Fehler bei fehlgeschlagener Verarbeitung.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/webhooks/subscribe Schlüssel + Träger

Erstellen Sie ein signiertes SellViaApp-Ziel für den Wix-Anschluss.

Input

JSON-Body

NameArt der ArtRequirementBeschreibung

target_url url Erforderlich

HTTPS URL des empfangenden Systems.

events array Optional

order.created | order.updated | order.cancelled | *

Output

201Ressourcen geschaffen

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /wix/webhooks/list Schlüssel + Träger

Liste SellViaApp Webhooks für den Wix Connector.

Input

Verfügbare Parameter

URL query

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /wix/webhooks/delete Schlüssel + Träger

Deaktivieren Sie einen Wix Connector Webhook.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

id Ganzzahl Erforderlich

Webhook ID

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /wix/webhooks/process Schlüssel + Träger

Prozess ausstehende SellViaApp-Lieferungen für Wix.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

limit Ganzzahl Optional

Höchstzahl der Lieferungen.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /wix/sync/logs Schlüssel + Träger

Sehen Sie sich das isolierte Wix Synchronisationsprotokoll an.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

page Ganzzahl Optional

Seitenzahl, beginnend bei 1.

per_page Ganzzahl Optional

Anzahl der Ergebnisse pro Seite.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /odoo/oauth/device/code öffentlich

Starten Sie eine Odoo OAuth-Autorisierung, ohne das SellViaApp-Passwort zu teilen.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

client_id String Erforderlich

sellviaapp_odoo

installation_id String Erforderlich

Stabile UUID für diese Odoo Installation.

instance_url url Optional

Öffentliche HTTPS URL der Odoo Instanz.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /odoo/oauth/device/token öffentlich

Tauschen Sie einen genehmigten Gerätecode für ein widerrufbares Integrationszugriffstoken aus.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

client_id String Erforderlich

sellviaapp_odoo

grant_type String Erforderlich

urn:ietf:params:oauth:grant-type:device_code

device_code String Erforderlich

Der undurchsichtige Code wurde beim Starten des Flows zurückgegeben.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /odoo/account Schlüssel + Träger

Überprüfen Sie das SellViaApp-Konto, das mit der Odoo-Installation verbunden ist.

Input

Verfügbare Parameter

URL query

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /odoo/disconnect Schlüssel + Träger

Sofort widerrufen Sie dieses Odoo Installationstoken.

Input

Verfügbare Parameter

JSON-Body

Es wird kein Geschäftsparameter erwartet. Senden Sie nur die angegebenen Authentifizierungs-Header.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /odoo/categories/sync Schlüssel + Träger

Synchronisieren Sie die Odoo Kategoriehierarchie.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 500 Odoo Kategorien pro Charge.

items[].external_id String Erforderlich

Stabile Odoo Kennung.

items[].name String Erforderlich

Visible name.

items[].parent_external_id String Optional

Elternkategorie.

items[].translations object Optional

Übersetzte Namen mit Sprachcode.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /odoo/categories/archive Schlüssel + Träger

Ausblenden Odoo Kategorien aus dem Katalog entfernt.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Root-Kategorie-Identifikatoren zu verstecken.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /odoo/products/sync Schlüssel + Träger

Synchronisieren Sie Odoo-Varianten, Referenzen, Beschreibungen, Übersetzungen, Bilder, Preise, Mehrwertsteuer und Lagerbestände.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 250 Odoo Produkte oder Varianten pro Charge.

items[].external_id String Erforderlich

Stable product.product variant identifier.

items[].parent_external_id String Optional

product.template Identifier.

items[].sku String Optional

Odoo interne Referenz.

items[].barcode String Optional

Barcode.

items[].name String Erforderlich

Produkt- oder Variantenbezeichnung.

items[].description String Optional

Verkehrsbezeichnung.

items[].regular_price Dezimalzahl Optional

Odoo Verkaufspreis.

items[].vat_rate Dezimalzahl Optional

Erster anwendbarer Mehrwertsteuersatz.

items[].stock_quantity Dezimalzahl Optional

Verfügbarer oder On-Hand-Lager gemäß der Odoo-Einstellung.

items[].images array Optional

Bis zu fünf signierte Odoo HTTPS Bild-URLs.

items[].translations object Optional

Name und Beschreibung in aktiven Odoo Sprachen.

items[].attributes array Optional

Variante Attribute.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /odoo/products/inventory Schlüssel + Träger

Aktualisieren Sie schnell die Preise, den Bestand und die Sichtbarkeit von Odoo.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 500 leichte Preis-, Lager- oder Sichtbarkeitsupdates.

items[].external_id String Erforderlich

Stabile Kennung eines bereits veröffentlichten product.product records.

items[].stock_quantity Dezimalzahl Optional

Verfügbare oder verfügbare Menge gemäß der Einstellung Odoo.

items[].stock_status enum Optional

instock | outofstock

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /odoo/products/archive Schlüssel + Träger

Ausblenden entfernt Odoo Produkte, Kategorien oder Unterkategorien.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

entity_type enum Optional

product | category | subcategory

items array Erforderlich

Externe Odoo-Identifikatoren zum Ausblenden.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /odoo/customers/sync Schlüssel + Träger

Senden Sie Odoo-Kontakte an SellViaApp und bereiten Sie ihren mobilen Zugang vor.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Bis zu 250 Odoo Kontakte pro Batch.

items[].external_id String Erforderlich

Stabile res.partner Kennung.

items[].email E-Mail-E-Mail-Adresse Erforderlich

E-Mail für den mobilen Zugang.

items[].send_invitation Boolestan Optional

Senden Sie die Einladung nur beim Erstellen des Kontos.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /odoo/customers/feed Schlüssel + Träger

Abrufen von SellViaApp-Kunden für den doppelt sicheren Abgleich mit Odoo-Kontakten.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

limit Ganzzahl Optional

1 bis 100 Kunden pro Seite.

cursor String Optional

Der undurchsichtige Cursor wurde von der vorherigen Seite zurückgegeben.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /odoo/orders/feed Schlüssel + Träger

Retrieve bestätigt SellViaApp Bestellungen in Odoo.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

limit Ganzzahl Optional

Von 1 bis 100 Bestellungen pro Seite.

cursor String Optional

Der undurchsichtige Cursor wurde von der vorherigen Seite zurückgegeben.

unacknowledged_only Boolestan Optional

Nur noch nicht importierte Bestellungen zurückgeben.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /odoo/orders/acknowledge Schlüssel + Träger

Notieren Sie das Ergebnis eines Odoo-Orderimports.

Input

Verfügbare Parameter

JSON-Body

NameArt der ArtRequirementBeschreibung

items array Erforderlich

Importieren Sie Ergebnisse mit Bestellkennung, Status und Odoo-Referenz.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /odoo/sync/logs Schlüssel + Träger

Sehen Sie sich das isolierte Odoo Synchronisationsprotokoll an.

Input

Verfügbare Parameter

URL query

NameArt der ArtRequirementBeschreibung

page Ganzzahl Optional

Seitenzahl, beginnend bei 1.

per_page Ganzzahl Optional

Anzahl der Ergebnisse pro Seite.

Output

Mögliche Ergebnisse

200Erfolgreicher Betrieb

400Ungültiger Antrag oder JSON

401Fehlende oder ungültige Authentifizierung

403Unzureichender Zugang

404Angeforderte Ressource nicht gefunden

409Konflikt mit vorhandenen Daten

422Parameter abgelehnt durch Validierung

429Anforderungslimit erreicht

5xxVorübergehende technische Störung

Erfolgsbeispiel

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Reference

Antworten und Fehler

Über „Parameter und Antworten“ sehen Sie Pflichtfelder, optionale Felder, Statuscodes und JSON-Beispiele. Eine leere Liste bedeutet nur, dass noch keine Daten vorhanden sind. Der Endpunkt ist deshalb nicht ausgefallen.

400Antrag auf Ungültigkeit

401Authentifizierung erforderlich

403Zugang verweigert

404Ressource oder Route nicht gefunden

409Geschäftskonflikt

422Validierung fehlgeschlagen

429Zu viele Anfragen

5xxTechnische Störung

API-Arbeitsbereich

Endpoint

GET

URL-ParameterEin Parameter pro Zeile: name=wert JSON-BodyBearbeiten Sie die Beispielwerte vor dem Test.

Der erzeugte Code enthält die eingegebenen Zugangsdaten. Bewahren Sie sie serverseitig auf und teilen Sie niemals einen ungeschwärzten Screenshot.

API-Antwort