Save Configuration

post

https://preview.threekit.com/api/configurations

Saves the configuration of a product and generates a shortID which can be used to retrieve the configuration, in place of the UUID. Files can also be stored along with the configuration provided a mapping is provided for the filenames to a unique key which can then be used to fetch the file using the "fetch attachment API"

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

bearer_token

string

Public access token used to authorize the request. Requests may only come from the token's allowed domains. This parameter is mandatory when making requests from a browser. Outside of the browser instead supply a bearer header using a private access token.

orgId

string

Organization ID.

Body Params

Configuration information to be saved.

orgId

string

Organization ID

productId

string

required

ID of the product

productVersion

string

required

Version of the product

variant

object

Configuration variant information (If present). This refers to the product attributes and their values for the configuration in question.

sceneGraphState

string

ID of file containing the complete state of the scene-graph. This is present if the 'Save Complete Scene' Player Setting is enabled at the time when the configuration is saved.

metadata

object

Metadata information associated with the configuration (If present)

files

file

An image or a thumbnail of the configured product. NOTE --- This parameter will only accept a file. It can also be used to attach multiple files to the request

shortId

string

Automatically generated shortID. It can be used in place of the id field

customerId

string

Customer ID

attachments

object

This field can be used to define mappings to fetch files, if multiple files are attached to the the request. Please check the example request to see how mapping should be defined

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful POST request, response body will include the created configuration details.

401User is not authenticated. They must be authenticated to use this service.

403User is authenticated but lacks authorization to use this service

422The configuration information provided in the request is missing mandatory fields. Or the mapping defined when multiple files are provided in the request, is incorrect.