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. Dies umfasst bestimmte zu ergreifende Endpunkte (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 Best Practices für die Integration.
Aktionen
Verb | Pfad | Aktion | Beschreibung |
---|---|---|---|
GET | /api/markets |
Index | Führt Aktion aus, um alle Märkte abzurufen |
POST | /api/markets |
erstellen | Erstellt ein oder mehrere Marktobjekte. |
PUT | /api/markets |
aktualisieren | 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. |
GET | /api/markets/:id |
zeigen | Eine Marktdaten anzeigen. |
PUT | /api/markets/:id |
aktualisieren | Jeweils einen Markt mit der ID aktualisieren |
LÖSCHEN | /api/markets/:id |
löschen | Löschen Sie jeweils einen Markt. |
Elemente
Dies sind die für die Markt-API verfügbaren Elemente
Feldname | Feldbeschreibung | Erford. | Eindeutig? | Zulässige Werte | In | Out | Typ |
---|---|---|---|---|---|---|---|
ID |
Eine eindeutige automatisch inkrementelle, vom System generierte ID |
Ja | Ganzzahl | ||||
Name | Name des Marktes | Ja | Ja | Ja | Zeichenfolge | ||
Beschreibung | Kurzbeschreibung des Marktes | Ja | Ja | Zeichenfolge |
Beispiele
In diesem Beispiel haben wir eine Markt-API abgefragt. Wir haben eine GET-to-URL durchgeführt:
https://<instance>.cso.coupahost.com/api/markets
Märkte GET-Antwort
{
"total": 10,
"markets": [
{
"id": "9219601763469521167",
"name": "!Bank of Montreal Savings Tracker Demo"
},
{
"id": "9219595277140974408",
"name": "!JIRA-Tickets"
},
{
"id": "9219593060488131385",
"name": "!Market 1",
"description": "Logistics and Transportation"
},
{
"id": "9220538753220565326",
"name": "Arj Market 1",
"description": "XPO logistics"
},
{
"id": "9220538753220565329",
"name": "Arj Market 2",
"description": "XPO Transportation"
},
{
"id": "9219592846040196615",
"name": "Common Information"
},
{
"id": "9219593864376360801",
"name": "Consulting"
},
{
"id": "9219601774059719348",
"name": "D - Nikisha's Demo Market"
},
{
"id": "9219601938334799391",
"name": "E-Integrations"
},
{
"id": "9219601936493380282",
"name": "E-Top Tips to Audit Events"
}
]
}
Erstellen/Aktualisieren/Löschen
Im Folgenden wird beschrieben, wie Sie die Coupa-API verwenden können, um Aktionen auf Märkten durchzuführen.
Erstellen
/api/markets
Die folgende Nutzlast schafft zwei Märkte.
Payload:
{
"markets": [
{
"name": "Arjun Market 1",
"description": "XPO logistics"
},
{
"name": "Arjun Market 2",
"description": "XPO Transportation"
}
]
}
Response: 201
{
"result": [
{
"type": "api.post.added",
"description": "2 objects created."
}
],
"added": 2,
"markets": [
{
"id": "9220538753220565326"
},
{
"id": "9220538753220565329"
}
]
}
update
/api/markets
Die folgende Payload aktualisiert einen Markt.
To update one or more market at a time:
Payload:
{
"markets": [
{
"name": "Arj Market 1",
"description": "XPO logistics updated"
},
{
"name": "Arj Market 2",
"description": "XPO Transportation updated"
}
]
}
Response: 200 OK
{
"result": [
{
"type": "api.put.updated",
"description": "2 objects updated."
}
],
"updated": 2
}
Löschen
/api/markets
Die folgende Payload besteht darin, mehrere Märkte gleichzeitig zu löschen. Bitte denken Sie daran, dass das Löschen von Märkten einzeln oder in großen Mengen auch dazu führt, dass zugehörige Ereignisse gelöscht werden.
Payload:
{
"markets": [
{
"id": "9220538753220565326"
},
{
"name": "Arjun Market 2"
}
]
}
Response: 200 OK
{
"result": [
{
"type": "market.deleted.logMsg",
"description": "The market Arjun Market 1 was deleted."
}
],
"deleted": 1
}
Aktualisierungen erfolgen nachsichtig, d. h. wenn die Aktualisierung einer Ressource fehlschlägt, können die anderen erfolgreich sein. Siehe z. B. Payload oben löschen. Die Payload hat nur einen Markt gelöscht. Zum Löschen oder Aktualisieren ist eine ID in der Payload erforderlich.
Erfolgreiche Anfragen werden zurückgegeben HTTP 200 Response
. Der Text der Antwort enthält die erstellte Anforderung. Fehlgeschlagene Anfragen werden zurückgegeben HTTP 400 Bad Request
. Der Text der Antwort enthält Validierungsfehler, die als XML formatiert sind.
Parts or all of this page might have been machine-translated. We apologize for any inaccuracies.