Skip to Content

How much of your range has 3D

Needs the scope products:read

How much of your range has a 3D model: counts in total and per category, and the article numbers without one. The question an agent asks before ordering.

Query Parameters

category?string

Only this category.

Response Body

OK

application/json
  1. response
client*

The company the key belongs to.

total*integer
with3d*integer

Products with a delivered model.

inProduction*integer

Products being made, in review or approved.

without3d*integer

Products we hold that have no model and no order in progress.

byCategory*array<>
missing*array<string>

Article numbers without a model, up to 500; use GET /products?has3d=false for all of them.

Example Request
curl -sS https://platform.charpstar.co/api/v1/coverage \  -H "Authorization: Bearer $CHARPSTAR_API_KEY"
Example Response
{  "client": {    "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",    "name": "Your Company"  },  "total": 120,  "with3d": 80,  "inProduction": 15,  "without3d": 25,  "byCategory": [    {      "category": "Furniture",      "total": 90,      "with3d": 70,      "inProduction": 10,      "without3d": 10    },    {      "category": "Lighting",      "total": 30,      "with3d": 10,      "inProduction": 5,      "without3d": 15    }  ],  "missing": [    "CH-2001",    "LA-0100"  ]}