Brightpearl icon

Brightpearl

Work with orders, products, and price lists in Brightpearl

Order Custom Field → Update

AI-generated

Summary

Updates an order’s custom fields by sending a JSON Patch to Brightpearl. Choose Builder mode to create patch operations from field entries, or Raw JSON Patch to provide the RFC 6902 array yourself.

Inputs

  • Authentication — Select OAuth2 or Private App authentication; Private App is the default.
  • Order ID (required) — Brightpearl order ID to update.
  • Input Mode — Choose Builder or Raw JSON Patch.
  • Custom Fields — In Builder mode, add one or more fields with an operation (Add / Set, Replace, or Remove), field code, and value type. Add / Set can create or overwrite; Replace requires an existing value; Remove deletes an existing value. The value type should match the Brightpearl field: text/date, number, boolean, or select option ID. Type mismatches can cause Brightpearl to return a 500. Value and type are ignored for Remove.
  • JSON Patch — In Raw JSON Patch mode, provide an RFC 6902 array with operations, paths such as "/PCF_FIELD_CODE", and values as required by each field type. Booleans and numbers must be unquoted JSON values; select fields use an object containing the numeric option ID. Type mismatches can cause Brightpearl to return a 500.

Output shape

Not determinable from the supplied source pack.

The source pack contains only signatures and omits the operation implementation body, so it does not establish the returned data shape.

Links

Discussion