Browse the Shapeways API Documentation below or check out our JSON API Discovery - Get the JSON View addon for your browser
oauth_consumer_key | string | required | Public oauth consumer key. |
oauth_signature | string | required | Generated oauth signature. |
oauth_signature_method | string | required | HMAC-SHA1 |
oauth_nonce | int | required | Random number |
oauth_timestamp | int | required | Number of seconds since the Unix Epoch. |
oauth_verifier | string | required | Oauth verifier. |
oauth_consumer_key | string | required | Public oauth consumer key |
oauth_signature_method | string | required | HMAC-SHA1 |
oauth_nonce | int | required | A random string with a maximum of 254 characters, uniquely generated by the client to allow the server to verify that a request has never been made before. The nonce value must be unique across all requests with the same timestamp, client credentials, and token combinations. |
oauth_timestamp | int | required | Number of seconds since the Unix Epoch. |
oauth_version | string | required | 1.0 |
oauth_token | string | required | Public oauth request token key |
oauth_signature | string | required | Generated oauth signature |
result | string | A 'result' field stating 'success' |
nextActionSuggestions | array | Suggestions for next actions |
rateLimit | array |
Rate limiting information {
"retryInSeconds":{
"type":"int",
"description":"Time in seconds you must wait before making another API call"
},
"retryTimestamp":{
"type":"int",
"description":"Unix timestamp you must wait before making another API call"
},
"windowInSeconds":{
"type":"int",
"description":"Rate limiting sliding window in seconds"
},
"limit":{
"type":"int",
"description":"Maximum number of API calls during the rate limiting window"
},
"remaining":{
"type":"int",
"description":"Remaining number of API calls in the current rate limiting window"
},
"history":{
"type":"array",
"description":"Number of API calls made for each minute during the rate limiting window."
}
} |
result | string | A 'result' field stating 'success' |
itemCount | int | Quantity of items in the cart |
items | array |
List of cart items {
"type":"object",
"description":"Cart Item",
"properties":{
"modelId":{
"type":"int",
"description":"Model id"
},
"spin":{
"type":"int",
"description":"SPIN"
},
"materialId":{
"type":"int",
"description":"Material id"
},
"quantity":{
"type":"int",
"description":"Quantity of models in this material"
}
}
} |
nextActionSuggestions | object | Suggestions for next actions |
modelId | int | required | Model id |
materialId | int | optional | Material id |
quantity | int | optional |
Quantity of models in this material - Default: 1 |
result | string | A 'result' field stating 'success' |
nextActionSuggestions | object | Suggestions for next actions |
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 |
materialId | int | required | Material id |
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 |
page | int | optional | The model page, starting with 1. Each page contains 36 models. |
result | string | A 'result' field stating 'success' |
models | array |
List of models {
"modelId":{
"type":"int",
"description":"Model ID"
},
"modelVersion":{
"type":"int",
"description":"Model version"
},
"title":{
"type":"string",
"description":"Model title"
}
} |
nextActionSuggestions | object | Suggestions for next actions |
file | string | required | Model file data |
fileName | string | required | Model filename |
uploadScale | float | optional |
Model scale in meters: 1.0 - meter, 0.001 - millimeter, 0.0254 - inch. - Default: 1 |
hasRightsToModel | boolean | required |
You have the rights to, or have authorization to use this model - 0 - You do not have rights to, nor have authorization to use this model - 1 - You have rights to, or have authorization to use this model |
acceptTermsAndConditions | boolean | required |
You accept the Terms and Conditions, see https://www.shapeways.com/terms_and_conditions. - 0 - You do not accept the Terms and Conditions, see https://www.shapeways.com/terms_and_conditions. - 1 - You accept the Terms and Conditions, see https://www.shapeways.com/terms_and_conditions. |
title | string | optional | Model title |
description | string | optional |
Model description - Default: |
isPublic | boolean | optional |
Model visibility - Default: 0 - 0 - Private Model (viewable only with a private key) - 1 - Public Model |
isClaimable | boolean | optional |
Whether a model is claimable with a claim key - Default: false |
isForSale | int | optional |
Model is for sale - Default: 0 - 0 - Model cannot be purchased - 1 - Model can be purchased |
isDownloadable | boolean | optional |
Model is downloadable - Default: 0 - 0 - Model cannot be downloaded - 1 - Model can be downloaded |
tags | array | optional |
Model tags {
"type":"string",
"description":"The name of the tag."
} |
materials | object | optional |
Material objects {
"<materialId>":{
"id":"<materialId>",
"type":"object",
"description":"Material Object",
"properties":{
"markup":{
"type":"float",
"description":"Markup amount"
},
"isActive":{
"type":"boolean",
"description":"Is this material active"
},
"price":{
"type":"float",
"description":"Price"
}
}
}
} |
defaultMaterialId | int | optional | The material id for this model's default material |
categories | array | optional |
Array of category ids. {
"type":"int",
"description":"Category Id"
} |
result | string | A 'result' field stating 'success' |
modelId | int | Model ID |
modelVersion | int | Model version |
title | string | Model title |
fileName | string | Model filename |
contentLength | int | The file size of the uploaded file in bytes |
fileMd5Checksum | string | The md5 checksum of the file |
description | string | Model description |
isPublic | boolean | Can be seen by the public |
isClaimable | boolean | Can be claimed via claimKey |
isForSale | boolean | Model is for sale |
isDownloadable | boolean | Model is downloadable |
materials | object |
Material objects {
"<materialId>":{
"id":"<materialId>",
"type":"object",
"description":"Material Object",
"properties":{
"markup":{
"type":"float",
"description":"Markup amount"
},
"isActive":{
"type":"boolean",
"description":"Is this material active"
},
"price":{
"type":"float",
"description":"Price"
}
}
}
} |
secretKey | string | The secret key is used to allow ANY user to access a private model. The model can be accessed using the url query parameter ?key=[key] at the end of the url |
claimKey | string | The claim key is used to allow ANY user to claim a model into their own account. The claim function should be used when your app is generating models using your own permanent access tokens.To enable a user to claim a model, send them to the edit model page url with query parameter ?key=[key].If the model is not "claimable" this key will be blank. Once a model is set to claimable, it cannot be set to public or for-sale. |
defaultMaterialId | int | The material id for this model's default material |
categories | object |
Category Objects {
"<categoryId>":{
"id":"<categoryId>",
"type":"object",
"description":"Category Object",
"properties":{
"title":{
"type":"string",
"description":"Category title"
},
"parentId":{
"type":"int",
"description":"Category's parent category. For topmost categories, 0 will be returned to indicate that there is no parent."
}
}
}
} |
tags | string | Tags |
urls | object |
Url Objects {
"<address>":{
"id":"<address>",
"type":"object",
"description":"Url Object",
"properties":{
"address":{
"type":"string",
"description":"Url Address"
}
}
}
} |
spin | string | SPIN |
printable | string | Model Printability |
nextActionSuggestions | object | Suggestions for next actions |
modelId | int | required | Model id |
result | string | A 'result' field stating 'success' |
modelId | int | Model ID |
modelVersion | int | Model version |
title | string | Model title |
fileName | string | Model filename |
contentLength | int | The file size of the uploaded file in bytes |
fileMd5Checksum | string | The md5 checksum of the file |
fileData | string | Model file data |
description | string | Model description |
isPublic | boolean | Can be seen by the public |
isClaimable | boolean | Can be claimed via claimKey |
isForSale | boolean | Model is for sale |
isDownloadable | boolean | Model is downloadable |
materials | object |
Material objects {
"<materialId>":{
"id":"<materialId>",
"type":"object",
"description":"Material Object",
"properties":{
"markup":{
"type":"float",
"description":"Markup amount"
},
"isActive":{
"type":"boolean",
"description":"Is this material active"
},
"price":{
"type":"float",
"description":"Price"
},
"name":{
"type":"string",
"description":"Material name"
},
"basePrice":{
"type":"float",
"description":"Base Price"
},
"isPrintable":{
"type":"boolean",
"description":"Is this material printable"
},
"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"
}
}
}
}
}
}
}
}
} |
secretKey | string | The secret key is used to allow ANY user to access a private model. The model can be accessed using the url query parameter ?key=[key] at the end of the url |
claimKey | string | The claim key is used to allow ANY user to claim a model into their own account. The claim function should be used when your app is generating models using your own permanent access tokens.To enable a user to claim a model, send them to the edit model page url with query parameter ?key=[key].If the model is not "claimable" this key will be blank. Once a model is set to claimable, it cannot be set to public or for-sale. |
defaultMaterialId | int | The material id for this model's default material |
categories | object |
Category Objects {
"<categoryId>":{
"id":"<categoryId>",
"type":"object",
"description":"Category Object",
"properties":{
"title":{
"type":"string",
"description":"Category title"
},
"parentId":{
"type":"int",
"description":"Category's parent category. For topmost categories, 0 will be returned to indicate that there is no parent."
}
}
}
} |
tags | string | Tags |
urls | object |
Url Objects {
"<address>":{
"id":"<address>",
"type":"object",
"description":"Url Object",
"properties":{
"address":{
"type":"string",
"description":"Url Address"
}
}
}
} |
spin | string | SPIN |
printable | string | Model Printability |
nextActionSuggestions | object | Suggestions for next actions |
modelId | int | required | ID of the model to delete. |
result | string | A 'result' field stating 'success' |
modelId | int | ID of the model that was deleted. |
nextActionSuggestions | object | Suggestions for next actions |
modelId | int | required | The existing 3D model id |
result | string | A 'result' field stating 'success' |
modelId | int | Model ID |
modelVersion | int | Model version |
title | string | Model title |
description | string | Model description |
isPublic | boolean | Can be seen by the public |
isClaimable | boolean | Can be claimed via claimKey |
isForSale | boolean | Model is for sale |
isDownloadable | boolean | Model is downloadable |
materials | object |
Material objects {
"<materialId>":{
"id":"<materialId>",
"type":"object",
"description":"Material Object",
"properties":{
"markup":{
"type":"float",
"description":"Markup amount"
},
"isActive":{
"type":"boolean",
"description":"Is this material active"
},
"price":{
"type":"float",
"description":"Price"
},
"name":{
"type":"string",
"description":"Material name"
},
"basePrice":{
"type":"float",
"description":"Base Price"
},
"isPrintable":{
"type":"boolean",
"description":"Is this material printable"
},
"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"
}
}
}
}
}
}
}
}
} |
secretKey | string | The secret key is used to allow ANY user to access a private model. The model can be accessed using the url query parameter ?key=[key] at the end of the url |
claimKey | string | The claim key is used to allow ANY user to claim a model into their own account. The claim function should be used when your app is generating models using your own permanent access tokens.To enable a user to claim a model, send them to the edit model page url with query parameter ?key=[key].If the model is not "claimable" this key will be blank. Once a model is set to claimable, it cannot be set to public or for-sale. |
defaultMaterialId | int | The material id for this model's default material |
categories | object |
Category Objects {
"<categoryId>":{
"id":"<categoryId>",
"type":"object",
"description":"Category Object",
"properties":{
"title":{
"type":"string",
"description":"Category title"
},
"parentId":{
"type":"int",
"description":"Category's parent category. For topmost categories, 0 will be returned to indicate that there is no parent."
}
}
}
} |
tags | string | Tags |
urls | object |
Url Objects {
"<address>":{
"id":"<address>",
"type":"object",
"description":"Url Object",
"properties":{
"address":{
"type":"string",
"description":"Url Address"
}
}
}
} |
spin | string | SPIN |
printable | string | Model Printability |
nextActionSuggestions | object | Suggestions for next actions |
modelId | int | required | The existing 3D model id |
title | string | optional | Model title |
description | string | optional | Model description |
isPublic | boolean | optional |
Model visibility - 0 - Private Model (viewable only with a private key) - 1 - Public Model |
isClaimable | boolean | optional |
Whether a model is claimable with a claim key - Default: false |
isForSale | int | optional |
Model is for sale - 0 - Model cannot be purchased - 1 - Model can be purchased |
isDownloadable | boolean | optional |
Model is downloadable - 0 - Model cannot be downloaded - 1 - Model can be downloaded |
tags | array | optional |
Model tags {
"type":"string",
"description":"The name of the tag."
} |
materials | object | optional |
Material objects {
"<materialId>":{
"id":"<materialId>",
"type":"object",
"description":"Material Object",
"properties":{
"markup":{
"type":"float",
"description":"Markup amount"
},
"isActive":{
"type":"boolean",
"description":"Is this material active"
},
"price":{
"type":"float",
"description":"Price"
}
}
}
} |
defaultMaterialId | int | optional | The material id for this model's default material |
categories | array | optional |
Array of category ids. {
"type":"int",
"description":"Category Id"
} |
result | string | A 'result' field stating 'success' |
modelId | int | Model ID |
modelVersion | int | Model version |
title | string | Model title |
description | string | Model description |
isPublic | boolean | Can be seen by the public |
isClaimable | boolean | Can be claimed via claimKey |
isForSale | boolean | Model is for sale |
isDownloadable | boolean | Model is downloadable |
materials | object |
Material objects {
"<materialId>":{
"id":"<materialId>",
"type":"object",
"description":"Material Object",
"properties":{
"markup":{
"type":"float",
"description":"Markup amount"
},
"isActive":{
"type":"boolean",
"description":"Is this material active"
},
"price":{
"type":"float",
"description":"Price"
}
}
}
} |
secretKey | string | The secret key is used to allow ANY user to access a private model. The model can be accessed using the url query parameter ?key=[key] at the end of the url |
claimKey | string | The claim key is used to allow ANY user to claim a model into their own account. The claim function should be used when your app is generating models using your own permanent access tokens.To enable a user to claim a model, send them to the edit model page url with query parameter ?key=[key].If the model is not "claimable" this key will be blank. Once a model is set to claimable, it cannot be set to public or for-sale. |
defaultMaterialId | int | The material id for this model's default material |
categories | object |
Category Objects {
"<categoryId>":{
"id":"<categoryId>",
"type":"object",
"description":"Category Object",
"properties":{
"title":{
"type":"string",
"description":"Category title"
},
"parentId":{
"type":"int",
"description":"Category's parent category. For topmost categories, 0 will be returned to indicate that there is no parent."
}
}
}
} |
tags | string | Tags |
urls | object |
Url Objects {
"<address>":{
"id":"<address>",
"type":"object",
"description":"Url Object",
"properties":{
"address":{
"type":"string",
"description":"Url Address"
}
}
}
} |
spin | string | SPIN |
printable | string | Model Printability |
nextActionSuggestions | object | Suggestions for next actions |
file | string | required | Model file data |
fileName | string | required | Model filename |
uploadScale | float | optional |
Model scale in meters: 1.0 - meter, 0.001 - millimeter, 0.0254 - inch. - Default: 1 |
hasRightsToModel | boolean | required |
You have the rights to, or have authorization to use this model - 0 - You do not have rights to, nor have authorization to use this model - 1 - You have rights to, or have authorization to use this model |
acceptTermsAndConditions | boolean | required |
You accept the Terms and Conditions, see https://www.shapeways.com/terms_and_conditions. - 0 - You do not accept the Terms and Conditions, see https://www.shapeways.com/terms_and_conditions. - 1 - You accept the Terms and Conditions, see https://www.shapeways.com/terms_and_conditions. |
result | string | A 'result' field stating 'success' |
modelId | int | Model ID |
modelVersion | int | Model version |
title | string | Model title |
fileName | string | Model filename |
contentLength | int | The file size of the uploaded file in bytes |
fileMd5Checksum | string | The md5 checksum of the file |
nextActionSuggestions | object | Suggestions for next actions |
modelId | int | required | Model id |
fileVersion | int | required | Model file version |
file | boolean | optional |
Include model data file in the response - Default: 0 - 0 - Do not include model file data - 1 - Include model file data |
result | string | A 'result' field stating 'success' |
modelId | int | Model ID |
modelVersion | int | Model version |
title | string | Model title |
fileName | string | Model filename |
contentLength | int | The file size of the uploaded file in bytes |
fileMd5Checksum | string | The md5 checksum of the file |
fileData | string | Model file data |
nextActionSuggestions | object | Suggestions for next actions |
modelId | int | required | Model id |
file | string | required | Photo file data |
title | string | optional |
Photo title - Default: |
description | string | optional |
Photo description - Default: |
materialId | int | optional | Material depicted in the photo |
result | string | A 'result' field stating 'success' |
contentLength | int | Photo file size in bytes |
fileMd5Checksum | string | Md5 checksum of the photo file |
modelId | int | Model id this photo belongs to |
title | string | The title of this photo |
description | string | A description of this photo |
width | int | The width of the photo |
height | int | The height of the photo |
materialId | int | The material id of the material shown in this photo |
photoId | int | The id of this photo |
photoCount | int | The number of photos that exist for this model |
nextActionSuggestions | object | Suggestions for next actions |
result | string | A 'result' field stating 'success' |
printers | array |
List of printers {
"id":"<printerId>",
"type":"object",
"description":"Printer Item",
"properties":{
"printerId":{
"type":"int",
"description":"Printer id"
},
"title":{
"type":"string",
"description":"Printer name"
},
"xBoundMin":{
"type":"float",
"description":"Printer's minimum object size in the X axis direction in cm"
},
"xBoundMax":{
"type":"float",
"description":"Printer's maximum object size in the X axis direction in cm"
},
"yBoundMin":{
"type":"float",
"description":"Printer's minimum object size in the Y axis direction in cm"
},
"yBoundMax":{
"type":"float",
"description":"Printer's maximum object size in the Y axis direction in cm"
},
"zBoundMin":{
"type":"float",
"description":"Printer's minimum object size in the Z axis direction in cm"
},
"zBoundMax":{
"type":"float",
"description":"Printer's maximum object size in the Z axis direction in cm"
}
}
} |
nextActionSuggestions | object | Suggestions for next actions |
printerId | int | required | Printer id |
result | string | A 'result' field stating 'success' |
printerId | int | Printer id |
title | string | Printer name |
xBoundMin | float | Printer's minimum object size in the X axis direction in cm |
xBoundMax | float | Printer's maximum object size in the X axis direction in cm |
yBoundMin | float | Printer's minimum object size in the Y axis direction in cm |
yBoundMax | float | Printer's maximum object size in the Y axis direction in cm |
zBoundMin | float | Printer's minimum object size in the Z axis direction in cm |
zBoundMax | float | Printer's maximum object size in the Z axis direction in cm |
nextActionSuggestions | object | Suggestions for next actions |
volume | float | required | Model volume (cubic meters, use 0.000001 for cm^3) |
area | float | required | Model surface area (square meters, use 0.0001 for cm^2) |
xBoundMin | float | required |
Model bounding box minimum on the x-axis in meters - Default: 0 |
xBoundMax | float | required |
Model bounding box maximum on the x-axis in meters - Default: 0 |
yBoundMin | float | required |
Model bounding box minimum on the y-axis in meters - Default: 0 |
yBoundMax | float | required |
Model bounding box maximum on the y-axis in meters - Default: 0 |
zBoundMin | float | required |
Model bounding box minimum on the z-axis in meters - Default: 0 |
zBoundMax | float | required |
Model bounding box maximum on the z-axis in meters - Default: 0 |
materials | array | optional |
Limit pricing to a set of materials. If left blank, prices for ALL materials will be returned. {
"type":"int",
"description":"Material Id"
} |
result | string | A 'result' field stating 'success' |
prices | object |
List of material prices {
"<materialId>":{
"id":"<materialId>",
"type":"object",
"description":"Price Object",
"properties":{
"price":{
"type":"float",
"description":"Price for model geometry in this material"
},
"currency":{
"type":"string",
"description":"Price currency"
}
}
}
} |
nextActionSuggestions | object | Suggestions for next actions |
result | string | A 'result' field stating 'success' |
categories | object |
Category objects {
"<categoryId>":{
"id":"<categoryId>",
"type":"object",
"description":"Category Object",
"properties":{
"title":{
"type":"string",
"description":"Category title"
},
"parentId":{
"type":"int",
"description":"Category's parent category. For topmost categories, 0 will be returned to indicate that there is no parent."
}
}
}
} |
nextActionSuggestions | object | Suggestions for next actions |
categoryId | int | required | Category id |
result | string | A 'result' field stating 'success' |
category | object |
Category Object {
"title":{
"type":"string",
"description":"Category title"
},
"parentId":{
"type":"int",
"description":"Category's parent category. For topmost categories, 0 will be returned to indicate that there is no parent."
}
} |
nextActionSuggestions | object | Suggestions for next actions |
result | string | A 'result' field stating 'success' |
ordersCount | object |
Contains a summary of the number of orders classified by status {
"total":{
"type":"int",
"description":"Total number of orders"
},
"placed":{
"type":"int",
"description":"Number of orders placed"
},
"in_production":{
"type":"int",
"description":"Number of orders in production"
},
"cancelled":{
"type":"int",
"description":"Number of orders cancelled"
},
"unknown":{
"type":"int",
"description":"Number of orders in an unknown status"
},
"shipped":{
"type":"int",
"description":"Number of orders shipped"
}
} |
ordersStatus | json_object | Contains a detailed summary of each order and it's status |
ordersInfo | array |
Contains target ship date, target delivery date and shipments for each order {
"id":"<orderId>",
"type":"object",
"description":"Contains target ship date, target delivery date and shipments for each order",
"properties":{
"orderId":{
"type":"int",
"description":"Order id"
},
"targetDeliveryDate":{
"type":"string",
"description":"Target delivery date"
},
"targetShipDate":{
"type":"string",
"description":"Target to ship date"
},
"shipments":{
"type":"array",
"description":"Shipments for this order",
"items":{
"id":"<shipmentId>",
"type":"object",
"description":"Shipment Information",
"properties":{
"shipmentId":{
"type":"int",
"description":"Shipment id"
},
"shipDate":{
"type":"string",
"description":"Ship date"
},
"carrier":{
"type":"string",
"description":"Shipment carrier"
},
"trackingNumber":{
"type":"string",
"description":"Tracking number"
}
}
}
},
"orderProducts":{
"type":"array",
"description":"Contains detailed information for the items contained within each purchased product.",
"items":{
"id":"<orderProductId>",
"type":"object",
"description":"Contains a detailed summary of each item and it's status",
"properties":{
"orderProductId":{
"type":"int",
"description":"Unique id for this product in this order"
},
"spin":{
"type":"string",
"description":"Shapeways Product Identification Number"
},
"productTitle":{
"type":"string",
"description":"Product title at the time of purchase"
},
"optionId":{
"type":"int",
"description":"Unique id for this product in its purchased option"
},
"optionDescription":{
"type":"int",
"description":"Name of this item in its ordered material and variant options"
},
"quantity":{
"type":"int",
"description":"Total quantity of this product purchased in this order"
},
"models":{
"type":"array",
"description":"Contains detailed information for each model in the purchased product",
"items":{
"type":"object",
"description":"3D printed models in your ordered product",
"properties":{
"modelId":{
"type":"int",
"description":"Model id"
},
"materialId":{
"type":"int",
"description":"Material id"
},
"title":{
"type":"int",
"description":"The title of the model at time of purchase"
}
}
}
}
}
}
}
}
} |
nextActionSuggestions | object | Suggestions for next actions |
firstName | string | required | First name for shipping address |
lastName | string | required | Last name for shipping address |
country | string | required | Shipping address country name or 2-letter code (ISO 3166) |
state | string | required | Shipping address state or region. In the US, must be the 2-letter abbreviation. |
city | string | required | Shipping address city name |
address1 | string | required | Shipping address line 1 |
address2 | string | optional | Shipping address line 2 |
address3 | string | optional | Shipping address line 3 |
zipCode | string | required | Shipping address zip code |
phoneNumber | string | required | Customer phone number. Must be 10 digits in the US and CA |
items | array | required |
Set of items in your order {
"type":"object",
"description":"Item in your order",
"properties":{
"modelId":{
"type":"int",
"description":"Model id"
},
"materialId":{
"type":"int",
"description":"Material id"
},
"quantity":{
"type":"int",
"description":"Quantity of models in this material"
}
}
} |
incentives | array | optional |
Set of incentives to apply to the order {
"type":"string",
"description":"Incentive code"
} |
paymentVerificationId | string | required | Shapeways-issued id to authorize payments for your app |
paymentMethod | string | required |
Payment method for this order - credit_card - use the credit card you have on file with shapeways to process this order |
shippingOption | string | required |
Shipping option for this order - Cheapest - use the cheapest shipping option available |
metadata | array | optional |
metadata {
"type":"object",
"description":"Metadata can only be used by certain applications.",
"properties":{
"modelId":{
"type":"int",
"description":"Model id"
},
"name":{
"type":"string",
"description":"Metadata Name"
},
"value":{
"type":"string",
"description":"Metadata value"
}
}
} |
result | string | A 'result' field stating 'success' |
orderId | int | Id of the order that was created |
productionOrderIds | array |
Set of production order ids {
"type":"int",
"description":"Production Order Id"
} |
nextActionSuggestions | object | Suggestions for next actions |
orderIds | string | optional | Filter by order ids provided for the order |
orderId | string | optional | Filter by the order id provided for the order |
firstName | string | optional | Filter by first name on the address that was used to place the order |
lastName | string | optional | Filter by last name on the address that was used to place the order |
country | string | optional | Filter by country on the address that was used to place the order |
state | string | optional | Filter by region on the address that was used to place the order |
city | string | optional | Filter by city on the address that was used to place the order |
address1 | string | optional | Filter by address street (line 1) on the address that was used to place the order |
address2 | string | optional | Filter by address street (line 2) on the address that was used to place the order |
address3 | string | optional | Filter by address street (line 3) on the address that was used to place the order |
zipCode | string | optional | Filter by zip code on the address that was used to place the order |
phoneNumber | string | optional | Filter by phone number used to place the order |
string | optional | Filter by email used to place the order | |
limit | int | optional |
Limits the number of orders returned. Limit cannot exceed 100 - Default: 20 |
result | string | A 'result' field stating 'success' |
ordersCount | object |
Contains a summary of the number of orders classified by status {
"total":{
"type":"int",
"description":"Total number of orders"
},
"placed":{
"type":"int",
"description":"Number of orders placed"
},
"in_production":{
"type":"int",
"description":"Number of orders in production"
},
"cancelled":{
"type":"int",
"description":"Number of orders cancelled"
},
"unknown":{
"type":"int",
"description":"Number of orders in an unknown status"
},
"shipped":{
"type":"int",
"description":"Number of orders shipped"
}
} |
ordersStatus | json_object | Contains a detailed summary of each order and it's status |
ordersInfo | array |
Contains target ship date, target delivery date and shipments for each order {
"id":"<orderId>",
"type":"object",
"description":"Contains target ship date, target delivery date and shipments for each order",
"properties":{
"orderId":{
"type":"int",
"description":"Order id"
},
"targetDeliveryDate":{
"type":"string",
"description":"Target delivery date"
},
"targetShipDate":{
"type":"string",
"description":"Target to ship date"
},
"shipments":{
"type":"array",
"description":"Shipments for this order",
"items":{
"id":"<shipmentId>",
"type":"object",
"description":"Shipment Information",
"properties":{
"shipmentId":{
"type":"int",
"description":"Shipment id"
},
"shipDate":{
"type":"string",
"description":"Ship date"
},
"carrier":{
"type":"string",
"description":"Shipment carrier"
},
"trackingNumber":{
"type":"string",
"description":"Tracking number"
}
}
}
},
"orderProducts":{
"type":"array",
"description":"Contains detailed information for the items contained within each purchased product.",
"items":{
"id":"<orderProductId>",
"type":"object",
"description":"Contains a detailed summary of each item and it's status",
"properties":{
"orderProductId":{
"type":"int",
"description":"Unique id for this product in this order"
},
"spin":{
"type":"string",
"description":"Shapeways Product Identification Number"
},
"productTitle":{
"type":"string",
"description":"Product title at the time of purchase"
},
"optionId":{
"type":"int",
"description":"Unique id for this product in its purchased option"
},
"optionDescription":{
"type":"int",
"description":"Name of this item in its ordered material and variant options"
},
"quantity":{
"type":"int",
"description":"Total quantity of this product purchased in this order"
},
"models":{
"type":"array",
"description":"Contains detailed information for each model in the purchased product",
"items":{
"type":"object",
"description":"3D printed models in your ordered product",
"properties":{
"modelId":{
"type":"int",
"description":"Model id"
},
"materialId":{
"type":"int",
"description":"Material id"
},
"title":{
"type":"int",
"description":"The title of the model at time of purchase"
}
}
}
}
}
}
}
}
} |
nextActionSuggestions | object | Suggestions for next actions |
orderId | int | required | The existing order id |
status | string | required |
Desired order status - cancelled - update the status of this order to cancelled |
result | string | A 'result' field stating 'success' |
orderId | int | Id of the order that was canceled |
nextActionSuggestions | object | Suggestions for next actions |
orderProductId | int | required | Id of order product to be reprinted |
reprintReasonId | int | required | Reason why order needs to be reprinted |
reprintComment | string | required | Comment explaining the reason for reprinting |
quantity | int | required | Quantity of order product to be reprinted |
result | string | A 'result' field stating 'success' |
orderId | int | Id of the order that was created for reprinting |
nextActionSuggestions | object | Suggestions for next actions |
spin | string | required | spin |
customParams | object |
Parameters available for Custom Products {
"text":{
"type":"string",
"description":"Text for customization"
},
"picture":{
"type":"string",
"description":"Picture data for customization",
"encoding":"base64"
},
"pictureName":{
"type":"string",
"description":"Picture file name for customization. Required when picture is set."
}
} |
result | string | A 'result' field stating 'success' |
spin | string | Spin for customized product |
modelId | int | Model id of the customized model |
nextActionSuggestions | object | Suggestions for next actions |