GET /edi/api/order

Permet de récupérer au format JSON les informations d'une commande PMS, notamment son statut, son message interne et la liste de ses colis.

Cette API est l'équivalent REST JSON de l'ancien endpoint XML order_query.

Cette API utilise une authentification OAuth 2.0.

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/order?order_ref=486454&delivery_note_ref=", 
    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

order_ref : obligatoire. Numéro de commande transmis dans OrderId lors de la création de la commande.
delivery_note_ref : facultatif. Numéro de BL ou numéro d'envoi transmis dans DeliveryNoteId. Obligatoire pour identifier la commande si un même OrderId peut faire l'objet de plusieurs expéditions.

Si delivery_note_ref n'est pas fourni, PMS recherche la commande dont DeliveryNoteId est vide.

Exemple de réponse


{
  "order_id": 7846454,
  "order_ref": "486454",
  "public_order_ref": "",
  "customer_ref": "64154",
  "delivery_note_ref": "",
  "invoice_ref": "",
  "shop_id": 1,
  "shop_ref": "SHOP-01",
  "user_data1": "",
  "user_data2": "",
  "user_data3": "",
  "user_data4": "",
  "status": 90,
  "message": "Attention : merci d'ajouter une carte cadeau",
  "delivery_method_id": 12,
  "delivery_method_ref": "3",
  "service_code": "DOM",  
  "carrier_connector": "colissimo_ws",
  "end_packing_date": "2017-09-05 15:10:07",
  "shipping_date": "2017-09-05 15:11:18",
  "who_packing": 14,
  "who_shipping": 14,
  "ship_weight": 267,
  "ship_on_date": "2017-09-05",
  "deliver_on_date": "2017-09-06 00:00:00",
  "stock_ready": 1,
  "parcels": [
    {
      "is_return": 0,
      "parcel_rank": 1,
      "delivery_method_id": 12,
      "delivery_method_ref": "3",
      "service_code": "DOM",
      "carrier_connector": "colissimo_ws",
      "ship_number": "9V154515540151",
      "foreign_key": "",
      "ship_weight": 267,
      "label_url": "https://www.transporteur.com/label_9V154515540151.pdf",
      "customs_url": "https://www.transporteur.com/cn23_9V154515540151.pdf",
      "tracking_url": "https://www.transporteur.com/?9V154515540151",
      "cost": 5.67
    }
  ]
}

Champs de la réponse

order_id : identifiant interne PMS de l'instance de la commande. Cet identifiant peut changer lorsque la commande est retransmise.
order_ref : votre numéro de commande dans votre ERP.
public_order_ref : votre numéro de commande connu du client final.
customer_ref : votre numéro du client de la commande.
delivery_note_ref : votre numéro de BL ou numéro d'envoi.
invoice_ref : votre numéro de facture.
shop_id : identifiant interne PMS de l'enseigne.
shop_ref : votre référence de l'enseigne.
user_data1 à user_data4 : vos données libres transmises avec la commande.
status : statut courant de la commande dans PMS.
message : message interne associé à la commande.
delivery_method_id : identifiant interne PMS du service de transport.
delivery_method_ref : votre référence du service de transport.
end_packing_date : date de fin du packing.
shipping_date : date d'expédition.
who_packing : identifiant de l'employé ayant réalisé le packing.
who_shipping : identifiant de l'employé ayant réalisé l'expédition.
ship_weight : poids de la commande en grammes.
ship_on_date : date prévue d'expédition.
deliver_on_date : date prévue de livraison.
stock_ready : indicateur de disponibilité du stock.

Champs des colis

is_return : 1 s'il s'agit d'un colis retour, 0 sinon.
parcel_rank : numéro de séquence du colis.
delivery_method_ref : identifiant du service de transport du colis.
carrier_connector : nom du connecteur transporteur utilisé.
ship_number : numéro de suivi.
foreign_key : identifiant externe du colis lorsqu'il existe.
ship_weight : poids du colis en grammes.
label_url : URL de l'étiquette transporteur.
customs_url : URL du document de douane.
tracking_url : URL de suivi.
cost : coût du transport HT.

Exemple d'erreur


{
  "error": "unknown_order",
  "error_description": "Unknown order."
}