Ingram.Marketplace.OrderManagement (Ingram Marketplace API v1.4.2) View Source

API calls for all endpoints tagged OrderManagement.

Link to this section Summary

Functions

Create a new order Place an order for a set of products for a specific customer.

Estimate an order price Get estimated prices of an order.

Get full details of a specific order Get extended details of a specific order.

Get a list of orders Get basic details of orders in the platform.

Link to this section Functions

Link to this function

create_order(order_details, opts \\ [], connection \\ Connection.new())

View Source

Specs

Create a new order Place an order for a set of products for a specific customer.

Parameters

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

    Returns

} on success {:error, info} on failure

Link to this function

estimate_order(order_estimation_request, opts \\ [], connection \\ Connection.new())

View Source

Specs

Estimate an order price Get estimated prices of an order.

Parameters

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

    Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Get full details of a specific order Get extended details of a specific order.

Parameters

  • id (String.t): This is the ID of the order that must 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_orders(opts \\ [], connection \\ Connection.new())

View Source

Specs

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

Get a list of orders Get basic details of orders in the platform.

Parameters

  • opts (KeywordList): [optional] Optional parameters
    • :offset (integer()): The number of items to skip before starting to collect the result set.
    • :limit (integer()): The number of items to return.
    • :customerId (String.t): The ID of the customer for whom the order was placed.
    • :status (String.t): The order status that can be one of the following: submitted processing error completed * cancelled
    • :subscriptionId (String.t): The ID of the subscription created from the order.
    • :creationTimeFrom (DateTime.t): This is the beginning of a specific period of time used to search for orders created during that same period.
    • :creationTimeTo (DateTime.t): This is the end of a specific period of time used to search for orders created during that same period.
  • connection (Ingram.Marketplace.Connection): Connection to server

    Returns

} on success {:error, info} on failure