API de la société
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
Consultez la rubrique Bonnes pratiques d'intégration pour plus d'informations.
Actions
Verbe | Chemin d'accès | Action | Description |
---|---|---|---|
OBTENIR | /api/companies |
index | Effectue une action Obtenir pour récupérer toutes les sociétés |
POSTE | /api/companies |
créer | Crée un ou plusieurs objets Sociétés. |
METTRE | /api/companies |
mettre à jour | Met à jour une ou plusieurs sociétés . Peut effectuer des mises à jour en masse. |
OBTENIR | /api/companies/:id |
montrer | Afficher les données d'une entreprise. |
METTRE | /api/companies/:id |
mettre à jour | Mettre à jour une société à la fois en utilisant l'ID |
Éléments
Voici les éléments disponibles pour l'API de l'entreprise
Nom de champ | Description du champ | Demande d'achat | Unique ? | Valeurs autorisées | Dans | Sortie * | Type |
---|---|---|---|---|---|---|---|
id |
ID de la société |
Oui | oui | entier | |||
déclarer | Statut de la société |
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 la société | oui | oui | chaîne | |||
courrier électronique | Adresse électronique de la société | oui | oui | chaîne | |||
rue | Partie de la rue de l'adresse de la société | oui | oui | chaîne | |||
code postal | Partie du code postal de l'adresse de la société | oui | oui | chaîne | |||
ville | Ville de l'adresse de la société | oui | oui | chaîne | |||
pays | Partie du pays de l'adresse de la société | oui | oui | chaîne | |||
duns-scac | Code de sécurité Duns pour la société. | oui | oui | chaîne | |||
mots-clés | Mots-clés associés à la société | oui | oui | chaîne |
La charge utile de réponse n'affiche pas de valeurs NULL.
Exemples
Dans cet exemple, nous avons recherché une API d'entreprise. Nous avons accédé à l'URL :
https://<instance>.cso.coupahost.com/api/companies
Réponse de la société GET
{
"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"
}
]
}
Créer/Mettre à jour
La section suivante décrit comment utiliser l'API Coupa pour effectuer des actions sur l'entreprise.
Créer
/api/companies
La charge utile ci-dessous crée deux sociétés.
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"
}
]
}
Mettre à jour
/api/companies
La charge utile ci-dessous met à jour une ou plusieurs sociétés.
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
}
Les mises à jour sont effectuées de manière souple, c'est-à-dire que si la mise à jour d'une ressource échoue, les autres peuvent réussir. ID de la société requis pour les mises à jour.
Les demandes réussies seront renvoyées HTTP 200 Response
. Le corps de la réponse inclura la demande créée. Les demandes infructueuses seront renvoyées HTTP 400 Bad Request
. Le corps de la réponse inclut les erreurs de validation au format XML.
Veuillez noter que certaines parties de ce contenu peuvent avoir été générées par traduction automatique.