Delete Order
starshipit_delete_orderPermanently delete an unshipped StarShipIt order created in error. Use only for irreversible removal; archive orders you want to retain instead.
Instructions
Permanently delete an order from StarShipIt. This action is irreversible — the order will be removed from the system entirely.
When to use: Only use on unshipped orders that were created in error and must be removed. For orders you want to retain but hide from the queue, use starshipit_archive_order instead.
Parameters:
order_id(required) — StarShipIt internal order ID to permanently delete
Returns: Confirmation message on success.
Warning: This is a destructive, permanent action. The order cannot be recovered after deletion.
Errors: 404 if order not found; 409 if the order has already been shipped (cannot delete shipped orders — use archive instead); 401 if API keys invalid.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| order_id | Yes | StarShipIt internal order ID to permanently delete |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| errors | No | Validation or processing errors returned by StarShipIt | |
| object | No | The response payload when StarShipIt returns a non-object value | |
| success | No | StarShipIt success flag (a boolean on most endpoints) |