• Dernière modification le: 25 March 2021

API du marché

Utilisez l'API Markets pour créer, mettre à jour ou interroger les marchés.

Utilisez les API du marché pour créer, mettre à jour ou interroger les données du marché. Cela inclut des points de terminaison spécifiques pour prendre des mesures (créer/mettre à jour/supprimer) ainsi que des événements liés aux marchés.

L'URL pour accéder aux API est : https://<instance>.cso.coupahost.com/api/markets

Consultez la rubrique Bonnes pratiques d'intégration pour plus d'informations.

Actions

Verbe Chemin d'accès Action Description
OBTENIR /api/markets index Effectue une action Get pour récupérer tous les marchés
POSTE /api/markets créer Crée un ou plusieurs objets de marché.
METTRE /api/markets mettre à jour Met à jour un ou plusieurs marchés . Peut effectuer des mises à jour en masse.
EFFACER /api/markets effacer Supprime un ou plusieurs marchés. Peut effectuer des suppressions en masse.
OBTENIR /api/markets/:id montrer Afficher une seule donnée du marché. 
METTRE /api/markets/:id mettre à jour Mettre à jour un marché à la fois en utilisant l'ID
EFFACER /api/markets/:id effacer Supprimer un marché à la fois.

Éléments

Il s'agit des éléments disponibles pour l'API Markets

Nom de champ Description du champ Demande d'achat Unique ? Valeurs autorisées Dans Sortie Type
id

ID unique généré par le système, incrémentiel automatiquement

        oui entier
Nom Nom du marché   Oui   oui oui chaîne
description Brève description du marché       oui oui chaîne

Exemples

Dans cet exemple, nous avons recherché une API de marchés. Nous avons accédé à l'URL : 

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

Marché GET Réponse

{
		"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"
				}
	 ]
}

Créer/Mettre à jour/Supprimer

La section suivante décrit comment utiliser l'API Coupa pour effectuer des actions sur les marchés.

Créer

/api/markets

La charge utile ci-dessous crée deux marchés.

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"
				}
		]
}

Mettre à jour

/api/markets

La charge utile ci-dessous met à jour un marché. 

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
}

Effacer

/api/markets

La charge utile ci-dessous permet de supprimer plusieurs marchés à la fois. N'oubliez pas que la suppression de marchés individuellement ou en masse entraînera également la suppression d'événements associés. 

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
}
Remarque

 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. Voir supprimer la charge utile ci-dessus par exemple. La charge utile a supprimé un seul marché. Pour la suppression ou les mises à jour, un ID est requis dans la charge utile.

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.

Une partie ou la totalité de cette page peut avoir été traduite par machine. Toutes nos excuses pour les inexactitudes.

Articles associés


L'API Coupa Core

Notre API RESTful fournit un accès robuste pour lire, modifier ou intégrer vos données à la plate-forme Coupa.

Ressources

Nous avons organisé nos points de terminaison API par type d'objet : Données de référence, données transactionnelles et ressources partagées.

Ressources de données de référence

Les données de référence sont utilisées pour configurer les composants de base de Coupa tels que les utilisateurs, les fournisseurs, les comptes, et plus encore.

Ressources transactionnelles

Au fur et à mesure que les gens utilisent Coupa, des données transactionnelles telles que des demandes, des bons de commande et des factures sont créées.