Reports

The Reports API lets you request reports. Report types are specified using the ReportTypes enumeration.

The report process begins by creating a report request. Next, you obtain a list of report requests which shows the report request identifier and status of each requested report. Finally, you use the report request identifier from this listing to get the actual report. The process steps are as follows:

Submit a report request using the RequestReport operation. This is a request to xSellco to generate a specific report. Note that you can also schedule order report requests to be submitted periodically using the ManageReportSchedule operation.

Submit a request using the GetReportRequestList operation to get a list that shows the report requests and the status and ID of each report request. API returns a ReportRequestId for every report requested per RequestType. When xSellco sets the status of a report request to DONE, the report is ready to be retrieved. Some reports create a GeneratedReportId that you can pass to the GetReport operation (see step 4).

If no GeneratedReportId was created, submit a request using the GetReportList operation and include the ReportRequestId for the report requested. The operation returns a ReportId that you can then pass to the GetReport operation (see step 4).

Submit a request using the GetReport operation to receive a specific report. You include in the request the GeneratedReportId or the ReportId for the report you want to receive.

The following steps shows the process for submitting and receiving an on-request report:

Seller submits a RequestReport operation, xSellco receives request, returns ReportRequestId

Seller submits a GetReportRequestList operation xSellco returns the processing status and when DONE, reports return the GeneratedReportId

If the report is not ready, return back to SECTION 2. If that is ready the process is going further…

Seller submits a GetReportList operation using the ReportRequestId obtain the ReportId

Seller submits a GetReport operation using the ReportId to download file or data.

Complete

You can also schedule order report requests so that they are submitted periodically by using the ManageReportSchedule operation. The Schedule enumeration is used to specify the time period for submitting report requests. You can also get a list of scheduled order report requests using the GetReportScheduleList operation.

The following steps shows the process for submitting and receiving a scheduled report:

Determine what reports to schedule and how often

Seller submits a ManageReportSchedule operation for each report (INVENTORY) xSellco receives request and schedule reports.

Seller schedules a GetReportList operation every (xx), xSellco creates reports. Returns a ReportId for each type of the report request.

Seller submits a GetReport operation using the ReportId, xSellco returns requested reports and updates the reports' statuses to received.

ReportType enumeration

Report Types available for Repricer Ultimate and above:

Schedule enumeration

Provides the units of time that indicate how often a report request can be requested.

ProcessingStatus enumeration