Skip to main content

@dialstack/sdk-dev / server/src / HardwareOrder

Interface: HardwareOrder

Defined in: sdk/server/src/index.ts:2268

Properties​

account​

TypeScript
account: string | Account;

Defined in: sdk/server/src/index.ts:2274

The account the order ships to: its id, or the full Account when expand: ['account'] is passed.


backorder​

TypeScript
backorder: HardwareOrderBackorder | null;

Defined in: sdk/server/src/index.ts:2298

The acceptance of parts on temporary backorder; null when none was given.


cancel_reason​

TypeScript
cancel_reason: string | null;

Defined in: sdk/server/src/index.ts:2349

Why the order was cancelled, when cancelled; otherwise null.


cancelled_at​

TypeScript
cancelled_at: string | null;

Defined in: sdk/server/src/index.ts:2351

When the order was cancelled, or null.


created_at​

TypeScript
created_at: string;

Defined in: sdk/server/src/index.ts:2359


fulfillment_status​

TypeScript
fulfillment_status: HardwareOrderFulfillmentStatus;

Defined in: sdk/server/src/index.ts:2284


goods_cents​

TypeScript
goods_cents: number;

Defined in: sdk/server/src/index.ts:2315

What the items cost, in USD cents, at the prices they were sold at.


id​

TypeScript
id: string;

Defined in: sdk/server/src/index.ts:2269


items​

TypeScript
items: HardwareOrderItem[];

Defined in: sdk/server/src/index.ts:2358

The physical units the lines expanded into, one per device.


lines​

TypeScript
lines: HardwareOrderLine[];

Defined in: sdk/server/src/index.ts:2356

What was ordered, and what it cost. A quantity of three is one line and three units; a bundle is one line and one unit per component.


payment_settled_at​

TypeScript
payment_settled_at: string | null;

Defined in: sdk/server/src/index.ts:2308

When the funds actually became ours, days after submission. Set only for settled and reversed; a reversal keeps it.


payment_status​

TypeScript
payment_status: HardwareOrderPaymentStatus;

Defined in: sdk/server/src/index.ts:2283


payment_submitted_at​

TypeScript
payment_submitted_at: string | null;

Defined in: sdk/server/src/index.ts:2303

When the debit was handed to the network. Null while payment_status is unpaid, set for every other state. Not an authorization — ACH has none.


placed_at​

TypeScript
placed_at: string | null;

Defined in: sdk/server/src/index.ts:2290

When checkout completed. Null means the order is still a draft: its contents can be changed and its prices are not yet frozen. This is the only place draftness is recorded — there is no draft status value.


po_number​

TypeScript
po_number: string | null;

Defined in: sdk/server/src/index.ts:2280

The purchase order number the distributor holds this order under. Null until the order is placed with the distributor, which happens after review. Changes if the order has to be placed again.


rejection_reason​

TypeScript
rejection_reason: string | null;

Defined in: sdk/server/src/index.ts:2347

Why the order was declined at review, when rejected. On a draft, why DialStack declined its request; requesting again clears it.


requested_at​

TypeScript
requested_at: string | null;

Defined in: sdk/server/src/index.ts:2296

When the platform asked DialStack to place this draft with hardwareOrders.request. Null on an order nobody requested, and again after DialStack declines the request.


ship_to_address​

TypeScript
ship_to_address: HardwareOrderAddress | null;

Defined in: sdk/server/src/index.ts:2336

Where the order ships. Required before checkout.


ship_to_recipient​

TypeScript
ship_to_recipient: string | null;

Defined in: sdk/server/src/index.ts:2334

The name the parcel is addressed to. Optional: when null, the account's name goes on the shipping label.


shipments​

TypeScript
shipments: HardwareOrderShipment[];

Defined in: sdk/server/src/index.ts:2282

The shipments the distributor has reported. Empty until the order ships.


shipped_at​

TypeScript
shipped_at: string | null;

Defined in: sdk/server/src/index.ts:2313

When the distributor first reported a tracking number. Null until then. The order is fulfilled once every item's fulfilled is true.


shipping_cents​

TypeScript
shipping_cents: number | null;

Defined in: sdk/server/src/index.ts:2323

Shipping in USD cents, passed through at cost and stated separately from goods. Set when a carrier service is chosen from a shipping quote, at that quote's price. Null means none has been chosen, which is not the same as free — checkout refuses a null, while 0 is a legitimate price. Changing the order's contents or its destination clears it.


shipping_method​

TypeScript
shipping_method: string | null;

Defined in: sdk/server/src/index.ts:2329

The carrier service chosen for this order, as the distributor names it (for example FED_2DY). Null until a service is chosen.


shipping_quoted_at​

TypeScript
shipping_quoted_at: string | null;

Defined in: sdk/server/src/index.ts:2324


total_cents​

TypeScript
total_cents: number | null;

Defined in: sdk/server/src/index.ts:2342

goods_cents plus shipping_cents. Null until shipping has been quoted: an order with no quote has no total, rather than one that happens to equal its goods.


updated_at​

TypeScript
updated_at: string;

Defined in: sdk/server/src/index.ts:2360