Skip to main content

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

Interface: ShippingQuote

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

What the distributor quoted to ship a draft order, and what it quoted for. Creating one changes nothing on the order; choose a service from it with shipping_quote and shipping_method on hardwareOrders.update.

Properties​

backorder_terms?​

TypeScript
backorder_terms?:
| {
text: string;
version: string;
}
| null;

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

The statement to accept to place the parts this quote flags as on temporary backorder, rendered as it will be recorded: show text verbatim and send version as backorder_terms_version. Null when nothing is held.


created_at​

TypeScript
created_at: string;

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


expires_at​

TypeScript
expires_at: string;

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

After this, the quote can no longer be chosen from, and an order whose service was chosen from it can no longer be checked out.


hardware_order​

TypeScript
hardware_order: string;

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

ID of the order this quote was taken for.


id​

TypeScript
id: string;

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


items​

TypeScript
items: object[];

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

The cart this quote was priced for. It can be chosen from only while the order holds exactly these quantities.

hardware_catalog​

TypeScript
hardware_catalog: string;

quantity​

TypeScript
quantity: number;

object​

TypeScript
object: "shipping_quote";

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


options​

TypeScript
options: ShippingQuoteOption[];

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

Every carrier service on offer, cheapest first.


ship_to_address​

TypeScript
ship_to_address: HardwareOrderAddress;

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

The destination this quote was priced for. It can be chosen from only while the order still ships here.