Expedition

Expedition Entity

The Expedition entity represents the shipment process of an order. It includes key attributes such as orderNumber, deliveryAddress, billingAddress, carrier, and more. The expedition's status reflects its progress in fulfillment, from booking to delivery. This guide walks you through all endpoints related to expeditions and their structure.

Each expedition is uniquely identified by its id and belongs to an eshop.

Find more about expedition flow in our Knowledge Base.

Expedition catalog

Get Expedition	GET /api/expedition/{id}	Fetches all data about a specific expedition.
Update Expedition	PUT /api/expedition/{id}	Updates an existing expedition.
Patch expedition without rebooking	PATCH /api/expedition/{id}	Updates custom reference fields of an expedition without triggering a rebooking.
Get list of Expedition	POST /api/expedition/list	Retrieves a list of all expeditions in Mailship.
Send multiple expeditions to WMS	PUT /api/expedition/send	Sends multiple expeditions for processing into WMS.
Continue multiple expeditions to WMS	PUT /api/expedition/process	Allows the processing of multiple expeditions in WMS.
Cancel multiple expeditions	PUT /api/expedition/cancel	Cancels multiple expeditions, provided they meet the cancellation conditions.
Create Expedition	POST /api/expedition	Creates a new expedition.
Rebook Expedition	PATCH /api/expedition/{id}/rebook	Rebooks an existing expedition entity.
Unbook all from Expedition	PATCH /api/expedition/{id}/unbook	Unbooks all items from an expedition.
Get Expedition Invoice	GET /api/expedition/{id}/invoice	Fetches the invoice associated with an expedition.
Upload Expedition Invoice	POST /api/expedition/{id}/invoice	Uploads an invoice to an expedition.
Remove Expedition Invoice	DELETE /api/expedition/{id}/invoice	Removes an invoice from an expedition.
Send Expedition to WMS	PUT /api/expedition/{id}/send	Sends an expedition for processing in WMS.
Process Expedition to WMS	PUT /api/expedition/{id}/process	Allows processing of an expedition in WMS.
Cancel Expedition	PUT /api/expedition/{id}/cancel	Cancels a specific expedition, provided it meets the cancellation conditions.
Rollback Expedition	PUT /api/expedition/{id}/rollback	Rollbacks a specific expedition, provided it meets the rollback conditions.
Delete Expedition	PUT /api/expedition/{id}/delete	Deletes a specific expedition, provided it meets the deletion conditions.

Expedition Item

An Expedition Item represents an individual product unit within an expedition. It contains information about the product, quantity. Each expedition can have multiple items, where each item corresponds to a specific product being shipped.

Get list of ExpeditionItems

POST /api/expedition-item/list

Retrieves a list of expedition items based on specified criteria.

For more details, please visit other subsections in the expedition category.