Export API - Filter based on updated_at

πŸ”

Problem Statement

As a client exporting subscription and billing data, I experience inefficiencies when I can only filter exports by created_at, which results in retrieving full data dumps even when I only need recent updates. This increases processing time, payload size, and unnecessary API usage.

πŸ’‘

User Story

As a client, I want to filter exports using updated_at instead of just created_at, so that I can request only deltas (recent changes) instead of full data sets.

As a developer, I want a date_field parameter in the export request, so that I can specify whether filtering should be based on created_at (default) or updated_at.

🎯

Definition of Done (DoD)

βœ”οΈ
  • Given an export request with date_field=updated_at, when I provide a date range filter, then the response should return only records updated within that range.

βœ”οΈ
  • This change will impact the Exports API, specifically the request-export endpoint.

βœ”οΈ
  • This solution will support the following exports out of the box:

    • - Customers

      - Invoices

      - Payments

      - Refunds

      - Newsletters

      - Addresses

      - Balance transactions

      - Credit notes

      - Orders

      - Memberships

βœ”οΈ
  • This solution will explicitly not support:

    • Accounting exports

      Customers metadata

  • This solution will include the following limitations:

    - Default behavior remains date_field=created_at for backward compatibility.

    - Filtering by updated_at only applies to supported resources listed above.

Please authenticate to join the conversation.

Upvoters
Status

Backlog

Board
πŸ’‘

Pelcro Product

Date

5 months ago

Author

Rana Haleem

Subscribe to post

Get notified by email when there are changes.