Skip to documentation
Consignment Intake integration

Ensure Consignment ClaimSoft Order

Perform Ensure Consignment ClaimSoft Order through Consignment Intake.

View as Markdown
ensure_consignment_claimsoft_order
writeclaimsoft

Inputs

  • document_id
    expressionrequired
    Document Id

    Required literal value or workflow expression.

  • expected_idempotency_key
    expressionrequired
    Expected Idempotency Key

    Required literal value or workflow expression.

  • order_params
    jsonrequired
    Order Params

    Required JSON value.

Outputs

  • successSuccess
  • order_idOrder Id
  • createdCreated
  • duplicate_preventedDuplicate Prevented
  • match_basisMatch Basis
  • idempotency_keyIdempotency Key
  • messageMessage
  • error_kindError Kind
  • errorError

Output schema completeness: best_effort_declared

Safety

External effect
write
Confirmation recommended
No
Retry safe
No
Dry run supported
No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema
{
  "type": "object",
  "required": [
    "document_id",
    "expected_idempotency_key",
    "order_params"
  ],
  "properties": {
    "document_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "order_params": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "expected_idempotency_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "created": {},
    "message": {},
    "success": {},
    "order_id": {},
    "error_kind": {},
    "match_basis": {},
    "idempotency_key": {},
    "duplicate_prevented": {}
  },
  "additionalProperties": true
}
View all Consignment Intake actions