Inspirion API Integration Documentation
Table of Contents
- Overview
- Base URL
- Authentication
- Endpoints
- 4.1. Products
- 4.2. Product Prices
- 4.3. Stock
- 4.4. Print Prices
- 4.5. Price Calculation
- 4.6. Deleted Products
- 4.7. Company
- 4.8. Shipping
- 4.9. Materials
- 4.10. Datasheets
- 4.11. SVHC
- 4.12. Print Templates
- 4.13. Create Order
- 4.14. Delivery time
- 4.15. Products Categories
- 4.16. Sales Restrictions
- 4.17. Printdata
- Multi-language Support
- Postman Usage Guide
- Examples
1. Overview
The Inspirion API provides a comprehensive suite of features designed to streamline product and inventory management. Users can leverage the API to access a variety of information, including:
- Product Information: Comprehensive details about products, including descriptions, materials, and branding options.
- Industry and Client-Specific Prices: Customized pricing information tailored to industries and clients.
- Stock Levels: Real-time stock information for warehouses and regions.
- Print Information: Provides information about printing costs, including setup costs, flat rates, and scaled pricing for various order quantities.
- Print Price Calculation: Accurate price calculations for various printing configurations.
- Deleted Products: Information on discontinued or deleted products.
- Company Information: Shows all the information we have on you like contact name or address.
- Shipping Information: Shows detailed information about delivery costs to a specific country.
- Material Composition: Material composition details.
- Datasheets: Detailed product specifications and datasheets.
- REACH information: Details about the SVHC in a product.
- Print templates: Pictures of products including an indication, where printing can be done and corresponding print position name.
This documentation supports integration across multiple languages to facilitate global operations and ensure seamless API usage.
This documentation provides instructions for integrating with the Inspirion API. It supports the following response languages:
- German (
de) - Czech (
cz) - English (
en) - Spanish (
es) - French (
fr) - Croatian (
hr) - Hungarian (
hu) - Italian (
it) - Dutch (
nl) - Polish (
pl) - Romanian (
ro)
2. Base URL
The base URL for the API is:
https://leoapi.inspirion.eu
3. Authentication
3.1 Authentication (Customer)
All requests require the X-Gateway-API-Key header with your API key. (Customer)
Example:
X-Gateway-API-Key: YOUR_API_KEY
3.2 Authentication (Partner)
All requests require the X-Gateway-API-Key-Partner header with your API key. (Partner)
Example:
X-Gateway-API-Key-Partner: YOUR_API_KEY
4. Endpoints
4.1.1 Products API - Version V1
a. List Products
Description: This API call retrieves a list of products, including detailed information about each product such as name, description, materials, branding options, country of origin, and available variants. It is useful for populating product catalogs, managing inventory, or displaying product details in an e-commerce platform. This endpoint uses pagination to return data in batches. Please use the Version 2 in case you don't want to use pagination.
Endpoint:
GET /api/v1/products
Parameters:
language: Language for the response.page: The page number of results to retrieve. Default is1.perPage: Number of items per page. Default is20.
Response formats
This enpoint only supports JSON.
Example Request:
GET https://leoapi.inspirion.eu/api/v1/products?language=en&page=1&perPage=20
Example Response:
{
"current_page": 1,
"data": [
{
"name": "Kugelschreiber MODERN",
"description": "<b>Kugelschreiber MODERN</b>: mit Druckmechanismus, silbermattem Kunststoff-Clip, schwarzschreibend",
"sku": "3176377",
"materials": ["Kunststoff"],
"branding_methods": [
{
"position_title": "mittig auf dem weißen Bereich",
"position_key": "centered_on_the_white_part",
"size": "45x6mm",
"print_technique_title": "Digitaldruck",
"print_technique_key": "digital_direct_print",
"print_area": "rectangle",
"print_codes": "DP6",
"handling_code": null,
"pretreatment_code": null,
"max_number_of_colors": "1",
"default": false
}
],
"commodity_code": "9608 1092 000",
"origin_country": "CN",
"keywords": ["Kugelschreiber", "Stifte", "Büroaccessoires", "Schreibgeräte"],
"total_variants": 2,
"variants": [
{
"article_id": "56-1101115",
"colour": "lila, weiß",
"ean": "4035475097428",
"size": {
"length": "14.30",
"length_unit": "cm"
},
"weight": {
"net": "10.000",
"gross": "12.000",
"unit": "g"
},
"volume": {
"volume": "42.000",
"volume_unit": "cm³"
},
"ipu": {
"ipu": 50,
"length": "14.500",
"length_unit": "cm",
"width": "11.000",
"width_unit": "cm",
"height": "10.000",
"height_unit": "cm",
"volume": "0.0021",
"volume_unit": "m³",
"net_weight": "0.5000",
"gross_weight": "0.5000",
"weight_unit": "KG"
},
"pu": {
"pu": 500,
"length": "56.500",
"length_unit": "cm",
"width": "16.500",
"width_unit": "cm",
"height": "22.000",
"height_unit": "cm",
"volume": "0.0210",
"volume_unit": "m³",
"net_weight": "5.0000",
"gross_weight": "5.8000",
"weight_unit": "KG"
},
"images": [
{
"image_url": "https://media.inspirion.eu/72/56-1101115_MODERN_01.jpg"
}
],
"images_300": [
{
"image_url": "https://media.inspirion.eu/300/56-1101115_MODERN_01.jpg"
}
]
}
]
}
],
"pagination": {
"currentPage": 1,
"perPage": 20,
"totalPages": 5,
"totalItems": 100
}
}
4.1.2 Products API - Version V2
a. List Products
Description: This API call retrieves a comprehensive list of all available products in a single request, without pagination. Each product entry includes detailed information such as the product name, description, materials, branding options, country of origin, and available variants. This endpoint is ideal for use cases such as populating full product catalogs, synchronizing inventory systems, or displaying detailed product information within e-commerce platforms. This endpoint does not use pagination. Please use the Version 1 in case you want to use pagination.
Endpoint:
GET /api/v2/products
Parameters:
language: Language for the response.
Response formats
This enpoint supports JSON and XML. The default format is JSON. You can switch to XML using the Accept: text/xml header.
Example Request:
GET https://leoapi.inspirion.eu/api/v2/products?language=de
Example Response:
[
{
"name": "Emaille Becher RETRO CUP",
"description": "<b>Emaille Becher RETRO CUP</b>: mit Henkel, außen farbig und innen weiß, Füllmenge ca. 350 ml",
"sku": "3227398",
"materials": [
"Metall",
"Emaille"
],
"brand": null,
"commodity_code": "7323 9400 000",
"origin_country": "CN",
"pictograms": [
{
"text": "Lasergravur",
"print_export_marker": "l",
"content": "12cm² LR12+H2 (1)",
"type": "print",
"image_url": "https://media.inspirion.eu/GetImages/GetTextImage.aspx?fontfamily=Bedruckungsicons_2020&fontsize=100&fontcolor=111111&fontbold=false&text=l"
}
],
"additional_pictograms": "",
"additional_informations": "",
"prodh": null,
"mgvr3": null,
"keywords": [
"Becher",
"Tassen",
"Kaffee-Accessoires",
"Haushaltsartikel",
"Küchenutensilien",
"Tee-Accessoires",
"Kaffeebecher"
],
"total_variants": 4,
"details_images": [],
"details_images_300": [],
"variants": [
{
"article_id": "56-0304420",
"colour": "schwarz, weiß",
"ean": "4035475082745",
"size": {
"length": null,
"length_unit": null,
"width": null,
"width_unit": null,
"height": "8.00",
"height_unit": "cm",
"diameter": "9.00",
"diameter_unit": "cm",
"unit": null
},
"weight": {
"net": "90.000",
"gross": "98.000",
"unit": "g"
},
"volume": {
"volume": "792.657",
"volume_unit": "cm³"
},
"ipu": {
"ipu": 6,
"length": "27.300",
"length_unit": "cm",
"width": "28.000",
"width_unit": "cm",
"height": "8.500",
"height_unit": "cm",
"volume": "0.0048",
"volume_unit": "m³",
"net_weight": "0.5400",
"gross_weight": "0.5400",
"weight_unit": "kg"
},
"pu": {
"pu": 60,
"length": "37.500",
"length_unit": "cm",
"width": "28.500",
"width_unit": "cm",
"height": "44.500",
"height_unit": "cm",
"volume": "0.0476",
"volume_unit": "m³",
"net_weight": "5.4000",
"gross_weight": "5.9000",
"weight_unit": "kg"
},
"pallet": {
"pal": 1080,
"length": "120.000",
"length_unit": "cm",
"width": "80.000",
"width_unit": "cm",
"height": "131.000",
"height_unit": "cm",
"volume": "0.8561",
"volume_unit": "m³"
},
"images": [
{
"image_url": "https://media.inspirion.eu/72/56-0304420_RETRO-CUP_01.jpg"
}
],
"images_300": [
{
"image_url": "https://media.inspirion.eu/300/56-0304420_RETRO-CUP_01.jpg"
}
]
}
]
}
]
4.2.1 Product Prices API - Version V1
a. Show Prices
Description: This API call retrieves price information for all products. This includes client specific prices and catalogue prices. This endpoint uses pagination to return data in batches. Please use the Version 2 in case you don't want to use pagination.
Endpoint:
GET /api/v1/pricelist
Response formats
This enpoint only supports JSON.
Example Request:
GET https://leoapi.inspirion.eu/api/v1/pricelist?language=en
Example Response:
{
"current_page": 1,
"data": [
{
"article_id": "56-0381020",
"pricelist": [
{
"price": "5.90",
"catalog_price": "6.50",
"currency": "EUR"
}
]
},
{
"article_id": "56-0403193",
"pricelist": [
{
"price": "1.00",
"catalog_price": "1.25",
"currency": "EUR"
}
]
}
],
"first_page_url": "https://leoapi-test.inspirion.eu/api/v1/pricelist?language=en&page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://leoapi-test.inspirion.eu/api/v1/pricelist?language=en&page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://leoapi-test.inspirion.eu/api/v1/pricelist?language=en&page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "https://leoapi-test.inspirion.eu/api/v1/pricelist",
"per_page": 50,
"prev_page_url": null,
"to": 50,
"total": 2
}
4.2.2 Product Prices API - Version V2
a. Show Prices
Description: This API call retrieves price information for all products. This includes client specific prices and catalogue prices. This endpoint does not use pagination. Please use the Version 1 in case you want to use pagination.
Endpoint:
GET /api/v2/pricelist
Response formats
This enpoint supports JSON and XML. The default format is JSON. You can switch to XML using the Accept: text/xml header.
Example Request:
GET https://leoapi.inspirion.eu/api/v2/pricelist?language=en
Example Response:
[
{
"article_id": "56-0381020",
"pricelist": [
{
"price": "5.40",
"catalog_price": "7.50",
"currency": "EUR",
"bulk_volume": 1
},
{
"price": "5.40",
"catalog_price": "7.00",
"currency": "EUR",
"bulk_volume": 25
},
{
"price": "5.40",
"catalog_price": "6.50",
"currency": "EUR",
"bulk_volume": 50
},
{
"price": "5.40",
"catalog_price": "6.00",
"currency": "EUR",
"bulk_volume": 100
}
]
},
{
"article_id": "56-0402335",
"pricelist": [
{
"price": "1.02",
"catalog_price": "1.27",
"currency": "EUR",
"bulk_volume": 1
},
{
"price": "0.86",
"catalog_price": "1.07",
"currency": "EUR",
"bulk_volume": 25
},
{
"price": "0.78",
"catalog_price": "0.97",
"currency": "EUR",
"bulk_volume": 50
},
{
"price": "0.70",
"catalog_price": "0.87",
"currency": "EUR",
"bulk_volume": 100
}
]
}
]
Notes:
This endpoint always returns all scales of catalogue prices for a product. In case your individual price has only one scale for a given product this price will be displayed in all columns. See article 56-0381020 in example response. In case your individual price has multiple scales for a given product this prices will be displayed in acording to the bulk_volumes. See article 56-0402335 in example response.
4.3 Stock API
a. List Stock
Description: This API call retrieves stock information for products across various regions and warehouses. Users can expect detailed stock levels for different geographical locations, warehouse distributions, and future inventory arrivals. This is useful for inventory management, logistics planning, and ensuring availability in specific regions.
Endpoint:
GET /api/v1/stock
Response formats
This enpoint supports JSON and XML. The default format is JSON. You can switch to XML using the Accept: text/xml header.
Example Request:
GET https://leoapi.inspirion.eu/api/v1/stock
Example Response:
{
"article_id": "56-0101051",
"stock_floating": 3504,
"stock_in_production": 0,
"stock_dach": 810,
"stock_uk": 810,
"stock_scandinavia": 810,
"stock_spain": 810,
"stock_greece": 810,
"stock_eastern_europe": 810,
"stock_france": 810,
"stock_italy": 810,
"stock_czechia": 1228,
"stock_netherlands": 810,
"stock_poland": 916,
"stock_hungary": 1228,
"warehouses": {
"germany": 810,
"poland": 106,
"hungary": 418
},
"inventory_arrival": [
{
"arrival_date": "2026-03-16 00:00:00",
"arrival_quantity": 3504
}
]
}
4.4 Print Prices API
a. List Print Prices
Description: This API call retrieves pricing details for product prints, including setup costs, flat rates, and scaled pricing for various order quantities. The information provided is vital for calculating print costs, especially for different order sizes and configurations. This endpoint supports multiple pricing tiers and handles cases where additional colors impact pricing.
Endpoint:
GET /api/v1/print-prices
Response formats
This enpoint supports JSON and XML. The default format is JSON. You can switch to XML using the Accept: text/xml header.
Example Request:
Without language parameter (default language for names is english):
GET https://leoapi.inspirion.eu/api/v1/print-prices
With language parameter:
GET https://leoapi.inspirion.eu/api/v1/print-prices?language=en
Example Response:
{
"printcode": "D4",
"name": "D4 Doming bis 4 cm²",
"currency": "EUR",
"setup": "30.00",
"setup_per_colour": false,
"flatRateStart": 1,
"flatRateEnd": 49,
"flatRate": "99.04",
"scale1": 50,
"price1": "1.98",
"scale1AdditionalColor": null,
"price1AdditionalColor": null,
"scale2": 100,
"price2": "1.91",
"scale2AdditionalColor": null,
"price2AdditionalColor": null,
"scale3": 250,
"price3": "1.52",
"scale3AdditionalColor": null,
"price3AdditionalColor": null,
"scale4": 500,
"price4": "1.30",
"scale4AdditionalColor": null,
"price4AdditionalColor": null,
"scale5": 1000,
"price5": "1.24",
"scale5AdditionalColor": null,
"price5AdditionalColor": null,
"scale6": 2500,
"price6": "1.21",
"scale6AdditionalColor": null,
"price6AdditionalColor": null,
"scale7": 5000,
"price7": "1.17",
"scale7AdditionalColor": null,
"price7AdditionalColor": null,
"scale8": 10000,
"price8": "1.13",
"scale8AdditionalColor": null,
"price8AdditionalColor": null,
"scale9": null,
"price9": null,
"scale9AdditionalColor": null,
"price9AdditionalColor": null,
"flatRateStartAdditionalColor": null,
"flatRateEndAdditionalColor": null,
"flatRateAdditionalColor": null
}
Notes on calculating the printing price
This section contains notes on the calculation of the print prices of Inspirion. If you do not want to calculate the print price yourself you can use the Price Calculation API instead.
-
Pre-Treatment costs: The pre-treatment costs are determined for each print position and each article (i)
$$ Pretreatment costs = \sum_{i=1}^n Volume_i * Pretreatment code_i * Print positions_i $$
-
Handling costs: Currenly handling costs are incurred once per article. For multiple printPosition, only the highest handling costs apply! In the near future, handling costs will occur for every printPosition. If multiple printPositions are selected, the highest handling costs of all printPositions is chosen and additionally, for every other printPosition the lowest one is added (H1)
$$ Handling costs = \sum_{i=1}^n Volume_i * Handling code_i $$
-
Printing costs: Printing costs depend on printing type and the tier classification (which is based on Volume). There is a minimum Volume of 25. Quantities below 25 fall into the flat rate category independend of the actual quantity. For ArticleID which belong to the same SKU, the quantities are summed up. This can only be taken into account at the order level.
Tampon & Screen print: $$ Printing costs = \sum_{i=1}^n \max(Volume_i * Tier Price_i * Colours_i; Flat Rate Price_i * Colours_i) $$
Transfer print: $$ Printing costs = \sum_{i=1}^n \max(Volume_i * (Tier Price_i + (Colours_i - 1)\
- Price Additional Colour); (Flat Rate Price_i + (Colours_i - 1)\
- Flat Rate Price Additional Colour)) $$
All other printing techniques: $$ Printing costs = \sum_{i=1}^n \max(Volume_i * Tier Price_i; Flat Rate Price_i) $$
-
Setup costs: Setup costs are determined for each print position and depend on the number of colors (only applies to print techniques which require mixing of colors). In the endpoint the field
setup_per_colourindicates wether the amount of colours is required for calculating setup costs for that print code.setup_per_colouris True $$ Setup costs = \sum_{i=1}^n Setup costs_i * Print positions_i * Colours_i * Logos $$setup_per_colouris False $$ Setup costs = \sum_{i=1}^n Setup costs_i * Print positions_i * Logos $$ -
Total print costs: All the parts are summed up to receive the total print costs (pre-treatment costs, handling costs, printing costs, setup costs)
$$ Total print costs = \sum_{i=1}^n Pretreatment costs_i * Handling costs_i * Printing costs_i + Setup costs_i $$
4.5 Price Calculation API
a. Calculate Price
Description: This API call calculates the price for a specific product based on its articleId. The calculation also shows the print price based on the provided print_code, volume, colours, print position and shipping country.
Endpoint:
POST /api/v1/price-calculation
Body Parameters:
articleId: Product ID.volume: Quantity.printCode: Print code.colours: Number of colors.printPosition: Print position.shippingCountry: Shipping country.
Response formats
This enpoint supports only JSON.
4.6 Deleted Products API
a. List Deleted Products
Description: This API call retrieves a list of product IDs that have been marked as deleted from the system. This is useful for ensuring inventory and catalog data remain up-to-date by identifying products that are no longer available. The response includes an array of product IDs for easy integration with other systems.
Endpoint:
GET /api/v1/deleted-products
Response formats
This enpoint supports JSON and XML. The default format is JSON. You can switch to XML using the Accept: text/xml header.
Example Request:
GET https://leoapi.inspirion.eu/api/v1/deleted-products
Example Response:
[
"56-0104112",
"56-0101131",
"56-0101132",
"56-0107002"
]
4.7 Company API
a. Get Company Details
Description: This API call retrieves detailed information about a company, including its name, address, contact details, and additional metadata. It is designed for users who need to fetch company-related data for reporting, integration, or verification purposes.
Endpoint:
GET /api/v1/company
Response formats
This enpoint supports JSON and XML. The default format is JSON. You can switch to XML using the Accept: text/xml header.
Example Request:
GET https://leoapi.inspirion.eu/api/v1/company
Example Response:
{
"name": "ABC GmbH",
"street": "ABC street 123",
"city": "Hamburg",
"country": "DE",
"zip": "22083",
"contact_name": "AAA",
"contact_surname": "BBB",
"contact_email": "AAA.BBB@ABC.de",
"products_price_list": "IG",
"print_price_list": "DE"
}
4.8 Shipping API
a. Calculate Shipping
Description: This API call retrieves all relevant shipping information about delivery costs to a specific country.
Endpoint:
POST /api/v1/shipping
Body Parameters:
shippingCountryarticleIdvolume
Example Request:
POST https://leoapi.inspirion.eu/api/v1/shipping
Example Response:
{
"product_cost": "18.00",
"shipping_cost": "13.80",
"currency": "EUR",
"shipping_message": ""
}
4.9 Materials API
Description: This API call retrieves all the materials which are used in an article.
a. List Materials
Endpoint:
GET /api/v1/materials
Response formats
This enpoint supports JSON and XML. The default format is JSON. You can switch to XML using the Accept: text/xml header.
Example Request:
GET https://leoapi.inspirion.eu/api/v1/materials
Example Response:
{
"article_id": "56-0101108",
"materials": [
"Metal",
"Polyester"
]
}
4.10 Datasheets API
a. Get Datasheet
Description: This API call generates a PDF data sheet for a specific product based on its articleId. The data sheet includes detailed product specifications, features, and other relevant information, making it ideal for use in marketing, sales, or customer inquiries. The generated PDF is returned as a downloadable file.
Endpoint:
GET /v1/data-sheet/{articleId}
Example Request:
GET https://leoapi.inspirion.eu/api/v1/data-sheet/56-0101051
Response:
Content Type: application/pdf
The response is a binary stream of the PDF file containing the product data sheet. The file can be directly downloaded or displayed in a PDF viewer.
This endpoint simplifies the generation of professional, shareable data sheets for products, ensuring accurate and consistent product information is readily accessible.
4.11 SVHC API
a. Show SVHC in articles
Description: This API call retrieves all SVHC which are present in a product. In case an article does not contain any SVHC, the response will say so.
Endpoint:
GET /api/v1/svhc/{articleId}
Example Request:
GET https://leoapi.inspirion.eu/api/v1/svhc/58-8110002
Example Response:
{
"article_id": "58-8110002",
"contains_the_following_svhc": [
"Lead"
]
}
4.12 Print templates
a. Show print templates
Description: This API call retrieves all possible print positions on all articles with their corresponding name and an url to the actual picture, which shows the print position.
Endpoint:
GET /api/v1/print-templates
Response formats
This enpoint supports JSON and XML. The default format is JSON. You can switch to XML using the Accept: text/xml header.
Example Request:
GET https://leoapi.inspirion.eu/api/print-templates
Example Response:
{
"article_id": "56-0101051",
"print_position": "on_panel_1",
"image_url": "https://media.inspirion.eu/print-template/56-0101051_POCKET_z_Panel-A_S-T-DT-RT.jpg"
}
References
article_id: References thearticle_idfield from products endpoint.print_position: References theposition_keyfields from products endpoint.
4.13 Create order via API
a. New order without print
Description: Creates a new order with customer and delivery details along with the list of products to be ordered.
Endpoint:
POST /api/v1/create-order
Example Request:
POST https://leoapi.inspirion.eu/api/v1/create-order
Example Request:
{
"name": "Johnny Inspirion",
"email": "johnny@inspirion.eu",
"order_number": "ABC-12345",
"comment": "Please deliver as soon as possible.",
"delivery_address": {
"name": "Johnny Inspirion",
"company": "Inspirion GmbH",
"street": "Inspirionstraße",
"number": "2",
"postcode": "27367",
"city": "Sottrum",
"country": "DE"
},
"products": [
{
"article_id": "56-0101051",
"volume": 50,
"customer_article_id": "A-1"
}
]
}
Request Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string (30 char) | Yes | Full name of an employee from Inspirion's client company handeling the order |
email |
string (39 char) | Yes | Email address of an employee from Inspirion's client company handeling the order |
order_number |
string (30 char) | No | Customer order number |
comment |
string | No | Customer comment |
delivery_address |
object | Yes | Address details for order delivery |
delivery_address.name |
string (30 char) | Yes | Recipient's name |
delivery_address.company |
string (30 char) | No | Company name (if applicable) |
delivery_address.street |
string (30 char) | Yes | Street name |
delivery_address.number |
string (10 char) | No | House number |
delivery_address.postcode |
string (10 char) | Yes | Postal code |
delivery_address.city |
string (30 char) | Yes | City |
delivery_address.country |
string (30 char) | Yes | Country code (ISO 3166-1 alpha-2 format) |
products |
array | Yes | List of products to be ordered |
products[].article_id |
string (16 char) | Yes | Unique identifier for the product |
products[].volume |
integer (10 char) | Yes | Quantity of the product |
products[].customer_article_id |
string (30 char) | No | Customer article number for the product |
Additional Rules:
-
The combination of
delivery_address.streetanddelivery_address.numbermust have a maximum length of 30 characters. -
The value in
products[].volumemust be in stock in the german warehouse. Please reference the Stock API for more information. If you want to buy articles that are not in stock in germany please contact your Inspirion sales contact. -
The
products[].article_idmust reference a valid an active article. The all versions of the Product API only return active products. Inactive articles can be identified with the Deleted Products API.
Example Response:
Success
Status Code: 200 Created
This response code indicated that the order was succesfully created. The returned number is the order id at Inspirion and has always 10 digits.
{
"message": "Order created: 1234567890"
}
Error
Status Code: 400 Bad Request
This response indicates that something was wrong with the request. The error message provides additional information about the error. Some example responses are provided below.
Invalid Email
{
"error": {
"email": [
"The email field must be a valid email address."
]
}
}
Insufficient Stock
{
"error": "No stock for product: 56-0101051"
}
Inactive Product
{
"error": "Inactive product: 56-0101050"
}
500 Internal Server Error - Server error
{
"error": "An unexpected error occurred"
}
Notes
- The
countryfield should be in ISO 3166-1 alpha-2 format (e.g.,DEfor Germany,USfor the United States). - The
article_idshould match the product catalog identifiers. - Ensure
volumeis a positive integer representing the order quantity.
4.14 Delivery Time
a. Get Delivery Time
Description: This API call provides basic delivery time information in workdays, including estimated timeframes for standard and printed deliveries. The Delivery Time refers to the time the goods leave Inspirion's warehouse.
Endpoint:
GET /api/v1/delivery-time
Response formats
This enpoint supports JSON and XML. The default format is JSON. You can switch to XML using the Accept: text/xml header.
Example Request:
GET https://leoapi.inspirion.eu/api/v1/delivery-time
Example Response:
{
"article_id": "56-0381020",
"delivery": {
"no-print": "1 working day",
"print": "7 working days after approval of the print file"
}
}
4.15 Products Categories
a. Get Products Categories
Description: This API call retrieves the available product categories from Inspirion's catalog, allowing clients to classify and filter items based on their assigned category.
Endpoint:
GET /api/v1/products/categories
Response formats
This enpoint supports JSON and XML. The default format is JSON. You can switch to XML using the Accept: text/xml header.
Example Request:
GET https://leoapi.inspirion.eu/api/v1/products/categories
Example Response:
[
{
"articleId": "56-0381020",
"categories": [
{
"parent_category": "sports-and-recreation",
"parent_category_translation": "Sport i rekreacja",
"category": "biking-cycling-accessories",
"category_translation": "Rowerowe akcesoria"
}
]
}
]
4.16 Sales Restrictions
a. Get Sales Restrictions
Description: This API call retrieves the sales restrictions for products.
Endpoint:
GET /api/v1/sales-restrictions
Response formats
This enpoint supports JSON and XML. The default format is JSON. You can switch to XML using the Accept: text/xml header.
Example Request:
GET https://leoapi.inspirion.eu/api/v1/sales-restrictions
Example Response:
[
{
"articleId": "56-0000001",
"country": "de",
"reason": "Test"
},
{
"articleId": "56-0000002",
"country": "de",
"reason": "Test"
}
]
4.17 Printdata
The printdata endpoints provide more detailed information on the printing options for our products. In addition to the information present in the products endpoints additional values for use in a print configurator are provided. This includes coordinates of the print shape and clean images of the print template.
a. List Printdata
This endpoint returns a list with the printdata for all products.
Example Request:
GET https://leoapi.inspirion.eu/api/v1/printdata?language=de
Example Response:
[
{
"article_id": "56-0101051",
"print_positions": [
{
"position_key": "centered_on_the_case",
"position_name": "mittig auf der Hülle",
"print_methods": [
{
"print_method_key": "transfer",
"print_method_name": "Transferdruck",
"print_codes": [
{
"print_code": "T50",
"print_code_name": "T50 Transferdruck bis 50 cm²",
"handling_code": "H5",
"handling_code_name": "Handlingskosten 5",
"treatment_code": null,
"treatment_code_name": null,
"max_colours": "4",
"default": false,
"priority": 51,
"print_area": {
"shape_key": "rectangle",
"shape_name": "Rechteck",
"display_size": "110x30mm (33cm²)",
"width_bottom": 110,
"width_top": null,
"width_unit": "mm",
"height": 30,
"height_unit": "mm",
"diameter": null,
"diameter_unit": null,
"print_area": 33,
"print_area_unit": "cm²"
},
"print_template": [
{
"print_template_files": [
{
"file_name": "56-0101051_POCKET_z_Case_T-DT-RT.pdf",
"file_type": "pdf",
"url": "https://media.inspirion.eu/print-templates/56-0101051_POCKET_z_Case_T-DT-RT.pdf",
"type": "printTemplate",
"width_pt": "679.4646",
"height_pt": "679.4646",
"width_cm": "23.9700",
"height_cm": "23.9700"
},
{
"file_name": "56-0101051_POCKET_z_Case_T-DT-RT.png",
"file_type": "png",
"url": "https://media.inspirion.eu/print-templates-clean/56-0101051_POCKET_z_Case_T-DT-RT.png",
"type": "backgroundImage",
"width_px": 1600,
"height_px": 1600
}
],
"coordinates": {
"origin": "top-left",
"center": {
"position_x_pt": "342.7087",
"position_x_px": "807.2200",
"position_y_pt": "360.0000",
"position_y_px": "847.6700",
"position_x_cm": "12.0900",
"position_y_cm": "12.7000"
},
"points": [
{
"position_x_pt": "186.5197",
"position_x_px": "439.1800",
"position_y_pt": "317.4803",
"position_y_px": "747.2900",
"position_x_cm": "6.5800",
"position_y_cm": "11.2000"
},
{
"position_x_pt": "499.1811",
"position_x_px": "1175.2500",
"position_y_pt": "317.4803",
"position_y_px": "747.2900",
"position_x_cm": "17.6100",
"position_y_cm": "11.2000"
},
{
"position_x_pt": "499.1811",
"position_x_px": "1175.2500",
"position_y_pt": "402.5197",
"position_y_px": "948.0400",
"position_x_cm": "17.6100",
"position_y_cm": "14.2000"
},
{
"position_x_pt": "186.5197",
"position_x_px": "439.1800",
"position_y_pt": "402.5197",
"position_y_px": "948.0400",
"position_x_cm": "6.5800",
"position_y_cm": "14.2000"
}
],
"circle": {
"radius_pt": null,
"radius_cm": null,
"radius_px": null
},
"area_cm2": "33.1600",
"perimeter_cm": "28.0700",
"shape_orientation_angle_degrees": "0.00",
"print_orientation_angle_degrees": "0.00",
"note": null
}
}
]
}
]
}
]
}
]
}
]
b. List Printdata for Product
This endpoint returns a list with the printdata for one products.
Example Request:
GET https://leoapi.inspirion.eu/api/v1/printdata/56-0101051?language=de
Example Response:
{
"article_id": "56-0101051",
"print_positions": [
{
"position_key": "centered_on_the_case",
"position_name": "mittig auf der Hülle",
"print_methods": [
{
"print_method_key": "transfer",
"print_method_name": "Transferdruck",
"print_codes": [
{
"print_code": "T50",
"print_code_name": "T50 Transferdruck bis 50 cm²",
"handling_code": "H5",
"handling_code_name": "Handlingskosten 5",
"treatment_code": null,
"treatment_code_name": null,
"max_colours": "4",
"default": false,
"priority": 51,
"print_area": {
"shape_key": "rectangle",
"shape_name": "Rechteck",
"display_size": "110x30mm (33cm²)",
"width_bottom": 110,
"width_top": null,
"width_unit": "mm",
"height": 30,
"height_unit": "mm",
"diameter": null,
"diameter_unit": null,
"print_area": 33,
"print_area_unit": "cm²"
},
"print_template": [
{
"print_template_files": [
{
"file_name": "56-0101051_POCKET_z_Case_T-DT-RT.pdf",
"file_type": "pdf",
"url": "https://media.inspirion.eu/print-templates/56-0101051_POCKET_z_Case_T-DT-RT.pdf",
"type": "printTemplate",
"width_pt": "679.4646",
"height_pt": "679.4646",
"width_cm": "23.9700",
"height_cm": "23.9700"
},
{
"file_name": "56-0101051_POCKET_z_Case_T-DT-RT.png",
"file_type": "png",
"url": "https://media.inspirion.eu/print-templates-clean/56-0101051_POCKET_z_Case_T-DT-RT.png",
"type": "backgroundImage",
"width_px": 1600,
"height_px": 1600,
"resize_factor": "0.0100"
}
],
"coordinates": {
"origin": "top-left",
"center": {
"position_x_pt": "342.7087",
"position_x_px": "807.2200",
"position_y_pt": "360.0000",
"position_y_px": "847.6700",
"position_x_cm": "12.0900",
"position_y_cm": "12.7000"
},
"points": [
{
"position_x_pt": "186.5197",
"position_x_px": "439.1800",
"position_y_pt": "317.4803",
"position_y_px": "747.2900",
"position_x_cm": "6.5800",
"position_y_cm": "11.2000"
},
{
"position_x_pt": "499.1811",
"position_x_px": "1175.2500",
"position_y_pt": "317.4803",
"position_y_px": "747.2900",
"position_x_cm": "17.6100",
"position_y_cm": "11.2000"
},
{
"position_x_pt": "499.1811",
"position_x_px": "1175.2500",
"position_y_pt": "402.5197",
"position_y_px": "948.0400",
"position_x_cm": "17.6100",
"position_y_cm": "14.2000"
},
{
"position_x_pt": "186.5197",
"position_x_px": "439.1800",
"position_y_pt": "402.5197",
"position_y_px": "948.0400",
"position_x_cm": "6.5800",
"position_y_cm": "14.2000"
}
],
"circle": {
"radius_pt": null,
"radius_cm": null,
"radius_px": null
},
"area_cm2": "33.1600",
"perimeter_cm": "28.0700",
"shape_orientation_angle_degrees": "0.00",
"print_orientation_angle_degrees": "0.00",
"note": null
}
}
]
}
]
}
]
}
]
}
c. General Information on Printdata
These general information on printdata apply to both the listing and the view endpoint for printdata.
Sizes
For all sizes in context of the print templates applies that values in point (pt) and centimeter (cm) are only valid for PDFs. Values in pixel (px) are only valid for images.
Orientation angles
shape_orientation_angle_degreesindicates the orientation of the area shape on the template.print_orientation_angle_degreesindicates the orientation of the print itself.
5. Multi-language Support
You can specify the response language by including the language parameter in your requests.
Example:
GET https://leoapi.inspirion.eu/api/v1/products?language=fr
6. Postman Usage Guide
6.1 Import the Postman Collection
- Download the Postman Collection (JSON) file using the link below:
- Download Postman Collection.
- Use the Import button in Postman to upload the file.
6.2 Set Environment Variables
| Variable | Description |
|---|---|
base_url |
API base URL (https://leoapi.inspirion.eu) |
gateway_api_key |
Your API key |
lang |
Language for responses |
country |
Country for responses |
articleId |
Article ID |
volume |
Volume |
printcode |
Printcode |
printPosition |
Print Position |
colours |
Colours |
7. Examples
7.1 PHP
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://leoapi.inspirion.eu/api/v1/products?language=en",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["X-Gateway-API-Key: YOUR_API_KEY"],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
7.2 Python
import requests
headers = {"X-Gateway-API-Key": "YOUR_API_KEY"}
response = requests.get("https://leoapi.inspirion.eu/api/v1/products", headers=headers)
print(response.json())
7.3 Node.js
const axios = require('axios');
axios.get('https://leoapi.inspirion.eu/api/v1/products?language=en', {
headers: {
'X-Gateway-API-Key': 'YOUR_API_KEY'
}
}).then(response => {
console.log(response.data);
}).catch(error => {
console.error(error);
});
7.4 Laravel
use Illuminate\Support\Facades\Http;
$response = Http::withHeaders([
'X-Gateway-API-Key' => 'YOUR_API_KEY',
])->get('https://leoapi.inspirion.eu/api/v1/products', [
'language' => 'en'
]);
echo $response->body();
7.5 C#
using (HttpClient client = new HttpClient())
{
client.DefaultRequestHeaders.Add("X-Gateway-API-Key", "YOUR_API_KEY");
HttpResponseMessage response = await client.GetAsync("https://leoapi.inspirion.eu/api/v1/products?language=en");
if (response.IsSuccessStatusCode)
{
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
else
{
Console.WriteLine($"Error: {response.StatusCode}");
}
}
Notes
- Replace
YOUR_API_KEYwith your actual API key. - Use HTTPS to ensure secure communication.