Skip to Content

Show 3D coverage in your PIM

Read how much of your range has a 3D model and list the products that have none yet.

You end up with the share of your range that has 3D, per category, and the article numbers that still have none. Your PIM can show both next to your own product data.

Read the coverage

GET/api/v1/coverageproducts:read
curl -sS https://platform.charpstar.co/api/v1/coverage \
  -H "Authorization: Bearer $CHARPSTAR_API_KEY"

The answer:

{
  "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"]
}
  • with3d is the products with a delivered model, inProduction the products being made, in review or approved, and without3d the products we hold that have no model and no order in progress.
  • byCategory has the same counts for each category. Pass category to read only one.

List the products that have no 3D yet

GET/api/v1/productsproducts:read

missing holds the article numbers without a model, up to 500. For all of them, call GET /api/v1/products?has3d=false: has3d=true returns only products with a delivered model and has3d=false only products without one. The list is newest first. While nextCursor is not null, call again with cursor set to it. limit sets the items per page, from 1 to 100.

Decide what to show in the PIM

Each answer gives you these numbers to put on a screen:

  • The range: total, with3d, inProduction and without3d.
  • A category: the same four counts from byCategory.
  • A product: whether its article number is in missing, or its status from the product list.

On this page