Sending Expedition to WMS | Developer portal

Each expedition created in Mailship via POST /api/expedition must be sent to our WMS (our warehouse management system).

Creating an expedition alone assigns it the “on_hold” status. It remains in this state until processed. The PUT /api/expedition/{id}/send endpoint triggers the processing of the order, initiating its transition into our WMS for picking, packing, and shipping.

Send Expedition to WMS

Send the expedition for processing.

Request structure

Endpoint:	PUT /api/expedition/{id}/send
URL (prod):	https://app.mailship.eu/api/expedition/{id}/send
Headers:	`Authorization: Bearer YOUR_ACCESS_TOKEN Accept: application/json`
Request body:	None (this request does not require a body). Optional body: `{ "rebook": true }` However, using no request body is preferred.
Request Example (cURL):	`curl --location --request PUT 'https://app.mailship.eu/api/expedition/42cf3202-a3a1-4c4c-8695-a6807efeae29/send' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {{token}}'`

Path parameter:

Parameter	Type	Required	Description
`id`	string	✅	The unique expedition identifier. Example: `42cf3202-a3a1-4c4c-8695-a6807efeae29`

Response

If successful, the API returns the expedition entity in JSON format.

See more details in the API Doc.

Process Expedition to WMS

This endpoint is designed for expeditions with the “to_be_confirmed” status. Once an order reaches this state, you can trigger this endpoint to send expeditions to WMS for processing without using the Send Expedition to WMS endpoint.

Request structure

Endpoint:	PUT /api/expedition/{id}/process
URL (prod):	https://app.mailship.eu/api/expedition/{id}/process
Headers:	`Authorization: Bearer YOUR_ACCESS_TOKEN Accept: application/json`
Request body:	None (this request does not require a body).
Request Example (cURL):	`curl --location --request PUT 'https://app.mailship.eu/api/expedition/42cf3202-a3a1-4c4c-8695-a6807efeae29/process' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {{token}}'`

Path parameter:

Parameter	Type	Required	Description
`id`	string	✅	The unique expedition identifier. Example: `42cf3202-a3a1-4c4c-8695-a6807efeae29`

Response

If successful, the API returns the expedition entity in JSON format.

See more details in the API Doc.

Send multiple Expedition to WMS

Send multiple expeditions for processing.

Request structure

Endpoint:	PUT /api/expedition/send
URL (prod):	https://app.mailship.eu/api/expedition/send
Headers:	`Authorization: Bearer YOUR_ACCESS_TOKEN Accept: application/json`
Request body:	An array of expedition IDs for processing.
Request Example (cURL):	`curl --location --request PUT 'https://app.mailship.eu/api/expedition/send' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {{token}}' \ --data '{ "expeditions": [ "0a618dc0-4958-4f34-8643-7f1f76b2771e", "2521d43f-9c91-4c8a-a8d4-36036f5b67ce" ] }'`

Response

If successful, the API returns 204 No Content.

See more details in the API Doc.

Continutie multiple Expedition to WMS

Send multiple expeditions for processing from the “to_be_confirmed” status.

Request structure

Endpoint:	PUT /api/expedition/process
URL (prod):	https://app.mailship.eu/api/expedition/process
Headers:	`Authorization: Bearer YOUR_ACCESS_TOKEN Accept: application/json`
Request body:	An array of expedition IDs for processing.
Request Example (cURL):	`curl --location --request PUT 'https://app.mailship.eu/api/expedition/process' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {{token}}' \ --data '{ "expeditions": [ "0c1a4855-70ab-4ff3-b8f7-80d3b2e50e2b", "3d1aac8c-cada-47d8-8e32-b3308e760ea7" ] }'`

Response

If successful, the API returns 204 No Content.

See more details in the API Doc.