• Zuletzt bearbeitet am: 09 November 2023

Open Buy-API-Referenz

Die Open Buy-API wurde entwickelt, um allen Lieferanten eine schnellere, standardisierte und sichere Schnittstelle für die Suche und den Kauf von Artikeln in Echtzeit zu bieten.

Einleitung

Die Open Buy-API wurde entwickelt, um allen Lieferanten eine schnellere, standardisierte und sichere Schnittstelle für die Suche und den Kauf von Artikeln in Echtzeit zu bieten. Es ist so konzipiert, dass es einfach ist und den gängigen Mustern folgt, die die meisten E-Commerce-APIs bieten.

Die vier Kernkonzepte der Open Buy-API umfassen:

Informationen darüber, wie sich die Open Buy-API auf Kunden und Käufer auswirkt, finden Sie unter Open Buy-API für Käufer.

Laden Sie unsere Open Buy-Schemadatei zur Verwendung in Postman oder einem anderen OpenAPI 3.0-kompatiblen Tool herunter oder sehen Sie sich die Schemadatei direkt in einem Online-Viewer wie ReDoc an.

Authentifizierungsmethoden

Die Open Buy-API kann authentifiziert werden durch:

  • Benutzername und Kennwort (ähnlich cXML-Identität/Geheimpaar)

  • OAuth

Aktionen

Mit der Open Buy-API können Sie:

