Archive Order
starshipit_archive_orderArchive a StarShipIt order to remove it from the active fulfilment queue while keeping its record for auditing, reporting, or restoration instead of deleting it.
Instructions
Archive an order in StarShipIt. Archived orders are hidden from the main fulfilment queue but remain in the system and can be restored at any time.
When to use: Use this instead of deleting when you want to remove an order from the active queue while retaining its record for auditing, reporting, or potential restoration.
Parameters:
order_id(required) — StarShipIt internal order ID to archive
Returns: Confirmation message on success.
Errors: 404 if order not found; 401 if API keys invalid.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| order_id | Yes | StarShipIt internal order ID to archive |
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) |