Skip to Content

Cancel a product before modelling starts

Needs the scope products:write

Stop a product before modelling starts. Its status becomes cancelled, it leaves our production queue, and status.changed is sent. A product that has started answers 409 not_cancellable; talk to your CharpstAR contact instead.

Path Parameters

article*string

Your article number.

Match^[A-Za-z0-9][A-Za-z0-9._\-]{0,63}$

Header Parameters

Idempotency-Key?string

A unique value such as a UUID. A retry with the same key within 24 hours returns the original answer and runs nothing twice; the same key with a different body is refused with 409 idempotency_conflict.

Lengthlength <= 128

Response Body

OK

application/json
  1. response
articleId*string
status*string
cancelledAt*string
Formatdate-time
Example Request
curl -sS -X POST https://platform.charpstar.co/api/v1/products/CH-1001/cancel \  -H "Authorization: Bearer $CHARPSTAR_API_KEY"
Example Response
{  "articleId": "CH-1001",  "status": "cancelled",  "cancelledAt": "2026-10-21T14:02:00.000Z"}