Documentation

i.materialise has a wide range of APIs in place. These APIs serve different business needs. There are four types of APIs available. A first type, the pricing APIs, allow you to receive the (shipment) price for your models. A second type, the ordering APIs, allow you to create orders. A third type, the reporting APIs, summarizes useful data regarding uploads, orders… A fourth and final type, the info API, provides information, f.e. about the materials (and sizes) we print in.

Pricing APIs

Pricing by Parameters API
Retrieve the price of a specific model in a specific material without uploading a model to our server. You can get a price of a model by providing X, Y, Z volume and surface details.

Pricing by Model ID API
Retrieve the price of a specific model in a specific material that you have already uploaded or ordered by the ID of your model.

Ordering APIs

Upload Model API
Retrieve the dimensions of a model by uploading it to our server. The API analyses the model, returns a reference to the model to be used in other APIs, and calculates the dimensions and parameters of the uploaded model.

3D Print Lab Connection API
Upload a 3D model to the i.materialise server and get a link to the 3D Print Lab in return to which your application can redirect your customers to. They will see the model in the 3D Print Lab where they can select a material, finish, size, and quantity as well as get an instant price.

Cart Item Creation API
Create cart items. Preparing a cart is a two-step approach. Cart items need to be generated first and then added to a cart. These 2 actions are done through 2 separate APIs: the Cart Item Creation API and Cart Creation API. The split up is done to allow maximum flexibility in the creation of a cart.

Cart Creation API
Fill a cart containing cart items. Preparing a cart is a two-step approach. Cart items need to be generated first and then added to a cart. These 2 actions are done through 2 separate APIs: the Cart Item Creation API and Cart Creation API. The split up is done to allow maximum flexibility in the creation of a cart.

Cart Checkout API
Check out the cart and place the order.

Add/Remove Cart Item API
Modify your cart after its creation: Remove already added items or add new items to the cart. This API is to be used in combination with the Cart Item Creation and Cart Creation API.

Order Status API
Retrieve information about the orders placed at i.materialise through your application or website, without using the user interface of i.materialise.

Cart Status API
Retrieve information about the status of the cart created at i.materialise through your application over the API.

Order Cancellation APIs

Order Cancellation by ID API
Cancel an earlier placed order by using the ID of the order. Order cancellation is possible as long as the order processing didn’t start.

Order Cancellation by Number API
Cancel an earlier placed order by using the order number. Order cancellation is possible as long as the order processing didn’t start.

Delivery Note APIs

Delivery Note Retrieval by Order ID API
Retrieve the delivery notes for your orders. This API is intended to be used in the white label business model approach where you are in control of the delivery note inserted in the transport box.

Delivery Note Add/Update API
Add and update the delivery notes for your orders. This API is intended to be used in the white label business model approach where you are in control of the delivery note inserted in the transport box.

Invoice APIs

Invoice Retrieval by Order ID API
Retrieve invoice documents for your orders. This API is intended to be used in white label business model approach where you want to be in control of the invoice.

Invoice Add/Update API
Add and update invoice documents for your orders. This API is intended to be used in white label business model approach where you want to be in control of the invoice.

Reporting APIs

Uploaded Models Reporting API
Retrieve information about the uploaded models that were tagged with your personal tool IDs. This API provides in depth information per model.

Uploaded Models Statistics Report API
Retrieve information about the uploaded models that were tagged with your personal tool IDs. This API provides a summary per status of the models.

Order Statistics APIs

Order Statistics API
Follow up the orders of customers you have been forwarding to i.materialise.

Ordered Models Statistics API
Retrieve the details of all the models that were ordered through i.materialise.

Info APIs