Developers - Plan an expedition

Plan an expedition

To schedule a shipment you simply need to add the sender's account number to the complete quote request.

Example request

        URL: https://api.fmlogique.com/ship/ 
        POST: {
            "apiKey": "YOUR-API-KEY",
            "PickAddress": {
                "Name": "FM Logique",
                "Contact": "François",
                "Adressline1": "1395 Rue Fleury Est",
                "Adressline2": "Suite 102.2",
                "Adressline3": "",
                "City": "Montréal",
                "Province": "QC",
                "Code": "H2C 1R7",
                "Phone": "(438)777-6857",
                "PhoneExt": "",
                "Email": "info@fmlogique.com"
            },
            "DestAddress": {
                "Name": "FM Logique",
                "Contact": "François",
                "Adressline1": "1395 Rue Fleury Est",
                "Adressline2": "Suite 102.2",
                "Adressline3": "",
                "City": "Montréal",
                "Province": "QC",
                "Code": "H2C 1R7",
                "Phone": "(438)777-6857",
                "PhoneExt": "",
                "Email": "info@fmlogique.com"
            },
            "RVDate": "2020-02-28 21:47",
            "Service": "jour",
            "Account":"0",
            "Parcels": [
                {
                    "Parcel": "Boite",
                    "Weight": "10.00",
                    "Size": "10 X 12 X 8"
                },
                {
                    "Parcel": "Enveloppe",
                    "Weight": "1.00",
                    "Size": "1 X 1 X 1"
                }
            ]
        }       

Account: (STRING)

Service: (STRING)

The service choices are:

• jour: Next day.
• periode: Half day.
• 180: Regular 3 hours.
• 120: Express 2 hours.
• 60: Exclusive 1 hour.

The elements of special instructions:

• ParcelNote: Note on packages.
• Note: General instructions.
• PickNote: Instructions for Picking.
• DestNote: Delivery Instructions.
• Reference: The client's reference.

JSON response

Operation

• If response indicates the elements ShippingID and TrackingNumber then the shipment is planned.

Example of response when the shipment has been planned

          
        {
            "ShippingID": 600601739,
            "TrackingNumber": 600601739,
            "message": "Une nouvelle commande à été créé!",
            "result": [
                {
                    "ID": 5,
                    "ServiceTag": "jour",
                    "ServiceNameFr": "Lendemain",
                    "ServiceNameEn": "Next day",
                    "DeliveryDate": "2020-03-02 17:00",
                    "BasePrice": 5,
                    "SurchargeCharges": [],
                    "SurchargeTotal": 0,
                    "TaxCharges": [
                        {
                            "ID": "GST",
                            "Charge": 0.25,
                            "Rate": 0.05,
                            "NameFr": "TPS",
                            "NameEn": "GST"
                        },
                        {
                            "ID": "PST",
                            "Charge": 0.5,
                            "Rate": 0.1,
                            "NameFr": "TVQ",
                            "NameEn": "PST"
                        },
                        {
                            "ID": "HST",
                            "Charge": 0,
                            "Rate": 0,
                            "NameFr": "TVH",
                            "NameEn": "HST"
                        }
                    ],
                    "SubTotal": 5,
                    "Total": 5.75
                }
            ],
            "errors": []
        }           

Description of the root elements of the response

ShippingID: (INT)

TrackingNumber: (INT)

message: (STRING)

result: (ARRAY)

errors: (ARRAY)

Description of the elements of the result object

ID: (INT)

ServiceTag: (STRING)

ServiceNameFr: (STRING)

ServiceNameEn: (STRING)

DeliveryDate: (STRING)

BasePrice: (FLOAT)

SurchargeCharges: (ARRAY)

• NameFr: (STRING) The description of the additional charge in French.
• NameEn: (STRING) The description of the additional charge in English.
• Charge: (FLOAT) Amount of additional charge.

SurchargeTotal: (FLOAT)

TaxCharges: (ARRAY)

• ID: (INT) The tax id
• Charge: (FLOAT) The amount of tax.
• Rate: (FLOAT) The tax rate.
• NameFr: (STRING) The description of the tax in French.
• NameEn: (STRING) the description of the tax in English.

SubTotal: (FLOAT)

Total: (FLOAT)