Update Consignment

Update an existing consignment record. Only include the fields you want to change.

PATCH /datatable-consignments/{id}

Writable Fields

All fields that can be set during consignment creation (POST) can also be updated via PATCH. Only include the fields you want to modify.

Example Request - Update Basic Information

PATCH /api/v1.0/datatable-consignments/999

{
  "label": "Updated Estate Jewelry Collection",
  "published": 1
}

Example Request - Update Financial Values

{
  "estimated": 750000,
  "insurance_value": 1000000,
  "underbid": 0.75
}

Example Request - Update Commission Structure

{
  "consignor_commission_step_type": "tiered",
  "consignor_commission_steps": [
    {
      "step_from": 0,
      "consignor_commission": "20%"
    },
    {
      "step_from": 25000,
      "consignor_commission": "15%"
    },
    {
      "step_from": 100000,
      "consignor_commission": "10%"
    }
  ]
}

Example Request - Add Shipping Method

{
  "shipping_methods": [
    {
      "shipping_id": 2,
      "amount": 175.50,
      "tax_customs_number": 67890,
      "tax_customs_type": "export",
      "date": 1704067200000,
      "type": "outgoing",
      "method_type": 3,
      "customs_tracking_number": "1Z999AA10987654321",
      "shipping_notes": "Return shipment to consignor",
      "description": "Unsold items return"
    }
  ]
}

Note: Multifield arrays completely replace existing values (not merged)

Example Request - Update Additional Charges

{
  "additional_charges": [
    {
      "amount": 200.00,
      "term": 5,
      "description": "Premium catalog photography with video",
      "attached_to": "consignment",
      "tax": 40.00
    },
    {
      "amount": 100.00,
      "term": 12,
      "description": "Conservation assessment",
      "attached_to": "consignment",
      "tax": 20.00
    }
  ]
}

Example Request - Update Responsible Users

{
  "responsible_user": [5, 12, 18]
}

Example Request - Update Owner/Consignor

{
  "owner": 789
}

Example Request - Add Finder Fees

{
  "finder_fees": [
    {
      "commission": "5%",
      "finder": 444,
      "item": 777
    },
    {
      "commission": "3%",
      "finder": 555,
      "item": 888
    }
  ]
}

Example Request - Update Tax and Payment

{
  "tax_type": "vat",
  "payment_instructions": "Bank transfer to IBAN: GB29 NWBK 6016 1331 9268 19"
}

Example Request - Toggle Post-Sale Processing

{
  "no_post_sale": 1
}

Response

{
  "data": [{
    "id": "999",
    "consignment_id": "CON-2025-001",
    "label": "Updated Estate Jewelry Collection",
    "published": true,
    "status": {
      "value": "active",
      "label": "Active"
    },
    "owner": {
      "id": "456",
      "label": "John Smith"
    },
    "estimated": 750000,
    "insurance_value": 1000000,
    "underbid": 0.75,
    "updated": "2025-12-31T15:30:00Z"
  }]
}

Updatable Field Categories

label, consignment_id, owner, published, promoted, responsible_user

estimated, insurance_value, insurance_type, underbid, payment_instructions

consignor_commission_step_type, consignor_commission_steps (multifield)

shipping_methods (multifield: shipping_id, amount, tax_customs_number, tax_customs_type, date, type, method_type, customs_tracking_number, shipping_notes, description)

additional_charges (multifield: amount, term, description, attached_to, tax), finder_fees (multifield: commission, finder, item)

tax_type, no_post_sale

Read-Only Fields (Cannot be Updated)

The following fields are read-only and will be ignored if included in PATCH requests:

id, status (computed from field_consignment_status)
house_consignment (calculated based on system configuration)
current_custom_shipping_id (global shipping ID)
tax_customs_number (derived from shipping methods)
closed_statements, statements (computed from related statements)
sale, customer_number (inherited from context/owner)
files (managed separately)
workflow (computed from workflow system)
created, updated timestamps

Important Notes

PATCH requests are partial updates - only send fields you want to change
All monetary values are in cents
Dates are in milliseconds (JavaScript timestamps)
Commission percentages are strings with % symbol
Multifield arrays completely replace existing values - they are not merged. To add an item, you must include all existing items plus the new one.
The owner field must reference a valid client
Shipping methods can track both incoming and outgoing shipments
Additional charges can be attached to consignments or individual items
Finder fees reference specific items within the consignment
Client access is restricted in token mode
See Create Consignment for detailed field descriptions and structures