Pricing by Model ID API

The Pricing APIs let you request prices and shipping cost calculation for 3D printing models without uploading them to our website. There are two APIs related to Pricing available on our site:

• Pricing by Parameters*. Using this API, you can receive prices for the various material and finish combinations based on the dimensions, volume and surface of the model.
  
• Pricing by Model ID. You can get price of previously uploaded models by using this API. All you need to know is ID of the model you want to calculate the price for. This API is described on current page

*Note that by using this API it is impossible to calculate prices for some materials: paintable resin, transparent resign, high delail resin and ABS.

The Pricing API is designed for users who have an application or website that generates models that need to be 3D printed and who wants an instant price before ordering models. If you would like prices to be calculated for your 3D models without transferring your information to i.materialise for performance, security or other reasons, this is the API for you.

We have created demo pages for you so you can test the tool ID and your acquired API code.

The demo page of Pricing by Model ID API on production server:

https://i.materialise.com/api/demo/pricing-by-model-id-api.htm

These fully functioning pages are linked to the pricing engine that is used in our 3D print lab, meaning that the API generated prices are identical to the prices generated by i.materialise’s 3D print lab.

Also, we’ve developed a sandbox server, which is an isolated server (not hooked up to a payment system or production environment, allowing you to test the service without getting billed) to try out your sandbox API code, tool ID and integration with us. This is different from our demo pages which are used to check if a particular API is working and is connected with our production site.

The demo page of Pricing by Model ID API on sandbox server:

https://imatsandbox.materialise.net/api/demo/pricing-by-model-id-api.htm

This API requires the personal API code. It is therefore not possible to use AJAX requests.

The Pricing API works by posting data to our service. You can use either XML (Extensible Markup Language) or JSON (JavaScript Object Notation) formats for posting. The HTTP encoding type of a particular request depends on the type of API you are going to use. This will be described in “Documentation” section of this page.

To specify the exact content type which your client can accept and parse, the Accept header in your request has to be set to one of the supported encoding types:

• text/json
• application/json
• text/xml
• application/xml

The API code needs to be specified in the API code HTTP header. To get prices through the Pricing API, POST a well-structured request via “HTTPS” to this URL:

https://i.materialise.com/web-api/pricing/model

To use APIs of the sandbox, the POST needs to be submitted to:

https://imatsandbox.materialise.net/web-api/pricing/model

The server will return a structured response in XML or JSON which your application can parse to retrieve pricing information.

The request, in XML or JSON format, needs to follow a certain structure to be able to generate prices. The structure consists of the following sections:

The header of your request needs to contain:

Accept:        [preferred Content Type: "application/json" or "text/xml"]
API code:      [API code provided by i.materialise]

Within the same request, it’s possible to request prices for multiple quantities and multiple material and finish options.

The section is not required. If you would like the shipping cost calculated into the quote, simply add this to the request.

The header of your request needs to contain:

<PricingRequest>
  <Models>
    <Model>
      <ModelID>28ba016b-68a6-4511-a518-2cd4dafd43b7</ModelID>
      <MaterialID>2e7b80e9-634b-485a-bc40-5e4324078b54</MaterialID>
      <FinishID>0261af53-8fed-4854-a248-4b111d759f8d</FinishID>
      <Quantity>1</Quantity>
      <Scale>1.0</Scale>
    </Model>
  </Models>
  <ShipmentInfo>
      <CountryCode>BE</CountryCode>
      <StateCode></StateCode>
      <City>Leuven</City>
      <ZipCode>3001</ZipCode>
  </ShipmentInfo>
  <Currency>EUR</Currency>
</PricingRequest>

{
   "models":[
      {
         "modelID":"28ba016b-68a6-4511-a518-2cd4dafd43b7",
         "materialID":"035f4772-da8a-400b-8be4-2dd344b28ddb",
         "finishID":"bba2bebb-8895-4049-aeb0-ab651cee2597",
         "quantity":"1",
         "scale":"1.0"
      }
   ],
   "shipmentInfo": 
    {
        "countryCode": "BE",
        "stateCode": "",
        "city": "Leuven",
        "zipCode":  "3001"
    },
    "currency":"EUR"
}

This section contains a list of models with the following parameters:

You’ll only see a shipping cost response if your request contains a shipment Information section.
Whenever there is a model for which the price could not be calculated, then the Shipment Information Section will show a shipping error.

All prices in the response (model prices and shipment cost) are calculated and returned in currency shown in this section.

This response section appears only if request was NOT processed successfully.

<PriceResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Models>
    <Model>
      <ModelID>28ba016b-68a6-4511-a518-2cd4dafd43b7</ModelID>
      <ToolID>20ef6277-52f5-a1s2-a306-1282ab8bc035</ToolID>
      <MaterialID>2e7b80e9-634b-485a-bc40-5e4324078b54</MaterialID>
      <MaterialName>Prime gray</MaterialName>
      <FinishID>0261af53-8fed-4854-a248-4b111d759f8d</FinishID>
      <FinishingName>Natural gray</FinishingName>
      <Quantity>1</Quantity>
      <TotalPrice>5.00</TotalPrice>
      <XDimMm>1.00000000000</XDimMm>
      <YDimMm>1.00000000000</YDimMm>
      <ZDimMm>1.00000000000</ZDimMm>
      <VolumeCm3>0.0010000000</VolumeCm3>
      <SurfaceCm2>0.0600000000</SurfaceCm2>
    </Model>
  </Models>
  <ShipmentCost>
    <Services>
      <Service>
        <Name>Standard</Name>
        <Value>6.68</Value>
        <DaysInTransit>3</DaysInTransit>
      </Service>
      <Service>
        <Name>Express</Name>
        <Value>8.92</Value>
        <DaysInTransit>1</DaysInTransit>
      </Service>
    </Services>
  </ShipmentCost>
  <Currency>EUR</Currency>
</PriceResponse>

{
    "models":[
        {
            "modelID":"28ba016b-68a6-4511-a518-2cd4dafd43b7",
            "toolID":"20ef6277-123b-4551-a306-1282ab8bc035",
            "materialID":"035f4772-da8a-400b-8be4-2dd344b28ddb",
            "materialName":"Polyamide",
            "finishID":"bba2bebb-8895-4049-aeb0-ab651cee2597",
            "finishingName":"Natural white",
            "quantity":1,
            "totalPrice":12.50,
            "xDimMm":1.00000000000,
            "yDimMm":1.00000000000,
            "zDimMm":1.00000000000,
            "volumeCm3":0.0010000000,
            "surfaceCm2":0.0600000000
        }
    ],
    "shipmentCost":{
        "services":[
            {
                "name":"Standard",
                "value":6.68,
                "daysInTransit":3
            },
            {
                "name":"Express",
                "value":8.92,
                "daysInTransit":1
            }
        ]
    },
    "currency":"EUR"
}

Below described all possible errors which can appear in both Pricing APIs (Pricing by Parameters and Pricing by Model ID).

If a wrong/empty API code is used, then you’ll see a 401 error response: statusText=”Unauthorized”.

The RequestError response shows up only if the request was NOT processed successfully.

<PriceResponse>
  <RequestError>This currency is not supported, please specify EUR/USD/JPY/GBP</RequestError>
  <Error>
    <Message>This currency is not supported, please specify EUR/USD/JPY/GBP</Message>
    <Code>206</Code>
  </Error>
</PriceResponse>

{
    "requestError":"This currency is not supported,
     please specify EUR/USD/JPY/GBP",
    "error":{
        "message":"This currency is not supported,
         please specify EUR/USD/JPY/GBP",
        "code":206
    }
}

The models>pricingError message appears if the price for a model cannot be calculated. Each model can have its own pricing error. Pricing errors appear when some parameters are filled in incorrectly, or when it’s impossible to calculate online prices according to i.materialise rules.

<Models>
    <Model>
      <ToolID />
      <MaterialID>d7ed51be-aaa1-40ea-8ca7-8763c65fc66e</MaterialID>
      <FinishID>496ce425-aaa1-4320-b78a-2dfa7c41657b</FinishID>
      <Quantity>1</Quantity>
      <TotalPrice>0</TotalPrice>
      <XDimMm>10</XDimMm>
      <YDimMm>10</YDimMm>
      <ZDimMm>10</ZDimMm>
      <VolumeCm3>1</VolumeCm3>
      <SurfaceCm2>6</SurfaceCm2>
      <PricingError>
        <Message>We don’t offer an online price for this material</Message>
        <Code>220</Code>
      </PricingError>
      <ModelReference>some model.xml</ModelReference>
    </Model>
  </Models>

"models":[
    {
        "modelReference":"some model.xml",
        "toolID":"20ef6277-52f5-4551-a306-1282ab8bc035",
        "materialID":"d7ed51be-aaa1-40ea-8ca7-8763c65fc66e",
        "finishID":"496ce425-aaa1-4320-b78a-2dfa7c41657b",
        "quantity":1,
        "totalPrice":0.0,
        "xDimMm":10.0,
        "yDimMm":10.0,
        "zDimMm":10.0,
        "volumeCm3":1.0,
        "surfaceCm2":6.0,
        "pricingError":{
        "message":"We don’t offer an online price for this material",
        "code":220
        }
     }
],

<ShipmentCost>
  <ShipmentError>ZipCode is required.</ShipmentError>
</ShipmentCost>

"shipmentCost":{
    "shipmentError":"Wrong CountryCode. Please use international country code (e.g.: BE for Belgium)."
},