Delete Shipment

Removes a shipment from an order. This cannot be undone, and it does not notify the carrier or void a label.

delete

Authorizations

ORDERDESK-API-KEYstringRequired

Your API key, found under Store Settings on the API tab. This should be kept server-side.

ORDERDESK-STORE-IDstringRequired

Your store ID, found under Store Settings on the API tab.

Path parameters

order_idintegerRequired

Order Desk's internal order ID. This is not your source_id.

Example: 736745

shipment_idintegerRequired

Order Desk's internal ID for the shipment.

Example: 44821

Responses

200

The shipment was deleted.

application/json

statusstring · enumRequired

Either success or error.

Possible values:

messagestringOptional

Describes the result. Always present when an error occurs.

execution_timestringOptional

Time taken to process the request.

Example: 0.1524 seconds

401

Authentication failed. See the Authentication guide, and note that an invalid store ID blocks your store rather than simply failing the request.

application/json

404

No record matches that ID in your store.

application/json

429

You are sending too fast. Wait X-Retry-After seconds. See the Rate Limits guide.

application/json

default

The request could not be completed.

application/json

delete/orders/{order_id}/shipments/{shipment_id}

curl "https://app.orderdesk.me/api/v2/orders/736745/shipments/44821" \
  -X DELETE \
  -H "ORDERDESK-STORE-ID: your-store-id" \
  -H "ORDERDESK-API-KEY: your-api-key"

{
  "status": "success",
  "message": "Shipment Deleted",
  "execution_time": "0.0836 seconds"
}