API Verb Pfad Aktion Beschreibung
Authentifizierung BEITRAG /authentifizierung/v1.0.0 authentifizieren Authentifizierung beim Lieferantenstandort
Suche BEITRAG /de/search/v1.0.0 suchen Artikeldaten basierend auf einer Suchanfrage abrufen
Detail BEITRAG /detail/v1.0.0 details Abrufen von Artikeldaten für einen bestimmten Artikel zur detaillierten Überprüfung
Zur Kasse BEITRAG /checkout/v1.0.0 zur Kasse Artikeldaten für den Kauf abrufen

    Authentifizierung

    API Verb Pfad Aktion Beschreibung
    Authentifizierung BEITRAG /authentifizierung/v1.0.0 authentifizieren Authentifizierung beim Lieferantenstandort

    Beispiel Authentifizierungsanfrage

    {
    
    	"Anmeldeinformationen": "423j23j2j334l4s04",
    
    	"email": "email@coupa.com"
    
    }

    Antworten

    Code Beschreibung
    200

    Token erfolgreich abgerufen

    
    
    {
    
    "Token": "ABC12345"
    
    }

     

    400

    Ungültige Anforderungsparameter; wir konnten den Abruf nicht versuchen.

    401

    Nicht autorisiert

    500

    Servicefehler während der Anforderung. Bitte versuchen Sie es später erneut

    Suche

    API Verb Pfad Aktion Beschreibung
    Suche BEITRAG /search/v1.0.0 suchen Artikeldaten basierend auf einer Suchanfrage abrufen

    Parameter

    Element Beschreibung Pflichtfeld? Eindeutig? Zulässiger Wert Datentyp
    query Die Suchanfrage ja nein alle zeichenfolge
    page_number Seitennummer für Ergebnisse nein nein alle zahl

    Antworten

    Code Beschreibung
    200

    Suchergebnisse erfolgreich abgerufen

    
    
    {
    
    	"count": 0,
    
    	"total_count": 0,
    
    	"results": [
    
    		{
    
    			"source_part_num": 12345,
    
    			"Titel": "Lederhandschuhe - XL",
    
    			„url“: „https://localhost/image“,
    
    			"Preis": 100,
    
    			"currency": "USD",
    
    			"uom": "EA"
    
    		}
    
    	]
    
    }
    400

    Ungültige Anforderungsparameter; wir konnten den Abruf nicht versuchen.

    401

    Nicht autorisiert

    500

    Servicefehler während der Anforderung. Bitte versuchen Sie es später erneut

    Detail

    API Verb Pfad Aktion Beschreibung
    Detail BEITRAG /detail/v1.0.0 details Abrufen von Artikeldaten für einen bestimmten Artikel zur detaillierten Überprüfung

    Parameter

    Element Beschreibung Pflichtfeld? Eindeutig? Zulässiger Wert Datentyp
    item_id Die eindeutige Artikel-ID ja nein alle zeichenfolge

    Antworten

    Code Beschreibung
    200

    Der Artikel wurde erfolgreich abgerufen

    
    
    {
    
    	"source_part_num": 12345,
    
    	"Titel": "Lederhandschuhe - XL",
    
    	„url“: „https://localhost/image“,
    
    	"Preis": 100,
    
    	"currency": "USD",
    
    	"uom": "EA"
    
    }
    400

    Ungültige Anforderungsparameter; wir konnten den Abruf nicht versuchen.

    401

    Nicht autorisiert

    500

    Servicefehler während der Anforderung. Bitte versuchen Sie es später erneut

    Zur Kasse

    API Verb Pfad Aktion Beschreibung
    Zur Kasse BEITRAG /checkout/v1.0.0 zur Kasse Artikeldaten für den Kauf abrufen

    Parameter

    Element Beschreibung Pflichtfeld? Eindeutig? Zulässiger Wert Datentyp
    item_id Die eindeutige Artikel-ID ja ja alle zeichenfolge
    menge Menge nein nein alle zeichenfolge

    Antworten

    Code Beschreibung
    200

    Der Artikel wurde erfolgreich abgerufen

    
    
    {
    
    	"source_part_num": 12345,
    
    	"Titel": "Lederhandschuhe - XL",
    
    	„url“: „https://localhost/image“,
    
    	"Preis": 100,
    
    	"Währung": "USD",
    
    	"uom": "EA"
    
    }
    400

    Ungültige Anforderungsparameter; wir konnten den Abruf nicht versuchen.

    401

    Nicht autorisiert

    500

    Servicefehler während der Anforderung. Bitte versuchen Sie es später erneut

    Open Buy-API-Schema

    Authentifizierungsanfrage

    Die Anmeldeinformationen und die E-Mail zum Abrufen eines Zugriffstokens.

    Element Beschreibung Pflichtfeld? Datentyp
    anmeldeinformationen

    Lieferantenspezifische Zeichenfolge zur Autorisierung der Sitzung. Beispiele sind ein Aktualisierungs-Token, ein Benutzer und ein Kennwort oder ein Autorisierungsschlüssel.

    nein zeichenfolge
    e-Mail

    E-Mail-Adresse des Benutzers

    nein zeichenfolge

    Authentifizierungsergebnis

    Das Ergebnis einer Authentifizierungsanfrage

    Element Beschreibung Pflichtfeld? Datentyp
    token

    Der TRÄGER-TOKEN

    nein zeichenfolge

    Zusätzliche Artikeleinzelheiten

    Namenswertpaare

    Element Beschreibung Pflichtfeld? Datentyp
    name Name nein zeichenfolge
    value Wert nein zeichenfolge

    Suchergebnisse

    Das Ergebnis einer Suchanfrage

    Element Beschreibung Pflichtfeld? Datentyp
    zählen

    Anzahl der Suchanfragen

    ja ganze Zahl
    total_count Ungefähre Gesamtanzahl im Katalog nein ganze Zahl
    ergebnisse Ergebnisse nein Artikel-Ergebnis

    Artikel-Ergebnis

    Das Ergebnis einer Anforderung von Artikeldaten

    Element Beschreibung Pflichtfeld? Datentyp
    item_id

    Eindeutige Artikel-ID

    nein zeichenfolge
    source_part_num

    Die Lieferantenartikelnummer

    nein zeichenfolge
    titel zeichenfolge

    Der Titel des Artikels

    nein zeichenfolge
    typ zeichenfolge

    Artikeltyp (Artikel, Gruppe). Gruppe stellt ein übergeordnetes Element von käuflichen Artikeln dar.

    nein zeichenfolge
    image

    Eine URL zum Artikelbild

    nein zeichenfolge
    miniaturansicht

    Miniaturansicht des Produkts

    nein zeichenfolge
    preis

    Preis

    nein nummer
    währung

    Währung

    nein zeichenfolge
    listPrice

    Listenpreis

    nein zahl
    uom

    Preis

    nein zeichenfolge
    übersicht

    Detailbeschreibung zum Artikel

    nein zeichenfolge
    manufacturer_name

    Hersteller Name

    nein zeichenfolge
    manufacturer_part_num

    Artikelnummer des Herstellers

    nein zeichenfolge
    source_teil_hilfs_id

    Zusätzliche Lieferantenartikelnummer

    nein zeichenfolge
    uNSPSC

    UNSPSC

    nein zeichenfolge
    vorbereitungszeit

    Bearbeitungszeit

    nein zeichenfolge
    min_order_quantity

    Mindestbestellmenge

    nein nummer
    max_order_quantity Maximale Bestellmenge nein nummer
    order_increment_quantity

    Bestellschrittnr.

    nein nummer
    menge

    Menge für die Kasse

    nein zahl
    tableDetails Spalten, die angezeigt werden sollen, wenn sie in einer Tabelle angezeigt werden nein zeichenfolge
    details Details nein Zusätzliche Artikeleinzelheiten
    detaillinks Detailverknüpfungen nein Zusätzliche Artikeleinzelheiten
    detailimages Detailbilder nein Zusätzliche Artikeleinzelheiten

     

    Hinweis: Einige Inhalte wurden maschinell übersetzt.