Ingram.Marketplace.OrderManagement.get_orders
You're seeing just the function
get_orders
, go back to Ingram.Marketplace.OrderManagement module for more information.
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