Ingram Marketplace API v1.4.6

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

API calls for all endpoints tagged CustomerManagement.

Link to this section Summary

Functions

create_customer(post_customer_details, opts \\ [], connection \\ Connection.new())

Create a new customer Create a customer in the platform and associate it with the reseller that sends this request.

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

Get full details of a specific customer Get extended details about a specific customer in the platform.

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

Get a list of customers Get a list of customers and their basic details.

Link to this section Functions

Link to this function

create_customer(post_customer_details, opts \\ [], connection \\ Connection.new())

View Source

Specs

create_customer(
  Ingram.Marketplace.Model.PostCustomerDetails.t(),
  keyword(),
  Tesla.Env.client() | nil
) ::
  {:ok, Ingram.Marketplace.Model.GetCustomerDetails.t()}
  | {:error, Tesla.Env.t()}

Create a new customer Create a customer in the platform and associate it with the reseller that sends this request.

Parameters

  • post_customer_details (Ingram.Marketplace.Model.PostCustomerDetails):
  • opts (KeywordList): [optional] Optional parameters
  • connection (Ingram.Marketplace.Connection): Connection to server

    Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Get full details of a specific customer Get extended details about a specific customer in the platform.

Parameters

  • id (String.t): The ID of the customer 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

Link to this function

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

View Source

Specs

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

Get a list of customers Get a list of customers and their basic details.

Parameters

  • opts (KeywordList): [optional] Optional parameters
    • :name (String.t): Find customers that are similar to the provided name.
    • :email (String.t): Find customers that have a contact person with the provided email address.
    • :externalId (String.t): Find customers that have an external ID assigned equal to the provided ID.
    • :offset (integer()): The number of items to skip before starting to collect the result set.
    • :limit (integer()): The number of items to return.
  • connection (Ingram.Marketplace.Connection): Connection to server

    Returns

} on success {:error, info} on failure