Ingram.Marketplace.ReportManagement (Ingram Marketplace API v1.4.6) View Source

API calls for all endpoints tagged ReportManagement.

Link to this section Summary

Functions

get_report_by_id(id, opts \\ [], connection \\ Connection.new())

Get full details of a report Get extended details about a report in the platform.

get_reports(opts \\ [], connection \\ Connection.new())

Retrieve a list of exported reports Get a list of the reseller's rated data reports exported during the specified period.

Link to this section Functions

get_report_by_id(id, opts \\ [], connection \\ Connection.new())

Specs

get_report_by_id(String.t(), keyword(), Tesla.Env.client() | nil) ::
  {:ok, Ingram.Marketplace.Model.ReportItem.t()} | {:error, Tesla.Env.t()}

Get full details of a report Get extended details about a report in the platform.

Parameters

id (String.t): The ID of the report to be processed by the request.
opts (KeywordList): [optional] Optional parameters
connection (Ingram.Marketplace.Connection): Connection to server
Returns

} on success {:error, info} on failure

get_reports(opts \\ [], connection \\ Connection.new())

Specs

get_reports(keyword(), Tesla.Env.client() | nil) ::
  {:ok, Ingram.Marketplace.Model.InlineResponse2004.t()}
  | {:error, Tesla.Env.t()}

Retrieve a list of exported reports Get a list of the reseller's rated data reports exported during the specified period.

Parameters

opts (KeywordList): [optional] Optional parameters
- :limit (integer()): The number of items to return.
- :offset (integer()): The number of items to skip before starting to collect the result set.
- :name (String.t): The name of the requested reports.
- :format (String.t): The format filter of the requested reports. Available types: json xml csv xlsx
- :status (String.t): The status filter of the requested reports. Available types: submitted processing completed error
- :type (String.t): The type filter of the requested reports. Available types: periodic daily monthly onetime * on_invoice
- :from (Date.t): The first day of the requested period.
- :to (Date.t): The last day of the requested period.
connection (Ingram.Marketplace.Connection): Connection to server
Returns

} on success {:error, info} on failure