Wie können wir Ihnen helfen? Produkte Coupa-Produktdokumentation Ressourcen für Lieferanten Ressourcen für die Lieferantenintegration Open Buy API-Referenz

Open Buy API-Referenz

Revised: 18 December 2021

Einleitung

Die Open Buy-API wurde entwickelt, um eine schnellere, standardmäßige und sichere Schnittstelle für die Suche und den Kauf von Artikeln in Echtzeit für alle Lieferanten bereitzustellen. Es ist einfach konzipiert und folgt den gängigen Mustern, die die meisten eCommerce-APIs bereitstellen.

Zu den vier Kernkonzepten der Open Buy-API gehören:

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

Authentifizierungsmethoden

Die Open Buy-API kann authentifiziert werden durch:

Benutzername und Kennwort (ähnlich wie cXML-Identität/geheimes Paar)
Auth.

Aktionen

Mit der Open Buy-API können Sie:

API	Verb	Pfad	Aktion	Beschreibung
Authentifizierung	POST	`/authentication/v1.0.0`	authentifizieren	Authentifizierung mit Lieferanten-Site
Suche	POST	`/search/v1.0.0`	Suche	Artikeldaten basierend auf einer Suchanfrage abrufen
Detail	POST	`/detail/v1.0.0`	Detail	Artikeldaten für einen bestimmten Artikel zur detaillierten Überprüfung abrufen
Checkout	POST	`/checkout/v1.0.0`	Kasse	Artikeldaten für Kauf abrufen

Authentifizierung

API	Verb	Pfad	Aktion	Beschreibung
Authentifizierung	POST	`/authentication/v1.0.0`	authentifizieren	Authentifizierung mit Lieferanten-Site

Beispielauthentifizierungsanforderung

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

Antworten

Code	Beschreibung
200	Token erfolgreich abgerufen `{ "token": "ABC12345" }`
400	Ungültige Anforderungsparameter; wir konnten keinen Abrufversuch durchführen.
401	Unberechtigt
500	Servicefehler während der Anforderung. Bitte versuchen Sie es später erneut

Suche

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

Parameter

Element	Beschreibung	Pflichtfeld?	Eindeutig?	Zulässiger Wert	Datentyp
Abfrage	Die Suchanfrage	Ja	Nein	beliebig	Zeichenfolge
Blattnummer	Seitennummer für Ergebnisse	Nein	Nein	beliebig	Nummer

Antworten

Code	Beschreibung
200	Suchergebnisse erfolgreich abgerufen `{ "count": 0, "total_count": 0, "results": [ { "source_part_num": 12345, "title": "Leather Gloves - XL", "url": "https://localhost/image", "price": 100, "currency": "USD", "uom": "EA" } ] }`
400	Ungültige Anforderungsparameter; wir konnten keinen Abrufversuch durchführen.
401	Unberechtigt
500	Servicefehler während der Anforderung. Bitte versuchen Sie es später erneut

Detail

API	Verb	Pfad	Aktion	Beschreibung
Detail	POST	`/detail/v1.0.0`	Detail	Artikeldaten für einen bestimmten Artikel zur detaillierten Überprüfung abrufen

Parameter

Element	Beschreibung	Pflichtfeld?	Eindeutig?	Zulässiger Wert	Datentyp
Artikel_ID	Die eindeutige Artikel-ID	Ja	Nein	beliebig	Zeichenfolge

Antworten

Code	Beschreibung
200	Artikel erfolgreich abgerufen `{ "source_part_num": 12345, "title": "Leather Gloves - XL", "url": "https://localhost/image", "price": 100, "currency": "USD", "uom": "EA" }`
400	Ungültige Anforderungsparameter; wir konnten keinen Abrufversuch durchführen.
401	Unberechtigt
500	Servicefehler während der Anforderung. Bitte versuchen Sie es später erneut

Checkout

API	Verb	Pfad	Aktion	Beschreibung
Checkout	POST	`/checkout/v1.0.0`	Kasse	Artikeldaten für Kauf abrufen

Parameter

Element	Beschreibung	Pflichtfeld?	Eindeutig?	Zulässiger Wert	Datentyp
Artikel_ID	Die eindeutige Artikel-ID	Ja	Ja	beliebig	Zeichenfolge
Menge	Menge	Nein	Nein	beliebig	Zeichenfolge

Antworten

Code	Beschreibung
200	Artikel erfolgreich abgerufen `{ "source_part_num": 12345, "title": "Leather Gloves - XL", "url": "https://localhost/image", "price": 100, "currency": "USD", "uom": "EA" }`
400	Ungültige Anforderungsparameter; wir konnten keinen Abrufversuch durchführen.
401	Unberechtigt
500	Servicefehler während der Anforderung. Bitte versuchen Sie es später erneut

Open Buy API-Schemas

Authentifizierungsanforderung

Die Anmeldeinformationen und E-Mail zum Abrufen eines Zugriffstokens.

Element	Beschreibung	Pflichtfeld?	Datentyp
Anmeldedaten	Lieferantenspezifische Zeichenfolge zur Autorisierung der Sitzung. Beispiele sind ein Aktualisierungstoken, ein Benutzer und ein Kennwort oder ein Autorisierungsschlüssel.	Nein	Zeichenfolge
E-Mail	E-Mail des Benutzers	Nein	Zeichenfolge

Authentifizierungsergebnis

Das Ergebnis einer Authentifizierungsanforderung

Element	Beschreibung	Pflichtfeld?	Datentyp
Token	Das Inhabertoken	Nein	Zeichenfolge

Zusätzliche Artikeldetails

Namenswertpaare

Element	Beschreibung	Pflichtfeld?	Datentyp
Name	Name	Nein	Zeichenfolge
Wert	Wert	Nein	Zeichenfolge

Suchergebnisse

Das Ergebnis einer Suchanfrage

Element	Beschreibung	Pflichtfeld?	Datentyp
zählen	Anzahl der Suchvorgänge	Ja	Ganzzahl
Summe_Anzahl	Ungefähre Gesamtzahl im Katalog	Nein	Ganzzahl
Ergebnisse	Ergebnisse	Nein	Artikelergebnis

Artikelergebnis

Das Ergebnis einer Anforderung von Artikeldaten

Element	Beschreibung	Pflichtfeld?	Datentyp
Artikel_ID	Eindeutige Artikel-ID	Nein	Zeichenfolge
source_part_num	Die Lieferantteilenummer	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
Bild	Eine URL zum Artikelbild	Nein	Zeichenfolge
Miniaturbild	Miniaturansicht des Produkts	Nein	Zeichenfolge
Preis	Preis	Nein	Nummer
Währung	Währung	Nein	Zeichenfolge
Listenpreis	Listenpreis	Nein	Nummer
Maßeinheit	Preis	Nein	Zeichenfolge
Zusammenfassung	Detailbeschreibung des Artikels	Nein	Zeichenfolge
Herstellername	Name des Herstellers	Nein	Zeichenfolge
manufacturer_part_num	Teilenummer des Herstellers	Nein	Zeichenfolge
Quelle_Teil_Hilfskennung	Lieferanten-Hilfsteilenummer	Nein	Zeichenfolge
UNSPSC	UNSPSC	Nein	Zeichenfolge
Vorlaufzeit	Bearbeitungszeit	Nein	Zeichenfolge
min_order_quantity	Minimale Bestellmenge	Nein	Nummer
max_order_quantity	Max. Bestellmenge	Nein	Nummer
order_increment_quantity	Bestellschrittnummer	Nein	Nummer
Menge	Menge für Kasse	Nein	Nummer
TabelleDetails	anzuzeigende Spalten, wenn sie in einer Tabelle angezeigt werden	Nein	Zeichenfolge
Details	Details	Nein	Zusätzliche Artikeldetails
Detaillierte Links	Detail-Links	Nein	Zusätzliche Artikeldetails
Details	Detailbilder	Nein	Zusätzliche Artikeldetails

Parts or all of this page might have been machine-translated. We apologize for any inaccuracies.