Replace Sales Order Line Options
PUT/api/sales-order-lines/:salesOrderLine/options
Replace a sales order line's manual options. Send the complete list each time: options you leave out are removed, and an empty list removes them all. Channel options are read-only; a manual option with the same name as a channel option overrides it wherever the line is shown. Names are normalised the same way as channel option names; values are kept as typed. When the line is linked to a manufacturing order, the change is carried to it (or flagged there if a step has already started).
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (scope orders:write).
Body:
options[](array, required — may be empty, max 100)name(string, required, max 255)value(string, optional, max 2,000)id(integer, optional) — accepted for round-tripping a previous response; ignored.
Response: message and data[] — the line's options after the edit (channel and manual, hide rules applied, configured SKU option excluded), in the same shape as a line's options.
Returns 422 once the line is fully fulfilled, or while line options are switched off; 404 when the line does not exist.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.