Create Sale

Create a new auction/sale event with dates, pricing structure, and configuration.

POST /datatable-sales

Basic Information

Field	Type	Required	Description
`published`	boolean	No	Publication status (0 or 1)
`description`	string	No	Sale description (HTML)
`subtitle`	string	No	Sale subtitle
`sale_type`	string	No	Type of sale (live, online, hybrid)
`sale_number`	string	No	Sale reference number
`auctioneer_name`	string	No	Name of auctioneer

Date Fields

Note: Date range fields are split into _from and _to variants. Send dates as milliseconds (JavaScript timestamps).

Field	Type	Description
`mail_sale_date_from`	integer	Mail sale start date (milliseconds)
`mail_sale_date_to`	integer	Mail sale end date (milliseconds)
`live_sale_date_from`	integer	Live sale start date (milliseconds)
`live_sale_date_to`	integer	Live sale end date (milliseconds)
`last_date_for_consignment`	integer	Last date to accept consignments (milliseconds)
`auto_sync_image_end_date`	integer	Auto sync image cutoff date (milliseconds)

Financial Configuration

Field	Type	Description
`buyers_premium`	string	Buyer's premium percentage or structure
`post_sale_discount`	float	Post-sale discount percentage
`initial_finder_fees_orders`	string	Initial finder fees orders configuration
`additional_charges`	array	Array of additional charge objects (multifield). See structure below.
`bid_steps`	string	Bid step increments configuration

Settings & Configuration

Field	Type	Description
`lots_locked`	boolean	Lock lots from editing (0 or 1)
`next_consignment_notice`	string	Notice for next consignment
`date_and_location_string`	string	Formatted date and location display string
`item_images_dir`	string	Item images directory path
`sync_active`	boolean	Enable synchronization (0 or 1)
`display_live_links`	boolean	Display live bidding links (0 or 1)
`hide_sold_information`	boolean	Hide sold information from public (0 or 1)
`hide_sale`	boolean	Hide sale from public view (0 or 1)

Media & Documents

Field	Type	Description
`pdf_link`	string	PDF catalog link
`pdf_sale_result`	string	PDF sale results link
`e_book_link`	string	E-book catalog link

Organization

Field	Type	Description
`departments`	array	Array of department term IDs or labels
`external_ids`	array	Array of external ID objects (multifield)

Additional Charges Structure (Multifield)

{
  "additional_charges": [
    {
      "amount": 25.00,
      "term": 5,
      "description": "Catalog subscription fee",
      "attached_to": "sale",
      "tax": 5.00
    }
  ]
}

Additional Charge Fields:

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

Example Request - Basic Sale

POST /api/v1.0/datatable-sales

{
  "published": 1,
  "subtitle": "Spring Rare Stamps Auction",
  "sale_type": "hybrid",
  "sale_number": "SALE-2025-001",
  "auctioneer_name": "John Auctioneer",
  "mail_sale_date_from": 1711929600000,
  "mail_sale_date_to": 1712534400000,
  "live_sale_date_from": 1712534400000,
  "live_sale_date_to": 1712620800000,
  "buyers_premium": "20%",
  "lots_locked": 0
}

Example Request - Complete Sale Configuration

{
  "published": 1,
  "description": "Premier auction featuring exceptional philatelic rarities.",
  "subtitle": "World Classics & Modern Rarities",
  "sale_type": "hybrid",
  "sale_number": "SALE-2025-002",
  "auctioneer_name": "Sarah Smith",
  "mail_sale_date_from": 1714348800000,
  "mail_sale_date_to": 1715558400000,
  "live_sale_date_from": 1715558400000,
  "live_sale_date_to": 1715644800000,
  "last_date_for_consignment": 1710979200000,
  "buyers_premium": "20% up to $5000, 15% thereafter",
  "post_sale_discount": 5.0,
  "lots_locked": 0,
  "next_consignment_notice": "Now accepting consignments for Fall 2025 auction",
  "date_and_location_string": "April 15-16, 2025 | New York Auction House",
  "sync_active": 1,
  "display_live_links": 1,
  "hide_sold_information": 0,
  "hide_sale": 0,
  "pdf_link": "https://example.com/catalogs/sale-2025-002.pdf",
  "e_book_link": "https://example.com/ebooks/sale-2025-002",
  "departments": ["Stamps", "Postal History"],
  "additional_charges": [
    {
      "amount": 50.00,
      "term": 10,
      "description": "Premium catalog subscription",
      "attached_to": "sale",
      "tax": 10.00
    }
  ],
  "bid_steps": "Standard",
  "auto_sync_image_end_date": 1714262400000
}

Response

{
  "data": [{
    "id": "888",
    "uuid": "xyz-abc-888",
    "subtitle": "Spring Rare Stamps Auction",
    "published": true,
    "status": {
      "value": "upcoming",
      "label": "Upcoming"
    },
    "sale_number": "SALE-2025-001",
    "sale_type": "hybrid",
    "mail_sale_date_from": 1711929600000,
    "mail_sale_date_to": 1712534400000,
    "live_sale_date_from": 1712534400000,
    "live_sale_date_to": 1712620800000,
    "buyers_premium": "20%",
    "created": "2025-12-31T10:00:00Z",
    "updated": "2025-12-31T10:00:00Z"
  }]
}

Notes

All dates are in milliseconds (JavaScript timestamps)
Server converts milliseconds to Unix timestamps (seconds)
Date range fields split into _from and _to variants
Monetary values in cents
Taxonomy terms (departments) can be sent as IDs or labels
Multifield arrays allow multiple entries
Buyer's premium can be a simple percentage or tiered structure
Client access is restricted in token mode (view-only)
lots_locked prevents editing of lots in the sale
sync_active enables automatic synchronization
hide_sale hides entire sale from public view
hide_sold_information hides only sold prices/buyers