Materials

Use the /materials/v1 API endpoint to get up-to-date information about Shapeways’ materials.


GET - List materials

Retrieves information on all available 40+ Shapeways’ materials.

Request

GET /materials/v1

Response

parameters
type
description
result
string
A 'result' field stating 'success'
materials
object
Material objects
{
 "<materialId>":{
    "id":"<materialId>",
    "type":"object",
    "description":"Material Object",
    "properties":{
       "title":{
          "type":"string",
          "description":"Material name"
       },
       "supportsColorFiles":{
          "type":"boolean",
          "description":"Material supports color"
       },
       "printerId":{
          "type":"int",
          "description":"Printer id that this material is printed on"
       },
       "swatch":{
          "type":"string",
          "description":"The url for the material swatch"
       },
       "restrictions":{
          "id":"restrictions",
          "type":"object",
          "description":"Material Restriction Object",
          "properties":{
             "<restrictionId>":{
                "id":"<restrictionId>",
                "type":"object",
                "description":"Material Restriction Object",
                "properties":{
                   "restrictionId":{
                      "type":"int",
                      "description":"Material Restriction ID"
                   },
                   "restrictionName":{
                      "type":"string",
                      "description":"Material Restriction Name"
                   },
                   "restrictionEntityIds":{
                      "type":"array",
                      "description":"Material Restriction Entity Ids",
                      "default":[

                      ],
                      "items":{
                         "type":"int",
                         "description":"Material Restriction Entity Id"
                      }
                   }
                }
             }
          }
       }
    }
 }
}
nextActionSuggestions
object
Suggestions for next actions

GET - Material information

Retrieves information for a specific material (Specified by the materialId)

Request

GET /materials/{materialId}/v1
parameters
type
required
description
materialId
int
required
Material id

Response

parameters
type
description
result
string
A 'result' field stating 'success'
materialId
int
Material ID
title
string
Material name
supportsColorFiles
boolean
Material supports color
printerId
int
Printer id that this material is printed on
swatch
string
The url for the material swatch
restrictions
object
Material Restriction Object
{
 "<restrictionId>":{
    "id":"<restrictionId>",
    "type":"object",
    "description":"Material Restriction Object",
    "properties":{
       "restrictionId":{
          "type":"int",
          "description":"Material Restriction ID"
       },
       "restrictionName":{
          "type":"string",
          "description":"Material Restriction Name"
       },
       "restrictionEntityIds":{
          "type":"array",
          "description":"Material Restriction Entity Ids",
          "default":[

          ],
          "items":{
             "type":"int",
             "description":"Material Restriction Entity Id"
          }
       }
    }
 }
}
nextActionSuggestions
object
Suggestions for next actions