API - Commande

 Pour être informés de toutes les mises à jour concernant l’API v2 de SPREAD, inscrivez-vous ici : https://social-sb.com/z/newsletter-api-v1-v2

GET Order

Cette méthode permet de récupérer les valeurs d'une commande précise.

GET ⇒ social-sb.com/api/v2/orders/{orderId}

Paramètres obligatoires :

• "orderId" : votre identifiant commande (la référence)

Paramètres complémentaires :

Aucun

Réponse :

Si GET ok alors

"order": {
 "id": "654321",
 "createdAt": "2018-05-19 07:33:44",
 "updatedAt": "2018-05-31 08:33:26",
 "amount": "54.00",
 "customerId": "123456",
 "orderId": "aaaaa123bbbbb",
 "facturationNumber": null,
 "status": "10",
 "startService": "2019-01-21",
 "endService": "2019-01-29",
 "tags": ["tag1","tag2","tag3"],
 "attributes": [
	 ["attr1-groupe1","attr2-groupe1"],
	 ["attr1-groupe2","attr2-groupe2"]
 ]
 }

Sinon, affichage d'un message d'erreur.

Exemple d'appel PHP :

$curl = curl_init(); 
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/orders/aaaaa123bbbbb"); 
curl_setopt($curl, CURLOPT_USERPWD, "cle_publique:cle_privee"); // À remplacer par les clés d'API publique et privée dans votre back office, menu "Paramétrage > Tracker" en bas de page
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
$curl_return = curl_exec($curl); 
var_dump($curl_return); 
curl_close($curl);

GET Orders

Permet de récupérer toutes les commandes pour un site_id.

GET ⇒ social-sb.com/api/v2/orders

Paramètres obligatoires :

Aucun

Paramètres complémentaires :

Aucun

Réponse :

Si GET ok alors

"orders": [
 {
 "id": "654321",
 "createdAt": "2018-05-13 17:40:44",
 "updatedAt": "2018-05-31 08:31:43",
 "amount": "54.00",
 "customerId": "123456",
 "orderId": "aaaaa123bbbbb",
 "facturationNumber": null,
 "status": "10",
 "startService": "2019-01-21",
 "endService": "2019-01-29"
 },
 {
 "id": "987654",
 "createdAt": "2018-05-19 07:33:44",
 "updatedAt": "2018-05-31 08:33:26",
 "amount": "77.00",
 "customerId": "565653",
 "orderId": "ccccc879ddddd",
 "facturationNumber": null,
 "status": "20",
 "startService": null,
 "endService": null
 }
 ],
 "count": 2,
 "nextPageUrl": "http://social-sb.com/api/v2/orders?startAt=2"
}"

Sinon, affichage d'un message d'erreur.

Exemple d'appel PHP :

$curl = curl_init(); 
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/orders"); 
curl_setopt($curl, CURLOPT_USERPWD, "cle_publique:cle_privee"); // À remplacer par les clés d'API publique et privée dans votre back office, menu "Paramétrage > Tracker" en bas de page
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
$curl_return = curl_exec($curl); 
var_dump($curl_return); 
curl_close($curl);

Faire une recherche précise :

Il est possible d'affiner la liste retournée en passant des paramètres GET.

Les paramètres d'affinage possibles :

• "createdAfter" ⇒ seules les commandes créées après la date passée en paramètre seront remontées
• "createBefore" ⇒ seules les commandes créées avant la date passée en paramètre seront remontées
• "modifiedAfter" ⇒ seules les commandes modifiées après la date passée en paramètre seront remontées
• "modifiedBefore" ⇒ seules les commandes modifiées avant la date passée en paramètre seront retournées
• "minAmount" ⇒ seules les commandes avec un montant supérieur à la valeur du paramètre seront remontées
• "maxAmount" ⇒ seules les commandes avec un montant inférieur à la valeur du paramètre seront remontées
• "amount" ⇒ seules les commandes avec un montant identique à la valeur du paramètre seront remontées
• "minStatus" ⇒ seules commandes avec un statut supérieur à la valeur du paramètre seront remontées
• "maxStatus" ⇒ seules les commandes avec un statut inférieur à la valeur du paramètre seront remontées
• "status" ⇒ seules les commandes avec un statut identique à la valeur du paramètre seront remontées
• "startServiceBefore" ⇒ seules les commandes avec une date de début de prestation avant la date passée en paramètre seront remontées
• "startServiceAfter" ⇒ seules les commandes avec une date de début de prestation après la date passée en paramètre seront remontées
• "endServiceBefore" ⇒ seules les commandes avec une date de fin de prestation avant la date passée en paramètre seront remontées
• "endServiceAfter" ⇒ seules les commandes avec une date de fin de prestation après la date passée en paramètre seront remontées
• "customerId" ⇒ seules les commandes du customer seront remontées
• "showOrderTags" ⇒ si à pour valeur 1, les commandes seront remontées avec leurs tags associés. Si le paramètre ne fait pas partie de l'appel alors aucune des commandes ne sera remontée avec ses tags
• "showProductAttributes" ⇒ si à pour valeur 1, les commandes seront remontées avec leurs attributs produit associés. Si le paramètre ne fait pas partie de l'appel, alors aucune des commandes ne sera remontée avec ses attributs produit
• "tag" ⇒ seules les commandes possédant un tag strictement identique à celui passé en paramètres seront remontées

Les paramètres sur la pagination :

• "startAt" ⇒ permet de commencer la liste des commandes à partir de l'occurence passée en paramètre
• "maxResult" ⇒ permet de limiter le nombre de commandes remontées par pages (max 5000)