Skip to main content
POST
Replace

Path Parameters

workspaceId
string
required
itemId
string
required
partId
string
required

Body

application/json
expectedPartItemId
string
required
partItemId
string
required
quantity
string
Pattern: ^(?!0+(?:\.0{1,2})?$)\d{1,16}(?:\.0{1,2})?$
confirmRelease
boolean

Response

200 - application/json

The item's parts list after the replace. Refusals: 400 INVALID_COMPONENT_TYPE, PART_ITEM_NOT_FOUND, SELF_REFERENCE, MATERIAL_CANNOT_HAVE_PARTS; 404 when the item or its link is not found (a link already replaced by this product answers 200); 409 CATALOG_IDENTITY_CHANGED when the link no longer holds expectedPartItemId, the product the caller saw on it (a finish changed meanwhile), and nothing is written; 409 DUPLICATE_PART, PART_HAS_OWN_PARTS, OWNER_ALREADY_USED_AS_PART, CIRCULAR_DEPENDENCY, PART_DEPTH_LIMIT_EXCEEDED, CATALOG_FAMILY_DISCONTINUED; 409 LOCK_TIMEOUT while another write holds the item's or the chosen product's family, a duplicate of an in-flight replace included — retryable, and a retry after the first committed answers 200 with the same list.

id
string
required
itemId
string
required
partItemId
string
required
partItemName
string
required
partFamilyId
string
required
partFamilyName
string
required
partFamilyType
enum<string>
required
Available options:
default,
material
primaryImageUrl
string | null
required
categoryName
string
required
quantity
string
required
createdAt
string
required