Skip to main content
POST
Reconcile source reference

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

id
integer
required

ID of the fulfillment order

Body

application/json
source_reference_identifier
string | null

The remote OMS order ID to bind. Omit or pass null for auto mode. Provide a value for manual mode.

Maximum string length: 255
force
boolean
default:false

Manual mode only. When true, skip line-item quantity/SKU validation and bind the remote order regardless. Has no effect in auto mode and returns a 422 if used without source_reference_identifier.

dry_run
boolean
default:false

When true, validate and return what would happen without writing to the database or dispatching a refresh job.

trigger_order_refresh
boolean
default:true

When true (default), dispatch a sales order refresh job after a successful bind. Ignored when dry_run is true.

debug
boolean
default:false

When true, capture and return outbound OMS HTTP traffic in data.debug.

Response

Reconciliation succeeded (or was already reconciled / dry run). Check data.data.mode to distinguish: "auto", "manual", "noop" (already reconciled), or the dry_run flag.

data
object