Skip to main content

API Reference

Welcome to the ZenFlow API reference. This documentation covers all available endpoints for managing orders, products, stock, and webhooks.

Base URL

Authentication

All API requests require authentication via API Key:
See Authentication for details.

Response Format

All responses follow a consistent JSON structure:

Success Response

Paginated Response

Error Response

Available Endpoints

Orders

Products

Stock

Webhooks

Common Parameters

Pagination

Most list endpoints support pagination:

Filtering

Many endpoints support filtering via query parameters. See individual endpoint documentation for available filters.

Date Formats

All dates use ISO 8601 format:
  • 2024-01-15 (date only)
  • 2024-01-15T10:30:00Z (with time)

HTTP Status Codes

Rate Limiting

See Rate Limits for details.