Skip to main content

How to Use the Rollback Expedition Endpoint

Guide on reverting expeditions in Mailship before warehouse processing using the Rollback endpoint.

Updated over a year ago

The Rollback Expedition endpoint is a useful feature that allows you to withdraw an expedition from the Warehouse if it has not started processing. This action will set the expedition's status to ON-HOLD, allowing you to make changes to it. Here's a step-by-step guide on how to use this endpoint.


API URL

The API URL for this endpoint is http://app.mailship.eu/api/expedition/{id}/rollback. The {id} in the URL should be replaced with the ID of the expedition you want to rollback.


Request Method

This endpoint uses the PUT HTTP method.

Request Payload

This endpoint does not require a request payload. The ID of the expedition to be rolled back is specified in the URL.


How to Use

To use this endpoint, you need to make a PUT request to the API URL, replacing {id} with the ID of the expedition you want to rollback. Here's an example of how to do this using curl:

curl -X PUT "http://app.mailship.eu/api/expedition/123456/rollback"

In this example, 123456 is the ID of the expedition to be rolled back.

Response

The response from the endpoint will be a JSON object containing the details of the rolled back expedition. If the rollback was successful, the expedition's status will be set to ON-HOLD.


Conclusion

The Rollback Expedition endpoint is a powerful tool that allows you to withdraw an expedition from the Warehouse if it has not started processing. This can be particularly useful in situations where you need to make changes to an expedition after it has been created but before it has started processing. By understanding how to use this endpoint, you can effectively manage your expeditions and ensure they are processed correctly.


​

Did this answer your question?