Retrieve order list by identifier
GET/v2/orderlists/:id
Retrieve detailed information about a specific order list by its unique identifier.
Returns comprehensive order list data including product assignments, user permissions, company associations, and all configuration settings. Essential for order list management, bulk ordering operations, and administrative oversight.
The returned order list includes:
- Basic information (ID, descriptions, code, dates)
- Product and cluster assignments
- User and company permissions
- Configuration settings (type, active status, partner entity)
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Order list retrieved successfully.
Returns complete order list information including all assignments and configuration details. The response contains all data necessary for order list management and bulk ordering operations.
Invalid request parameters.
The provided order list ID is not a valid integer, is missing, or is not a positive number. Ensure the ID parameter is a valid positive integer.
Authentication required.
Valid authentication credentials must be provided to access order list data. Ensure your OAuth2 token is valid and properly formatted.
Access denied.
Insufficient permissions to view the requested order list or the order list belongs to a different organization. Verify that your account has the necessary permissions and access to this order list.
Order list not found.
No order list exists with the specified identifier, it has been deleted, or you don't have access to it. Verify the order list ID is correct and still exists in the system.
Server error.
An unexpected error occurred while retrieving the order list. Please try again later or contact support if the problem persists.