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

BAM-22413 Update publisher reporting docs #188

Merged
merged 8 commits into from
Sep 25, 2023
Merged

BAM-22413 Update publisher reporting docs #188

merged 8 commits into from
Sep 25, 2023

Conversation

kavya315
Copy link
Contributor

Add returns reporting information
Update introduction with all potential locations for report sharing
Add what to expect sections
Add example queries

docs/pubreport.rst Outdated Show resolved Hide resolved
docs/pubreport.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@nattaylor nattaylor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I started making changes but we need to see how this builds because I think rst doesnt respect single line breaks so all the lists and stuff will currently come out jumbling

@kavya315 kavya315 force-pushed the BAM-22413 branch 3 times, most recently from fdfff70 to a816fca Compare September 21, 2023 18:32
docs/pubreport.rst Outdated Show resolved Hide resolved
docs/pubreport.rst Outdated Show resolved Hide resolved
Co-authored-by: Nat Taylor <nattaylor@gmail.com>
docs/pubreport.rst Outdated Show resolved Hide resolved
Co-authored-by: Nat Taylor <nattaylor@gmail.com>
Copy link
Contributor

@nattaylor nattaylor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made a few wording suggestions

To gain a comprehensive view of returns, we recommend aggregating the values for each unique combination of
checkout_id, merchant and product_id (denoted by the order_product_id column) across all return files.

Since this report is designed to be used to complement the data in the orders reports, the column 'order_product_id'
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should it be a combination of checkout_id and order_product_id to join

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The event_product_id is a uniquely generated id for each entry in the events_products table so it should be unique to the combination of merchant+checkout_id+product_id.

@kavya315 kavya315 merged commit 3432cc8 into master Sep 25, 2023
1 check passed
@kavya315 kavya315 deleted the BAM-22413 branch September 25, 2023 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants