Create Consignment

Create a new consignment with consignor information, commission structure, shipping methods, and additional charges.

POST /datatable-consignments?sale_id={sale_id}

Basic Information

Field	Type	Required	Description
`label`	string	Yes	Consignment title/name
`consignment_id`	string	No	Unique consignment identifier (e.g., "CON-2025-001")
`owner`	integer	Yes	Consignor client ID (references datatable-clients)
`published`	boolean	No	Publication status (0 or 1)
`promoted`	boolean	No	Promoted to front page (0 or 1)
`responsible_user`	array	No	Array of responsible user IDs

Financial Information

Field	Type	Description
`estimated`	integer	Estimated value (in cents)
`insurance_value`	integer	Insurance value (in cents)
`insurance_type`	string	Type of insurance coverage
`underbid`	float	Underbid multiplier (e.g., 0.8 for 80%)
`payment_instructions`	string	Payment instructions for consignor

Commission Structure

Field	Type	Description
`consignor_commission_step_type`	string	Commission calculation type (percentage, fixed, etc.)
`consignor_commission_steps`	array	Array of commission tier objects (multifield). See structure below.

Shipping Information

Field	Type	Description
`shipping_methods`	array	Array of shipping method objects (multifield). See structure below.

Additional Charges & Fees

Field	Type	Description
`additional_charges`	array	Array of additional charge objects (multifield). See structure below.
`finder_fees`	array	Array of finder fee objects (multifield). See structure below.

Tax & Processing

Field	Type	Description
`tax_type`	string	Tax calculation type
`no_post_sale`	boolean	Exclude from post-sale processing (0 or 1)

Commission Steps Structure (Multifield)

{
  "consignor_commission_steps": [
    {
      "step_from": 0,
      "consignor_commission": "15%"
    },
    {
      "step_from": 10000,
      "consignor_commission": "12%"
    },
    {
      "step_from": 50000,
      "consignor_commission": "10%"
    }
  ]
}

Shipping Methods Structure (Multifield)

{
  "shipping_methods": [
    {
      "shipping_id": 1,
      "amount": 125.50,
      "tax_customs_number": 789,
      "tax_customs_type": "export",
      "date": 1695945600000,
      "type": "incoming",
      "method_type": 2,
      "customs_tracking_number": "1Z999AA10123456784",
      "shipping_notes": "Fragile - Handle with care",
      "description": "Incoming shipment from consignor"
    }
  ]
}

Shipping Method Fields:

shipping_id (integer): Custom shipping ID
amount (float): Shipping amount
tax_customs_number (integer): Tax/customs reference number
tax_customs_type (string): Type of customs (import, export, etc.)
date (integer): Shipping date (milliseconds)
type (string): Shipping type (incoming, outgoing)
method_type (integer): Shipping method term ID (FedEx, UPS, etc.)
customs_tracking_number (string): Tracking number
shipping_notes (string): Internal notes
description (string): Shipment description

Additional Charges Structure (Multifield)

{
  "additional_charges": [
    {
      "amount": 50.00,
      "term": 5,
      "description": "Professional catalog photography",
      "attached_to": "consignment",
      "tax": 10.00
    }
  ]
}

Additional Charge Fields:

amount (float): Charge amount
term (integer): Charge type term ID (Photography, Insurance, etc.)
description (string): Charge description
attached_to (string): What the charge is attached to
tax (float): Tax amount

Finder Fees Structure (Multifield)

{
  "finder_fees": [
    {
      "commission": "5%",
      "finder": 111,
      "item": 222
    }
  ]
}

Finder Fee Fields:

commission (string): Commission percentage or amount
finder (integer): Finder client node ID
item (integer): Item node ID this fee applies to

Example Request - Basic Consignment

POST /api/v1.0/datatable-consignments?sale_id=123

{
  "label": "Estate Jewelry Collection",
  "consignment_id": "CON-2025-001",
  "owner": 456,
  "published": 1,
  "estimated": 500000,
  "insurance_value": 750000,
  "insurance_type": "full",
  "tax_type": "standard",
  "consignor_commission_step_type": "percentage",
  "consignor_commission_steps": [
    {
      "step_from": 0,
      "consignor_commission": "15%"
    },
    {
      "step_from": 10000,
      "consignor_commission": "12%"
    }
  ]
}

Example Request - Complete Consignment with Shipping

POST /api/v1.0/datatable-consignments?sale_id=123

{
  "label": "Rare Stamp Collection",
  "consignment_id": "CON-2025-002",
  "owner": 789,
  "published": 1,
  "promoted": 0,
  "estimated": 1000000,
  "insurance_value": 1500000,
  "insurance_type": "comprehensive",
  "underbid": 0.8,
  "tax_type": "vat",
  "payment_instructions": "Wire transfer to account ending in 1234",
  "no_post_sale": 0,
  "responsible_user": [10, 15],
  "consignor_commission_step_type": "tiered",
  "consignor_commission_steps": [
    {
      "step_from": 0,
      "consignor_commission": "15%"
    },
    {
      "step_from": 50000,
      "consignor_commission": "10%"
    }
  ],
  "shipping_methods": [
    {
      "shipping_id": 1,
      "amount": 250.00,
      "tax_customs_number": 12345,
      "tax_customs_type": "import",
      "date": 1695945600000,
      "type": "incoming",
      "method_type": 2,
      "customs_tracking_number": "1Z999AA10123456784",
      "shipping_notes": "Insured shipment - signature required",
      "description": "Initial consignment delivery"
    }
  ],
  "additional_charges": [
    {
      "amount": 150.00,
      "term": 5,
      "description": "Professional photography and cataloging",
      "attached_to": "consignment",
      "tax": 30.00
    },
    {
      "amount": 75.00,
      "term": 8,
      "description": "Expert authentication",
      "attached_to": "consignment",
      "tax": 15.00
    }
  ],
  "finder_fees": [
    {
      "commission": "3%",
      "finder": 555,
      "item": 888
    }
  ]
}

Response

{
  "data": [{
    "id": "999",
    "consignment_id": "CON-2025-001",
    "label": "Estate Jewelry Collection",
    "published": true,
    "promoted": false,
    "status": {
      "value": "active",
      "label": "Active"
    },
    "owner": {
      "id": "456",
      "label": "John Smith",
      "self": "https://backoffice.ddev.site/api/v1.0/datatable-clients/456"
    },
    "estimated": 500000,
    "insurance_value": 750000,
    "insurance_type": "full",
    "tax_type": "standard",
    "consignor_commission_step_type": "percentage",
    "consignor_commission_steps": [
      {
        "step_from": 0,
        "consignor_commission": "15%"
      },
      {
        "step_from": 10000,
        "consignor_commission": "12%"
      }
    ],
    "created": "2025-12-31T10:00:00Z",
    "updated": "2025-12-31T10:00:00Z"
  }]
}

Notes

Consignments require a sale_id parameter (sale context)
All monetary values are in cents (divide by 100 for dollar amounts)
Dates are in milliseconds (JavaScript timestamps)
Commission percentages are strings with % symbol
The owner field must reference a valid client from datatable-clients
Multifield arrays allow multiple entries for complex data structures
Shipping methods track both incoming and outgoing shipments with customs information
Additional charges can be attached to consignments or individual items
Finder fees track commissions paid to third-party finders for specific items
House consignments are system-managed and have special handling
Client access is restricted in token mode

Sale Context Required