API ReferenceField Requests

Add Field Request Item

Adds a material line item to an existing field request.

Requires scope: field_requests:write

Authentication

API_KEYstring
API Key authentication via header

Path parameters

idUUIDRequired
Field request ID.

Request

This endpoint expects an object.
quantitydoubleRequired
Quantity requested. Must be greater than zero.
materialIdUUIDOptional

ID of the material being requested. Required unless materialVariationId is supplied.

materialVariationIdUUIDOptional

ID of the specific material variation. Required unless materialId is supplied.

Response

This endpoint returns an object.
idUUID
Unique identifier for the line item.
createdAtdatetime
ISO 8601 timestamp when the record was created.
updatedAtdatetime
ISO 8601 timestamp when the record was last updated.
materialobjectOptional
The material being requested.
variationobjectOptional
The specific material variation being requested.
requestedQuantitydoubleOptional
Quantity requested.
receivedQuantitydoubleOptional

Quantity received so far. Starts at 0.

statusenumOptional

Fulfillment status of this line. New items start as PENDING.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Rate Limit Error