Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] : add pagination support for customers list #3746

Open
2 tasks done
Narayanbhat166 opened this issue Feb 21, 2024 · 5 comments
Open
2 tasks done

[FEATURE] : add pagination support for customers list #3746

Narayanbhat166 opened this issue Feb 21, 2024 · 5 comments
Labels
C-feature Category: Feature request or enhancement good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Narayanbhat166
Copy link
Member

Narayanbhat166 commented Feb 21, 2024

Feature Description

The customers list endpoint currently has no pagination support. It returns the list of all the customers in the database. There would be thousands of customers for a merchant. A pagination support for the api would be necessary.

Possible Implementation

accept two fields, limit and offset

  • limit specifies the number of objects returned in the response.
  • offset specifies the number of items to skip from the start, this is open to discussion whether to use offset or some other field.

This would be similar to the payments_list pagination. Refer here

Have you spent some time checking if this feature request has been raised before?

  • I checked and didn't find a similar issue

Have you read the Contributing Guidelines?

Are you willing to submit a PR?

None

@Narayanbhat166 Narayanbhat166 added C-feature Category: Feature request or enhancement S-awaiting-triage Status: New issues that have not been assessed yet good first issue Good for newcomers labels Feb 21, 2024
@Narayanbhat166 Narayanbhat166 changed the title [FEATURE] : add pagination support for customers endpoint [FEATURE] : add pagination support for customers list Feb 21, 2024
@Narayanbhat166 Narayanbhat166 added help wanted Extra attention is needed and removed S-awaiting-triage Status: New issues that have not been assessed yet labels Feb 21, 2024
@tanbirali
Copy link
Contributor

I am interested to take this issue, I will like to know little bit more, from what I saw both product list and customer list look same to me.

@Narayanbhat166
Copy link
Member Author

Hey @tanbirali, thanks for showing interest. Payment list accepts limit and other parameters, which are used for pagination. These parameters are not available in customers list endpoint.

@tanbirali
Copy link
Contributor

Okay, correct me if I am wrong, I have to create a CustomerListConstraints where I need to add limit and offset

@Narayanbhat166
Copy link
Member Author

Yes, you would have to create the struct and add limit and offset to it.

@hegdeadithyak
Copy link

Hi there @Narayanbhat166 ,

I'd like to take a look at this issue and see if I can help fix it. Please let me know if it's already assigned to someone or if there's anything specific I should keep in mind while working on it.

Thanks,
Adithya Hegde Kota

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-feature Category: Feature request or enhancement good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants