Skip to main content
POST
Push Item

Path Parameters

workspaceId
string
required
projectId
string
required
id
string
required

Body

application/json
version
number
required
applyProjectUpdates
boolean
projectEventIds
string[]
Minimum array length: 1
Pattern: ^[1-9]\d*$

Response

200 - application/json
notes
string
required

Item-owned notes, separate from instructions.

id
string
required
projectId
string
required
projectItemSlotId
string | null
required
name
string
required
catalogFamilyId
string
required

BigInt string

catalogItemId
string
required

BigInt string

materialFinish
object | null
required
columnsAttributes
object
required
formulaAssignments
object
required
effectiveFormulaAssignments
object
required
effectiveTaxSettings
object | null
required
inheritedTaxSettings
object | null
required
formulaResults
object
required
purchaseQuantityOverride
string | null
required
purchasingUnit
enum<string>
required
Available options:
units,
packages
sourceMeta
object | null
required
isPrimary
boolean
required
optionStatus
enum<string>
required
Available options:
active,
cancelled
catalogConnectionMode
enum<string>
required

live participates in catalog synchronization; saved is a project-only saved catalog version

Available options:
live,
saved
savedAt
string<date-time> | null
required
selectedSource
object | null
required
collectionApplication
object | null
required
categoryId
string
required
productTypeId
string | null
required
kind
enum<string>
required
Available options:
option,
component
catalogFamilyStatus
enum<string> | null
required

CatalogFamily.status — drives FE Push/Pull button visibility

Available options:
draft,
new_from_project,
new_from_collection,
ready_to_use,
null
catalogSourceLifecycle
object | null
required
catalogFamilyItemType
enum<string> | null
required

CatalogFamily.itemType for the linked live Catalog family

Available options:
default,
material,
null
catalogDecisionEventIds
string[]
required
refNumber
string | null
required
affectedParentPiIds
string[]
required

Parent PI ids whose parts list embeds this PI as a row. Set only when the mutated PI is a component; FE invalidates each parent PI parts-list cache entry. Empty array for options.

version
number
required
createdAt
string
required
updatedAt
string
required
updatesRevision
integer
required

The workspace Updates revision once the push finished: Updates counts (GET …/sync-updates/counts) naming this revision or a later one already reflect it; counts naming an earlier one may or may not.

pricingSettings
object
required
slotColumnsAttributes
object | null
required
catalogFamilyDiscontinued
boolean
required
coreChangePolicy
object
required
catalogFamilySourceId
string | null
softCostOverrides
object
effectiveSoftCosts
object[]
syncStateCache
object | null
affectedCatalogFamilyId
string | null
componentBuildCostBreakdown
object | null