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 Best Practices für die Integration.
Aktionen
Verb | Pfad | Aktion | Beschreibung |
---|---|---|---|
GET | /api/companies |
Index | Führt eine Aktion zum Abrufen aller Unternehmen aus |
POST | /api/companies |
erstellen | Erstellt ein oder mehrere Companies-Objekte. |
PUT | /api/companies |
aktualisieren | Aktualisiert ein oder mehrere Unternehmen. Kann Massenaktualisierungen durchführen. |
GET | /api/companies/:id |
zeigen | Zeigen Sie eine Unternehmensdaten an. |
PUT | /api/companies/:id |
aktualisieren | Aktualisieren Sie ein Unternehmen nach dem anderen unter Verwendung der ID |
Elemente
Dies sind die für die Unternehmens-API verfügbaren Elemente
Feldname | Feldbeschreibung | Erford. | Eindeutig? | Zulässige Werte | In | Ausgang * | Typ |
---|---|---|---|---|---|---|---|
ID |
ID des Unternehmens |
Ja | Ja | Ganzzahl | |||
Staat | Status des Unternehmens |
Aktiv, entfernt (Groß-/Kleinschreibung beachten) |
Ja | Ja | Zeichenfolge | ||
Name | Name des Unternehmens | Ja | Ja | Ja | Zeichenfolge | ||
Telefonnummer | Telefonnummer des Unternehmens | Ja | Ja | Zeichenfolge | |||
E-Mail des Unternehmens | Ja | Ja | Zeichenfolge | ||||
Straße | Straße Teil der Unternehmensadresse | Ja | Ja | Zeichenfolge | |||
Postleitzahl | Postleitzahlenteil der Unternehmensadresse | Ja | Ja | Zeichenfolge | |||
Ort | Stadt Teil der Unternehmensadresse | Ja | Ja | Zeichenfolge | |||
Land | Länderteil der Unternehmensadresse | Ja | Ja | Zeichenfolge | |||
Dunstabzugshaube | Der DUNS-SCAC-Code für das Unternehmen. | Ja | Ja | Zeichenfolge | |||
Schlüsselwörter | Dem Unternehmen zugeordnete Schlüsselwörter | Ja | Ja | Zeichenfolge |
Antwort-Payload zeigt keine Nullwerte an.
Beispiele
In diesem Beispiel haben wir eine Unternehmens-API abgefragt. Wir haben eine GET-to-URL durchgeführt:
https://<instance>.cso.coupahost.com/api/companies
GET-Antwort des Unternehmens
{
"total": 7,
"compannies": [
{
"id": "9219592888303484960",
"state": "Active",
"name": "! New Supplier (Spanish)"
},
{
"id": "9219594398656586067",
"state": "Active",
"name": "! Simon Test Organization",
"email": "simon@kepgames.com"
},
{
"id": "9219592919623127484",
"state": "Active",
"name": "! SKF (test bidders)"
},
{
"id": "9219592881350550871",
"state": "Active",
"name": "! Spanish bidder",
"email": "heloisa.spanish@tradeext.com"
},
{
"id": "9219592230193035378",
"state": "Active",
"name": "! TE",
"email": "lorena@te.se",
"duns-scac": "testing123456789",
"keywords": "test"
},
{
"id": "9219596145584379778",
"state": "Active",
"name": "! TE Test Company"
},
{
"id": "9219592639285418804",
"state": "Active",
"name": "! TE Test Company 2",
"phone-number": "123-234-3456",
"email": "testcompany2+upg@coupa.com",
"street": "street address1",
"zip-code": "12345",
"city": "valahalla",
"country": "United States Minor Outlying Islands",
"keywords": "Carrier"
}
]
}
Erstellen/Aktualisieren
Im Folgenden wird beschrieben, wie Sie die Coupa-API verwenden können, um Aktionen für das Unternehmen durchzuführen.
Erstellen
/api/companies
Die folgende Payload erstellt zwei Unternehmen.
Payload:
{
"companies": [
{
"state": "Active",
"name": "Yes Heloisa",
"duns-scac": "Shall be updated"
},
{
"name": "TE Test Company 2",
"phone-number": "123-234-3456",
"email": "testcompany2+upg@coupa.com"
}
]
}
Response: 201
{
"result": [
{
"type": "api.post.added",
"description": "2 objects created."
}
],
"added": 2,
"companies": [
{
"id": "9220538753256092391"
},
{
"id": "9220538753250662192"
}
]
}
update
/api/companies
Die folgende Payload aktualisiert ein Unternehmen/Unternehmen.
To update one or more Company at a time:
Payload:
{
"companies": [
{
"id": "9219594319065198091",
"state": "Active",
"name": "! (TE) Heloisa",
"duns-scac": "Shall be updated"
},
{
"id": "9219596218212801426",
"state": "Active",
"name": "! (TE) Org only with bidders (Italian)",
"duns-scac": "Shall be updated",
"email": "testbidders_itl@coupa.com"
},
{
"id": "9219596218212801429",
"state": "Active",
"name": "! (TE) Org with only bidders",
"duns-scac": "Shall be updated",
"keywords": "Bidders"
}
]
}
Response: 200 OK
{
"result": [
{
"type": "api.put.updated",
"description": "3 objects updated."
}
],
"updated": 3
}
Aktualisierungen erfolgen nachsichtig, d. h. wenn die Aktualisierung einer Ressource fehlschlägt, können die anderen erfolgreich sein. Die Unternehmens-ID ist für Aktualisierungen 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.
Hinweis: Einige Inhalte wurden maschinell übersetzt.