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.
category?stringOnly this category.
OK
application/json- response
client*The company the key belongs to.
total*integerwith3d*integerProducts with a delivered model.
inProduction*integerProducts being made, in review or approved.
without3d*integerProducts 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.
curl -sS https://platform.charpstar.co/api/v1/coverage \ -H "Authorization: Bearer $CHARPSTAR_API_KEY"{ "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" ]}Approve a model or request changes POST
Approve a model, or send it back to our 3D team with comments. A model that has passed our quality check waits for your approval (review.requested tells you); one that is not waiting for you answers 409 not_ready. - approve publishes it, exactly as approving in your CharpstAR account does. asset.approved follows once its files are live. A product with variants is approved with all of them. - request_changes sends it back with your comments. Each comment can carry an image, which we copy to your account. - From the third change request on the same model, extra revisions will likely be charged. That request is made in your CharpstAR account, where you confirm it; the API answers 409 not_ready. - A change to a model that is already delivered is requested the same way. It stays delivered and its links keep working while we make the change. Each one counts against your yearly change allowance (402 allowance_reached once it is used up).
Report a sync run POST
Tell us after each scheduled sync run. Your CharpstAR contact then sees when your system last synced and whether it went well. Optional.