API ReferenceKits

Add Material to Kit

Adds a material variation to a kit. The server creates a new MaterialDetails record and returns it; the materialDetailsId in the response will differ from the input materialVariationId. Use the returned materialDetailsId for subsequent GET and DELETE operations. Returns 201 Created.

Requires scope: kits:write

Authentication

API_KEYstring
API Key authentication via header

Path parameters

idUUIDRequired
Kit ID.

Request

This endpoint expects an object.
materialVariationIdUUIDRequired
ID of the material variation to add. Required.
quantitydoubleRequired
Quantity of this material required per kit unit. Required.
costdoubleOptional
Cost per unit for this material within the kit.

Response

This endpoint returns an object.
materialDetailsIdUUID
ID of the MaterialDetails record created when the variation was added to a kit. This is not the same as the MaterialVariation ID.
quantitydouble
Quantity of this material required per kit unit.
materialobject
Reference to the parent material.
variationobject
Reference to the material variation, if applicable.
costdouble
Cost per unit for this material within the kit.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error