Sign in
Job Item To Make

Get a specific item to make on a job

get/api/jobs/{jobId}/items-to-make/{itemToMakeId}

Path parameters

jobIdstring required
itemToMakeIdstring required

Query parameters

includeCostBreakdownboolean

Response

The item to make for the given 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.

Changes

No recorded changes to this endpoint across all 23 revisions of this API.