Set requisition delivery instructions

When to use this endpoint

The CRM1 form sends all three current values on any delivery-detail change; omission is not a partial update.

Authentication and permissions

Authenticate with signed API-key fields or a logged-in CRM session. API keys use their owner’s tenant; session dispatch applies CSRF checks. Office requisition access requires View and Edit on Requisition Order or Requisition Orders. A visible UI control is not sufficient authorization.

Tenant and TeamAccess/legacy department scope apply to headers and to the parent of each line. Deleted parents hide their lines. Scoped users can see their own unlinked requisitions; the legacy department-only rule retains its target-based visibility. There is no additional Requisition feature-entitlement check.

Parameters

Parameter	Type	Required	Description
`id`	Positive integer	Yes	Existing, non-deleted requisition ID in the authenticated tenant and your record scope.
`attention`	String	Yes	Required presence; blank accepted.
`delivery_address`	String	Yes	Required presence; blank accepted; stored text, not a structured address.
`instructions`	String	Yes	Required presence; blank accepted.

Example request

$result = FM_api('RequisitionOrder_setDeliveryDetails', [
	'id' => '1042',
	'attention' => 'Site manager',
	'delivery_address' => 'North site',
	'instructions' => 'Use the service entrance',
]);

Example response

{"ok":1}

An exact no-op header setter may include warning:"No Change.". Committed follow-up failures include saved=1 and a warning; inspect saved state before retrying.

Errors and unusual responses

Response	Condition
`{"error":"not logged in"}`	No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs.
`{"error":"permission denied"}`	Required office page/action access is absent.
`{"error":"requisition order does not exist"}`	The header is missing, deleted or outside the caller’s scope.
`{"error":"Processed requisitions are read-only"}`	A material/header edit targets status 2.
`{"error":"Unable to save requisition. Check the saved state before retrying."}`	A checked database/audit operation failed; verify saved state before replaying an uncertain request.

Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.

Behaviour and edge cases

Overwrites all three delivery text fields together; blank text clears. No structured address lookup or normalization is performed. Each text input is limited to 65,535 bytes.
The header/line changes, aggregate totals and audit are checked in one tenant transaction. A failed write or audit rolls back the operation. Existing caller transactions use savepoints; the caller owns final commit. No request key deduplicates creation.
Follow-up notifications and mentions run after the owning commit. If a follow-up fails after persistence, the response includes saved=1 and a warning; read the saved object before retrying and do not replay creation.

Side effects

Checked header/totals/history writes with last_edited and deferred notifications/mentions/cache invalidation. Delivery remains separate from line totals; ordinary edits retain approval.

See it in Fieldmotion

CRM1

On CRM1 Requisition details edit Attention, Address or Instructions; filter for RequisitionOrder_setDeliveryDetails.

CRM2

No direct caller was found in CRM2 source. Its requisition screen uses mapped layout reads/writes instead of this legacy endpoint.

Related endpoints

RequisitionOrder_setDeliveryDate — Save expected arrival date.
RequisitionOrder_updateData — Use mapped partial field edits.