@sixtyninecommerce/admin 0.8.0 → 0.10.0

package/dist/orders/get.d.ts

@@ -0,0 +1,722 @@
+/**
+ * `admin.orders.get(orderId)`: one order, typed (headless spec §9.2 `orders`
+ * "read", plan W9-9).
+ *
+ * The read has two layers. The CORE is what the engine itself serves for an
+ * order, and it is all a call without `include` asks for. Around it sit the
+ * blocks a plugin adds to an order (payment terms, delivery terms, the order's
+ * own price list, the ERP and carrier references). Each is asked for by name
+ * in `include`, so a caller reads only what it uses, and the core document
+ * names no field an engine without that plugin lacks.
+ *
+ * Money is an integer in minor units of the order's currency, with three
+ * exceptions that are NOT converted to it: a line's `productVariant.price` and
+ * `priceWithTax` (the catalogue price in the currency of the request, which is
+ * the store's default unless the call names another), and a line's
+ * `customFields.cost` (the store's default currency). An instant is an ISO-8601
+ * string with its offset.
+ */
+import { type Transport } from '@sixtyninecommerce/core';
+import type { InventoryFlag } from '../catalog/variants.js';
+import type { OrderDiscount } from '../pricing/index.js';
+import type { Call } from '../types.js';
+/**
+ * The blocks a plugin adds to an order, in the order the document lists them.
+ *
+ * - `paymentTerms`: the payment terms the order was placed under, and the
+ *   order's own override of them (the B2B credit plugin).
+ * - `deliveryTerms`: the delivery terms accepted at placement (the shipping
+ *   calculator plugin).
+ * - `priceList`: the order's own price list, which is its one-time pricing
+ *   (the price-list plugin).
+ * - `lineAllocations`: each line's raw allocation rows (the stock-transfer
+ *   plugin). They never decrement: `OrderLine.outstandingAllocations` is what a
+ *   line reserves now, and needs no include.
+ * - `fulfillmentDetails`: each fulfillment's handler (code, name, its detail
+ *   rows) and packing slips (the order-documents plugin).
+ * - `vatValidation`: the customer's VAT number and its validation status (the
+ *   VAT-validation plugin).
+ * - `afas`, `parasut`: the references those ERP plugins keep on the order, its
+ *   customer and the customer's addresses.
+ * - `myparcel`: the MyParcel shipment and label state on each fulfillment.
+ */
+export declare const ORDER_INCLUDES: readonly ["paymentTerms", "deliveryTerms", "priceList", "lineAllocations", "fulfillmentDetails", "vatValidation", "afas", "parasut", "myparcel"];
+export type OrderInclude = (typeof ORDER_INCLUDES)[number];
+/** `Fields` when the read asked for `K` (for a union: any of them), else nothing. */
+type Block<I extends OrderInclude, K extends OrderInclude, Fields> = [Extract<I, K>] extends [never] ? unknown : Fields;
+/** Why an order's fulfillment is on hold. */
+export type OrderFulfillmentHoldReason = 'awaiting_payment' | 'address_issue' | 'customer_request' | 'credit_check' | 'stock_issue' | 'other';
+/** Whether payment terms could be established for the order's customer. */
+export type OrderPaymentTermsStatus = 'ASSIGNED' | 'UNASSIGNED' | 'UNRESOLVED' | 'STALE' | 'CONFLICT';
+/** What kind of payment condition the terms are. */
+export type OrderPaymentTermsClassification = 'SINGLE_DUE_DATE' | 'COMPLEX' | 'UNRESOLVED' | 'UNASSIGNED' | 'CONFLICT';
+/** Whether a part of the delivery terms could be established. */
+export type OrderDeliveryTermsStatus = 'ASSIGNED' | 'UNASSIGNED' | 'UNRESOLVED' | 'STALE' | 'CONFLICT';
+/** Where the order's shipping method came from. */
+export type OrderDeliverySelectionSource = 'CUSTOMER_DEFAULT' | 'EXPLICIT_OVERRIDE' | 'IMPORTED' | 'UNKNOWN';
+/** Whether the customer accepts a partial delivery. */
+export type OrderDeliveryAdvice = 'PARTIAL_ALLOWED' | 'COMPLETE_ORDER' | 'PARTIAL_WITHOUT_BACKORDER' | 'UNKNOWN';
+/** An address as the order holds it: a snapshot, not the customer's address book entry. */
+export interface OrderAddress {
+    fullName: string | null;
+    company: string | null;
+    streetLine1: string | null;
+    streetLine2: string | null;
+    city: string | null;
+    province: string | null;
+    postalCode: string | null;
+    /** The country's name. */
+    country: string | null;
+    countryCode: string | null;
+    phoneNumber: string | null;
+}
+/** One entry of the customer's address book. */
+export type OrderCustomerAddress<I extends OrderInclude = never> = {
+    id: string;
+    fullName: string | null;
+    company: string | null;
+    streetLine1: string;
+    streetLine2: string | null;
+    city: string | null;
+    postalCode: string | null;
+    country: {
+        code: string;
+    };
+    defaultShippingAddress: boolean | null;
+    defaultBillingAddress: boolean | null;
+} & Block<I, 'afas', {
+    customFields: {
+        afasAddressId: string | null;
+    } | null;
+}>;
+/** The customer's VAT number and what validating it found (`vatValidation`). */
+export interface OrderCustomerVatFields {
+    vatNumber: string | null;
+    vatValidationStatus: string | null;
+}
+/** The AFAS records the customer is linked to (`afas`). */
+export interface OrderCustomerAfasFields {
+    /** The AFAS debtor. */
+    afasVrId: string | null;
+    afasOrgId: string | null;
+    afasContactId: string | null;
+    afasPersId: string | null;
+}
+/** The Parasut contact the customer is linked to (`parasut`). */
+export interface OrderCustomerParasutFields {
+    parasutContactId: string | null;
+}
+/** The customer the order belongs to. */
+export type OrderCustomer<I extends OrderInclude = never> = {
+    id: string;
+    firstName: string;
+    lastName: string;
+    emailAddress: string;
+    phoneNumber: string | null;
+    addresses: OrderCustomerAddress<I>[] | null;
+} & Block<I, 'vatValidation' | 'afas' | 'parasut', {
+    customFields: (Block<I, 'vatValidation', OrderCustomerVatFields> & Block<I, 'afas', OrderCustomerAfasFields> & Block<I, 'parasut', OrderCustomerParasutFields>) | null;
+}>;
+export interface OrderAsset {
+    id: string;
+    /** The preview image's URL. */
+    preview: string;
+}
+/** A variant's stock at one location. */
+export interface OrderLineStockLevel {
+    stockLocationId: string;
+    stockOnHand: number;
+    /** What open orders have reserved there. */
+    stockAllocated: number;
+    stockLocation: {
+        id: string;
+        name: string;
+    };
+}
+/** The variant a line sells, as it stands now (not as it stood at placement). */
+export interface OrderLineVariant {
+    id: string;
+    name: string;
+    sku: string;
+    /**
+     * The catalogue unit price today, net and gross: the retail price, before any
+     * price list or override, unlike the line's own `unitPrice`.
+     *
+     * NOT in the order's currency. It is in the currency of the request: the
+     * store's default, unless the call names another (`tenant.currency`). On an
+     * order in another currency, never subtract it from or compare it with the
+     * line's own prices.
+     */
+    price: number;
+    priceWithTax: number;
+    stockOnHand: number;
+    stockAllocated: number;
+    /** How the variant tracks stock: its own setting, or the store's (`INHERIT`). */
+    trackInventory: InventoryFlag | (string & {});
+    outOfStockThreshold: number;
+    useGlobalOutOfStockThreshold: boolean;
+    stockLevels: OrderLineStockLevel[];
+    product: {
+        id: string;
+        name: string;
+        featuredAsset: OrderAsset | null;
+    };
+}
+/** What a line reserves at one location now. */
+export interface OrderLineOutstandingAllocation {
+    stockLocationId: string;
+    stockLocationName: string;
+    quantity: number;
+}
+/** One raw allocation row of a line (`lineAllocations`). */
+export interface OrderLineAllocation {
+    id: string;
+    stockLocation: {
+        id: string;
+        name: string;
+    };
+    quantity: number;
+}
+/** How a line came to its price. */
+export interface OrderLineCustomFields {
+    /**
+     * A price a merchant set for this line, in the LINE's tax basis: gross when
+     * `OrderLine.listPriceIncludesTax`, net otherwise. It is not the charged
+     * price: the order's price list discounts it in turn.
+     */
+    unitPriceOverride: number | null;
+    priceOverrideReason: string | null;
+    /** The override is an exact price that the price list must not discount. */
+    unitPriceImported: boolean | null;
+    /** The price list the line was priced from, if any. */
+    priceListId: string | null;
+    priceListName: string | null;
+    /** The retail unit price when the line was priced. Always gross. */
+    retailPrice: number | null;
+    /** The unit price the price list gave. Always gross. */
+    priceListPrice: number | null;
+    /** `percentage`, `fixed_amount`, `fixed_price` or `chain`. */
+    priceListDiscountType: string | null;
+    /** Basis points for `percentage`, minor units for the fixed types, null for `chain`. */
+    priceListDiscountValue: number | null;
+    /** JSON: the basis-point discounts of a `chain` entry. */
+    priceListDiscountChain: string | null;
+    /**
+     * The variant's unit cost when the line was priced, net. NOT in the order's
+     * currency: it is the variant's cost as recorded, in the store's default
+     * currency, and is not converted.
+     */
+    cost: number | null;
+    /** The location a merchant picked for this line to ship from. */
+    preferredStockLocationId: string | null;
+    /** Units that stock did not cover at placement. */
+    backorderedQuantity: number | null;
+}
+export type OrderLine<I extends OrderInclude = never> = {
+    id: string;
+    quantity: number;
+    unitPrice: number;
+    unitPriceWithTax: number;
+    /**
+     * The line's list price is stored gross. It follows the customer's tax zone,
+     * not the store's setting: a store that prices gross still holds net lines
+     * for a customer in a tax-exclusive country.
+     */
+    listPriceIncludesTax: boolean;
+    discountedUnitPrice: number;
+    discountedUnitPriceWithTax: number;
+    linePrice: number;
+    linePriceWithTax: number;
+    discountedLinePrice: number;
+    discountedLinePriceWithTax: number;
+    /** The line total with order-level discounts spread over the lines: what the subtotal sums. */
+    proratedLinePrice: number;
+    proratedLinePriceWithTax: number;
+    /** A percentage: 21 for 21 %. */
+    taxRate: number;
+    productVariant: OrderLineVariant;
+    featuredAsset: OrderAsset | null;
+    /**
+     * The units the line reserves now: allocations plus sales minus releases. It
+     * is 0 after a full release, and once the line has shipped.
+     */
+    outstandingAllocatedQuantity: number;
+    /** The same, per location, largest first. Empty when nothing is reserved. */
+    outstandingAllocations: OrderLineOutstandingAllocation[];
+    customFields: OrderLineCustomFields | null;
+} & Block<I, 'lineAllocations', {
+    allocations: OrderLineAllocation[];
+}>;
+export interface OrderSurcharge {
+    id: string;
+    description: string;
+    sku: string | null;
+    /** Net. Negative for a discount. */
+    price: number;
+    priceWithTax: number;
+    /** A percentage: 21 for 21 %. */
+    taxRate: number;
+}
+export interface OrderRefund {
+    id: string;
+    state: string;
+    total: number;
+    reason: string | null;
+}
+export interface OrderPayment {
+    id: string;
+    state: string;
+    /** The payment method's code. */
+    method: string;
+    amount: number;
+    transactionId: string | null;
+    createdAt: string;
+    refunds: OrderRefund[];
+}
+/** A packing slip issued for a fulfillment (`fulfillmentDetails`). */
+export interface OrderPackingSlip {
+    id: string;
+    packingSlipNumber: string;
+    fulfillmentId: string;
+    languageCode: string;
+    storageKey: string;
+    createdAt: string;
+}
+/** What `fulfillmentDetails` adds to a fulfillment. */
+export interface OrderFulfillmentDetails {
+    /** The code of the handler that created the fulfillment, e.g. `hendriks-3pl`. */
+    handlerCode: string;
+    /** The handler's display name, or its code when the handler is no longer registered. */
+    handlerName: string;
+    /** The handler's own rows (a 3PL order number, a barcode). Empty when it has none. */
+    handlerDetails: Array<{
+        label: string;
+        value: string;
+    }>;
+    packingSlips: OrderPackingSlip[];
+}
+/** The MyParcel shipment and label state of a fulfillment (`myparcel`). */
+export interface OrderFulfillmentMyparcelFields {
+    myparcelShipmentId: number | null;
+    /** `pending`, `ready` or `failed`. */
+    myparcelLabelStatus: string | null;
+    /** `A4`, `A6` or `BOTH`. */
+    myparcelLabelFormat: string | null;
+    myparcelLabelUrlA4: string | null;
+    myparcelLabelUrlA6: string | null;
+    myparcelLabelLastError: string | null;
+    /** A label handoff to the 3PL is pending. Set before a shipment exists. */
+    myparcelLabelHandoff: boolean | null;
+}
+export type OrderFulfillment<I extends OrderInclude = never> = {
+    id: string;
+    state: string;
+    nextStates: string[];
+    method: string;
+    trackingCode: string | null;
+    lines: Array<{
+        orderLineId: string;
+        quantity: number;
+    }>;
+    /**
+     * The warehouse it ships from. Null when none was recorded, or when that
+     * warehouse is no longer in this store.
+     */
+    stockLocationName: string | null;
+    /**
+     * Every order this fulfillment ships in this store, this one included,
+     * oldest placement first. One fulfillment can ship several orders of one
+     * customer.
+     */
+    linkedOrders: Array<{
+        id: string;
+        code: string;
+    }>;
+    customFields: ({
+        /** `none`, `booking`, `booked`, `failed` or `cancelled`. Null: booked when it was created. */
+        bookingStatus: string | null;
+    } & Block<I, 'myparcel', OrderFulfillmentMyparcelFields>) | null;
+    createdAt: string;
+} & Block<I, 'fulfillmentDetails', OrderFulfillmentDetails>;
+export interface OrderHistoryEntry {
+    id: string;
+    /** The engine's history entry type, e.g. `ORDER_STATE_TRANSITION`. */
+    type: string;
+    /** The entry's own payload. Its shape depends on `type`. */
+    data: Record<string, unknown>;
+    createdAt: string;
+    isPublic: boolean;
+    /** Who caused it. Null for the customer and for the system. */
+    administrator: {
+        id: string;
+        firstName: string;
+        lastName: string;
+    } | null;
+}
+export interface OrderTaxSummary {
+    description: string;
+    /** A percentage: 21 for 21 %. */
+    taxRate: number;
+    taxBase: number;
+    taxTotal: number;
+}
+/** The order's active fulfillment hold. */
+export interface OrderFulfillmentHold {
+    /** Null for a hold placed before holds carried a reason. */
+    reason: OrderFulfillmentHoldReason | (string & {}) | null;
+    note: string | null;
+    heldAt: string | null;
+    heldByUserId: string | null;
+    /** The display name of the administrator who placed it, when it can be resolved. */
+    heldBy: string | null;
+}
+/** The order's own fields that the engine itself declares. */
+export interface OrderCustomFields {
+    /** The order's content is locked. `admin.orders.status` says by what. */
+    isLocked: boolean | null;
+    /** The order's id on the platform it was imported from. */
+    externalOrderId: string | null;
+    externalPlatform: string | null;
+    /**
+     * Whether the source platform had already handed an imported order to its
+     * own fulfillment provider. Null: not established, or not an imported order.
+     */
+    sourceFulfillmentHandedOff: boolean | null;
+    /** When an imported order was placed on its source platform. */
+    originalPlacedAt: string | null;
+    sourceWarehouse: string | null;
+    /** JSON: the pickup location the buyer chose. */
+    pickupLocation: string | null;
+    /** When the order's stock reservation expires. */
+    allocationExpiresAt: string | null;
+    /** A signed gross amount (0 or below) that rounds the payable total down. */
+    goodwillRoundingMinor: number | null;
+    /** Null: the tax rules decide. True: tax removed. False: tax kept. */
+    removeTax: boolean | null;
+    isGift: boolean | null;
+    giftNote: string | null;
+    hidePricesOnPackingSlip: boolean | null;
+    /** The buyer's purchase-order reference. */
+    poNumber: string | null;
+    requestedDeliveryDate: string | null;
+    orderNotes: string | null;
+    /** The address book entry the shipping address was taken from. */
+    customerShippingAddressId: string | null;
+    customerBillingAddressId: string | null;
+    /** The shipping address is for this order only. */
+    shippingAddressIsTemporary: boolean | null;
+    billingAddressIsTemporary: boolean | null;
+    /**
+     * The four projected status dimensions. Null on an order that predates
+     * them, and for a moment on an order just created or changed.
+     */
+    paymentStatus: string | null;
+    fulfillmentStatus: string | null;
+    returnStatus: string | null;
+    /** `draft`, `open`, `completed` or `cancelled`. */
+    lifecycleStatus: string | null;
+}
+/** The order's own override of its payment terms (`paymentTerms`). */
+export interface OrderPaymentTermsFields {
+    /** A due-day override. Never set together with `paymentConditionCode`. */
+    paymentTermsDays: number | null;
+    /** An ERP payment-condition override. */
+    paymentConditionCode: string | null;
+}
+/** What AFAS holds for the order (`afas`). */
+export interface OrderAfasFields {
+    afasSalesOrderId: string | null;
+    afasDirectInvoiceOrNu: string | null;
+    afasInvoiceNumber: string | null;
+    afasInvoiceDate: string | null;
+    /** The order is settled or invoiced in AFAS. */
+    afasLocked: boolean | null;
+    afasLockReason: string | null;
+    afasLastSyncAt: string | null;
+}
+/** What Parasut holds for the order (`parasut`). */
+export interface OrderParasutFields {
+    parasutInvoiceId: string | null;
+    parasutEInvoiceStatus: string | null;
+    parasutEInvoiceUuid: string | null;
+    parasutLastError: string | null;
+}
+/** The payment terms the order was placed under, and what the ERP later confirmed. */
+export interface OrderPaymentTerms {
+    /** Where the terms came from: an ERP, the store's default. */
+    source: string;
+    managedExternally: boolean;
+    status: OrderPaymentTermsStatus | (string & {});
+    conditionCode: string | null;
+    conditionDescription: string | null;
+    /** The terms in a sentence. */
+    summary: string;
+    classification: OrderPaymentTermsClassification | (string & {});
+    paymentDays: number | null;
+    paymentEndOfMonths: number | null;
+    paymentMethod: string | null;
+    percentage: number | null;
+    discountPaymentDays: number | null;
+    discountPercentage: number | null;
+    paymentDiscountType: string | null;
+    stale: boolean;
+    syncedAt: string | null;
+    error: string | null;
+    /** When the terms were fixed on the order. */
+    resolvedAt: string;
+    /** What the ERP holds for the order, read back after the push. */
+    remoteConditionCode: string | null;
+    remoteConfirmedAt: string | null;
+    /** The ERP holds a different condition than the order was placed under. */
+    remoteMismatch: boolean;
+}
+/** The delivery terms accepted when the order was placed, and what the ERP later confirmed. */
+export interface OrderDeliveryTerms {
+    source: string;
+    sourceScope: string | null;
+    governingCustomerId: string | null;
+    sourceCustomerId: string | null;
+    managedExternally: boolean;
+    status: OrderDeliveryTermsStatus | (string & {});
+    shippingMethodStatus: OrderDeliveryTermsStatus | (string & {});
+    policyStatus: OrderDeliveryTermsStatus | (string & {});
+    /** The terms in a sentence. */
+    summary: string;
+    selectionSource: OrderDeliverySelectionSource | (string & {});
+    selectedShippingMethodId: string | null;
+    selectedShippingMethodCode: string | null;
+    selectedShippingMethodName: string | null;
+    platformShippingMethodCode: string | null;
+    platformShippingMethodName: string | null;
+    platformShippingMethodDescription: string | null;
+    platformShippingPrice: number | null;
+    platformShippingPriceWithTax: number | null;
+    preferredShippingMethodId: string | null;
+    incotermStatus: OrderDeliveryTermsStatus | (string & {});
+    incotermCode: string | null;
+    incotermVersion: number | null;
+    incotermAddress: string | null;
+    incotermDescription: string | null;
+    shippingLeadDays: number | null;
+    deliveryAdvice: OrderDeliveryAdvice | (string & {});
+    stale: boolean;
+    syncedAt: string | null;
+    warning: string | null;
+    /** When the terms were fixed on the order. */
+    resolvedAt: string;
+    /** What the ERP holds for the order, read back after the push. */
+    remoteShippingMethodCode: string | null;
+    remoteShippingMethodName: string | null;
+    remoteIncotermCode: string | null;
+    remoteIncotermVersion: number | null;
+    remoteIncotermAddress: string | null;
+    remoteDeliveryDate: string | null;
+    remoteConfirmedAt: string | null;
+    /** The ERP holds different terms than the order was placed under. */
+    remoteMismatch: boolean;
+}
+/** The price list locked to the order: its one-time pricing. */
+export interface OrderPriceList {
+    id: string;
+    name: string;
+    /** The merchant's reason for the discount. */
+    description: string | null;
+    /** A whole-order percentage in basis points, for every line without an entry of its own. */
+    defaultDiscountBps: number | null;
+    /** A whole-order amount PER UNIT, in the store's tax basis. */
+    defaultDiscountAmount: number | null;
+    /** Keyed by variant: two lines of one variant share an entry. */
+    entries: Array<{
+        id: string;
+        variantId: string;
+        /** `percentage`, `fixed_amount` or `fixed_price`. */
+        discountType: string;
+        /** Basis points for `percentage`, minor units in the store's tax basis otherwise. */
+        discountValue: number;
+    }>;
+}
+/**
+ * An order. `I` is the set of blocks the read asked for: a block's fields are
+ * on the type only when it was included, as they are on the answer.
+ */
+export type Order<I extends OrderInclude = never> = {
+    id: string;
+    code: string;
+    /** The engine state. `admin.orders.status` answers what it allows. */
+    state: string;
+    /**
+     * The order is a cart still open to its shopper. False for a draft, for a
+     * placed order and for a cancelled one. It says nothing about payment: an
+     * order placed on an authorized payment or on account is not active, with
+     * nothing collected yet.
+     */
+    active: boolean;
+    total: number;
+    totalWithTax: number;
+    subTotal: number;
+    subTotalWithTax: number;
+    shipping: number;
+    shippingWithTax: number;
+    /** ISO 4217. */
+    currencyCode: string;
+    /** Null until the order is placed. */
+    orderPlacedAt: string | null;
+    couponCodes: string[];
+    /** Null on an order no customer was set on yet. */
+    customer: OrderCustomer<I> | null;
+    lines: OrderLine<I>[];
+    surcharges: OrderSurcharge[];
+    /**
+     * Every promotion's discount on the order, one entry per promotion, amounts
+     * negative: the line promotions and the order promotions' shares of the lines
+     * and of shipping, added up per promotion. A line's own discounts are already
+     * in its `discountedLinePrice`, so do not add the two. The read selects these
+     * three fields of the pricing module's `OrderDiscount`;
+     * `pricing.discounts(orderId)` answers the rest.
+     */
+    discounts: Array<Pick<OrderDiscount, 'description' | 'amount' | 'amountWithTax'>>;
+    shippingLines: Array<{
+        shippingMethod: {
+            id: string;
+            name: string;
+        };
+    }>;
+    payments: OrderPayment[] | null;
+    fulfillments: OrderFulfillment<I>[] | null;
+    shippingAddress: OrderAddress | null;
+    billingAddress: OrderAddress | null;
+    /** The 50 most recent history entries, newest first. */
+    history: {
+        items: OrderHistoryEntry[];
+    };
+    taxSummary: OrderTaxSummary[];
+    /** Every state the engine's order process allows next. */
+    nextStates: string[];
+    createdAt: string;
+    updatedAt: string;
+    customFields: (OrderCustomFields & Block<I, 'paymentTerms', OrderPaymentTermsFields> & Block<I, 'afas', OrderAfasFields> & Block<I, 'parasut', OrderParasutFields>) | null;
+    /** Null when the order is not on hold. */
+    fulfillmentHold: OrderFulfillmentHold | null;
+    /**
+     * Set when the order was read by an app installation below `customerData:
+     * full`: the customer data its level withholds came back blanked. A blanked
+     * field is `null`, or an empty value where the field is never null: `""`
+     * for a string, `{}` for a history entry's `data`.
+     *
+     * Any part of the answer can be blanked, in the core read and in every
+     * block: whatever the engine counts as customer data at the installation's
+     * level. That is the customer and their addresses, both order addresses
+     * apart from the country, what the buyer typed, and text a carrier, an ERP
+     * or a plugin composed from the customer's record (a tracking code, a label
+     * link, a handler's detail rows, an error it reported, the delivery terms in
+     * a sentence). The engine decides the set, and it grows.
+     *
+     * So when this is set, read EVERY empty value on the order as "not
+     * granted", never as "none on record": an empty email is not a customer
+     * without one, a null label link is not a label still to come. Absent on an
+     * order nothing was withheld from.
+     */
+    redacted?: true;
+} & Block<I, 'paymentTerms', {
+    paymentTerms: OrderPaymentTerms | null;
+}> & Block<I, 'deliveryTerms', {
+    deliveryTerms: OrderDeliveryTerms | null;
+}> & Block<I, 'priceList', {
+    priceList: OrderPriceList | null;
+}>;
+/**
+ * The order document with EVERY block, written out whole.
+ *
+ * One static literal on purpose. The repository's GraphQL cost guard
+ * (`services/vendure/src/rate-limit/__tests__/graphql-cost-fits-repo.spec.ts`)
+ * measures every document this package holds against the engine's caps, and it
+ * can only read a literal. This is the largest operation the dashboard sends,
+ * so it has to be the one that is measured: do not assemble it at run time.
+ *
+ * A block's fields sit between a `#[name` line and its `#]` line. Both are
+ * GraphQL comments, so the literal parses as it stands. `orderQuery` keeps a
+ * marked part when the call included the block, drops it otherwise, and drops
+ * the marker lines either way. `#[a|b` marks a part that is kept when ANY of
+ * the named blocks is included: an object whose every field belongs to a block
+ * (an empty selection is not valid GraphQL).
+ */
+export declare const ORDER_QUERY_EVERY_BLOCK = "\n  query Order($id: ID!) {\n    order(id: $id) {\n      id\n      code\n      state\n      active\n      total\n      totalWithTax\n      subTotal\n      subTotalWithTax\n      shipping\n      shippingWithTax\n      currencyCode\n      orderPlacedAt\n      #[paymentTerms\n      paymentTerms {\n        source\n        managedExternally\n        status\n        conditionCode\n        conditionDescription\n        summary\n        classification\n        paymentDays\n        paymentEndOfMonths\n        paymentMethod\n        percentage\n        discountPaymentDays\n        discountPercentage\n        paymentDiscountType\n        stale\n        syncedAt\n        error\n        resolvedAt\n        remoteConditionCode\n        remoteConfirmedAt\n        remoteMismatch\n      }\n      #]\n      #[deliveryTerms\n      deliveryTerms {\n        source\n        sourceScope\n        governingCustomerId\n        sourceCustomerId\n        managedExternally\n        status\n        shippingMethodStatus\n        policyStatus\n        summary\n        selectionSource\n        selectedShippingMethodId\n        selectedShippingMethodCode\n        selectedShippingMethodName\n        platformShippingMethodCode\n        platformShippingMethodName\n        platformShippingMethodDescription\n        platformShippingPrice\n        platformShippingPriceWithTax\n        preferredShippingMethodId\n        incotermStatus\n        incotermCode\n        incotermVersion\n        incotermAddress\n        incotermDescription\n        shippingLeadDays\n        deliveryAdvice\n        stale\n        syncedAt\n        warning\n        resolvedAt\n        remoteShippingMethodCode\n        remoteShippingMethodName\n        remoteIncotermCode\n        remoteIncotermVersion\n        remoteIncotermAddress\n        remoteDeliveryDate\n        remoteConfirmedAt\n        remoteMismatch\n      }\n      #]\n      couponCodes\n      customer {\n        id\n        firstName\n        lastName\n        emailAddress\n        phoneNumber\n        #[vatValidation|afas|parasut\n        customFields {\n          #[vatValidation\n          vatNumber\n          vatValidationStatus\n          #]\n          #[afas\n          afasVrId\n          afasOrgId\n          afasContactId\n          afasPersId\n          #]\n          #[parasut\n          parasutContactId\n          #]\n        }\n        #]\n        addresses {\n          id\n          fullName\n          company\n          streetLine1\n          streetLine2\n          city\n          postalCode\n          country {\n            code\n          }\n          defaultShippingAddress\n          defaultBillingAddress\n          #[afas\n          customFields {\n            afasAddressId\n          }\n          #]\n        }\n      }\n      lines {\n        id\n        quantity\n        unitPrice\n        unitPriceWithTax\n        listPriceIncludesTax\n        discountedUnitPrice\n        discountedUnitPriceWithTax\n        linePrice\n        linePriceWithTax\n        discountedLinePrice\n        discountedLinePriceWithTax\n        proratedLinePrice\n        proratedLinePriceWithTax\n        taxRate\n        productVariant {\n          id\n          name\n          sku\n          price\n          priceWithTax\n          stockOnHand\n          stockAllocated\n          trackInventory\n          outOfStockThreshold\n          useGlobalOutOfStockThreshold\n          stockLevels {\n            stockLocationId\n            stockOnHand\n            stockAllocated\n            stockLocation {\n              id\n              name\n            }\n          }\n          product {\n            id\n            name\n            featuredAsset {\n              id\n              preview\n            }\n          }\n        }\n        featuredAsset {\n          id\n          preview\n        }\n        #[lineAllocations\n        allocations {\n          id\n          stockLocation {\n            id\n            name\n          }\n          quantity\n        }\n        #]\n        outstandingAllocatedQuantity\n        outstandingAllocations {\n          stockLocationId\n          stockLocationName\n          quantity\n        }\n        customFields {\n          unitPriceOverride\n          priceOverrideReason\n          unitPriceImported\n          priceListId\n          priceListName\n          retailPrice\n          priceListPrice\n          priceListDiscountType\n          priceListDiscountValue\n          priceListDiscountChain\n          cost\n          preferredStockLocationId\n          backorderedQuantity\n        }\n      }\n      surcharges {\n        id\n        description\n        sku\n        price\n        priceWithTax\n        taxRate\n      }\n      discounts {\n        description\n        amount\n        amountWithTax\n      }\n      shippingLines {\n        shippingMethod {\n          id\n          name\n        }\n      }\n      payments {\n        id\n        state\n        method\n        amount\n        transactionId\n        createdAt\n        refunds {\n          id\n          state\n          total\n          reason\n        }\n      }\n      fulfillments {\n        id\n        state\n        nextStates\n        method\n        trackingCode\n        lines {\n          orderLineId\n          quantity\n        }\n        #[fulfillmentDetails\n        handlerCode\n        handlerName\n        handlerDetails {\n          label\n          value\n        }\n        packingSlips {\n          id\n          packingSlipNumber\n          fulfillmentId\n          languageCode\n          storageKey\n          createdAt\n        }\n        #]\n        stockLocationName\n        linkedOrders {\n          id\n          code\n        }\n        customFields {\n          #[myparcel\n          myparcelShipmentId\n          myparcelLabelStatus\n          myparcelLabelFormat\n          myparcelLabelUrlA4\n          myparcelLabelUrlA6\n          myparcelLabelLastError\n          myparcelLabelHandoff\n          #]\n          bookingStatus\n        }\n        createdAt\n      }\n      shippingAddress {\n        fullName\n        company\n        streetLine1\n        streetLine2\n        city\n        province\n        postalCode\n        country\n        countryCode\n        phoneNumber\n      }\n      billingAddress {\n        fullName\n        company\n        streetLine1\n        streetLine2\n        city\n        province\n        postalCode\n        country\n        countryCode\n        phoneNumber\n      }\n      history(options: { take: 50, sort: { createdAt: DESC } }) {\n        items {\n          id\n          type\n          data\n          createdAt\n          isPublic\n          administrator {\n            id\n            firstName\n            lastName\n          }\n        }\n      }\n      taxSummary {\n        description\n        taxRate\n        taxBase\n        taxTotal\n      }\n      nextStates\n      createdAt\n      updatedAt\n      customFields {\n        isLocked\n        externalOrderId\n        externalPlatform\n        sourceFulfillmentHandedOff\n        originalPlacedAt\n        sourceWarehouse\n        pickupLocation\n        allocationExpiresAt\n        goodwillRoundingMinor\n        removeTax\n        isGift\n        giftNote\n        hidePricesOnPackingSlip\n        poNumber\n        requestedDeliveryDate\n        orderNotes\n        customerShippingAddressId\n        customerBillingAddressId\n        shippingAddressIsTemporary\n        billingAddressIsTemporary\n        paymentStatus\n        fulfillmentStatus\n        returnStatus\n        lifecycleStatus\n        #[paymentTerms\n        paymentTermsDays\n        paymentConditionCode\n        #]\n        #[afas\n        afasSalesOrderId\n        afasDirectInvoiceOrNu\n        afasInvoiceNumber\n        afasInvoiceDate\n        afasLocked\n        afasLockReason\n        afasLastSyncAt\n        #]\n        #[parasut\n        parasutInvoiceId\n        parasutEInvoiceStatus\n        parasutEInvoiceUuid\n        parasutLastError\n        #]\n      }\n      fulfillmentHold {\n        reason\n        note\n        heldAt\n        heldByUserId\n        heldBy\n      }\n      #[priceList\n      priceList {\n        id\n        name\n        description\n        defaultDiscountBps\n        defaultDiscountAmount\n        entries {\n          id\n          variantId\n          discountType\n          discountValue\n        }\n      }\n      #]\n    }\n  }\n";
+/**
+ * The document `get` sends for a set of blocks: {@link ORDER_QUERY_EVERY_BLOCK}
+ * without the blocks the call did not include, and without the marker lines.
+ * It depends on the SET only, never on the order the caller listed them in, so
+ * one set is one document.
+ */
+export declare function orderQuery(include?: readonly OrderInclude[]): string;
+/** True for a union of two or more types. */
+type IsUnion<T, U = T> = T extends unknown ? ([U] extends [T] ? false : true) : never;
+/** A list element that names ONE block for sure; an element that may be one of several names none. */
+type SureBlock<E> = [E] extends [never] ? never : true extends IsUnion<E> ? never : E;
+/**
+ * The blocks ONE `include` list type is sure to hold: each element of a list of
+ * fixed length that names exactly one block. A list whose length the type does
+ * not fix (`OrderInclude[]`) is sure of none, and so is an element that may be
+ * one of several (`[block]` for a `block: OrderInclude`).
+ *
+ * Not for a union of lists, which it would answer with every branch's blocks:
+ * {@link OrderFor} splits a union first and applies this to each branch. Kept
+ * out of the published entry for that reason.
+ */
+type SureIncludes<L extends readonly OrderInclude[]> = number extends L['length'] ? never : {
+    [K in keyof L]: SureBlock<L[K]>;
+}[number];
+/**
+ * The order a call to `get` answers, from the `include` list as its TYPE says
+ * it is: the blocks it is sure to hold ({@link SureIncludes}), and no more. A
+ * list that is one of several (`wants ? ['paymentTerms'] : []`) answers one of
+ * the matching orders, which `'paymentTerms' in order` tells apart. A list
+ * that may be absent answers the core read on that branch.
+ */
+export type OrderFor<L extends readonly OrderInclude[] | undefined> = L extends readonly OrderInclude[] ? Order<SureIncludes<L>> : Order;
+/** What `get` takes besides the order id. */
+export type OrderGetOptions = Call & {
+    include?: readonly OrderInclude[];
+};
+/**
+ * The order `get` answers for its options, as their TYPE says they are: the
+ * core read, plus the blocks of {@link OrderFor} when `include` is sure to be
+ * present. Options that may be absent, or an `include` that may be absent,
+ * answer the core read on that branch.
+ */
+export type OrderGetAnswer<O extends OrderGetOptions | undefined> = O extends {
+    include: infer L extends readonly OrderInclude[] | undefined;
+} ? OrderFor<L> : Order;
+export interface OrderGetModule {
+    /**
+     * One order of this store, or null when the store holds no order with that
+     * id (another store's order answers null too). Needs `ReadOrder`.
+     *
+     * Without `include` the answer is the order itself: totals, customer, lines
+     * with their stock and reservations, surcharges, discounts, payments and
+     * refunds, fulfillments, both addresses, the 50 most recent history entries,
+     * the tax summary and the engine's own custom fields. Each name in `include`
+     * adds one plugin's block ({@link ORDER_INCLUDES}), on the answer and on its
+     * type: `get(id, { include: ['priceList'] })` answers an order with
+     * `priceList`, and a read that did not ask for it has no such field.
+     *
+     * The type follows the options as they are TYPED ({@link OrderGetAnswer}):
+     * pass a literal list of block names, or `ORDER_INCLUDES`, to have those
+     * blocks on the type. A list of no fixed length (`OrderInclude[]`), an
+     * element that may be one of several blocks, or an `include` that may be
+     * absent promises no block: it is on the answer, not on the type.
+     *
+     * An `include` name this version does not know is refused with a
+     * `ValidationError` (`INVALID_ORDER_INCLUDE`) before anything is asked.
+     *
+     * An app installation below `customerData: full` reads the order with the
+     * customer data its level withholds blanked, and the answer says so:
+     * `redacted: true` (see {@link Order}).
+     *
+     * Why the order is the way it is (its lock, what may be done to it) is
+     * {@link OrderStatusModule.status}, not a field here.
+     */
+    get(orderId: string): Promise<Order | null>;
+    get<const O extends OrderGetOptions | undefined>(orderId: string, options: O): Promise<OrderGetAnswer<O> | null>;
+}
+export declare function createOrderGetModule(transport: Transport): OrderGetModule;
+export {};