Cron Timings

This guide provides best practices for setting up cron jobs to poll new orders using the GET API method with the order status "Created". The goal is to balance timely data retrieval with minimizing server load.

Recommended Cron Polling Intervals

The optimal polling frequency depends on your business use case and order volume. Here are guidelines for different scenarios:

Sample API Request

Here's an example of how an API request might look with filters that are discussed further:

This request would fetch the first 100 created sale orders from a 5-minute window on January 1, 2025.

Industry Standard Data Filter Parameters

Using appropriate filters in your GET API requests improves efficiency and reduces server load. Here are the recommended data filter parameters for polling new orders:

Order Status

• Parameter: orderStatus=CREATED
• Purpose: Fetch only new orders in the "Created" state. Similarly, orders with different statuses can be retrieved using this filter.

Date or Timestamp Range

• Parameter: orderDateFrom=YYYY-MM-DDTHH:MM:SS and orderDateTo=YYYY-MM-DDTHH:MM:SS
• Purpose: Filter orders created within a specific timeframe.

Pagination

• Parameter: pageNumber and pageSize
• Purpose: Retrieve a fixed number of results per request.

Ordering Channel

• Parameter: orderingChannel=ECOMM
• Purpose: Filter orders by their ordering channel (e.g., ECOMM, JIOMART, ONDC).

Additional Considerations

To ensure smooth operation of your order polling system, keep these factors in mind:

1. API Rate Limits: Ensure your cron job frequency doesn't exceed the API rate limits of the integrated system.
2. Time Zone Management: Use IST timestamps in all filters for consistency.
3. Error Handling & Retries: Implement logic to handle failed API requests and retry missed orders.
4. Real-Time Push Notifications: Consider using push notifications or webhooks alongside polling for real-time order alerts.

By following these guidelines, you can efficiently poll for new orders while minimizing unnecessary load on your systems.