.do
ApiCommerce

Backorder

An out-of-stock item on backorder allowing customers to purchase with delayed fulfillment when inventory is replenished.

Backorder

An out-of-stock item on backorder allowing customers to purchase with delayed fulfillment when inventory is replenished.

Properties

  • id (string): Unique identifier for the backorder.
  • product ([[Product]]): The product being backordered.
  • business ([[Business]]): The business managing this backorder.
  • customer ([[Customer]]): The customer who placed the backorder.
  • order ([[Order]]): The order containing this backordered item.
  • quantity (number): The number of units backordered.
  • status (string): The backorder state (pending, confirmed, in-production, in-transit, fulfilled, cancelled).
  • price (number): The price locked in for this backorder (in cents).
  • estimatedShipDate (number): The estimated date when the item will ship (Unix timestamp).
  • estimatedDeliveryDate (number): The estimated date when the item will arrive (Unix timestamp).
  • actualShipDate (number): The actual date when the item shipped (Unix timestamp).
  • actualDeliveryDate (number): The actual date when the item was delivered (Unix timestamp).
  • priorityLevel (string): The fulfillment priority (standard, expedited, rush).
  • supplierOrder (string): The supplier order number for inventory replenishment.
  • createdAt (number): The timestamp when the backorder was created (Unix timestamp).
  • cancelledAt (number): The timestamp when the backorder was cancelled (Unix timestamp).
  • metadata (object): Set of key-value pairs for storing additional information.

Actions

create

Create a new backorder for an out-of-stock product.

Input: [[Backorder]]
Output: [[Backorder]]

update

Modify backorder quantity, dates, or status.

Input: [[Backorder]]
Output: [[Backorder]]

delete

Permanently remove the backorder record.

Input: [[Backorder]]
Output: [[Backorder]]

confirm

Confirm the backorder with customer and supplier.

Input: [[Backorder]]
Output: [[Backorder]]

fulfill

Process the backorder when inventory becomes available.

Input: [[Backorder]]
Output: [[Backorder]]

cancel

Cancel the backorder and process refund if applicable.

Input: [[Backorder]]
Output: [[Backorder]]

updateEstimate

Update estimated ship and delivery dates.

Input: [[BackorderEstimate]]
Output: [[Backorder]]

notifyCustomer

Send status updates to customer about backorder.

Input: [[BackorderNotification]]
Output: [[Backorder]]

Events

  • created: Triggered when a new backorder is created.
  • updated: Triggered when backorder details are modified.
  • deleted: Triggered when a backorder is permanently removed.
  • confirmed: Triggered when the backorder is confirmed.
  • fulfilled: Triggered when the backorder is shipped to customer.
  • cancelled: Triggered when the backorder is cancelled.
  • estimateUpdated: Triggered when delivery estimates are revised.
  • inventoryArrived: Triggered when inventory for backorder arrives.
  • delayNoticed: Triggered when backorder will miss estimated date.