List Consignments (DataTable)

Retrieve a paginated list of consignments with advanced filtering, sorting, and field selection. Manage consignor inventory, commissions, shipping methods, and workflow tracking.

GET /datatable-consignments
Query Parameters
Parameter Type Description Example
range integer Items per page (default: 25) ?range=50
page integer Page number (0-indexed) ?page=2
sort string Sort field and direction (prefix with - for descending) ?sort=-updated
sale_id integer Filter by sale ID (sale context) ?sale_id=123
filter[status] string Filter by consignment status ?filter[status]=active
filter[owner] integer Filter by owner (client) ID ?filter[owner]=456
filter[owner_name] string Filter by owner name (text search) ?filter[owner_name]=Smith
filter[responsible_user] string Filter by responsible user's full name ?filter[responsible_user]=John
filter[finder_fees] string Filter by finder name ?filter[finder_fees]=finder_name
filter[has_email] boolean Filter consignors with/without email ?filter[has_email]=1
workflow_filter integer Filter by workflow task completion ?workflow_filter=5
global_search string Search across multiple fields ?global_search=antique
Response Fields
Field Type Description
id string Consignment node ID
consignment_id string Unique consignment identifier
label string Consignment title/label
published boolean Publication status
promoted boolean Promoted to front page
status object Consignment status with value and label
owner object Consignor client information (references datatable-clients)
customer_number string Customer number / PhilaWorksPlace ID
sale object Associated sale information
estimated integer Estimated value (cents)
insurance_value integer Insurance value (cents)
insurance_type string Type of insurance coverage
underbid float Underbid amount
house_consignment boolean Whether this is a house consignment
no_post_sale boolean Exclude from post-sale processing
consignor_commission_step_type string Commission calculation type
consignor_commission_steps array Commission tiers with step_from and consignor_commission
shipping_methods array Array of shipping method objects (see below)
additional_charges array Additional fees and charges
finder_fees array Finder fees with commission, finder, and item references
tax_type string Tax calculation type
tax_customs_number integer Highest tax customs number from shipping methods
current_custom_shipping_id integer Current global custom shipping ID
payment_instructions string Payment instructions for consignor
files array Attached files (bills, documents)
responsible_user array Responsible users with id and label (full name)
workflow object Workflow inventory status
statements array Associated consignment statements
closed_statements array Closed statements for this consignment
Shipping Methods Structure
{
  "shipping_id": 123,
  "amount": 45.50,
  "tax_customs_number": 456,
  "tax_customs_type": "import",
  "date": "2025-10-15",
  "type": "outgoing",
  "method_type": { "id": 1, "label": "FedEx" },
  "customs_tracking_number": "TRACK123456",
  "shipping_notes": "Handle with care",
  "description": "Shipment details"
}
Additional Charges Structure
{
  "amount": 25.00,
  "term": { "id": 5, "label": "Photography" },
  "description": "Professional photography fee",
  "attached_to": "consignment",
  "tax": 5.00
}
Example Requests
GET /api/v1.0/datatable-consignments?range=25&sort=-updated
GET /api/v1.0/datatable-consignments?sale_id=123&range=25&sort=consignment_id
GET /api/v1.0/datatable-consignments?filter[owner]=456&filter[status]=active
GET /api/v1.0/datatable-consignments?sale_id=123&workflow_filter=5
Response Example
{
  "data": [
    {
      "id": "789",
      "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"
      },
      "customer_number": "CUST-456",
      "sale": {
        "id": "123",
        "label": "Spring Auction 2025"
      },
      "estimated": 500000,
      "insurance_value": 750000,
      "insurance_type": "full",
      "underbid": 0.8,
      "house_consignment": false,
      "no_post_sale": false,
      "consignor_commission_step_type": "percentage",
      "consignor_commission_steps": [
        {
          "step_from": 0,
          "consignor_commission": "15%"
        },
        {
          "step_from": 10000,
          "consignor_commission": "12%"
        }
      ],
      "shipping_methods": [
        {
          "shipping_id": 1,
          "amount": 125.50,
          "tax_customs_number": 789,
          "tax_customs_type": "export",
          "date": "2025-09-15",
          "type": "incoming",
          "method_type": {
            "id": 2,
            "label": "UPS Ground"
          },
          "customs_tracking_number": "1Z999AA10123456784",
          "shipping_notes": "Fragile - Handle with care",
          "description": "Incoming shipment from consignor"
        }
      ],
      "additional_charges": [
        {
          "amount": 50.00,
          "term": {
            "id": 5,
            "label": "Photography"
          },
          "description": "Professional catalog photography",
          "attached_to": "consignment",
          "tax": 10.00
        }
      ],
      "finder_fees": [
        {
          "commission": "5%",
          "finder": {
            "id": "111",
            "label": "Jane Appraiser"
          },
          "item": {
            "id": "222",
            "label": "Lot 45"
          }
        }
      ],
      "tax_type": "standard",
      "tax_customs_number": 789,
      "current_custom_shipping_id": 1,
      "payment_instructions": "Wire transfer to account ending in 1234",
      "files": [
        {
          "id": "999",
          "filename": "consignment_agreement.pdf",
          "url": "https://backoffice.ddev.site/api/v1.0/files/999"
        }
      ],
      "responsible_user": [
        {
          "id": "10",
          "label": "Sarah Johnson"
        }
      ],
      "workflow": {
        "tasks": [
          {
            "id": 1,
            "name": "Intake",
            "completed": true
          },
          {
            "id": 2,
            "name": "Photography",
            "completed": false
          }
        ]
      },
      "statements": [],
      "closed_statements": [],
      "updated": "2025-10-20T15:45:00Z"
    }
  ],
  "count": 87
}
Autocomplete Search

Search consignments by consignment ID and label:

GET /api/v1.0/datatable-consignments?autocomplete[string]=CON-2025
Notes
  • All monetary values are in cents (divide by 100 for dollar amounts)
  • Commission percentages are returned as strings with % symbol
  • Dates are in ISO 8601 format (YYYY-MM-DD)
  • The owner field references the datatable-clients endpoint
  • Use sale_id parameter to filter consignments within a specific sale
  • The workflow_filter excludes consignments where a specific workflow task is completed
  • Autocomplete searches filter by consignment ID (e.g., "CON-2025")
  • House consignments are system-managed inventory items
  • 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
Common Use Cases
  • Get all consignments for a sale: ?sale_id=123
  • Find consignments by owner: ?filter[owner]=456
  • Search by owner name: ?filter[owner_name]=Smith
  • Filter by status: ?filter[status]=active
  • Find by responsible user: ?filter[responsible_user]=John
  • Get house consignments only: ?filter[house_consignment]=1
  • Exclude completed workflow tasks: ?workflow_filter=5
  • Consignors with email addresses: ?filter[has_email]=1
Related Endpoints
Back to API Home