API Documentation - Send Order to Megawin

Endpoint

POST https://api.megawin.be/order/sendtomegawin/

Headers

Content-Type: application/json

Parameters

Query Parameters

Parameter Type Description Required
apikey string Your API key to authenticate requests. Yes
guid string Unique identifier for the order. Yes
modeLivraison string Mode of delivery. -> 1 = To deliver / 2 = Pickup from Point of Sale Yes
deliverydate string Desired delivery date in YYYY-MM-DD format. Yes
deliverycomment string Comment for delivery (URL-encoded). No
adresseLivraison string Delivery address (URL-encoded). No

JSON Payload

Field Type Description Required
guid string Unique identifier for the order. Yes

Example Request

URL

https://api.megawin.be/order/sendtomegawin/?apikey=YOUR_API_KEY&guid=123456&deliverydate=2024-12-31&deliverycomment=Urgent%20delivery&modeLivraison=1&adresseLivraison=10%20Rue%20de%20Paris

Body

{
    "guid": "123456"
}

Response

Successful Response

{
    "success": true,
    "message": "Order sent",
    "result": {
        "guid": "123456",
        "file": "CMD_123456202412311200.xml",
        "orderNumber": "123456"
    }
}

Error Response

{
    "success": false,
    "message": "Error description"
}

Order XML Example

<?xml version="1.0" encoding="ISO-8859-1"?>
<Commande>
    <Date>20241231</Date>
    <Cli_No>CLIENT_NO</Cli_No>
    <Commande_No>123456</Commande_No>
    <TypeCode>ArticleNo</TypeCode>
    <NombreLigne>3</NombreLigne>
    <RemarqueLivraison>Urgent delivery</RemarqueLivraison>
    <AdresseLivraison>10 Rue de Paris</AdresseLivraison>
    <Date_liv>2024-12-31</Date_liv>
    <Mode_liv>Express</Mode_liv>
    <TotalBrut>1000.00</TotalBrut>
    <Web_remise>0</Web_remise>
    <Lignes>
        <Ligne>
            <ARCLEUNIK>12345</ARCLEUNIK>
            <Code>ABC123</Code>
            <Quantite_Colis>10</Quantite_Colis>
            <Quantite_Par_Colis>1</Quantite_Par_Colis>
            <Quantite_Totale>10</Quantite_Totale>
            <Prix_un>100.00</Prix_un>
            <Montant_HT>1000.00</Montant_HT>
        </Ligne>
    </Lignes>
</Commande>

Important Notes

  • Order Validation: If an order already exists in the system (guid is reused), a message will indicate the order has already been sent.
  • Guest Account Restrictions: Orders created using guest accounts may have limited functionality.
  • File Generation: The API generates an XML file and stores it locally or uploads it via FTP, depending on configuration.
  • FTP Configuration: Ensure FTP credentials and access rights are correctly set up for the OUTBOX directory.

For further assistance, contact support at support@megatech.com.