API du marché

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

Éléments

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

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
}

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.