Skip to main content

Update Fulfillment Order Signature Requirement

PATCH 
/api/fulfillment-orders/:fulfillmentOrder/signature

Add or remove "signature required on delivery" on a fulfillment order that has already been submitted to its shipping provider. The change is sent to the provider in the same request, and is saved only if the provider accepts it.

Required scope: orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Use this after submission; before submission, set requested_metadata.signature_required with Edit Fulfillment Order Shipping Details instead.

When it is allowed. The fulfillment order must be status=open with request_status submitted or accepted, have no shipment yet, and its shipping provider must accept the change before shipping (currently Odoo 3PL, while the provider order is still a draft). Check can_update_signature on the fulfillment order before calling.

A change made here is recorded as your decision (requested_metadata.signature_required_source = operator), so a later sales-channel tag change will not undo it. Sending the value the order already has is a no-op and does not contact the provider.

Body fields:

  • signature_required (required, boolean) — true to require a signature, false to remove the requirement.

Responses: 200 returns the updated fulfillment order. 409 when the order can no longer take the change (not submitted, already shipped, or a provider that does not accept it after submission). 422 when the body is invalid or the provider rejects the update — nothing is saved in that case.

Authentication: requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type