Threekit Assets: Importing and Exporting API

assets import create update

Creates new assets from the request body. Products are assets of type "item". If any of the requested assets already exist then the existing asset will be updated instead. As of now, we only support imports using a JSON file in the request.

REST Endpoint

POST https://admin.threekit.com/products/import?orgId=[orgId]

Query Parameters

Name	In	Type	Required	Description
orgId	query	string	true	ID of the organization which the assets belong to

Body Parameters

{
  "query": {
    "id": "string",
    "name": "string",
    "metadata": [
      {
        "name": "string",
        "defaultValue": "string",
        "type": "string"
      }
    ]
  },
  "product": {
    "name": "string",
    "assetId": "string",
    "asset": {
      "assetId": "string",
      "configuration": {},
      "type": "string"
    },
    "type": "string",
    "description": "string",
    "keywords": [
      "string"
    ],
    "tags": [
      "string"
    ],
    "metadata": [
      [
        {
          "name": "string",
          "defaultValue": "string",
          "type": "string"
        }
      ]
    ],
    "attributes": [
      [
        {
          "name": "string",
          "defaultValue": "string",
          "type": "string"
        }
      ]
    ],
    "rules": [
      [
        {
          "conditions": [
            {
              "attributeId": "string",
              "attribute": "string",
              "operator": "string",
              "value": "string"
            }
          ],
          "actions": [
            {
              "type": "string",
              "name": "string",
              "label": "string",
              "attribute": "string",
              "attributeId": "string",
              "visible": true
            }
          ],
          "name": "string"
        }
      ]
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	assets import success	None
401	Unauthorized	User is unauthorized to import assets	None
422	Unprocessable Entity	Fortmat or information in imported file is not valid.	None

Example Responses

200

{
  "products": [
    {
      "id": "6e4b65b7-862b-4cd9-b183-c07d82d5beed",
      "name": "ThreeKit Sofa",
      "description": "The original ThreeKit sofa, now configurable!",
      "orgId": "d7e8d7a2-93b1-43d5-bf20-32195396598c",
      "sku": {},
      "keywords": [
        "sofa",
        "demo"
      ],
      "categories": []
    },
    {
      "id": "ae774d8d-095a-4374-b10a-dae909860597",
      "name": "ThreeKit Table",
      "description": "Motorized standing desk that comes in different sizes, tabletop, and leg styles.",
      "orgId": "d7e8d7a2-93b1-43d5-bf20-32195396598c",
      "sku": {},
      "keywords": [],
      "categories": []
    }
  ]
}

401

{
  "error": {
    "type": "unautorized",
    "message": "unauthorized"
  }
}

422

{
  "productdataInvalid": {
    "summary": "missing asset fields or format of fields are not valid",
    "value": {
      "error": {
        "type": "product_data_invalid",
        "message": "product data not valid on all products"
      }
    }
  }
}

assets export list

Exports assets of "type" item belonging to the given organization. When tags or keywords are provided, only matching assets will be exported. Currently the only supported export format is JSON

GET https://admin.threekit.com/products/export/:format

Query Parameters

Name	In	Type	Required	Description
orgId	query	string	true	ID of the organization which the assets belong to
tags	query	string	false	Asset tags to search for
keywords	query	string	false	Asset keywords to search for

Responses

Status	Meaning	Description	Schema
200	OK	Export Assets Successfully	None
401	Unauthorized	User is unauthorized to export assets	None

Example Responses

200

string

401

{
  "error": {
    "type": "unautorized",
    "message": "unauthorized"
  }
}

Schemas

metadataQuery

[
  {
    "name": "string",
    "defaultValue": "string",
    "type": "string"
  }
]

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
defaultValue	string	false	none	none
type	string	false	none	none

attribute

[
  {
    "name": "string",
    "defaultValue": "string",
    "type": "string"
  }
]

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
defaultValue	string	false	none	none
type	string	false	none	none

rule

[
  {
    "conditions": [
      {
        "attributeId": "string",
        "attribute": "string",
        "operator": "string",
        "value": "string"
      }
    ],
    "actions": [
      {
        "type": "string",
        "name": "string",
        "label": "string",
        "attribute": "string",
        "attributeId": "string",
        "visible": true
      }
    ],
    "name": "string"
  }
]

Properties

Name	Type	Required	Restrictions	Description
conditions	[object]	false	none	none
» attributeId	string	true	none	none
» attribute	string	false	none	optional to attributeId, add new attribute into rules
» operator	string	true	none	none
» value	string	true	none	none
actions	[object]	false	none	none
» type	string	true	none	none
» name	string	true	none	none
» label	string	true	none	none
» attribute	string	false	none	optional to attributeId, add new attribute into rules
» attributeId	string	true	none	none
» visible	boolean	false	none	none
name	string	false	none	none

fileJson

{
  "query": {
    "id": "string",
    "name": "string",
    "metadata": [
      {
        "name": "string",
        "defaultValue": "string",
        "type": "string"
      }
    ]
  },
  "product": {
    "name": "string",
    "assetId": "string",
    "asset": {
      "assetId": "string",
      "configuration": {},
      "type": "string"
    },
    "type": "string",
    "description": "string",
    "keywords": [
      "string"
    ],
    "tags": [
      "string"
    ],
    "metadata": [
      [
        {
          "name": "string",
          "defaultValue": "string",
          "type": "string"
        }
      ]
    ],
    "attributes": [
      [
        {
          "name": "string",
          "defaultValue": "string",
          "type": "string"
        }
      ]
    ],
    "rules": [
      [
        {
          "conditions": [
            {
              "attributeId": "string",
              "attribute": "string",
              "operator": "string",
              "value": "string"
            }
          ],
          "actions": [
            {
              "type": "string",
              "name": "string",
              "label": "string",
              "attribute": "string",
              "attributeId": "string",
              "visible": true
            }
          ],
          "name": "string"
        }
      ]
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
query	object	false	none	none
» id	string(string)	false	none	none
» name	string(string)	false	none	none
» metadata	metadataQuery	false	none	none
product	object	false	none	none
» name	string	false	none	none
» assetId	string	false	none	assetId linked in the item
» asset	object	false	none	asset linked in the item
»» assetId	string	false	none	none
»» configuration	object	false	none	none
»» type	string	false	none	none
» type	string	false	none	asset type, item/model/material/scene
» description	string	false	none	none
» keywords	[string]	false	none	none
» tags	[string]	false	none	none
» metadata	[attribute]	false	none	none
» attributes	[attribute]	false	none	none
» rules	[rule]	false	none	none

⬇️ Single assets can be exported using a new parameter on the `Asset Export` API:

/api/assets/export/:id

Menu

In this article

assets import create update

REST Endpoint

Query Parameters

Body Parameters

Responses

Example Responses

assets export list

Query Parameters

Responses

Example Responses

Schemas

metadataQuery

Properties

attribute

Properties

rule

Properties

fileJson

Properties

Menu

Threekit Assets: Importing and Exporting API

In this article

assets import create update

REST Endpoint

Query Parameters

Body Parameters

Responses

Example Responses

assets export list

Query Parameters

Responses

Example Responses

Schemas

metadataQuery

Properties

attribute

Properties

rule

Properties

fileJson

Properties

Related articles