Skip to main content

Core Concepts

Understanding the core concepts of the Shirtigo Cockpit API will help you maximize its capabilities and build robust integrations.

API Overview​

  • Catalog API – Provides information about base products that can be processed using different techniques.
  • Order API – Enables order placement.
  • Product API – Allows the creation of products for integrations.
  • Design API – Manages designs in your design pool for reuse in products.
  • Project API – Allows manipulation (create, view, modify) of user projects.
  • Warehousing API – Handles warehouse-related objects and their management.
  • User API – Manages user-related operations (create, view, modify).
  • Image API – Supports mockup and design generation.
  • Webhook API – Manages webhooks for real-time event notifications.
  • Integration API – Manages integrations with third-party applications.
  • Authorization API – Handles OAuth2 authentication and security.
  • Miscellaneous Endpoints – Covers additional utility functionalities.

Enhancing API Responses​

Most GET endpoints support includes, allowing you to add extra data to the response.
To include additional data, append the following query parameter:

?include=firstInclude,secondInclude.subInclude

Rate Limiting​

To ensure stable service for all users, our API implements rate limiting:

  • Standard tier: 60 requests per minute

Webhooks​

Webhooks provide real-time updates about:

  • Order status changes
  • Production status of the item
  • Shipping events
  • System notifications

Error Handling​

Our API uses standard HTTP response codes and provides detailed error messages:

  • 2xx: Successful operations
  • 4xx: Client errors
  • 5xx: Server errors

Each error response includes:

  • Error code
  • Human-readable message
  • Additional context when available

Best Practices​

  1. Implement Retry Logic: Handle temporary failures gracefully
  2. Use Webhooks: Instead of polling for updates
  3. Cache Responses: Store frequently accessed data
  4. Validate Input: Check data before sending to API
  5. Handle Pagination: For large data sets

Understanding these core concepts will help you build reliable integrations with the Shirtigo Cockpit API. For detailed information about specific features, please refer to the respective sections in our documentation.