v2

latestOpenAPI 3.0.42026-08-084694591.6 MB

Job Item To Make

Get a list of items to make on a job

post/api/jobs/{jobId}/items-to-make/list

Path parameters

jobIdstring required

Query parameters

includeCostBreakdownboolean

Response

The items to make for the given job id

idstring required

Unique Id associated to this entity

itemIdstring required

Id of the item on which this entity is based. Please reference /api/items endpoint.

quantityToMakenumber double required

Quantity of this item produced by the associated job.

isCustomboolean required

Denotes whether this job produces a customized version of the base item

status'new' | 'working' | 'complete' | 'cancelled' required

Job Item to Make status

quantityMadenumber double nullable

Quantity already produced, if the job is in progress.

depthinteger required

Structurally, identify where in the tree of building the parent item this item lies. Example: The top-level item would have a depth of zero and it's direct subcomponents would be 1. This cascades down so that a subcomponent to a subcomponent would be 2... and so on.

routingNotesstring nullable

The routing notes (the "Routing Notes" field) captured on this job's routing for the item. Null when the job's routing has no note for the item.