API : Order

Usage de la commande Order

La commande Order permet la transmission des données d'une commande à PMS.

La commande Order permet de

1. transmettre une première fois (action=CREATE).
2. retransmettre (action=REPLACE).
3. annuler (action=CANCEL).

Vous devez mettre en place deux modes de fonctionnement dans votre ERP :

1. La transmission automatique d'une commande. Exemple : transmission de la commande lors du passage en statut "En attente de préparation". Ne transmettez que les commandes considérées comme expédiables.
2. La transmission à la demande de l'utilisateur via l'interface utilisateur. Exemple ci-dessous (module PMS sur une page de commande dans Prestashop).

Exemple de requête

<order>
	<AccountName>beautyshop</AccountName>
    <Action>Create</Action>
	<OrderId>451566</OrderId>
	<CustomerOrderId></CustomerOrderId>
	<OrderDate>2013-06-04</OrderDate>
	<CustomerId>14524</CustomerId>
	<DeliveryNoteId></DeliveryNoteId>
	<InvoiceId></InvoiceId>
	<InvoiceDate></InvoiceDate>
	<IsTransfer>0</IsTransfer>
	<ShopId>1</ShopId>
	<SalesChannelId>1</SalesChannelId>
	<Priority></Priority>
	<ShipOnDate></ShipOnDate>
	<DeliverOnDate></DeliverOnDate >
	<DeliveryMethod>Colissimo</DeliveryMethod>
	<DeliveryMethodId>5</DeliveryMethodId>
	<DeliveryFirstName>JEAN</DeliveryFirstName>
	<DeliveryLastName>DUPOND</DeliveryLastName>
	<DeliveryCompany>STARTUP SARL</DeliveryCompany>
	<DeliveryAddress1>1 RUE DE LA REPUBLIQUE</DeliveryAddress1>
	<DeliveryAddress2></DeliveryAddress2>
	<DeliveryAddress3></DeliveryAddress3>
	<DeliveryZipCode>75000</DeliveryZipCode>
	<DeliveryCity>PARIS</DeliveryCity>
	<DeliveryStateCode></DeliveryStateCode>
	<DeliveryCountry>FR</DeliveryCountry>
	<DeliveryPhone>+33611223344</DeliveryPhone>
	<DeliveryEmail>jeandurand@domaine.com</DeliveryEmail>
	<InsuranceValue>250</InsuranceValue>
	<SubscribeInsurance>0</SubscribeInsurance>
	<Message><![CDATA[Fragile, attention à l'emballage]]></Message>
	<GiftMessage><![CDATA[<h1>Joyeux anniversaire !</h1>]]></GiftMessage>
	<DocumentMessage1><![CDATA[<span style=\"size:12px;\">Merci Monsieur Durand pour votre achat !</span>]]></DocumentMessage1>
	<DocumentMessage2></DocumentMessage2>
	<FollowUpEmail></FollowUpEmail>
	<UserData1></UserData1>
	<UserData2></UserData2>
	<UserData3></UserData3>
	<UserData4></UserData4>
	<B2B>0</B2B>
	<ShippingCostTaxIncl>250</ShippingCostTaxIncl>
	<Currency>EUR</Currency>
	<products>
  		<product>
			<Sku>125452</Sku>
			<Quantity>1</Quantity>
			<UnitPrice>19.99</UnitPrice>
			<UnitPriceTaxExcl>19.99</UnitPriceTaxExcl>
			<InStock>1</InStock>
			<WarehouseId>1</WarehouseId>
			<GiftWrap>0</GiftWrap>
			<UserData1></UserData1>
			<UserData2></UserData2>
			<UserData3></UserData3>
			<UserData4></UserData4>
			<Customization><![CDATA[{"Prénom:":"PIERRE"}]]></Customization>            
		</product>
		<product>
			<Sku>9458454</Sku>
			<Quantity>2</Quantity>
			<UnitPrice>75.00</UnitPrice>
			<UnitPriceTaxExcl>75.00</UnitPriceTaxExcl>
			<InStock>1</InStock>
			<WarehouseId>2</WarehouseId>
			<GiftWrap>0</GiftWrap>
			<UserData1></UserData1>
			<UserData2></UserData2>
			<UserData3></UserData3>
			<UserData4></UserData4>
		</product>
	</products>
	<DeliveryOptions>
        <point_relais_id>01997</point_relais_id>
        <tracking_key>123456789</tracking_key>
        <url_push><![CDATA[https://domaine.com/index.php?controller=ajax&option=push&order=999&key=123456789]]></url_push>
	</DeliveryOptions>
</order>

Champs de données

Champs <order>

Champs <order> <products> <product>

Champs <DeliveryOptions> : Boxtal

Champs <DeliveryOptions> : Chronopost

Champs <DeliveryOptions> : Colissimo

Champs <DeliveryOptions> : TNT Express France

Champs <DeliveryOptions> : Mondial Relay

Données <product> homogènes

Si Quantity > 1 et que seule une partie est en stock, vous devez créer deux enregistrements Product, un pour la quantité en stock, l'autre pour la quantité non disponible. Idem pour le champ WarehouseId. Il faut donc diviser les quantités par caractéristiques homogènes. Exemples :

Article Sku n°33444, vendu pour une quantité de 5 ex, dont 3 à l'entrepôt n°1 et 2 à l'entrepôt n°3 :

<products>
    <product>
         <Sku>33444</Sku>
         <Quantity>3</Quantity>
         <InStock>1</InStock>
         <WarehouseId>1</WarehouseId>
    </product>
    <product>
         <Sku>33444</Sku>
         <Quantity>2</Quantity>
         <InStock>1</InStock>
         <WarehouseId>3</WarehouseId>
    </product>
</products>

Si maintenant, sur les 3 exemplaires à l'entrepôt n°1, seuls 2 sont physiquement en stock, cela donne :

<products>
    <product>
         <Sku>33444</Sku>
         <Quantity>2</Quantity>
         <InStock>1</InStock>
         <WarehouseId>1</WarehouseId>
    </product>
    <product>
         <Sku>33444</Sku>
         <Quantity>1</Quantity>
         <InStock>0</InStock>
         <WarehouseId>1</WarehouseId>
    </product>
    <product>
         <Sku>33444</Sku>
         <Quantity>2</Quantity>
         <InStock>1</InStock>
         <WarehouseId>3</WarehouseId>
    </product>
</products>

Réponse

<response>error:duplicate</response>