Orders API
Comprehensive REST API for orders management in the e-commerce platform.
This API provides full CRUD operations and advanced search capabilities for managing orders, shipments, tracking information, and related entities. All endpoints support OAuth2 authentication and return structured JSON responses with comprehensive error handling.
Key Features
- Full CRUD Operations: Create, read, update, and delete operations for all entities
- Advanced Search: Powerful filtering and pagination capabilities
- Data Expansion: Reduce API calls by expanding related data in responses
- Comprehensive Validation: Input validation with detailed error messages
- OAuth2 Security: Secure access with client credentials flow
Response Format
All successful responses follow a consistent structure with appropriate HTTP status codes. Error responses include detailed error messages and validation information.
Pagination
List endpoints support pagination with page and offset parameters.
Default page size is 12 items per page.
Data Expansion
Many endpoints support the expands query parameter to include related data
in the response, reducing the need for additional API calls.
Authentication
- OAuth 2.0: OAuth2
OAuth2 client credentials flow for API authentication. Obtain access token from the token endpoint using your client credentials.
Security Scheme Type: | oauth2 |
|---|---|
OAuth Flow (clientCredentials): | Token URL: https://api.helice.cloud/oauth2/token/ Scopes:
|