API Key Parameters

Overview

API parameters are critical variables used as input to make API calls. These parameters influence the response from an endpoint and are essential for tailoring API functionality to specific requirements. Each parameter consists of a name and an associated value.

Below is a detailed description of the key parameters used in the OnSite API:

m

modelID

A unique identifier for uploaded 3D models. A single 3D model can generate multiple modelIDs, which are required to create a product. Additionally, a single modelID can be used to create multiple products.

technologyID

The identifier for 3D printing technologies. Each technology is associated with a specific technologyID.

materialID

The identifier for 3D printing materials. Each material is linked to a unique materialID. Note that multiple materialIDs can belong to a single technology.

finishID

The identifier for surface finishes. Each finish is associated with a unique finishID. Multiple finishIDs can belong to a single material.

colorID

The identifier for material colors. Each color is tied to a unique colorID.

productID

A unique identifier for products. A product is defined as a 3D model combined with specified technology, material, and finish. The productID is used to create quotation items. A single productID can be used to generate multiple quotation items.

quotationItemID

A unique identifier for quotation items. A quotation item represents a product with a specified quantity and production service.

quotationID

A unique identifier for quotations, which are collections of quotation items. Each quotationID can be ordered only once.

deliveryAddressID

The identifier for a delivery address linked to a specific user account. The deliveryAddressID is required to prepare a quotation for ordering and must be created in your OnSite account to receive its ID.

 

invoiceAddressID

The identifier for an invoice address linked to a specific user account. The invoiceAddressID is also required to prepare a quotation for ordering.

Was this article helpful?

Can’t find what you’re looking for?

Our customer service team is happy to help!