{"_id":"59bc55d72b480b0010010cb7","category":{"_id":"59bc55d72b480b0010010c96","version":"59bc55d72b480b0010010c92","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-03-17T15:51:04.102Z","from_sync":false,"order":3,"slug":"marketplace","title":"Marketplace"},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"_id":"59bc55d72b480b0010010c92","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-09-15T22:36:07.078Z","releaseDate":"2017-09-15T22:36:07.078Z","categories":["59bc55d72b480b0010010c93","59bc55d72b480b0010010c94","59bc55d72b480b0010010c95","59bc55d72b480b0010010c96","59bc55d72b480b0010010c97","59bc55d72b480b0010010c98","59bc55d72b480b0010010c99"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"3.22.2 Release","version_clean":"8976.0.0-Basics","version":"8976-Basics"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-03-30T13:17:19.675Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":25,"body":"This section will cover the following topics: \n* [Reporting overview](#section-reporting-overview)\n* [Common reporting scenarios](#section-common-reporting-scenarios)\n\n##Reporting overview\nTo keep track of your vendors, use our reports to review topics, such as transaction details and payout summaries.  Additionally, you can run a report to see all your vendors and specific details associated with each.  Your vendor reporting detail is available through both the BlueSnap Merchant Console and our [Reporting API](/v4.0/docs/reporting-api-overview).  \n\nYour vendor details can be found within the following reports:\n\n  * Sales by product & currency\n  * Transactions by product & currency\n  * Transaction Detail\n  * Decline report\n  * Subscription report\n  * Payout Detail Report\n  * Payout Summary Report\n  * Vendor Details Report\n\nMore information on reporting can be found [here](https://support.bluesnap.com/docs/reporting).\n\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##Common reporting scenarios \n###Scenario 1: Communicating payout information to your vendor\nUse the Payout Detail report to communicate payout information to your vendor. To run the report via our [Reporting API](/v4.0/docs/get-report-data), include the URL parameters `forvendorid` and `period` in the query string. Note that the value for `forvendorid` is the vendor ID and `period` is the period for which you would like to run the report. \n\nSuppose that you want to run the report for vendor ID 515503 for the last six months. The API endpoint for **sandbox** will be: \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://sandbox.bluesnap.com/services/2/report/PayoutDetail?period=LAST_6_MONTHS&forvendorid=515503\",\n      \"language\": \"text\",\n      \"name\": \"Payout Detail: API Endpoint\"\n    }\n  ]\n}\n[/block]\n###Scenario 2: Communicating sales history to your vendor\nSuppose your vendor (whose vendor ID is 515503) would like to know their sales history for the last three months. To provide this information, you'll run the Transaction Detail report. To do this via our Reporting API, you'll pass the URL parameters `vendor`, `period`, and `transactionType` in the query string. The resulting endpoint for **sandbox** will be: \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://sandbox.bluesnap.com/services/2/report/TransactionDetail?period=LAST_3_MONTHS&transactionType=SALE&vendor=515503\",\n      \"language\": \"text\",\n      \"name\": \"Transaction Detail: API Endpoint \"\n    }\n  ]\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##Next: Payout \nNow that you've learned about our reporting capabilities, move on to learn about payout. \n\n**[➔ Payout](/docs/payout)**","excerpt":"Learn about our reporting capabilities available through the Merchant Console and Reporting API\nIf you have questions after reading this guide, check out our answers to [frequently asked questions](https://support.bluesnap.com/docs/merchant-faqs#section--what-is-a-marketplace-).","slug":"reporting","type":"basic","title":"Reporting"}

Reporting

Learn about our reporting capabilities available through the Merchant Console and Reporting API If you have questions after reading this guide, check out our answers to [frequently asked questions](https://support.bluesnap.com/docs/merchant-faqs#section--what-is-a-marketplace-).

This section will cover the following topics:

Reporting overview

To keep track of your vendors, use our reports to review topics, such as transaction details and payout summaries. Additionally, you can run a report to see all your vendors and specific details associated with each. Your vendor reporting detail is available through both the BlueSnap Merchant Console and our Reporting API.

Your vendor details can be found within the following reports:

  • Sales by product & currency
  • Transactions by product & currency
  • Transaction Detail
  • Decline report
  • Subscription report
  • Payout Detail Report
  • Payout Summary Report
  • Vendor Details Report

More information on reporting can be found here.

Back to Top


Common reporting scenarios

Scenario 1: Communicating payout information to your vendor

Use the Payout Detail report to communicate payout information to your vendor. To run the report via our Reporting API, include the URL parameters forvendorid and period in the query string. Note that the value for forvendorid is the vendor ID and period is the period for which you would like to run the report.

Suppose that you want to run the report for vendor ID 515503 for the last six months. The API endpoint for sandbox will be:

https://sandbox.bluesnap.com/services/2/report/PayoutDetail?period=LAST_6_MONTHS&forvendorid=515503

Scenario 2: Communicating sales history to your vendor

Suppose your vendor (whose vendor ID is 515503) would like to know their sales history for the last three months. To provide this information, you'll run the Transaction Detail report. To do this via our Reporting API, you'll pass the URL parameters vendor, period, and transactionType in the query string. The resulting endpoint for sandbox will be:

https://sandbox.bluesnap.com/services/2/report/TransactionDetail?period=LAST_3_MONTHS&transactionType=SALE&vendor=515503

Back to Top


Next: Payout

Now that you've learned about our reporting capabilities, move on to learn about payout.

➔ Payout