• Zuletzt bearbeitet am: 25 March 2021

Unternehmens-API

Verwenden Sie die Unternehmens-API, um die Unternehmensdaten zu erstellen, zu aktualisieren oder abzufragen.

Verwenden Sie die Unternehmens-APIs, um die Unternehmensdaten zu erstellen, zu aktualisieren oder abzufragen. 

Die URL für den Zugriff auf die APIs lautet : https://<instance>.cso.coupahost.com/api/companies

Weitere Informationen finden Sie unter Integrations-Best Practices.

Aktionen

Verb Pfad Aktion Beschreibung
ABFRAGEN /api/companies index Führt Get-Aktion aus, um alle Unternehmen abzurufen
BEITRAG /api/companies erstellen Erstellt ein oder mehrere Firmenobjekte.
PUT /api/companies aktualisierung Aktualisiert ein oder mehrere Unternehmen . Kann Massenaktualisierungen durchführen.
ABFRAGEN /api/companies/:id anzeigen Zeigen Sie eine Firmendaten an. 
PUT /api/companies/:id aktualisieren Aktualisieren Sie ein Unternehmen nach dem anderen mit der ID

Elemente

Dies sind die Elemente, die für die Unternehmens-API verfügbar sind

Feldname Feldbeschreibung Anf. Eindeutig? Zulässige Werte In Out  * Typ
iD ID der Gesellschaft   Ja     ja ganze Zahl
status Status des Unternehmens     Aktiv, Entfernt  (Groß-/Kleinschreibung beachten) ja ja zeichenfolge
name Name der Gesellschaft   Ja   ja ja zeichenfolge
telefonnummer Telefonnummer des Unternehmens       ja ja zeichenfolge
e-Mail E-Mail des Unternehmens       ja ja zeichenfolge
straße Straße und Hausnummer des Unternehmens       ja ja zeichenfolge
postleitzahl Postleitzahl Teil der Firmenadresse       ja ja zeichenfolge
ort Stadtteil der Firmenadresse       ja ja zeichenfolge
land Land Teil der Firmenadresse       ja ja zeichenfolge
duns-scac Der DUNS-SCAC-Code für das Unternehmen.       ja ja zeichenfolge
schlüsselwörter Mit dem Unternehmen verknüpfte Schlüsselwörter       ja ja zeichenfolge
Hinweis

 Die Antwortnutzlast zeigt keine Nullwerte an.

Beispiele

In diesem Beispiel haben wir nach einer Unternehmens-API gefragt. Wir sind zur URL gelangt: 

https://<instance>.cso.coupahost.com/api/companies 

Antwort des Unternehmens ABRUFEN

{

		"total": 7.

		"compannies": [

				{

						"id": "9219592888303484960",

						"state": "Aktiv",

						"name": "! Neuer Lieferant (Spanisch)"

				},

				{

						"id": "9219594398656586067",

						"state": "Aktiv",

						"name": "! Simon Test Organisation",

						"email": "simon@kepgames.com"

				},

				{

						"id": "9219592919623127484",

						"state": "Aktiv",

						"name": "! SKF (Testbieter)“

				},

				{

						"id": "9219592881350550871",

						"state": "Aktiv",

						"name": "! Spanischer Bieter",

						"email": "heloisa.spanish@tradeext.com"

				},

				{

						"id": "9219592230193035378",

						"state": "Aktiv",

						"name": "! TE",

						"email": "lorena@te.se",

						"duns-scac": "Prüfung123456789",

						"keywords": "Test"

				},

				{

						"id": "9219596145584379778",

						"state": "Aktiv",

						"name": "! TE Test Company"

				},

				{

						"id": "9219592639285418804",

						"state": "Aktiv",

						"name": "! TE Test Company 2",

						"Telefonnummer": "123-234-3456",

						"email": "testcompany2+upg@coupa.com",

						"street": "Straße und Hausnummer1",

						"PLZ": "12345",

						"city": "valahalla",

						"Land": "Kleinere amerikanische Überseeinseln",

						"keywords": "Frachtunternehmen"

				}

	 ]

}

Erstellen/Aktualisieren

Im Folgenden wird beschrieben, wie Sie die Coupa-API zum Ausführen von Aktionen für das Unternehmen verwenden können.

Erstellen

/api/companies

Die unten stehende Nutzlast erstellt zwei Unternehmen.

Nutzdaten: 

{

		"companies": [

				{

						"state": "Aktiv",

						"Name": "Ja, Heloisa",

						"duns-scac": "Soll aktualisiert werden"

				},

				{

						"Name": "TE-Testunternehmen 2",

						"Telefonnummer": "123-234-3456",

						"email": "testcompany2+upg@coupa.com"

				}

		]

}



Antwort: 201

{

		"result": [

				{

						"type": "api.post.added",

						"Beschreibung": "2 Objekte erstellt."

				}

		],

		"hinzugefügt": 2.

		"companies": [

				{

						"id": "9220538753256092391"

				},

				{

						"id": "9220538753250662192"

				}

		]

}	 

Aktualisieren

/api/companies

Die folgende Nutzlast aktualisiert ein Unternehmen. 

So aktualisieren Sie jeweils ein oder mehrere Unternehmen: 

Nutzdaten:

{

		"companies": [

				{

						"id": "9219594319065198091",

						"state": "Aktiv",

						"name": "! (TE) Heloisa",

						"duns-scac": "Soll aktualisiert werden"

				},

				{

						"id": "9219596218212801426",

						"state": "Aktiv",

						"name": "! (TE) Org nur mit Bietern (Italienisch)",

						"duns-scac": "Wird aktualisiert",

						"email": "testbidders_itl@coupa.com"

				},

				{

						"id": "9219596218212801429",

						"state": "Aktiv",

						"name": "! (TE) Org mit nur Bietern",

						"duns-scac": "Wird aktualisiert",

						"keywords": "Bieter"

				}

		]

}



Antwort: 200 OK

{

		"result": [

				{

						"type": "api.put.updated",

						"Beschreibung": "3 Objekte aktualisiert."

				}

		],

		"aktualisiert": 3

}
Hinweis

 Aktualisierungen werden auf nachsichtige Weise durchgeführt, d. h. wenn die Aktualisierung einer Ressource fehlschlägt, können die anderen erfolgreich sein. Die Unternehmens-ID ist für Updates erforderlich.

Erfolgreiche Anfragen geben die HTTP-200-Antwort zurück. Der Text der Antwort enthält die erstellte Anforderung. Bei nicht erfolgreichen Anfragen wird http 400 Bad Request zurückgegeben. Der Text der Antwort enthält Validierungsfehler, die als XML formatiert sind.

Vergleichbare Artikel


Fakten-Blätter-API

25 March 2021

Verwenden Sie die Fact Sheets-API, um die Fact Sheets und die zugehörigen (Zeilen / Felder) Daten zu erstellen, zu aktualisieren oder abzufragen.

Felder-API

25 March 2021

Verwenden Sie die Feld-API, um die Felder und zugehörigen (Zeilen) Daten zu erstellen, zu aktualisieren oder abzufragen.

Markt API

25 March 2021

Verwenden Sie die Markt-API, um die Märkte zu erstellen, zu aktualisieren oder abzufragen.

Benutzer-API

25 March 2021

Verwenden Sie die Benutzer-API, um die Benutzerdaten zu erstellen, zu aktualisieren oder abzufragen.

Hinweis: Einige Inhalte wurden maschinell übersetzt.