Offboard Company
Companies
Offboard Company
This endpoint initiates the offboarding process for a company. Offboarding is a controlled process that safely transitions a company out of active service while preserving important data and ensuring proper closure of operations.
PUT
Offboard Company
This endpoint starts the offboarding process for a company, which is a safer alternative to permanent deletion. Offboarding allows for a controlled wind-down of operations while maintaining data integrity and compliance requirements.
What is Offboarding?
Offboarding is a structured process that:- Gracefully transitions the company out of active service
- Preserves historical data for compliance and reporting
- Ensures proper closure of ongoing operations
- Maintains audit trails for business purposes
- Allows for potential reactivation if needed
Offboarding vs Deletion: Unlike deletion, offboarding preserves all company data while marking the company as no longer active. This approach is recommended for compliance and business continuity.
Path Parameters
The unique identifier of the company to offboard
Offboarding Process
Automated Offboarding Steps
Automated Offboarding Steps
Company status is automatically changed to “Off Boarding”
All associated stores are marked for offboarding
Stores may be deactivated or marked as “Off Boarding” depending on configuration
System prevents new orders while allowing existing orders to complete
Inventory updates are disabled to prevent new stock changes
User accounts are disabled or restricted to view-only access
Third-party integrations are paused or disconnected safely
All historical data, reports, and configurations are preserved
Post-Offboarding Effects
System Changes After Offboarding
System Changes After Offboarding
Status automatically set to “Off Boarding”
All stores become unavailable for new orders
Most write operations are disabled, read operations may be restricted
Company and stores are hidden from customer-facing applications
Admin users get read-only access for reporting and data export
Billing cycles may be adjusted or terminated based on configuration
Response
Indicates whether the offboarding process was successfully initiated
Response Example
Reactivation Process
Reversing Offboarding
Reversing Offboarding
Reactivation typically requires manual intervention from support team
Business requirements and conditions may need to be reviewed
System integrity and data consistency checks are performed
Services are restored incrementally to ensure stability
Best Practices
Offboarding Recommendations
Offboarding Recommendations
Notify all stakeholders before initiating offboarding
Export critical business data before offboarding
Allow time for pending orders to complete naturally
Complete all financial transactions and settlements
Ensure all payments, refunds, and fees are properly processed
Properly disconnect third-party services and integrations
Error Scenarios
Common Offboarding Errors
Common Offboarding Errors
The specified company_id does not existStatus Code: 404
Company is already in “Off Boarding” or “Churned” statusStatus Code: 409
Company has active orders that may be affectedStatus Code: 200 (Success with warning)Note: Process continues but active orders are flagged for attention
User lacks permission to offboard companiesStatus Code: 403
Compliance: Offboarding maintains compliance with data retention requirements while safely removing companies from active service. This approach is preferred over deletion for regulated industries.