• Zuletzt bearbeitet am: 25 March 2021

Markt API

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

Verwenden Sie die Markt-APIs, um die Marktdaten zu erstellen, zu aktualisieren oder abzufragen. Dazu gehören spezifische Endpunkte zum Ergreifen von Maßnahmen (Erstellen/Aktualisieren/Löschen) sowie Ereignisse im Zusammenhang mit Märkten.

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

Weitere Informationen finden Sie unter Integrations-Best Practices.

Aktionen

Verb Pfad Aktion Beschreibung
ABFRAGEN /api/markets index Führt Get-Aktion aus, um alle Märkte abzurufen
BEITRAG /api/markets erstellen Erstellt ein oder mehrere Marktobjekte.
PUT /api/markets update Aktualisiert einen oder mehrere Märkte . Kann Massenaktualisierungen durchführen.
LÖSCHEN /api/markets löschen Löscht einen weiteren Markt. Kann Massenlöschungen durchführen.
ABFRAGEN /api/markets/:id anzeigen Zeigen Sie eine Marktdaten an. 
PUT /api/markets/:id aktualisierung Aktualisieren Sie einen Markt nach dem anderen mit der ID
LÖSCHEN /api/markets/:id löschen Löschen Sie jeweils einen Markt.

Elemente

Dies sind die Elemente, die für die Markets API verfügbar sind

Feldname Feldbeschreibung Anf. Eindeutig? Zulässige Werte In Out Typ
iD

Eine eindeutige, automatisch inkrementelle, vom System  generierte ID

        ja ganze Zahl
name Name des Markts   Ja   ja ja zeichenfolge
beschreibung Eine kurze Beschreibung des Markts       ja ja zeichenfolge

Beispiele

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

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

Märkte ERHALTEN ANTWORT

{

		"total": 10,

		"markets": [

				{

						"id": "9219601763469521167",

						"name": "! Demo des Sparkassen-Trackers der Bank von Montreal"

				},

				{

						"id": "9219595277140974408",

						"name": "!JIRA-Tickets"

				},

				{

						"id": "9219593060488131385",

						"name": "!Markt 1",

						"Beschreibung": "Logistik und Transport"

				},

			 {

						"id": "9220538753220565326",

						"Name": "Arj Market 1",

						"Beschreibung": "XPO-Logistik"

				},

				{

						"id": "9220538753220565329",

						"name": "Arj Market 2",

						"Beschreibung": "XPO Transport"

				},

				{

						"id": "9219592846040196615",

						"Name": "Allgemeine Informationen"

				},

				{

						"id": "9219593864376360801",

						"Name": "Beratung"

				},

				{

						"id": "9219601774059719348",

						"Name": "D - Nikishas Demo-Markt"

				},

				{

						"id": "9219601938334799391",

						"Name": "E-Integrationen"

				},

				{

						"id": "9219601936493380282",

						"name": "E-Top-Tipps zur Prüfung von Ereignissen"

				}

	 ]

}

Erstellen/Aktualisieren/Löschen

Im Folgenden wird beschrieben, wie Sie die Coupa-API zum Ausführen von Aktionen auf Märkten verwenden können.

Erstellen

/api/markets

Die unten stehende Nutzlast schafft zwei Märkte.

Nutzdaten: 

{

		"markets": [

				{

						"name": "Arjun-Markt 1",

						"Beschreibung": "XPO-Logistik"

				},

				{

						"Name": "Arjun-Markt 2",

						"Beschreibung": "XPO Transport"

				}

		]

}



Antwort: 201

{

		"result": [

				{

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

						"Beschreibung": "2 Objekte erstellt."

				}

		],

		"hinzugefügt": 2.

		"markets": [

				{

						"id": "9220538753220565326"

				},

				{

						"id": "9220538753220565329"

				}

		]

}

Aktualisieren

/api/markets

Die folgende Nutzlast aktualisiert einen Markt. 

So aktualisieren Sie jeweils einen oder mehrere Märkte: 

Nutzdaten:

{

		"markets": [

				{

						"Name": "Arj Market 1",

						"Beschreibung": "XPO-Logistik aktualisiert"

				},

				{

						"Name": "Arj Market 2",

						"Beschreibung": "XPO Transport aktualisiert"

				}

		]

}



Antwort: 200 OK

{

		"result": [

				{

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

						"Beschreibung": "2 Objekte aktualisiert."

				}

		],

		"aktualisiert": 2

}

Löschen

/api/markets

Die folgende Nutzlast besteht darin, mehr als einen Markt gleichzeitig zu löschen. Bitte denken Sie daran, dass das Löschen von Einzel- oder Massenmärkten auch zum Löschen der zugehörigen Ereignisse führt. 

Nutzdaten:

{

		"markets": [

				{

						"id": "9220538753220565326"

				},

				{

						"name": "Arjun-Markt 2"

				}

		]

}



Antwort: 200 OK

{

		"result": [

				{

						"type": "market.deleted.logMsg",

						"Beschreibung": "Der Markt Arjun Market 1 wurde gelöscht."

				}

		],

		"gelöscht": 1

}
Hinweis

 Aktualisierungen werden auf nachsichtige Weise durchgeführt, d. h. wenn die Aktualisierung einer Ressource fehlschlägt, können die anderen erfolgreich sein. Siehe z. B. Payload löschen oben. Die Nutzlast löschte nur einen Markt. Für das Löschen oder Aktualisieren wird eine ID in der Nutzlast benötigt.

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.

Benutzer-API

25 March 2021

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

Unternehmens-API

25 March 2021

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

Hinweis: Einige Inhalte wurden maschinell übersetzt.