Statuses

Both Sale and SaleItems have an enum property status that represent a status in the auction life cycle.

Sale Statuses

A sale is in one of the following statuses:

UNPUBLISHED

PUBLISHED

OPENED

CLOSING

CLOSED

PROCESSING

PAUSED

A typical life cycle for a sale will move between statuses as follows:

UNPUBLISHED → PUBLISHED → OPENED → CLOSING → CLOSED

UNPUBLISHED

The initial status when a sale is created. The sale is considered to be a draft and will not automatically move to another status. The sale can not be queried from ClientAPI.

PUBLISHED

To publish a sale a request has to be made

graphql
mutation PublishSale{
  publishSale(accountId:"ACCOUNT_ID", input: {
    saleId:"GENERATED_SALE_ID"
  }){
    id
    status
  }
}

Mutation to Publish a Sale

This makes the sale discoverable in the ClientAPI so it can be rendered to end users. Bids are not accepted while sale is in status published.

Sale will automatically move to status OPEN according to sale’s openDate property.

OPENED

A sale is automatically moved to OPENED according to sale’s openDate property. This also moves all it’s items to OPEN.

CLOSING

A sale moves to status CLOSING if sale’s closingMethod is set to OVERLAPPING or ONE_BY_ONE. A sale moves to status closing accord to sale’s closingDate property.

CLOSED

When all items for a sale are closed then the sale is closed. Bids are no longer accepted.

PROCESSING

🚧

PAUSED

🚧

Item Statuses

A saleItem is in one of the following statuses:

ITEM_NOT_OPEN

ITEM_OPEN

ITEM_CLOSING

ITEM_CLOSED

ITEM_PROCESSING

ITEM_PAUSED

A typical life cycle for a saleItem will move between statuses as follows:

ITEM_NOT_OPEN → ITEM_OPEN → ITEM_CLOSING → ITEM_CLOSED

ITEM_NOT_OPEN

When a sale is in either status UNPUBLISHED or status PUBLISHED.

ITEM_OPEN

When a sale is opened all it’s items are opened as well. Users can place a bid when an item is in status ITEM_OPEN.

ITEM_CLOSING

An item moves into status ITEM_CLOSING according to its closingStart date. Any bid placed between items closingStart and closingEnd date extends the closingEnd date by value defined in sale’s closingTimeCountdown.

ITEM_CLOSED

An item moves into status ITEM_CLOSED according to items closingEnd date. Bids are no longer accepted

ITEM_PROCESSING

🚧

ITEM_PAUSED

🚧