GET /edi/api/orders
Permet de récupérer les commandes PMS et leur statut courant au format JSON.
Cette API utilise une authentification OAuth 2.0.
Les paramètres GET sont facultatifs :
- status_min : statut courant minimum, inclus
- status_max : statut courant maximum, inclus
- status_date_min : date minimum du statut courant, au format
YYYY-MM-DDouYYYY-MM-DD HH:MM:SS - status_date_max : date maximum du statut courant, au format
YYYY-MM-DDouYYYY-MM-DD HH:MM:SS
Sans paramètre, toutes les commandes sont retournées.
Exemple de requête
$access_token = "{access-token}";
$ch = curl_init();
curl_setopt_array($ch, array(
CURLOPT_URL => "https://{account-name}.pms1.net/edi/api/orders?status_min=2&status_max=6&status_date_min=2026-08-01&status_date_max=2026-08-10",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_VERBOSE => true,
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Authorization: Bearer ' . $access_token
)
));
$reply = curl_exec ($ch);
curl_close($ch);
$json = json_decode($reply);
Paramètres
- status_min : retourne les commandes dont le statut courant est supérieur ou égal à cette valeur
- status_max : retourne les commandes dont le statut courant est inférieur ou égal à cette valeur
- status_date_min : retourne les commandes dont la date du statut courant est supérieure ou égale à cette date
- status_date_max : retourne les commandes dont la date du statut courant est inférieure ou égale à cette date
Lorsque status_date_max est fourni au format YYYY-MM-DD, toute la journée indiquée est incluse.
Exemple de réponse
[
{
"order_id": 123,
"order_ref": "ABC-123",
"status": 4,
"status_date": "2026-08-10 14:32:01"
},
{
"order_id": 124,
"order_ref": "ABC-124",
"status": 6,
"status_date": "2026-08-10 16:05:42"
}
]
- order_id : identifiant interne de la commande dans PMS
- order_ref : référence de la commande
- status : statut courant de la commande
- status_date : dernière date à laquelle le statut courant a été enregistré dans l'historique de la commande
Exemple d'erreur
{
"error": "invalid_parameter",
"error_description": "status_date_min must use YYYY-MM-DD or YYYY-MM-DD HH:MM:SS."
}