chore(customers): CUST-3623 update customers api docs based on cursor pagination

[isaacchen-bc]

CUST-3623

What changed?

• update v3 get customers api docs based on cursor pagination
• update v3 get ffvs api docs based on cursor pagination
• correct the value of meta for v3 post/put customers

Screenshots from swagger.io

get customers:

get ffvs:

Release notes draft

• Feature: Cursor pagination is now available to Customers V3 - Get All Customers
• Feature: Cursor pagination is now available to Customers V3 - Get Customer Form Field Values
• Fixed: Corrected the value of meta for the response of Customers V3 - Create/Update Customers

[bc-traciporter]

Made some editorial comments to remove passive voice.

[bc-akshatkaushik]

Minor suggestion but otherwise LGTM 💯

[snaderiBC]

Thanks Isaac 👏
Looking good 🚢

[bc-akshatkaushik]

💯

[bc-traciporter]

Hi @bc-akshatkaushik I plan to add this change to the release notes tomorrow. Here is my draft copy:

Cursor pagination is now available in the Customers V3 API for both the Get All Customers and Get Customer Form Field Values endpoints. This update simplifies navigation and supports more complex queries.

[isaacchen-bc]

Hi @bc-akshatkaushik I plan to add this change to the release notes tomorrow. Here is my draft copy:

Cursor pagination is now available in the Customers V3 API for both the Get All Customers and Get Customer Form Field Values endpoints. This update simplifies navigation and supports more complex queries.

Thanks for the draft @bc-traciporter! Just a bit of context for this. The reason why we introduce cursor pagination is that when users use it to navigate through the results, the performance would be drastically improved, especially when the store has a lot of customers or form field values.

[bc-traciporter]

@bc-akshatkaushik Thanks for the feedback. I will change the text slightly.

Cursor pagination is now available in the Customers V3 API for both the Get All Customers and Get Customer Form Field Values endpoints. This update improves navigation performance and supports many customers or form field values.