+

As dynamic as friendly

Developers - Cancel a shipment

In the event that a shipment needs to be canceled, it is possible to do so through our API. The shipment must not have been split to cancel it free of charge.

Cancel a shipment

To cancel a shipment, you simply need to indicate the shipment number in the cancellation request.

The account must be added to the account list which can be controlled by your API! Only FM Logique administrators can modify this list!
        URL: https://api.fmlogique.com/void/ 
        POST: {
            "apiKey": "YOUR-API-KEY",
            "ShippingID":"600601739"
        }       

ShippingID: (INT)

The FM Logique shipping number.

JSON response

Operation

  • If the response indicates the elements ShippingID and VoidNumber then the cancellation request is sent.

        {
            "ShippingID": 600601739,
            "VoidNumber": 10112,
            "message": "Cette commande sera annulé!",
            "errors": []
        }           

Description of the root elements of the response


ShippingID: (INT)

The FM Logique shipping number.


VoidNumber: (INT)

The FM Logique cancellation request number.

message: (STRING)

The message of success.

errors: (ARRAY)

Error messages.


To understand how it works!

In order to facilitate the integration of our functionalities into your system and to fully understand our APIs, you can use our test console provided for this purpose. Thanks to the documentation and the test console made available to you, the people who develop your website, software or application will be able to integrate our functionalities. For example, a button that would instantly schedule a shipment with the information you have in your system. Your shipments can also be scheduled automatically, for example when one of your customers buys one of your products and wishes to receive it by parcel. The automation possibilities are very lucrative in the end, since they save our customers a lot of time!

Test console
Developers
Shipments

25k

Packages delivered

Distance

1.5

Million kilometers

Help and Resources

3

Representatives

You have questions?

+
Are you sure you want to log out?
Logout