API de l'entreprise
Utilisez l'API de l'entreprise pour créer, mettre à jour ou interroger les données de l'entreprise.
Utilisez les API de l'entreprise pour créer, mettre à jour ou interroger les données de l'entreprise.
L'URL pour accéder aux API est : https ://<instance>.cso.coupahost.com/api/companies
Voir les meilleures pratiques d'intégration pour plus d'informations.
Actions
| Verbe | Chemin d'accès | Action | Description |
|---|---|---|---|
| OBTENIR | /API/entreprises |
index | Effectue une action Get pour récupérer toutes les entreprises |
| PUBLIER | /API/entreprises |
créer | Crée un ou plusieurs objets Companies. |
| METTRE | /API/entreprises |
mettre à jour | Met à jour une ou plusieurs entreprises . Peut effectuer des mises à jour de masse. |
| OBTENIR | /api/companies/:id |
afficher | Afficher les données d'une entreprise. |
| METTRE | /api/companies/:id |
mettre à jour | Mettre à jour une entreprise à la fois à l'aide de l'identifiant |
Éléments
Ce sont les éléments disponibles pour l'API de l'entreprise
| Nom de champ | Description du champ | Req'd | Unique ? | Valeurs admissibles | Dans | Sortie * | Type |
|---|---|---|---|---|---|---|---|
| iD | ID de l'entreprise | Oui | oui | nombre entier | |||
| état | Statut de l'entreprise | Actif, supprimé (sensible à la casse) | oui | oui | chaîne | ||
| nom | Nom de la société | Oui | oui | oui | chaîne | ||
| numéro de téléphone | Numéro de téléphone de l'entreprise | oui | oui | chaîne | |||
| E-mail de l'entreprise | oui | oui | chaîne | ||||
| rue | Partie rue de l'adresse de l'entreprise | oui | oui | chaîne | |||
| code postal | Code postal faisant partie de l'adresse de l'entreprise | oui | oui | chaîne | |||
| ville | Ville partie de l'adresse de l'entreprise | oui | oui | chaîne | |||
| pays | Pays partie de l'adresse de l'entreprise | oui | oui | chaîne | |||
| duns-scac | Le code duns scac de la société. | oui | oui | chaîne | |||
| mots-clés | Mots-clés associés à l'entreprise | oui | oui | chaîne |
La charge utile de réponse n'affiche pas de valeurs NULL.
Exemples
Dans cet exemple, nous avons demandé une API d'entreprise. Nous avons accédé À l'URL :
https ://<instance>.cso.coupahost.com/api/companies
Réponse de L'ENTREPRISE GET
{
"total" : 7,
"compannies" : [
{
"id" : "9219592888303484960",
"state" : "Actif",
"nom" : "! Nouveau fournisseur (espagnol)"
},
{
"id" : "9219594398656586067",
"state" : "Actif",
"nom" : "! Simon Test Organization",
"email" : "simon@kepgames.com"
},
{
"id" : "9219592919623127484",
"state" : "Actif",
"nom" : "! SKF (soumissionnaires test)"
},
{
"id" : "9219592881350550871",
"state" : "Actif",
"nom" : "! Soumissionnaire espagnol ",
"email" : "heloisa.spanish@tradeext.com"
},
{
"id" : "9219592230193035378",
"state" : "Actif",
"nom" : "! TE",
"email" : "lorena@te.se",
"duns-scac" : "test123456789",
"keywords" : "test"
},
{
"id" : "9219596145584379778",
"state" : "Actif",
"nom" : "! Société de test TE "
},
{
"id" : "9219592639285418804",
"state" : "Actif",
"nom" : "! TE Test Company 2",
"numéro de téléphone" : "123-234-3456",
"email" : "testcompany2+upg@coupa.com",
"street" : "adresse1",
"code postal" : "12345",
"city" : "valahalla",
"pays" : "Îles mineures éloignées des États-Unis",
"mots-clés" : "Transporteur"
}
]
}Créer/Mettre à jour
Ce qui suit décrit comment vous pouvez utiliser l'API Coupa pour effectuer des actions sur l'entreprise.
Créer
/API/entreprises
La charge utile ci-dessous crée deux sociétés.
Charge utile :
{
"sociétés" : [
{
"state" : "Actif",
"nom" : "Oui Heloisa",
"duns-scac" : "Doit être mis à jour"
},
{
"nom" : "TE Test Company 2",
"numéro de téléphone" : "123-234-3456",
"email" : "testcompany2+upg@coupa.com"
}
]
}
Réponse : 201
{
"result" : [
{
"type" : "api.post.added",
"description" : "2 objets créés."
}
],
"ajouté" : 2,
"sociétés" : [
{
"id" : "9220538753256092391"
},
{
"id" : "9220538753250662192"
}
]
} Mettre à jour
/API/entreprises
La charge utile ci-dessous met à jour une ou plusieurs sociétés.
Pour mettre à jour une ou plusieurs entreprises à la fois :
Charge utile :
{
"sociétés" : [
{
"id" : "9219594319065198091",
"state" : "Actif",
"nom" : "! (TE) Heloisa",
"duns-scac" : "Doit être mis à jour"
},
{
"id" : "9219596218212801426",
"state" : "Actif",
"nom" : "! (TE) Organisation uniquement avec les soumissionnaires (italien)",
"duns-scac" : "Doit être mis à jour",
"email" : "testbidders_itl@coupa.com"
},
{
"id" : "9219596218212801429",
"state" : "Actif",
"nom" : "! (TE) Org avec seulement des soumissionnaires",
"duns-scac" : "Doit être mis à jour",
"mots-clés" : « Enchérisseurs »
}
]
}
Réponse : 200 OK
{
"result" : [
{
"type" : "api.put.updated",
"description" : "3 objets mis à jour."
}
],
"mis à jour" : 3
}Les mises à jour sont effectuées de manière indulgente, c'est-à-dire que si la mise à jour d'une ressource échoue, les autres pourraient réussir. L'ID de l'entreprise est requis pour les mises à jour.
Les demandes réussies renverront une réponse HTTP 200. Le corps de la réponse inclura la demande créée. Les demandes infructueuses renverront HTTP 400 Bad Request. Le corps de la réponse comprendra des erreurs de validation formatées en XML.