ReferenceΒΆ
ERP Module API documentation
Base URL: https://erp.authentise.com
Overview
The ERP Module enables enterprises to plan resources such as printers and post-processing devices to service customer needs. This includes management of printers and their locations, supplies of different material stocks and automatically matching up customer orders with devices that can service those orders and batching the orders together for efficient utilization of resources
/about/
Get information about the service like the current version. Useful for testing the service is 'up'
Get service metadata
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| version | string |
The current version of the service Example: "1.4"
|
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
/bureau/
Administer information about a bureau. Most users of the ERP module will want to first register a bureau as most other resources in the system expect to take a bureau as a parameter. A bureau is what customers will see when placing orders - in order to generate an order in the system they must indicate which bureau should fulfill the order
Bureaus require a group URI that ties the bureau to a group in the user system. Members of that group will be able to make changes to the bureau and service requests on the bureau
List all of the bureaus in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| user | string |
The URI of the user making the bureau. |
| name | string |
The name of the bureau. |
| description | string |
The description of the bureau. |
| uri | URI |
The URI of the bureau. |
| group | URL |
The URI of the user group that will get access to orders from the bureau. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested bureau cannot be found. |
Create a new bureau.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| user | string |
The URI of the user making the bureau. Default: None |
| name | string |
The name of the bureau. Required |
| description | string |
The description of the bureau. Default: None |
| uri | URI |
The URI of the bureau. Default: None |
| group | URL |
The URI of the user group that will get access to orders from the bureau. Required |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested bureau cannot be found. |
/bureau/{uuid}/
Administer information about a bureau. Most users of the ERP module will want to first register a bureau as most other resources in the system expect to take a bureau as a parameter. A bureau is what customers will see when placing orders - in order to generate an order in the system they must indicate which bureau should fulfill the order
Bureaus require a group URI that ties the bureau to a group in the user system. Members of that group will be able to make changes to the bureau and service requests on the bureau
Get a single bureau by UUID.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| user | string |
The URI of the user making the bureau. |
| name | string |
The name of the bureau. |
| description | string |
The description of the bureau. |
| uri | URI |
The URI of the bureau. |
| group | URL |
The URI of the user group that will get access to orders from the bureau. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested bureau cannot be found. |
/currency-conversion/
Currency Conversion is an endpoint which works with /material/ and /shipping/. Once an order has a currency specified, we will be able to calculate the material cost and shipping cost for a bureau and currency mentioned in the order.
List all of the currency conversion in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| value | float |
The currency conversion value for a particular currency and bureau. |
| bureau | URI |
The URI of the bureau for which we have the currency-conversion value. |
| uri | URI |
The URI for currency conversion. |
| currency | string |
Currency abbreviation. Select from the choices ['JPY', 'USN', 'XBD', 'THB', 'SLL', 'RON', 'SBD', 'EEK', 'XFU', 'GMD', 'CDF', 'YER', 'PYG', 'RWF', 'AZN', 'BND', 'LKR', 'KMF', 'LRD', 'XPT', 'TWD', 'GBP', 'UGX', 'USD', 'XAG', 'XBC', 'BZD', 'TMM', 'BBD', 'CHF', 'BSD', 'KPW', 'CHW', 'CVE', 'PEN', 'ANG', 'DZD', 'SDG', 'PKR', 'LBP', 'MOP', 'CZK', 'SCR', 'LAK', 'NOK', 'BRL', 'CUP', 'CAD', 'UAH', 'FKP', 'XAU', 'SRD', 'TTD', 'EGP', 'BHD', 'BGN', 'BOB', 'PGK', 'ZWD', 'XBB', 'KYD', 'CYP', 'LVL', 'TRY', 'ISK', 'IDR', 'AMD', 'SHP', 'XTS', 'ZAR', 'ZMK', 'VUV', 'MWK', 'TND', 'SOS', 'RSD', 'MVR', 'NGN', 'SAR', 'STD', 'HRK', 'CLP', 'AOA', 'MTL', 'WST', 'EUR', 'TOP', 'QAR', 'PLN', 'NAD', 'SEK', 'BIF', 'XPD', 'HUF', 'KHR', 'BMD', 'ILS', 'GIP', 'GEL', 'BAM', 'NIO', 'BWP', 'MUR', 'XOF', 'INR', 'UYU', 'MMK', 'HKD', 'KRW', 'KZT', 'ETB', 'CNY', 'MGA', 'IRR', 'MKD', 'MDL', 'JMD', 'SYP', 'NZD', 'XAF', 'BOV', 'AUD', 'IQD', 'MYR', 'ALL', 'MXV', 'AFN', 'OMR', 'DOP', 'NPR', 'FJD', 'CLF', 'MAD', 'PAB', 'XPF', 'LYD', 'DKK', 'XXX', 'UZS', 'HTG', 'SGD', 'TJS', 'PHP', 'XDR', 'AWG', 'DJF', 'GNF', 'KGS', 'USS', 'BTN', 'LTL', 'XCD', 'AED', 'RUB', 'TZS', 'COP', 'UYI', 'MXN', 'ARS', 'GTQ', 'GHS', 'CRC', 'VEF', 'CHE', 'XBA', 'MZN', 'KWD', 'GYD', 'JOD', 'KES', 'HNL', 'MNT', 'BDT', 'SVC', 'MRO', 'COU', 'ERN', 'VND', 'BYR', 'SZL', 'XFO', 'LSL'] Choices
"JPY|USN|XBD|THB|SLL|RON|SBD|EEK|XFU|GMD|CDF|YER|PYG|RWF|AZN|BND|LKR|KMF|LRD|XPT|TWD|GBP|UGX|USD|XAG|XBC|BZD|TMM|BBD|CHF|BSD|KPW|CHW|CVE|PEN|ANG|DZD|SDG|PKR|LBP|MOP|CZK|SCR|LAK|NOK|BRL|CUP|CAD|UAH|FKP|XAU|SRD|TTD|EGP|BHD|BGN|BOB|PGK|ZWD|XBB|KYD|CYP|LVL|TRY|ISK|IDR|AMD|SHP|XTS|ZAR|ZMK|VUV|MWK|TND|SOS|RSD|MVR|NGN|SAR|STD|HRK|CLP|AOA|MTL|WST|EUR|TOP|QAR|PLN|NAD|SEK|BIF|XPD|HUF|KHR|BMD|ILS|GIP|GEL|BAM|NIO|BWP|MUR|XOF|INR|UYU|MMK|HKD|KRW|KZT|ETB|CNY|MGA|IRR|MKD|MDL|JMD|SYP|NZD|XAF|BOV|AUD|IQD|MYR|ALL|MXV|AFN|OMR|DOP|NPR|FJD|CLF|MAD|PAB|XPF|LYD|DKK|XXX|UZS|HTG|SGD|TJS|PHP|XDR|AWG|DJF|GNF|KGS|USS|BTN|LTL|XCD|AED|RUB|TZS|COP|UYI|MXN|ARS|GTQ|GHS|CRC|VEF|CHE|XBA|MZN|KWD|GYD|JOD|KES|HNL|MNT|BDT|SVC|MRO|COU|ERN|VND|BYR|SZL|XFO|LSL"
|
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
A currency-conversion with this bureau and currency already exists. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested currency-conversion cannot be found. |
Create a new currency conversion.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| value | float |
The currency conversion value for a particular currency and bureau. Required |
| bureau | URI |
The URI of the bureau for which we have the currency-conversion value. Required |
| uri | URI |
The URI for currency conversion. Default: None |
| currency | string |
Currency abbreviation. Select from the choices ['JPY', 'USN', 'XBD', 'THB', 'SLL', 'RON', 'SBD', 'EEK', 'XFU', 'GMD', 'CDF', 'YER', 'PYG', 'RWF', 'AZN', 'BND', 'LKR', 'KMF', 'LRD', 'XPT', 'TWD', 'GBP', 'UGX', 'USD', 'XAG', 'XBC', 'BZD', 'TMM', 'BBD', 'CHF', 'BSD', 'KPW', 'CHW', 'CVE', 'PEN', 'ANG', 'DZD', 'SDG', 'PKR', 'LBP', 'MOP', 'CZK', 'SCR', 'LAK', 'NOK', 'BRL', 'CUP', 'CAD', 'UAH', 'FKP', 'XAU', 'SRD', 'TTD', 'EGP', 'BHD', 'BGN', 'BOB', 'PGK', 'ZWD', 'XBB', 'KYD', 'CYP', 'LVL', 'TRY', 'ISK', 'IDR', 'AMD', 'SHP', 'XTS', 'ZAR', 'ZMK', 'VUV', 'MWK', 'TND', 'SOS', 'RSD', 'MVR', 'NGN', 'SAR', 'STD', 'HRK', 'CLP', 'AOA', 'MTL', 'WST', 'EUR', 'TOP', 'QAR', 'PLN', 'NAD', 'SEK', 'BIF', 'XPD', 'HUF', 'KHR', 'BMD', 'ILS', 'GIP', 'GEL', 'BAM', 'NIO', 'BWP', 'MUR', 'XOF', 'INR', 'UYU', 'MMK', 'HKD', 'KRW', 'KZT', 'ETB', 'CNY', 'MGA', 'IRR', 'MKD', 'MDL', 'JMD', 'SYP', 'NZD', 'XAF', 'BOV', 'AUD', 'IQD', 'MYR', 'ALL', 'MXV', 'AFN', 'OMR', 'DOP', 'NPR', 'FJD', 'CLF', 'MAD', 'PAB', 'XPF', 'LYD', 'DKK', 'XXX', 'UZS', 'HTG', 'SGD', 'TJS', 'PHP', 'XDR', 'AWG', 'DJF', 'GNF', 'KGS', 'USS', 'BTN', 'LTL', 'XCD', 'AED', 'RUB', 'TZS', 'COP', 'UYI', 'MXN', 'ARS', 'GTQ', 'GHS', 'CRC', 'VEF', 'CHE', 'XBA', 'MZN', 'KWD', 'GYD', 'JOD', 'KES', 'HNL', 'MNT', 'BDT', 'SVC', 'MRO', 'COU', 'ERN', 'VND', 'BYR', 'SZL', 'XFO', 'LSL'] Required Choices
"JPY|USN|XBD|THB|SLL|RON|SBD|EEK|XFU|GMD|CDF|YER|PYG|RWF|AZN|BND|LKR|KMF|LRD|XPT|TWD|GBP|UGX|USD|XAG|XBC|BZD|TMM|BBD|CHF|BSD|KPW|CHW|CVE|PEN|ANG|DZD|SDG|PKR|LBP|MOP|CZK|SCR|LAK|NOK|BRL|CUP|CAD|UAH|FKP|XAU|SRD|TTD|EGP|BHD|BGN|BOB|PGK|ZWD|XBB|KYD|CYP|LVL|TRY|ISK|IDR|AMD|SHP|XTS|ZAR|ZMK|VUV|MWK|TND|SOS|RSD|MVR|NGN|SAR|STD|HRK|CLP|AOA|MTL|WST|EUR|TOP|QAR|PLN|NAD|SEK|BIF|XPD|HUF|KHR|BMD|ILS|GIP|GEL|BAM|NIO|BWP|MUR|XOF|INR|UYU|MMK|HKD|KRW|KZT|ETB|CNY|MGA|IRR|MKD|MDL|JMD|SYP|NZD|XAF|BOV|AUD|IQD|MYR|ALL|MXV|AFN|OMR|DOP|NPR|FJD|CLF|MAD|PAB|XPF|LYD|DKK|XXX|UZS|HTG|SGD|TJS|PHP|XDR|AWG|DJF|GNF|KGS|USS|BTN|LTL|XCD|AED|RUB|TZS|COP|UYI|MXN|ARS|GTQ|GHS|CRC|VEF|CHE|XBA|MZN|KWD|GYD|JOD|KES|HNL|MNT|BDT|SVC|MRO|COU|ERN|VND|BYR|SZL|XFO|LSL"
|
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 400 |
A currency-conversion with this bureau and currency already exists. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested currency-conversion cannot be found. |
/currency-conversion/{uuid}/
Currency Conversion is an endpoint which works with /material/ and /shipping/. Once an order has a currency specified, we will be able to calculate the material cost and shipping cost for a bureau and currency mentioned in the order.
Get an individual currency conversion resource by UUID.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| value | float |
The currency conversion value for a particular currency and bureau. |
| bureau | URI |
The URI of the bureau for which we have the currency-conversion value. |
| uri | URI |
The URI for currency conversion. |
| currency | string |
Currency abbreviation. Select from the choices ['JPY', 'USN', 'XBD', 'THB', 'SLL', 'RON', 'SBD', 'EEK', 'XFU', 'GMD', 'CDF', 'YER', 'PYG', 'RWF', 'AZN', 'BND', 'LKR', 'KMF', 'LRD', 'XPT', 'TWD', 'GBP', 'UGX', 'USD', 'XAG', 'XBC', 'BZD', 'TMM', 'BBD', 'CHF', 'BSD', 'KPW', 'CHW', 'CVE', 'PEN', 'ANG', 'DZD', 'SDG', 'PKR', 'LBP', 'MOP', 'CZK', 'SCR', 'LAK', 'NOK', 'BRL', 'CUP', 'CAD', 'UAH', 'FKP', 'XAU', 'SRD', 'TTD', 'EGP', 'BHD', 'BGN', 'BOB', 'PGK', 'ZWD', 'XBB', 'KYD', 'CYP', 'LVL', 'TRY', 'ISK', 'IDR', 'AMD', 'SHP', 'XTS', 'ZAR', 'ZMK', 'VUV', 'MWK', 'TND', 'SOS', 'RSD', 'MVR', 'NGN', 'SAR', 'STD', 'HRK', 'CLP', 'AOA', 'MTL', 'WST', 'EUR', 'TOP', 'QAR', 'PLN', 'NAD', 'SEK', 'BIF', 'XPD', 'HUF', 'KHR', 'BMD', 'ILS', 'GIP', 'GEL', 'BAM', 'NIO', 'BWP', 'MUR', 'XOF', 'INR', 'UYU', 'MMK', 'HKD', 'KRW', 'KZT', 'ETB', 'CNY', 'MGA', 'IRR', 'MKD', 'MDL', 'JMD', 'SYP', 'NZD', 'XAF', 'BOV', 'AUD', 'IQD', 'MYR', 'ALL', 'MXV', 'AFN', 'OMR', 'DOP', 'NPR', 'FJD', 'CLF', 'MAD', 'PAB', 'XPF', 'LYD', 'DKK', 'XXX', 'UZS', 'HTG', 'SGD', 'TJS', 'PHP', 'XDR', 'AWG', 'DJF', 'GNF', 'KGS', 'USS', 'BTN', 'LTL', 'XCD', 'AED', 'RUB', 'TZS', 'COP', 'UYI', 'MXN', 'ARS', 'GTQ', 'GHS', 'CRC', 'VEF', 'CHE', 'XBA', 'MZN', 'KWD', 'GYD', 'JOD', 'KES', 'HNL', 'MNT', 'BDT', 'SVC', 'MRO', 'COU', 'ERN', 'VND', 'BYR', 'SZL', 'XFO', 'LSL'] Choices
"JPY|USN|XBD|THB|SLL|RON|SBD|EEK|XFU|GMD|CDF|YER|PYG|RWF|AZN|BND|LKR|KMF|LRD|XPT|TWD|GBP|UGX|USD|XAG|XBC|BZD|TMM|BBD|CHF|BSD|KPW|CHW|CVE|PEN|ANG|DZD|SDG|PKR|LBP|MOP|CZK|SCR|LAK|NOK|BRL|CUP|CAD|UAH|FKP|XAU|SRD|TTD|EGP|BHD|BGN|BOB|PGK|ZWD|XBB|KYD|CYP|LVL|TRY|ISK|IDR|AMD|SHP|XTS|ZAR|ZMK|VUV|MWK|TND|SOS|RSD|MVR|NGN|SAR|STD|HRK|CLP|AOA|MTL|WST|EUR|TOP|QAR|PLN|NAD|SEK|BIF|XPD|HUF|KHR|BMD|ILS|GIP|GEL|BAM|NIO|BWP|MUR|XOF|INR|UYU|MMK|HKD|KRW|KZT|ETB|CNY|MGA|IRR|MKD|MDL|JMD|SYP|NZD|XAF|BOV|AUD|IQD|MYR|ALL|MXV|AFN|OMR|DOP|NPR|FJD|CLF|MAD|PAB|XPF|LYD|DKK|XXX|UZS|HTG|SGD|TJS|PHP|XDR|AWG|DJF|GNF|KGS|USS|BTN|LTL|XCD|AED|RUB|TZS|COP|UYI|MXN|ARS|GTQ|GHS|CRC|VEF|CHE|XBA|MZN|KWD|GYD|JOD|KES|HNL|MNT|BDT|SVC|MRO|COU|ERN|VND|BYR|SZL|XFO|LSL"
|
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
A currency-conversion with this bureau and currency already exists. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested currency-conversion cannot be found. |
/location/
Locations are normally set up shortly after a bureau. This is because several other resources need to have a location defined
in order to create them such as printers. The location identifies an office where a bureau might maintain stock or process
orders from customers or ship out finished goods.
List all of the locations in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| bureau | URI |
The URI of the bureau. |
| name | string |
The name of the location. |
| contact | URL |
The URI of the user that will be the contact of the location. |
| address | string |
The address of the location. |
| group | string |
The URI of the user group. |
| uri | URI |
The URI of the location. |
| phone | string |
The phone of the location. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
You cannot change a location's group. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested location cannot be found. |
Create a new location.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| bureau | URI |
The URI of the bureau. Required |
| name | string |
The name of the location. Required |
| contact | URL |
The URI of the user that will be the contact of the location. Required |
| address | string |
The address of the location. Required |
| group | string |
The URI of the user group. Default: None |
| uri | URI |
The URI of the location. Default: None |
| phone | string |
The phone of the location. Required |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 400 |
You cannot change a location's group. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested location cannot be found. |
/location/{uuid}/
Locations are normally set up shortly after a bureau. This is because several other resources need to have a location defined
in order to create them such as printers. The location identifies an office where a bureau might maintain stock or process
orders from customers or ship out finished goods.
Get a single location by UUID.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| bureau | URI |
The URI of the bureau. |
| name | string |
The name of the location. |
| contact | URL |
The URI of the user that will be the contact of the location. |
| address | string |
The address of the location. |
| group | string |
The URI of the user group. |
| uri | URI |
The URI of the location. |
| phone | string |
The phone of the location. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
You cannot change a location's group. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested location cannot be found. |
/manufacturer/
A manufacturer represents an organization that creates a printer. This allows the system to keep track of what organization makes the printer to group printers with similar capabilities, support contracts and sales contacts together for convenience
List all of the manufacturers in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| bureau | URI |
The URI of the bureau for the manufacturer. |
| uri | URI |
The URI of the manufacturer. |
| name | string |
The name of the manufacturer. |
| contact | object |
The user that will be the contact of the manufacturer. Example: {}
|
| support | object |
The user that will be the support contact of the manufacturer. Example: {}
|
| address | string |
The address of the manufacturer. |
| notes | string |
Notes about manufacturer. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
The requested manufacturer name already exists. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested manufacturer cannot be found. |
Create a new manufacturer.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| bureau | URI |
The URI of the bureau for the manufacturer. Required |
| uri | URI |
The URI of the manufacturer. Default: None |
| name | string |
The name of the manufacturer. Required |
| contact | object |
The user that will be the contact of the manufacturer. Required Example: {}
|
| support | object |
The user that will be the support contact of the manufacturer. Required Example: {}
|
| address | string |
The address of the manufacturer. Required |
| notes | string |
Notes about manufacturer. Required |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 400 |
The requested manufacturer name already exists. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested manufacturer cannot be found. |
/manufacturer/{uuid}/
A manufacturer represents an organization that creates a printer. This allows the system to keep track of what organization makes the printer to group printers with similar capabilities, support contracts and sales contacts together for convenience
Get a single manufacturer by UUID.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| bureau | URI |
The URI of the bureau for the manufacturer. |
| uri | URI |
The URI of the manufacturer. |
| name | string |
The name of the manufacturer. |
| contact | object |
The user that will be the contact of the manufacturer. Example: {}
|
| support | object |
The user that will be the support contact of the manufacturer. Example: {}
|
| address | string |
The address of the manufacturer. |
| notes | string |
Notes about manufacturer. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
The requested manufacturer name already exists. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested manufacturer cannot be found. |
/material/
A material resource represents some kind of product that can be used to create digitally manufactured goods. This includes thermoplastics, metal powders, foundry sand, etc. Any material that may be used to produce parts. The material resource is then used to identify capabilities that printers have as well as allow users to define what material they would like their finished products to be made from.
Material can also be used in tracking stock usage and supply
List all of the materials in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| type | string |
Type of the material. Choices
"support|base"
|
| bureau | URI |
The URI of the material's bureau. |
| third_party_fulfillment | boolean |
Post processing of the material in seconds. Choices
"True|False"
|
| cost | float |
The cost of the material per cc. |
| description | string |
Description of the material. |
| name | string |
Name of the material. |
| thumbnail | object |
none available Example: {}
|
| color | string |
HEX Color of the material. Example: (#000000) |
| manufacturer | URI |
The URI of the material's manufacturer. |
| post_processing_seconds | integer |
Post processing of the material in seconds. |
| uri | URI |
The URI of the material. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
The provided color is not valid hex color. Example: #FF00FF You cannot delete this material because there are stocks or orders associated with it. Delete all orders and stocks using this material first. There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested material cannot be found. |
Create a new material.
After a new material is created a X-Upload-Location header will be returned. Using this allows us to upload a thumbnail for the material that was created. Use the X-Upload-Location header to PUT file contents to that location.
Example:
curl -X PUT -H 'Content-Type: image/png' --data-binary '@PATH-TO-YOUR-PNG' "<HEADER X-UPLOAD-LOCATION>"
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| type | string |
Type of the material. Required Choices
"support|base"
|
| bureau | URI |
The URI of the material's bureau. Required |
| third_party_fulfillment | boolean |
Post processing of the material in seconds. Required Choices
"True|False"
|
| cost | float |
The cost of the material per cc. Required |
| description | string |
Description of the material. Required |
| name | string |
Name of the material. Required |
| thumbnail | object |
none available Default: NoneExample: {}
|
| color | string |
HEX Color of the material. Example: (#000000) Required |
| manufacturer | URI |
The URI of the material's manufacturer. Required |
| post_processing_seconds | integer |
Post processing of the material in seconds. Required |
| uri | URI |
The URI of the material. Default: None |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 400 |
The provided color is not valid hex color. Example: #FF00FF You cannot delete this material because there are stocks or orders associated with it. Delete all orders and stocks using this material first. There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested material cannot be found. |
/material/{uuid}/
A material resource represents some kind of product that can be used to create digitally manufactured goods. This includes thermoplastics, metal powders, foundry sand, etc. Any material that may be used to produce parts. The material resource is then used to identify capabilities that printers have as well as allow users to define what material they would like their finished products to be made from.
Material can also be used in tracking stock usage and supply
Get a single material by UUID.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| type | string |
Type of the material. Choices
"support|base"
|
| bureau | URI |
The URI of the material's bureau. |
| third_party_fulfillment | boolean |
Post processing of the material in seconds. Choices
"True|False"
|
| cost | float |
The cost of the material per cc. |
| description | string |
Description of the material. |
| name | string |
Name of the material. |
| thumbnail | object |
none available Example: {}
|
| color | string |
HEX Color of the material. Example: (#000000) |
| manufacturer | URI |
The URI of the material's manufacturer. |
| post_processing_seconds | integer |
Post processing of the material in seconds. |
| uri | URI |
The URI of the material. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
The provided color is not valid hex color. Example: #FF00FF You cannot delete this material because there are stocks or orders associated with it. Delete all orders and stocks using this material first. There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested material cannot be found. |
/order-comment/
List all of the comments in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| user | URL |
The URI of the user who created the comment. |
| content | string |
The comment. |
| public | boolean |
The type of the comment. Choices
"True|False"
|
| created | iso-8601 datetime |
The date the comment was created. |
| order | URI |
The URI of the order that this comment is about. |
| uri | URI |
The URI of the comment. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 404 |
The requested comment cannot be found. |
Create a new comment.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| user | URL |
The URI of the user who created the comment. Default: None |
| content | string |
The comment. Required |
| public | boolean |
The type of the comment. Default: FalseChoices
"True|False"
|
| created | iso-8601 datetime |
The date the comment was created. Default: None |
| order | URI |
The URI of the order that this comment is about. Default: None |
| uri | URI |
The URI of the comment. Default: None |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 404 |
The requested comment cannot be found. |
/order-comment/{uuid}/
Get a single comment by UUID.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| user | URL |
The URI of the user who created the comment. |
| content | string |
The comment. |
| public | boolean |
The type of the comment. Choices
"True|False"
|
| created | iso-8601 datetime |
The date the comment was created. |
| order | URI |
The URI of the order that this comment is about. |
| uri | URI |
The URI of the comment. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 404 |
The requested comment cannot be found. |
/order/
List all of the order in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| third_party_provider | URI |
The URI of third party. |
| quantity | integer |
The number of objects to produce. |
| bureau | URI |
The URI of the bureau. |
| currency | string |
The currency of the order. Choices
"JPY|USN|XBD|THB|SLL|RON|SBD|EEK|XFU|GMD|CDF|YER|PYG|RWF|AZN|BND|LKR|KMF|LRD|XPT|TWD|GBP|UGX|USD|XAG|XBC|BZD|TMM|BBD|CHF|BSD|KPW|CHW|CVE|PEN|ANG|DZD|SDG|PKR|LBP|MOP|CZK|SCR|LAK|NOK|BRL|CUP|CAD|UAH|FKP|XAU|SRD|TTD|EGP|BHD|BGN|BOB|PGK|ZWD|XBB|KYD|CYP|LVL|TRY|ISK|IDR|AMD|SHP|XTS|ZAR|ZMK|VUV|MWK|TND|SOS|RSD|MVR|NGN|SAR|STD|HRK|CLP|AOA|MTL|WST|EUR|TOP|QAR|PLN|NAD|SEK|BIF|XPD|HUF|KHR|BMD|ILS|GIP|GEL|BAM|NIO|BWP|MUR|XOF|INR|UYU|MMK|HKD|KRW|KZT|ETB|CNY|MGA|IRR|MKD|MDL|JMD|SYP|NZD|XAF|BOV|AUD|IQD|MYR|ALL|MXV|AFN|OMR|DOP|NPR|FJD|CLF|MAD|PAB|XPF|LYD|DKK|XXX|UZS|HTG|SGD|TJS|PHP|XDR|AWG|DJF|GNF|KGS|USS|BTN|LTL|XCD|AED|RUB|TZS|COP|UYI|MXN|ARS|GTQ|GHS|CRC|VEF|CHE|XBA|MZN|KWD|GYD|JOD|KES|HNL|MNT|BDT|SVC|MRO|COU|ERN|VND|BYR|SZL|XFO|LSL"
|
| estimates | object |
none available Example: {"cost": {}, "materials": {}}
|
| created | iso-8601 datetime |
The date the order was created. |
| model | URL |
The URI of the order's model. |
| materials | object |
none available Example: {}
|
| name | string |
Name of the order. |
| shipping | object |
none available Example: {}
|
| uri | URI |
The URI of the order. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
The quantity value is too high The model does not seem printable An order with active prints cannot be deleted |
| 404 |
The requested order cannot be found. |
Create a new order.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| third_party_provider | URI |
The URI of third party. Default: None |
| quantity | integer |
The number of objects to produce. Required |
| bureau | URI |
The URI of the bureau. Required |
| currency | string |
The currency of the order. Required Choices
"JPY|USN|XBD|THB|SLL|RON|SBD|EEK|XFU|GMD|CDF|YER|PYG|RWF|AZN|BND|LKR|KMF|LRD|XPT|TWD|GBP|UGX|USD|XAG|XBC|BZD|TMM|BBD|CHF|BSD|KPW|CHW|CVE|PEN|ANG|DZD|SDG|PKR|LBP|MOP|CZK|SCR|LAK|NOK|BRL|CUP|CAD|UAH|FKP|XAU|SRD|TTD|EGP|BHD|BGN|BOB|PGK|ZWD|XBB|KYD|CYP|LVL|TRY|ISK|IDR|AMD|SHP|XTS|ZAR|ZMK|VUV|MWK|TND|SOS|RSD|MVR|NGN|SAR|STD|HRK|CLP|AOA|MTL|WST|EUR|TOP|QAR|PLN|NAD|SEK|BIF|XPD|HUF|KHR|BMD|ILS|GIP|GEL|BAM|NIO|BWP|MUR|XOF|INR|UYU|MMK|HKD|KRW|KZT|ETB|CNY|MGA|IRR|MKD|MDL|JMD|SYP|NZD|XAF|BOV|AUD|IQD|MYR|ALL|MXV|AFN|OMR|DOP|NPR|FJD|CLF|MAD|PAB|XPF|LYD|DKK|XXX|UZS|HTG|SGD|TJS|PHP|XDR|AWG|DJF|GNF|KGS|USS|BTN|LTL|XCD|AED|RUB|TZS|COP|UYI|MXN|ARS|GTQ|GHS|CRC|VEF|CHE|XBA|MZN|KWD|GYD|JOD|KES|HNL|MNT|BDT|SVC|MRO|COU|ERN|VND|BYR|SZL|XFO|LSL"
|
| estimates | object |
none available Default: NoneExample: {"cost": {}, "materials": {}}
|
| created | iso-8601 datetime |
The date the order was created. Default: None |
| model | URL |
The URI of the order's model. Required |
| materials | object |
none available Required Example: {}
|
| name | string |
Name of the order. Required |
| shipping | object |
none available Required Example: {}
|
| uri | URI |
The URI of the order. Default: None |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 400 |
The quantity value is too high The model does not seem printable An order with active prints cannot be deleted |
| 404 |
The requested order cannot be found. |
/order//callback/
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| status | string |
none available Required |
| bureau | string |
none available Required |
| model | string |
none available Required |
| callback_url | URL |
none available Required |
| currency | string |
none available Required |
| callback_method | string |
none available Required |
| price | float |
none available Required |
| uri | URL |
none available Required |
| material | string |
none available Required |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested order cannot be found. |
/order/estimate//callback/
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| slicing_uri | URL |
none available Required |
| status | string |
none available Required |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 404 |
The requested order cannot be found. |
/order/{uuid}/
Get a single order by UUID.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| third_party_provider | URI |
The URI of third party. |
| quantity | integer |
The number of objects to produce. |
| bureau | URI |
The URI of the bureau. |
| currency | string |
The currency of the order. Choices
"JPY|USN|XBD|THB|SLL|RON|SBD|EEK|XFU|GMD|CDF|YER|PYG|RWF|AZN|BND|LKR|KMF|LRD|XPT|TWD|GBP|UGX|USD|XAG|XBC|BZD|TMM|BBD|CHF|BSD|KPW|CHW|CVE|PEN|ANG|DZD|SDG|PKR|LBP|MOP|CZK|SCR|LAK|NOK|BRL|CUP|CAD|UAH|FKP|XAU|SRD|TTD|EGP|BHD|BGN|BOB|PGK|ZWD|XBB|KYD|CYP|LVL|TRY|ISK|IDR|AMD|SHP|XTS|ZAR|ZMK|VUV|MWK|TND|SOS|RSD|MVR|NGN|SAR|STD|HRK|CLP|AOA|MTL|WST|EUR|TOP|QAR|PLN|NAD|SEK|BIF|XPD|HUF|KHR|BMD|ILS|GIP|GEL|BAM|NIO|BWP|MUR|XOF|INR|UYU|MMK|HKD|KRW|KZT|ETB|CNY|MGA|IRR|MKD|MDL|JMD|SYP|NZD|XAF|BOV|AUD|IQD|MYR|ALL|MXV|AFN|OMR|DOP|NPR|FJD|CLF|MAD|PAB|XPF|LYD|DKK|XXX|UZS|HTG|SGD|TJS|PHP|XDR|AWG|DJF|GNF|KGS|USS|BTN|LTL|XCD|AED|RUB|TZS|COP|UYI|MXN|ARS|GTQ|GHS|CRC|VEF|CHE|XBA|MZN|KWD|GYD|JOD|KES|HNL|MNT|BDT|SVC|MRO|COU|ERN|VND|BYR|SZL|XFO|LSL"
|
| estimates | object |
none available Example: {"cost": {}, "materials": {}}
|
| created | iso-8601 datetime |
The date the order was created. |
| model | URL |
The URI of the order's model. |
| materials | object |
none available Example: {}
|
| name | string |
Name of the order. |
| shipping | object |
none available Example: {}
|
| uri | URI |
The URI of the order. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
The quantity value is too high The model does not seem printable An order with active prints cannot be deleted |
| 404 |
The requested order cannot be found. |
/permission-bureau/
A permision bureau record represenst a right that is created for a user on teh bureau. This right such as material.all will allow the user to edit, update, and delete the associated record type. In this case it is material. Creating a record here will grant the user access to perform the associated actions. Deleting will revoke the permission.
List all of the bureau permissions in the system.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| user | string |
User associated to the permission. |
| right | string |
Right for the permission. Choices
"currency_conversion.all|location.all|manufacturer.all|material.all|bureau.permission.all|post_processor_type.all|printer_type.all|service_provider.all|shipping.all|third_party.all"
|
| bureau | URI |
The URI of the bureau. |
| uri | URI |
The URI of the bureau. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
Create a new bureau permission.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| user | string |
User associated to the permission. Required |
| right | string |
Right for the permission. Required Choices
"currency_conversion.all|location.all|manufacturer.all|material.all|bureau.permission.all|post_processor_type.all|printer_type.all|service_provider.all|shipping.all|third_party.all"
|
| bureau | URI |
The URI of the bureau. Required |
| uri | URI |
The URI of the bureau. Default: None |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
/permission-bureau/{uuid}/
A permision bureau record represenst a right that is created for a user on teh bureau. This right such as material.all will allow the user to edit, update, and delete the associated record type. In this case it is material. Creating a record here will grant the user access to perform the associated actions. Deleting will revoke the permission.
Get a single bureau permission.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| user | string |
User associated to the permission. |
| right | string |
Right for the permission. Choices
"currency_conversion.all|location.all|manufacturer.all|material.all|bureau.permission.all|post_processor_type.all|printer_type.all|service_provider.all|shipping.all|third_party.all"
|
| bureau | URI |
The URI of the bureau. |
| uri | URI |
The URI of the bureau. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
/permission-location/
A permision location record represenst a right that is created for a user on teh location. This right such as material.all will allow the user to edit, update, and delete the associated record type. In this case it is material. Creating a record here will grant the user access to perform the associated actions. Deleting will revoke the permission.
List all of the location permissions in the system.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| user | string |
User associated to the permission. |
| right | string |
Right for the permission. Choices
"location.permission.all|post_processor.all|printer.all|stock.all"
|
| location | URI |
The URI of the location. |
| uri | URI |
The URI of the location. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
Create a new location permission.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| user | string |
User associated to the permission. Required |
| right | string |
Right for the permission. Required Choices
"location.permission.all|post_processor.all|printer.all|stock.all"
|
| location | URI |
The URI of the location. Required |
| uri | URI |
The URI of the location. Default: None |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
/permission-location/{uuid}/
A permision location record represenst a right that is created for a user on teh location. This right such as material.all will allow the user to edit, update, and delete the associated record type. In this case it is material. Creating a record here will grant the user access to perform the associated actions. Deleting will revoke the permission.
Get a single location permission.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| user | string |
User associated to the permission. |
| right | string |
Right for the permission. Choices
"location.permission.all|post_processor.all|printer.all|stock.all"
|
| location | URI |
The URI of the location. |
| uri | URI |
The URI of the location. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
/post-processor-type/
Post Process Type helps to track the devices that do post-processing after a print is completed. It will also be used to track types of machines and separately have instances of a given machine in a given location.
List all of the post-processor-types in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| manufacturer | URI |
Manufacturer of the post-processor-type |
| bureau | URI |
Bureau of the post-processor-type |
| description | string |
Description of the post-processor-type. |
| materials | array |
The URI of materials from the manufacturer. Example: ["..."]
|
| name | string |
Name of the post-processor-type. |
| uri | URI |
The URI of the post-processor-type. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau. The value you provided for materials does not appear to be a valid material |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested post-processor-type cannot be found. |
Create a new post-processor-type.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| manufacturer | URI |
Manufacturer of the post-processor-type Required |
| bureau | URI |
Bureau of the post-processor-type Required |
| description | string |
Description of the post-processor-type. Required |
| materials | array |
The URI of materials from the manufacturer. Required Example: ["..."]
|
| name | string |
Name of the post-processor-type. Required |
| uri | URI |
The URI of the post-processor-type. Default: None |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 400 |
There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau. The value you provided for materials does not appear to be a valid material |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested post-processor-type cannot be found. |
/post-processor-type/{uuid}/
Post Process Type helps to track the devices that do post-processing after a print is completed. It will also be used to track types of machines and separately have instances of a given machine in a given location.
Get a single post-processor-type.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| manufacturer | URI |
Manufacturer of the post-processor-type |
| bureau | URI |
Bureau of the post-processor-type |
| description | string |
Description of the post-processor-type. |
| materials | array |
The URI of materials from the manufacturer. Example: ["..."]
|
| name | string |
Name of the post-processor-type. |
| uri | URI |
The URI of the post-processor-type. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau. The value you provided for materials does not appear to be a valid material |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested post-processor-type cannot be found. |
/post-processor/
Post processor is an instance of a particular post-processor. This is normally set up shortly after a
post-processor-type and a valid location is set up. A user who has a permission to add post-processor
for a particular bureau will be able to create an instance of post processor.
List all of the post-processor in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| post_processor_type | URI |
The URI of a valid post-processor-type. |
| queue | array |
Ordered list of run URIs quesed on the post processor. Example: ["..."]
|
| name | string |
The name of the post-processor. |
| location | URI |
The URI of a valid location. |
| uri | URI |
The URI of the post-processor. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
You cannot change the position of an already post processing job. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested post-processor cannot be found. |
Create a new post-processor.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| post_processor_type | URI |
The URI of a valid post-processor-type. Default: None |
| queue | array |
Ordered list of run URIs quesed on the post processor. Default: []Example: ["..."]
|
| name | string |
The name of the post-processor. Required |
| location | URI |
The URI of a valid location. Default: None |
| uri | URI |
The URI of the post-processor. Default: None |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 400 |
You cannot change the position of an already post processing job. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested post-processor cannot be found. |
/post-processor/{uuid}/
Post processor is an instance of a particular post-processor. This is normally set up shortly after a
post-processor-type and a valid location is set up. A user who has a permission to add post-processor
for a particular bureau will be able to create an instance of post processor.
Get a single post-processor by UUID.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| post_processor_type | URI |
The URI of a valid post-processor-type. |
| queue | array |
Ordered list of run URIs quesed on the post processor. Example: ["..."]
|
| name | string |
The name of the post-processor. |
| location | URI |
The URI of a valid location. |
| uri | URI |
The URI of the post-processor. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
You cannot change the position of an already post processing job. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested post-processor cannot be found. |
/print/
List all of the print in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| order | URI |
The URI of print's order. |
| run | URI |
The URI of print's run. |
| status | string |
Status of the print. Choices
"created"
|
| uri | URI |
The URI of the print. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested print cannot be found. |
/print/{uuid}/
Get a single print by UUID.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| order | URI |
The URI of print's order. |
| run | URI |
The URI of print's run. |
| status | string |
Status of the print. Choices
"created"
|
| uri | URI |
The URI of the print. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested print cannot be found. |
/printer-type/
List all of the printer-types in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| type | string |
Type of the printer. |
| manufacturer | URI |
Manufacturer or the printer |
| bureau | URI |
Manufacturer or the printer |
| description | string |
Description of the printer-type. |
| materials | array |
The URI of the material's manufacturer. Example: ["..."]
|
| build_volume | object |
Dimensions of the build volume in millimeters. Example: {}
|
| name | string |
Name of the printer-type. |
| uri | URI |
The URI of the printer-type. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
The requested manufacturer name already exists. You cannot delete this printer_type because there are printers associated with it. Delete all printers of this type first. There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau. The value you provided for materials does not appear to be a valid material |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested manufacturer cannot be found. |
Create a new printer-type.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| type | string |
Type of the printer. Default: None |
| manufacturer | URI |
Manufacturer or the printer Required |
| bureau | URI |
Manufacturer or the printer Default: None |
| description | string |
Description of the printer-type. Required |
| materials | array |
The URI of the material's manufacturer. Required Example: ["..."]
|
| build_volume | object |
Dimensions of the build volume in millimeters. Required Example: {}
|
| name | string |
Name of the printer-type. Required |
| uri | URI |
The URI of the printer-type. Default: None |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 400 |
The requested manufacturer name already exists. You cannot delete this printer_type because there are printers associated with it. Delete all printers of this type first. There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau. The value you provided for materials does not appear to be a valid material |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested manufacturer cannot be found. |
/printer-type/{uuid}/
Get a single printer-type by UUID.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| type | string |
Type of the printer. |
| manufacturer | URI |
Manufacturer or the printer |
| bureau | URI |
Manufacturer or the printer |
| description | string |
Description of the printer-type. |
| materials | array |
The URI of the material's manufacturer. Example: ["..."]
|
| build_volume | object |
Dimensions of the build volume in millimeters. Example: {}
|
| name | string |
Name of the printer-type. |
| uri | URI |
The URI of the printer-type. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
The requested manufacturer name already exists. You cannot delete this printer_type because there are printers associated with it. Delete all printers of this type first. There is a mismatch in the bureau and the bureau of manufacturer in the payload. Kindly make sure the manufacturer belongs to the same bureau. The value you provided for materials does not appear to be a valid material |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested manufacturer cannot be found. |
/printer/
List all of the printer in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| queue | array |
Ordered list of run URIs queued on the printer. Example: ["..."]
|
| printer_type | URI |
The URI of the printer type. |
| description | string |
Description of printer |
| modeler | string |
A URI from the Machine Analytics service for a modeler. This URI will be used to capture updates from Machine Analytics and apply the data to this printer |
| name | string |
Name of the printer. |
| location | URI |
The URI of the printer's location. |
| uri | URI |
The URI of the printer. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
You cannot change the position of an already printing job. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested printer cannot be found. |
Create a new printer.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| queue | array |
Ordered list of run URIs queued on the printer. Default: []Example: ["..."]
|
| printer_type | URI |
The URI of the printer type. Default: None |
| description | string |
Description of printer Default: None |
| modeler | string |
A URI from the Machine Analytics service for a modeler. This URI will be used to capture updates from Machine Analytics and apply the data to this printer Default: None |
| name | string |
Name of the printer. Required |
| location | URI |
The URI of the printer's location. Default: None |
| uri | URI |
The URI of the printer. Default: None |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 400 |
You cannot change the position of an already printing job. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested printer cannot be found. |
/printer/{uuid}/
Get a single printer by UUID.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| queue | array |
Ordered list of run URIs queued on the printer. Example: ["..."]
|
| printer_type | URI |
The URI of the printer type. |
| description | string |
Description of printer |
| modeler | string |
A URI from the Machine Analytics service for a modeler. This URI will be used to capture updates from Machine Analytics and apply the data to this printer |
| name | string |
Name of the printer. |
| location | URI |
The URI of the printer's location. |
| uri | URI |
The URI of the printer. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
You cannot change the position of an already printing job. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested printer cannot be found. |
/run/
Get all of the runs the current user has access to
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| printer_type | URI |
The URI of run's printer type. |
| printer | URI |
The URI of run's printer. |
| estimates | object |
none available Example: {"materials": {}, "time": {}, "queue_delay": {}}
|
| created | iso-8601 datetime |
none available |
| uri | URI |
The URI of the run. |
| actuals | object |
none available Example: {"materials": {}, "time": {}}
|
| prints | array |
The URI of prints in the order. Example: ["..."]
|
| model | URL |
The URI of run's model. |
| id | string |
The identifier for this run. This identifier will be generated when the run is created and should be the name used for the print so the sytem can track it |
| status | string |
Status of the run. Choices
"calculating|calculated|queued|printing|post-processing|complete|error"
|
| layout | URL |
The URI of run's layout. |
| post_processor | URI |
The URI of run's post_processor. |
| error | string |
none available |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 404 |
The requested run cannot be found. |
| 409 |
The requested status transformation is not allowed. |
Create a new run.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| printer_type | URI |
The URI of run's printer type. Required |
| printer | URI |
The URI of run's printer. Default: None |
| estimates | object |
none available Default: NoneExample: {"materials": {}, "time": {}, "queue_delay": {}}
|
| created | iso-8601 datetime |
none available Default: None |
| uri | URI |
The URI of the run. Default: None |
| actuals | object |
none available Default: NoneExample: {"materials": {}, "time": {}}
|
| prints | array |
The URI of prints in the order. Required Example: ["..."]
|
| model | URL |
The URI of run's model. Default: None |
| id | string |
The identifier for this run. This identifier will be generated when the run is created and should be the name used for the print so the sytem can track it Default: None |
| status | string |
Status of the run. Default: NoneChoices
"calculating|calculated|queued|printing|post-processing|complete|error"
|
| layout | URL |
The URI of run's layout. Default: None |
| post_processor | URI |
The URI of run's post_processor. Default: None |
| error | string |
none available Default: None |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 404 |
The requested run cannot be found. |
| 409 |
The requested status transformation is not allowed. |
/run//callback/
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| spacing | float |
none available Required |
| build_y_mm | float |
none available Required |
| build_x_mm | float |
none available Required |
| fill_percentage | float |
none available Required |
| build_z_mm | float |
none available Required |
| callback_method | string |
none available Required |
| status | string |
none available Required |
| build_type | string |
none available Required |
| uri | URL |
none available Required |
| callback_url | URL |
none available Required |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested run cannot be found. Layout for the run does not exist. |
/run/model//callback/
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| callback_method | string |
none available Required |
| merged_model | URL |
none available Required |
| callback_url | URL |
none available Required |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 404 |
The requested run cannot be found. |
/run/{uuid}/
Get a single run by UUID.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| printer_type | URI |
The URI of run's printer type. |
| printer | URI |
The URI of run's printer. |
| estimates | object |
none available Example: {"materials": {}, "time": {}, "queue_delay": {}}
|
| created | iso-8601 datetime |
none available |
| uri | URI |
The URI of the run. |
| actuals | object |
none available Example: {"materials": {}, "time": {}}
|
| prints | array |
The URI of prints in the order. Example: ["..."]
|
| model | URL |
The URI of run's model. |
| id | string |
The identifier for this run. This identifier will be generated when the run is created and should be the name used for the print so the sytem can track it |
| status | string |
Status of the run. Choices
"calculating|calculated|queued|printing|post-processing|complete|error"
|
| layout | URL |
The URI of run's layout. |
| post_processor | URI |
The URI of run's post_processor. |
| error | string |
none available |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 404 |
The requested run cannot be found. |
| 409 |
The requested status transformation is not allowed. |
/service-provider/
ServiceProvider helps to store the 3rd party service provider information.
List all of the service-provider in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| bureau | URI |
The URI of the bureau for service-provider. |
| contact | string |
Contact name for service-provider |
| materials | array |
The URI of materials the service provider wants to work with. Example: ["..."]
|
| address | string |
Address of service-provider |
| name | string |
Name of the service-provider. |
| uri | URI |
The URI of the service-provider. |
| phone | string |
Phone number for service-provider. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested service-provider cannot be found. |
Create a new service-provider.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| bureau | URI |
The URI of the bureau for service-provider. Required |
| contact | string |
Contact name for service-provider Required |
| materials | array |
The URI of materials the service provider wants to work with. Required Example: ["..."]
|
| address | string |
Address of service-provider Required |
| name | string |
Name of the service-provider. Required |
| uri | URI |
The URI of the service-provider. Default: None |
| phone | string |
Phone number for service-provider. Required |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested service-provider cannot be found. |
/service-provider/{uuid}/
ServiceProvider helps to store the 3rd party service provider information.
Get a single service-provider.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| bureau | URI |
The URI of the bureau for service-provider. |
| contact | string |
Contact name for service-provider |
| materials | array |
The URI of materials the service provider wants to work with. Example: ["..."]
|
| address | string |
Address of service-provider |
| name | string |
Name of the service-provider. |
| uri | URI |
The URI of the service-provider. |
| phone | string |
Phone number for service-provider. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested service-provider cannot be found. |
/shipping/
Shipping endpoint has all the available shipping resource for a bureau and region. The total cost for a shipping an order is then calculate using the unit cost for shipping with the currency conversion for the involved order currency.
List all of the shipping in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| cost | float |
The unit cost of shipping. |
| bureau | URI |
The URI of the bureau for which we have the shipping value. |
| description | string |
The name of the shipping. Example: "Standard Shipping"
|
| name | string |
The description of the shipping. Example: "Standard fixed cost shipping"
|
| uri | URI |
The URI for shipping resource. |
| region | string |
Select a region from the list: ['africa', 'antarctica', 'asia', 'autralia', 'europe', 'north-america', 'south-america'] Choices
"africa|antarctica|asia|autralia|europe|north-america|south-america"
|
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
The value of bureau appears to be an invalid bureau. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested shipping cannot be found. |
Create a new shipping resource.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| cost | float |
The unit cost of shipping. Required |
| bureau | URI |
The URI of the bureau for which we have the shipping value. Required |
| description | string |
The name of the shipping. Required Example: "Standard Shipping"
|
| name | string |
The description of the shipping. Required Example: "Standard fixed cost shipping"
|
| uri | URI |
The URI for shipping resource. Default: None |
| region | string |
Select a region from the list: ['africa', 'antarctica', 'asia', 'autralia', 'europe', 'north-america', 'south-america'] Required Choices
"africa|antarctica|asia|autralia|europe|north-america|south-america"
|
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 400 |
The value of bureau appears to be an invalid bureau. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested shipping cannot be found. |
/shipping/{uuid}/
Shipping endpoint has all the available shipping resource for a bureau and region. The total cost for a shipping an order is then calculate using the unit cost for shipping with the currency conversion for the involved order currency.
Get an individual shipping resource by UUID.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| cost | float |
The unit cost of shipping. |
| bureau | URI |
The URI of the bureau for which we have the shipping value. |
| description | string |
The name of the shipping. Example: "Standard Shipping"
|
| name | string |
The description of the shipping. Example: "Standard fixed cost shipping"
|
| uri | URI |
The URI for shipping resource. |
| region | string |
Select a region from the list: ['africa', 'antarctica', 'asia', 'autralia', 'europe', 'north-america', 'south-america'] Choices
"africa|antarctica|asia|autralia|europe|north-america|south-america"
|
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
The value of bureau appears to be an invalid bureau. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested shipping cannot be found. |
/stock/
Stock works with the /material/ and /location/ endpoints to identify what materials are available on-hand for an organization. As orders are processed and prints are performed the stock will be consumed and should be replenished. By automatically tracking stock the ERP module makes it easier to avoid costly downtime due to out-of-stock issues and to produce reports on stock expiration, rotation and profitability
List all of the stocks in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| quantity | float |
The stock's quantity. |
| material | URI |
The URI of the stock's material. |
| status | string |
Status of the stock. Choices
"in-use|available|exhausted"
|
| units | string |
Unit of the stock. Choices
"grams|cm3"
|
| modeler | URL |
The URI of the stock's modeler. |
| location | URI |
The URI of the stock's location. |
| uri | URI |
The URI of the stock. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested stock cannot be found. |
Create a new stock.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| quantity | float |
The stock's quantity. Required |
| material | URI |
The URI of the stock's material. Required |
| status | string |
Status of the stock. Default: availableChoices
"in-use|available|exhausted"
|
| units | string |
Unit of the stock. Default: cm3Choices
"grams|cm3"
|
| modeler | URL |
The URI of the stock's modeler. Default: None |
| location | URI |
The URI of the stock's location. Required |
| uri | URI |
The URI of the stock. Default: None |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested stock cannot be found. |
/stock/{uuid}/
Stock works with the /material/ and /location/ endpoints to identify what materials are available on-hand for an organization. As orders are processed and prints are performed the stock will be consumed and should be replenished. By automatically tracking stock the ERP module makes it easier to avoid costly downtime due to out-of-stock issues and to produce reports on stock expiration, rotation and profitability
Get a single stock by UUID.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| quantity | float |
The stock's quantity. |
| material | URI |
The URI of the stock's material. |
| status | string |
Status of the stock. Choices
"in-use|available|exhausted"
|
| units | string |
Unit of the stock. Choices
"grams|cm3"
|
| modeler | URL |
The URI of the stock's modeler. |
| location | URI |
The URI of the stock's location. |
| uri | URI |
The URI of the stock. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested stock cannot be found. |
/third-party/
Administer information about a Third Party. The ERP module will allow to first register a third party as most other. A third party is where an order can be placed.
List all of the third-party in the system for your account.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| name | string |
The name of the third-party. |
| bureau | URI |
The URI of the third-party bureau. |
| description | string |
The description of the third-party. |
| uri | URI |
The URI of the third-party. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
The value of bureau appears to be an invalid bureau. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested third party cannot be found. |
Create a new third-party.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| name | string |
The name of the third-party. Required |
| bureau | URI |
The URI of the third-party bureau. Required |
| description | string |
The description of the third-party. Default: None |
| uri | URI |
The URI of the third-party. Default: None |
Responses
| Status Code | Description |
|---|---|
| 204 |
The request was successful |
| 400 |
The value of bureau appears to be an invalid bureau. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested third party cannot be found. |
/third-party/{uuid}/
Administer information about a Third Party. The ERP module will allow to first register a third party as most other. A third party is where an order can be placed.
Get a single third-party by UUID.
Schema (application/json)
| Property | Type | Description |
|---|---|---|
| name | string |
The name of the third-party. |
| bureau | URI |
The URI of the third-party bureau. |
| description | string |
The description of the third-party. |
| uri | URI |
The URI of the third-party. |
Responses
| Status Code | Description |
|---|---|
| 200 |
The request was successful |
| 400 |
The value of bureau appears to be an invalid bureau. |
| 403 |
You are not authorized to complete the request. |
| 404 |
The requested third party cannot be found. |