API Reference Ingram Marketplace API v1.4.2

Modules

Keeps the required bearer token around and refreshes it when required.

Handle Tesla connections for Ingram.Model.

API calls for all endpoints tagged CustomerManagement.

Helper functions for deserializing responses into models

The postal address data of a customer used in invoices and displayed when the customer logs in to the user panels. As for cloud services, this information may be required to create a service.

A customer representation that contains the basic information about the customer such as the identifier, name, type, status, and billing mode.

A set of product identifiers

The structure with additional information about the result of the API request.

Contact information about a physical person. This can be used in notifications and displayed when the person logs in to the user panels. When providing a service for a user, the respective cloud application may require this data.

The extended representation of a specific customer with additional arrays of addresses and contacts, and the preferred language of the customer.

Generic InlineResponse of a 200 used by CustomerManagement.

Generic InlineResponse of a 200 used by ProductCatalog.

Generic InlineResponse of a 200 used by OrderManagement.

Generic InlineResponse of a 200 used by SubscriptionManagement.

Generic InlineResponse of a 200 used by ReportManagement.

The representation of a specific order that contains high level data of a request to purchase one or more product items. In the platform, the order is extended with an array of orderLineItem objects that contain detailed information about each ordered product.

The extended representation of a specific order with additional information about the ordered items.

The extended representation of a specific order with additional information about the ordered items.

The representation of an order estimation.

The representation of an order to be estimated.

A structure representing the ordered item (one or more products) price.

The extended representation of a specific order product with basic information about the product.

The extended representation of a specific order product estimation with information about the price.

The extended representation of a specific order product estimation with information about the price.

The extended representation of a specific order product with price information about items.

The information about the returned results, including the current position of the returned range (offset), total number of items in the returned range (limit), and total number of items in the whole collection (total).

Contact information about a physical person. This can be used in notifications and displayed when the person logs in to the user panels. When providing a service for a user, the respective cloud application may require this data.

The extended representation of a specific customer with additional arrays of addresses and contacts, and the preferred language of the customer.

The representation of a product for sale.

The structure representing a product billing period.

The structure representing a product activation parameter.

A structure representing the product price.

A rated data report generated and exported during a specific period.

The representation of a subscription created when an order to a product is processed.

The representation of a specific subscription created when an order for products is processed.

The structure representing an individual product item in the subscription. A subscription may have one or more of these items.

A structure representing the total calculated price.

A structure representing the unit price of the product at which the product was ordered.

A structure representing the order total price estimation.

The structure representing an individual product parameter. It specifies the parameter name and its value that can be any of the following types: string, number, boolean, array, or object.

The structure representing an individual product parameter items.

List of product-specific activation parameters.

The structure representing an individual product parameter.

The result of validation of the product-specific activation parameters.

API calls for all endpoints tagged OrderManagement.

API calls for all endpoints tagged ProductCatalog.

API calls for all endpoints tagged ReportManagement.

Helper functions for building Tesla requests

API calls for all endpoints tagged SubscriptionManagement.

API calls for all endpoints tagged ValidationManagement.