API : Order Query

Usage de la commande Order Query

La commande order_query vous permet d'obtenir de la part de PMS des informations sur la commande, notamment :

le statut de la commande
la liste des colis avec leur poids, numéro de suivi et url de l'étiquette de transport
id de l'employé ayant réalisé le packing
id de l'employé ayant réalisé le shipping

Son usage (en pull) est complémentaire de l'URL Push : lire URL Push

Exemple de requête


<order_query>
	<AccountName>beautyshop</AccountName>
    <order>
        <OrderId>486454</OrderId>
        <CustomerOrderId></CustomerOrderId>
        <CustomerId>64154</CustomerId>
        <DeliveryNoteId></DeliveryNoteId>
        <InvoiceId></InvoiceId>
        <ShopId>1</ShopId>
    </order>
</order_query>

Champs de la requête

Ces champs ont pour seul but d'identifier la commande. Vous devez donc y reprendre strictement les mêmes valeurs que dans la requête de création de la commande.

Champ	Obligatoire	Description
AccountName	Oui	Votre identifiant de compte PMS

Champs <order>

Champ	Obligatoire	Description
OrderId	Oui	Numéro de commande dans votre ERP
CustomerOrderId	Non	Numéro de commande connu du client final si différent de OrderId. Pour impression sur le BL seulement. N'est pas utilisé par la solution comme donnée d'identification.
CustomerId	Non	Numéro de client
DeliveryNoteId	Non/Oui	Numéro de BL ou numéro d'envoi. Obligatoire si un même OrderId peut faire l'objet de plusieurs expéditions. Si ce cas n'est pas prévu dans votre ERP, laissez ce champ toujours vide.
InvoiceId	Non	Numéro de facture
ShopId	Oui	Id de l'enseigne

Exemple de réponse


<response>
    <order>
        <OrderId>486454</OrderId>
        <CustomerOrderId></CustomerOrderId>
        <CustomerId>64154</CustomerId>
        <DeliveryNoteId></DeliveryNoteId>
        <InvoiceId></InvoiceId>
        <ShopId>1</ShopId>

		<pms_order_id>784645489</pms_order_id>
        <status>90</status>
        <message><![CDATA[Attention : merci d'ajouter une carte cadeau]]></message>
        <DeliveryMethodId>3</ DeliveryMethodId>
        <end_packing_date>2017-09-05 15:10:07</status>
        <shipping_date>2017-09-05 15:11:18</status>
        <who_packing>14</who_packing>
        <who_shipping>14</who_shipping>
        <ship_weight>267</ship_weight>
        <parcels>
            <parcel>
                <is_return>0</is_return>
                <parcel_rank>1</parcel_rank>
                <DeliveryMethodId>54</DeliveryMethodId>
                <ship_number>9V154515540151</ship_number>
                <ship_weight>267</ship_weight>
                <label_url>http://www.transporteur.com/label_9V154515540151.pdf</label_url>
                <customs_url>http://www.transporteur.com/cn23_9V154515540151.pdf</customs_url>
                <tracking_url>http://www.transporteur.com/?9V154515540151</tracking_url>
                <cost>5.67</cost>
            </parcel>
        </parcels>
    </order>
</response>

Champs de la réponse

Les champs en majuscules/minuscules sont vos données. Nous ne les explicitons pas ci-dessous. Les champs en minuscules sont les données PMS :

Champ	Description
pms_order_id	Id PMS de l'instance de la commande. Attention cet id change à chaque fois que la commande est retransmise.
OrderStatus	Deprecated.
Message	Deprecated.
status	Statut de la commande dans PMS (voir dictionnaire)
message	Message interne (consigne aux équipes)
DeliveryMethodId	Votre id de service de transport
end_packing_date
shipping_date
who_packing	Id de l'employé ayant effectué le packing, sous réserve d'avoir renseigné les id employés dans les profils utilisateurs de PMS
who_shipping	Id de l'employé ayant effectué le shipping, sous réserve d'avoir renseigné les id employés dans les profils utilisateurs de PMS
ship_weight	Poids de la commande (somme des poids colis) en grammes

Champs <parcel>

Champ	Description
is_return	1 s'il s'agit d'un colis retour, 0 sinon
parcel_rank	N° de séquence du colis (1 à N)
DeliveryMethodId	Votre id de service de transport
ship_number	Numéro de suivi du colis
ship_weight	Poids en grammes
label_url	URL de l'étiquette transporteur au format PDF
customs_url	URL des documents de douane au format PDF
tracking_url
cost	Coût du transport HT