@sixtyninecommerce/admin 0.10.0 → 0.11.0

package/dist/fulfillments/warehouse.d.ts

@@ -0,0 +1,724 @@
+/**
+ * `admin.fulfillments.warehouse`: the pick/pack/ship workspace (headless W10-37; spec
+ * `decoupling-fulfillments`, ADR `2026-09-10-warehouse-access-model`).
+ *
+ * The warehouse API is the fulfillment's own API, built for warehouse staff who have no
+ * `ReadOrder`: it is PRICE-FREE (no order totals, prices, payment amounts, customer e-mail or
+ * billing address; a payment shows as a `paid | due | not_required` badge) and LOCATION-SCOPED.
+ * `detachPreview` is the one exception: it names money, so it is the order API's (`ReadOrder`).
+ *
+ * **Who may act where.** Reads need `ReadFulfillment` (or `UpdateOrder`), writes
+ * `UpdateFulfillment` (or `UpdateOrder`), and the store needs the `warehouse` entitlement
+ * (`WAREHOUSE_NOT_ENABLED` otherwise). `mine`, `demand` and `handlers` also serve office staff of a
+ * store without the entitlement: the shared create flow reads them. A caller holding `UpdateOrder`
+ * is office staff and works in every warehouse of the store, plus the fulfillments with no recorded
+ * warehouse. Anyone else works only in the warehouses a store admin assigned to them (none
+ * assigned: nothing). An API token or app restricted to stock locations is held to those
+ * locations whatever it holds, and never sees a fulfillment with no recorded warehouse.
+ *
+ * **One refusal for "not found" and "not yours":** `LOCATION_OUT_OF_SCOPE`, for a fulfillment or a
+ * warehouse that does not exist, belongs to another store, or is outside the caller's warehouses.
+ * The API never confirms that a fulfillment exists outside the caller's scope.
+ *
+ * **The stages.** With the entitlement a fulfillment moves `Pending → Picking` (`claim`),
+ * `Picking → Pending` (`unclaim`: the claimer or office staff), `Picking → Packed` (`pack`),
+ * `Packed → Picking` (`reopen`, while no carrier booking is active), `→ Shipped` from `Packed`, or
+ * from `Pending` for a 3PL or a manual method (`ship`), and `→ Delivered` from `Shipped` or
+ * `Pending` (`deliver`). A 3PL (`mode: outsourced`) skips picking and packing: creating it was the
+ * handoff. A held order, addresses that diverged in a consolidated fulfillment, a carrier booking
+ * still missing and, on a store that requires it, an order not paid in full each refuse shipping
+ * (`ORDER_ON_HOLD`, `CONSOLIDATION_ADDRESS_DIVERGED`, `BOOKING_REQUIRED`, `ORDER_NOT_COVERED`).
+ *
+ * **Refusals are coded errors.** A write's `WarehouseError` union member is thrown as a
+ * `PlatformError` carrying its `code` (`ALREADY_CLAIMED`, `INVALID_STAGE_TRANSITION`,
+ * `LOCATION_OUT_OF_SCOPE`, …), classified by the same code rules as the errors the warehouse
+ * queries throw, so one refusal reaches you as one class whichever call answered it:
+ * `INVALID_INPUT` is a `ValidationError` (400), `HANDLER_NOT_FOUND` (a carrier code the engine
+ * does not know) a `NotFoundError` (404), and the warehouse's other codes `BusinessRuleError`
+ * (422). A `COMBINE_RULE_VIOLATED` names the part of the rule that broke in `details[0].field`.
+ * Bulk `ship` and `deliver` report each fulfillment's refusal as data and throw only for the call
+ * as a whole. Three refusals come from before the warehouse decides: a missing permission is
+ * `FORBIDDEN`, a carrier of a plugin the store does not have (`setHandler`, `book`) is
+ * `PLUGIN_ACCESS_DENIED` (both `PermissionDeniedError`, 403), and an id that is not a uuid is
+ * `ENTITY_NOT_FOUND` (`NotFoundError`).
+ *
+ * **Idempotency keys: `append` only.** Every other write is safe to repeat: the stage it needs is
+ * gone after the first call, so a repeat is refused (see each method), and `options.idempotencyKey`
+ * is sent nowhere for it. `append` takes one per attempt (made up when omitted, as
+ * `orders.drafts.place` does).
+ */
+import { type Page, type PlatformError, type Transport, ValidationError } from '@sixtyninecommerce/core';
+import type { FulfillmentUnitDisposition } from '../orders/fields.js';
+import type { Call, ConfigArgDefinition } from '../types.js';
+/** How a warehouse's "To ship" queue routes a line. */
+export type WarehouseDemandRouting = 'preferred' | 'allocated' | 'unrouted' | 'no_stock';
+/** The payment dimension as the warehouse sees it: never an amount. */
+export type WarehousePaymentBadge = 'paid' | 'due' | 'not_required';
+/** A requested delivery day compared with today in the store's time zone. */
+export type WarehouseDeliveryDue = 'overdue' | 'today';
+/** In-house with a carrier to book, in-house with nothing to book, or handed to a 3PL. */
+export type WarehouseFulfillmentMode = 'in_house_carrier' | 'in_house_manual' | 'outsourced';
+/** The carrier booking's state, as the engine writes it. */
+export type WarehouseBookingStatus = 'none' | 'booking' | 'booked' | 'failed' | 'cancelled';
+/** Why the "To ship" queue leaves an order out (office reads with `includeIneligible`). */
+export type WarehouseQueueExclusion = 'on_hold' | 'source_may_have_shipped' | 'fulfillment_not_required' | 'not_open';
+/** The requested delivery day, counted in the store's time zone; `this_week` runs to Sunday. */
+export type WarehouseRequestedDelivery = 'overdue' | 'today' | 'this_week';
+/** Longest in its current stage first is the default (`STATE_CHANGED_ASC`). */
+export type WarehouseFulfillmentSort = 'STATE_CHANGED_ASC' | 'STATE_CHANGED_DESC' | 'CREATED_ASC' | 'CREATED_DESC';
+/** Options of the keyed warehouse write (`append`). */
+export interface KeyedWarehouseCall extends Call {
+    /**
+     * One key per attempt, re-sent unchanged on a retry of THAT attempt (a timeout, a dropped
+     * connection). Pass your own: left out, one is made up (a UUIDv7) and returned as
+     * `idempotencyKey` on the result, but on a thrown error only as an untyped own property of the
+     * error. Never reuse a key for a different request or a fresh attempt.
+     */
+    idempotencyKey?: string;
+}
+/** The most fulfillments one `ship`, `deliver` or `pickList` call takes. */
+export declare const MAX_WAREHOUSE_BULK_IDS = 100;
+export interface WarehouseLocation {
+    id: string;
+    name: string;
+}
+/** A shipping address as a picker needs it; never the billing address. */
+export interface WarehouseAddress {
+    fullName: string | null;
+    company: string | null;
+    streetLine1: string | null;
+    streetLine2: string | null;
+    city: string | null;
+    province: string | null;
+    postalCode: string | null;
+    countryCode: string | null;
+}
+/** The buyer as the warehouse sees them: name and phone, no e-mail. */
+export interface WarehouseCustomer {
+    id: string;
+    name: string | null;
+    phone: string | null;
+}
+/** An order's fulfilment hold. Reason and note are null until a reason was recorded. */
+export interface WarehouseHold {
+    reason: string | null;
+    note: string | null;
+}
+export interface WarehouseAsset {
+    id: string;
+    preview: string;
+}
+/** Tab badges of one warehouse. "Today" is today in the store's time zone. */
+export interface WarehouseCounts {
+    toShip: number;
+    toPick: number;
+    picking: number;
+    packed: number;
+    overdue: number;
+    shippedToday: number;
+    outsourced: number;
+}
+export interface WarehouseDemandLine {
+    orderLineId: string;
+    productVariantId: string;
+    sku: string;
+    name: string;
+    featuredAsset: WarehouseAsset | null;
+    /** Ordered minus the units in fulfillments that are not cancelled. */
+    openQty: number;
+    routing: WarehouseDemandRouting;
+    /** The warehouse whose queue shows the line; null for `no_stock`. */
+    routedLocationId: string | null;
+    /** On hand at `routedLocationId`; null when there is no stock level for it. */
+    onHandAtLocation: number | null;
+}
+/** One order of a warehouse's "To ship" queue, with its open lines there. */
+export interface WarehouseDemandOrder {
+    orderId: string;
+    orderCode: string;
+    poNumber: string | null;
+    orderNotes: string | null;
+    /** ISO-8601. */
+    requestedDeliveryDate: string | null;
+    deliveryDue: WarehouseDeliveryDue | null;
+    /** ISO-8601. */
+    orderPlacedAt: string | null;
+    customer: WarehouseCustomer | null;
+    shippingAddress: WarehouseAddress | null;
+    /** Equal for orders that may ship together (same customer and address); null for guests. */
+    consolidationKey: string | null;
+    /** The carrier to preselect: the customer's default delivery preference, else the order's. */
+    suggestedHandlerCode: string | null;
+    paymentBadge: WarehousePaymentBadge;
+    /** Set only for a held order, returned with `includeHeld`. */
+    hold: WarehouseHold | null;
+    /** Why the queue leaves the order out; empty for a queue order (see `includeIneligible`). */
+    queueExclusions: WarehouseQueueExclusion[];
+    /** The platform an imported order came from; null for a native order. */
+    externalPlatform: string | null;
+    externalOrderId: string | null;
+    /** For an imported order: false = its source never handed it off; null = unknown. */
+    sourceFulfillmentHandedOff: boolean | null;
+    /**
+     * Its source platform already handed this imported order to its own fulfilment provider, and
+     * the store blocks shipping it again (the duplicate-export guard's verdict, with the store's own
+     * switch): a create through that guard is refused unless the office states why it may go again.
+     * False when no such guard is loaded or the store does not block.
+     */
+    sourceFulfilled: boolean;
+    /**
+     * Why `sourceFulfilled` is true, in words for staff (the source platform and its order
+     * number); set exactly when `sourceFulfilled` is true, else null. Show it as sent.
+     */
+    sourceFulfilledReason: string | null;
+    /**
+     * The parcel count the customer paid shipping for, while this entry holds the whole order
+     * (every line, nothing of it in a fulfillment yet); null otherwise and when not priced per parcel.
+     */
+    chargedParcelCount: number | null;
+    lines: WarehouseDemandLine[];
+}
+/** What `demand` reads: one warehouse's "To ship" queue. */
+export interface WarehouseDemandInput {
+    stockLocationId: string;
+    /** Order code, customer reference, customer name or SKU. */
+    search?: string;
+    requestedDelivery?: WarehouseRequestedDelivery;
+    /** Also held orders (the office's "On hold" filter). */
+    includeHeld?: boolean;
+    /** Default: preferred, allocated, unrouted. `no_stock` is honoured for office staff only. */
+    routing?: WarehouseDemandRouting[];
+    /** Only these orders (at most 50). */
+    orderIds?: string[];
+    /** The queue's orders that may ship together with these (at most 50). */
+    shipTogetherWith?: string[];
+    /** Office staff, with `orderIds`: also those orders when the queue leaves them out. */
+    includeIneligible?: boolean;
+    /** 1–200, default 50. */
+    take?: number;
+    skip?: number;
+}
+/**
+ * A page of the "To ship" queue. `truncated`: the store had more open lines than the engine reads
+ * at once (5000), so the queue is incomplete.
+ */
+export type WarehouseDemandPage = Page<WarehouseDemandOrder> & {
+    truncated: boolean;
+};
+/** An order a fulfillment ships, as the warehouse sees it. */
+export interface WarehouseOrderRef {
+    id: string;
+    code: string;
+    poNumber: string | null;
+    orderNotes: string | null;
+    requestedDeliveryDate: string | null;
+    deliveryDue: WarehouseDeliveryDue | null;
+    paymentBadge: WarehousePaymentBadge;
+    hold: WarehouseHold | null;
+}
+export interface WarehouseParcel {
+    weightGrams: number;
+    lengthMm: number | null;
+    widthMm: number | null;
+    heightMm: number | null;
+}
+/**
+ * A fulfillment as the workspace lists it. Per-parcel barcodes are
+ * `admin.fulfillments.parcelTracking(id)`, a request of its own.
+ */
+export interface WarehouseFulfillment {
+    id: string;
+    /** `Pending`, `Picking`, `Packed`, `Shipped`, `Delivered`, `Cancelled`. */
+    state: string;
+    handlerCode: string;
+    method: string | null;
+    mode: WarehouseFulfillmentMode;
+    trackingCode: string | null;
+    /** Null for a legacy fulfillment whose warehouse was never recorded (office staff only). */
+    stockLocationId: string | null;
+    stockLocationName: string | null;
+    /** ISO-8601. */
+    createdAt: string;
+    /** ISO-8601: when its current stage began. */
+    stateChangedAt: string | null;
+    /** Past the store's `overdueAfterHours` for its stage. */
+    overdue: boolean;
+    claimedBy: {
+        id: string;
+        name: string | null;
+    } | null;
+    claimedAt: string | null;
+    packedAt: string | null;
+    bookingStatus: WarehouseBookingStatus | null;
+    /** The carrier's last booking error in its own words, never a code. */
+    bookingError: string | null;
+    parcels: WarehouseParcel[];
+    orders: WarehouseOrderRef[];
+    customer: WarehouseCustomer | null;
+    shippingAddress: WarehouseAddress | null;
+    lineCount: number;
+    unitCount: number;
+}
+export interface WarehouseFulfillmentLine {
+    orderLineId: string;
+    orderId: string;
+    orderCode: string;
+    productVariantId: string;
+    sku: string;
+    name: string;
+    featuredAsset: WarehouseAsset | null;
+    quantity: number;
+}
+/** One fulfillment with its lines (`get`). */
+export interface WarehouseFulfillmentDetail extends WarehouseFulfillment {
+    lines: WarehouseFulfillmentLine[];
+}
+/** What `list` reads. Delivered and Cancelled older than 14 days are always left out. */
+export interface WarehouseFulfillmentListInput {
+    /** Default: every warehouse in the caller's scope. */
+    stockLocationId?: string;
+    /** Only fulfillments with no recorded warehouse (office staff with no location restriction). */
+    unassignedOnly?: boolean;
+    states?: string[];
+    /** The carrier filter. */
+    handlerCodes?: string[];
+    overdueOnly?: boolean;
+    claimedByMe?: boolean;
+    /** true: only 3PL handoffs; false: only in-house work. Default: both. */
+    outsourced?: boolean;
+    /** Order code, customer reference, customer name, SKU or tracking code. */
+    search?: string;
+    /** ISO-8601 with an offset. */
+    createdAfter?: string;
+    /** ISO-8601 with an offset: only those whose current stage began at or after it. */
+    stateChangedAfter?: string;
+    requestedDelivery?: WarehouseRequestedDelivery;
+    /** 1–200, default 50. */
+    take?: number;
+    skip?: number;
+    sort?: WarehouseFulfillmentSort;
+}
+/** A carrier (fulfillment handler) as the warehouse offers it: no price. */
+export interface WarehouseFulfillmentHandler {
+    code: string;
+    description: string;
+    mode: WarehouseFulfillmentMode;
+    args: ConfigArgDefinition[];
+    /**
+     * The arguments a create is actually refused without. Read this, never `args[].required`,
+     * which the engine publishes unreliably.
+     */
+    argsRequiredForCreate: string[];
+}
+export interface WarehousePickListBreakdown {
+    fulfillmentId: string;
+    reference: string;
+    orderCodes: string[];
+    quantity: number;
+}
+export interface WarehousePickListLine {
+    sku: string;
+    name: string;
+    productVariantId: string;
+    /** Across the whole selection. */
+    quantity: number;
+    fulfillments: WarehousePickListBreakdown[];
+}
+export interface WarehousePickListFulfillment {
+    id: string;
+    reference: string;
+    state: string;
+    orderCodes: string[];
+    stockLocationName: string | null;
+    lineCount: number;
+    unitCount: number;
+}
+/** A pick list: the selection's lines aggregated by SKU. */
+export interface WarehousePickList {
+    /** ISO-8601. */
+    generatedAt: string;
+    /** The store's IANA time zone, to print `generatedAt` in. */
+    timeZone: string;
+    warehouseNames: string[];
+    printedBy: {
+        id: string;
+        name: string | null;
+    } | null;
+    /** In selection order. */
+    fulfillments: WarehousePickListFulfillment[];
+    /** Sorted by SKU. */
+    lines: WarehousePickListLine[];
+    lineCount: number;
+    unitCount: number;
+}
+export interface WarehouseParcelInput {
+    /** 1–70000. */
+    weightGrams: number;
+    /** 1–10000 each, when given. */
+    lengthMm?: number;
+    widthMm?: number;
+    heightMm?: number;
+}
+export interface PackWarehouseFulfillmentInput {
+    /**
+     * The parcels, 1 to the engine's limit; required while a carrier booking is outstanding
+     * (`PARCELS_REQUIRED`). Omitted: the fulfillment is packed as it stands. An empty list is
+     * refused (`INVALID_INPUT`).
+     */
+    parcels?: WarehouseParcelInput[];
+}
+/** One argument of a carrier, as a name and its value as text. */
+export interface WarehouseHandlerArg {
+    name: string;
+    value: string;
+}
+export interface CorrectWarehouseFulfillmentInput {
+    lines: Array<{
+        orderLineId: string;
+        /** What actually ships for this line within the fulfillment (0 or more, never more). */
+        quantity: number;
+        /** Office staff only (`OFFICE_ONLY` otherwise): also bill the customer for the lower quantity. */
+        reduceOrderLine?: boolean;
+    }>;
+    disposition: FulfillmentUnitDisposition;
+    /** At most 500 characters. */
+    reason?: string;
+}
+/** A line to add to a fulfillment. */
+export interface WarehouseFulfillmentLineInput {
+    orderLineId: string;
+    /** A whole number of 1 or more, at most what is left to ship. */
+    quantity: number;
+}
+/** One fulfillment's refusal inside a bulk call. */
+export interface WarehouseRefusal {
+    code: string;
+    message: string;
+    /** For `COMBINE_RULE_VIOLATED`: the part of the rule that broke. */
+    field: string | null;
+}
+export interface WarehouseBulkItem {
+    fulfillmentId: string;
+    /** The fulfillment as it now is; null when refused. */
+    fulfillment: WarehouseFulfillment | null;
+    error: WarehouseRefusal | null;
+}
+/** A bulk call's outcome: every fulfillment asked for, each on its own. */
+export interface WarehouseBulkResult {
+    results: WarehouseBulkItem[];
+    succeeded: number;
+    failed: number;
+}
+/** Per order that would stay after a detach. Money is integer MINOR UNITS. */
+export interface FulfillmentDetachOrderCharge {
+    orderId: string;
+    code: string;
+    currentCharge: number;
+    newCharge: number;
+}
+/**
+ * What detaching an order would do to the fulfillment's delivery charge. Nothing was written. Money
+ * is integer MINOR UNITS.
+ */
+export interface FulfillmentDetachPreview {
+    /** False when the fulfillment is not profile-bound; every amount is then 0. */
+    deliveryChargeApplies: boolean;
+    profileName: string | null;
+    /** The profile's minimum order value, NET. */
+    profileMinimum: number;
+    currencyCode: string;
+    /** Basis of `newCharge`; `profileMinimum` and `remainingNet` are always net. */
+    priceIncludesTax: boolean;
+    /** Basis of `currentCharge`, read off the charges already made; compare the two first. */
+    currentIncludesTax: boolean;
+    /** What the orders that stay carry of this fulfillment's charge today. */
+    currentCharge: number;
+    /** What they would be charged once priced alone: may be MORE than their shares. */
+    newCharge: number;
+    orders: FulfillmentDetachOrderCharge[];
+    /** The net of what would still ship, measured against `profileMinimum`. */
+    remainingNet: number;
+    belowProfileMinimum: boolean;
+    /** Set when the detach itself would be refused; no amount is meaningful then. */
+    refusal: {
+        code: string;
+        message: string;
+    } | null;
+}
+export interface WarehouseFulfillmentsModule {
+    /**
+     * The warehouses the caller may work in: every warehouse of the store for office staff, the
+     * assigned ones for anyone else (empty until a store admin assigns one), never more than a
+     * location-restricted credential's own.
+     *
+     * @effect read
+     */
+    mine(options?: Call): Promise<WarehouseLocation[]>;
+    /**
+     * One warehouse's tab badges. `LOCATION_OUT_OF_SCOPE` for a warehouse outside the caller's scope.
+     *
+     * @effect read
+     */
+    counts(stockLocationId: string, options?: Call): Promise<WarehouseCounts>;
+    /**
+     * A warehouse's "To ship" queue: the open lines it should ship, by order, requested delivery
+     * day first, then oldest placement. `page.next()` reads the following page with the same input.
+     * `LOCATION_OUT_OF_SCOPE` for a warehouse outside the caller's scope. Each order says whether its
+     * source platform already fulfilled it (`sourceFulfilled`, with the engine's own sentence in
+     * `sourceFulfilledReason`), the same verdict that refuses its create.
+     *
+     * @effect read
+     */
+    demand(input: WarehouseDemandInput, options?: Call): Promise<WarehouseDemandPage>;
+    /**
+     * The fulfillments in the caller's scope, longest in their stage first by default.
+     * `page.next()` reads the following page with the same input.
+     *
+     * @effect read
+     */
+    list(input?: WarehouseFulfillmentListInput, options?: Call): Promise<Page<WarehouseFulfillment>>;
+    /**
+     * One fulfillment with its lines. `LOCATION_OUT_OF_SCOPE` when it does not exist or is not in
+     * the caller's scope.
+     *
+     * @effect read
+     */
+    get(fulfillmentId: string, options?: Call): Promise<WarehouseFulfillmentDetail>;
+    /**
+     * The carriers with their argument forms and mode, for switching a fulfillment's carrier and for
+     * choosing one at create. Definitions only.
+     *
+     * @effect read
+     */
+    handlers(options?: Call): Promise<WarehouseFulfillmentHandler[]>;
+    /**
+     * The pick list of up to 100 fulfillments in the caller's scope, aggregated by SKU, in the order
+     * given. Reading it claims nothing: claim the Pending ones first if the picker takes them.
+     *
+     * @effect read
+     */
+    pickList(fulfillmentIds: string[], options?: Call): Promise<WarehousePickList>;
+    /**
+     * The orders that may join this fulfillment: open lines in its warehouse's "To ship" queue from
+     * the same customer and address. Held orders are left out.
+     *
+     * @effect read
+     */
+    appendCandidates(fulfillmentId: string, options?: Call): Promise<WarehouseDemandOrder[]>;
+    /**
+     * What detaching this order would do to the fulfillment's delivery charge, changing nothing: the
+     * orders that stay are re-priced as if they shipped alone, which may be MORE than their shares.
+     * Office staff only (`ReadOrder`): it names money, which the warehouse API never does. A detach
+     * the engine would refuse comes back as `refusal`, not a throw. Read without a lock: the detach
+     * decides again.
+     *
+     * @effect read
+     */
+    detachPreview(fulfillmentId: string, orderId: string, options?: Call): Promise<FulfillmentDetachPreview>;
+    /**
+     * `Pending → Picking` for the caller. A 3PL fulfillment cannot be claimed
+     * (`OUTSOURCED_NOT_CLAIMABLE`). Someone else's claim, or a repeat of your own, is refused
+     * `ALREADY_CLAIMED` naming who holds it.
+     *
+     * @effect write
+     */
+    claim(fulfillmentId: string, options?: Call): Promise<WarehouseFulfillment>;
+    /**
+     * `Picking → Pending`: the claimer, or office staff (`NOT_CLAIMER` for anyone else). A repeat is
+     * refused `INVALID_STAGE_TRANSITION`.
+     *
+     * @effect write
+     */
+    unclaim(fulfillmentId: string, options?: Call): Promise<WarehouseFulfillment>;
+    /**
+     * `Packed → Picking`, while no carrier booking is active (`BOOKING_ACTIVE`). A failed booking
+     * survives it. A repeat is refused `INVALID_STAGE_TRANSITION`.
+     *
+     * @effect write
+     */
+    reopen(fulfillmentId: string, options?: Call): Promise<WarehouseFulfillment>;
+    /**
+     * `Picking → Packed`, recording the parcels in the same step (a refused pack keeps none).
+     * `NOTHING_TO_PACK`, `PARCELS_REQUIRED` (a carrier booking is outstanding), `INVALID_INPUT` for a
+     * parcel out of bounds. A repeat is refused `INVALID_STAGE_TRANSITION`.
+     *
+     * @effect write
+     */
+    pack(fulfillmentId: string, input?: PackWarehouseFulfillmentInput, options?: Call): Promise<WarehouseFulfillment>;
+    /**
+     * Book the carrier label of a Packed fulfillment (a 3PL's handoff in any open stage), on the
+     * store's own carrier account; also the Retry of a failed booking, which adopts what the carrier
+     * already holds instead of booking twice. The label is bought in the background:
+     * `bookingStatus` reads `booking`, then `booked` or `failed`. Refused `BOOKING_ACTIVE` while one is
+     * being booked or is booked (so a repeat books nothing), `BOOKING_NOT_SUPPORTED` for a method
+     * with nothing to book, or one that books only at create. A carrier of a plugin the store does
+     * not have is `PLUGIN_ACCESS_DENIED` (`PermissionDeniedError`, 403).
+     *
+     * @effect money
+     */
+    book(fulfillmentId: string, options?: Call): Promise<WarehouseFulfillment>;
+    /**
+     * Cancel the carrier label; the fulfillment stays Packed. `NOT_BOOKED` when nothing is booked,
+     * which is also what a repeat answers. A failed booking is cleared by `book` (Retry), never by
+     * this.
+     *
+     * @effect destructive
+     */
+    unbook(fulfillmentId: string, options?: Call): Promise<WarehouseFulfillment>;
+    /**
+     * Switch the carrier of a Pending, Picking or Packed fulfillment while nothing is booked
+     * (`BOOKING_ACTIVE`). A 3PL is fixed once handed over, and cannot be chosen for an existing
+     * fulfillment (`OUTSOURCED_HANDOFF_FIXED`). After a FAILED booking the switch first retracts at
+     * the carrier whatever shipment those attempts left, so it neither ships nor is adopted later.
+     * Each switch writes a private note on every order of the fulfillment. A carrier code the engine
+     * does not know is `HANDLER_NOT_FOUND` (`NotFoundError`, 404); one of a plugin the store does
+     * not have is `PLUGIN_ACCESS_DENIED` (`PermissionDeniedError`, 403); arguments the carrier
+     * refuses are `PROVIDER_VALIDATION_FAILED`.
+     *
+     * @effect destructive
+     */
+    setHandler(fulfillmentId: string, handlerCode: string, handlerArgs?: WarehouseHandlerArg[], options?: Call): Promise<WarehouseFulfillment>;
+    /**
+     * Office staff only (`UpdateOrder`): give a Pending fulfillment with NO recorded warehouse its
+     * warehouse. Refused `SALE_LOCATION_MISMATCH` when its stock was sold from another one, and
+     * `WAREHOUSE_ALREADY_SET` once it has one (so a repeat changes nothing). A credential
+     * restricted to stock locations is answered `LOCATION_OUT_OF_SCOPE`.
+     *
+     * @effect write
+     */
+    setWarehouse(fulfillmentId: string, stockLocationId: string, options?: Call): Promise<WarehouseFulfillment>;
+    /**
+     * Record a short pick: what actually ships of each named line. The units taken out go back to
+     * stock or are written off (`disposition`). Without `reduceOrderLine` the order keeps asking for
+     * them (a later fulfillment ships them). A correction that empties an order of a consolidated
+     * fulfillment takes it out and re-prices the delivery charge of the orders that stay.
+     * `reduceOrderLine` (office staff only, `OFFICE_ONLY` otherwise) also bills the customer for the
+     * lower quantity; it issues no refund. A repeat changes nothing and is refused
+     * (`INVALID_INPUT`: nothing to correct).
+     *
+     * @effect money
+     */
+    correct(fulfillmentId: string, input: CorrectWarehouseFulfillmentInput, options?: Call): Promise<WarehouseFulfillment>;
+    /**
+     * Mark up to 100 fulfillments shipped (from Packed, or Pending for a 3PL or a manual method), each
+     * on its own; `trackingCode` (at most 255 characters) is set on every one. The customer gets the
+     * shipped e-mail. Each item's refusal is in its `error`; a repeat is refused per item
+     * (`INVALID_STAGE_TRANSITION`), so nothing ships or mails twice. Throws only for the call as a
+     * whole (no ids, more than 100, the store without the warehouse workspace).
+     *
+     * Shipping an order's last open lines moves the ORDER to `Shipped`, which on a store that
+     * pushes orders to its ERP when they ship (Exact Online's "fulfilled" auto-push) sends each such
+     * order there, where it cannot be taken back.
+     *
+     * @effect irreversible
+     */
+    ship(fulfillmentIds: string[], trackingCode?: string, options?: Call): Promise<WarehouseBulkResult>;
+    /**
+     * Mark up to 100 fulfillments delivered (from Shipped, or Pending), each on its own, as `ship`
+     * reports them.
+     *
+     * @effect write
+     */
+    deliver(fulfillmentIds: string[], options?: Call): Promise<WarehouseBulkResult>;
+    /**
+     * Add lines, typically another order of the same customer and address, to a Pending or Picking
+     * fulfillment with nothing booked. The lines ship from the fulfillment's warehouse and pass the
+     * create path's rules (`COMBINE_RULE_VIOLATED`, `LINE_OVER_FULFILLED`,
+     * `INSUFFICIENT_STOCK_AT_LOCATION`, `PROVIDER_NO_CONSOLIDATION`, `ORDER_NOT_COVERED`, …).
+     *
+     * A line nobody picked a warehouse for, whose stock is reserved at another warehouse, has its
+     * reservation moved here: released there and taken from this warehouse, as it is for warehouse
+     * staff assigned here (a line whose order picked another warehouse is refused,
+     * `LINE_PREFERS_OTHER_LOCATION`).
+     *
+     * MONEY: the fulfillment's delivery charge is re-priced across its orders, so what each order is
+     * billed may change (`SURCHARGE_LOCKED_BY_ERP` when an ERP already holds a share,
+     * `ORDER_BILLING_LOCKED` for an invoiced order). A charge it lowers or removes on an order that
+     * already paid it is NOT refunded or credited: the engine only logs that a refund may be owed.
+     *
+     * One key per attempt (`options.idempotencyKey`): a repeat under the same key answers the
+     * fulfillment as it is now and adds nothing, however few of a line's units it asked for. Another
+     * request under that key is `IDEMPOTENCY_CONFLICT` (`ConflictError`, 409), and a repeat while the
+     * first is still running `IDEMPOTENCY_IN_PROGRESS`. A refusal does not spend the key (nothing was
+     * added), so a repeat under it runs again. Left out, a key is made up and returned as
+     * `idempotencyKey` on the result, and on a thrown error as an untyped own property of the error.
+     *
+     * @effect money
+     */
+    append(fulfillmentId: string, lines: WarehouseFulfillmentLineInput[], options?: KeyedWarehouseCall): Promise<WarehouseFulfillment & {
+        idempotencyKey: string;
+    }>;
+    /**
+     * Take an order out of a Pending or Picking fulfillment that ships several, with nothing booked:
+     * its lines go back to the "To ship" queue, reserved at this warehouse. The last order cannot
+     * leave (`DETACH_LAST_ORDER`: remove the fulfillment instead). A repeat is refused
+     * (`INVALID_INPUT`: the order is no longer in it).
+     *
+     * MONEY: the orders that stay are re-priced as if they shipped alone, which may be MORE than
+     * their shares (`detachPreview` shows the figure first; `SURCHARGE_LOCKED_BY_ERP` when an ERP
+     * holds a share). A charge it lowers or removes on an order that already paid it is NOT refunded
+     * or credited: the engine only logs that a refund may be owed.
+     *
+     * @effect money
+     */
+    detach(fulfillmentId: string, orderId: string, options?: Call): Promise<WarehouseFulfillment>;
+}
+/**
+ * Every field of `WarehouseFulfillment` the workspace reads, without `lines`. A field list, never a
+ * named fragment: `orders-coverage.spec.ts` reads each document's root field with every
+ * interpolation replaced, which a fragment spread at the top level would not survive.
+ */
+export declare const FULFILLMENT_FIELDS = "\n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n";
+export declare const MY_WAREHOUSES_QUERY = "\n  query MyWarehouses {\n    myWarehouses {\n      id\n      name\n    }\n  }\n";
+export declare const WAREHOUSE_COUNTS_QUERY = "\n  query WarehouseCounts($stockLocationId: ID!) {\n    warehouseCounts(stockLocationId: $stockLocationId) {\n      toShip\n      toPick\n      picking\n      packed\n      overdue\n      shippedToday\n      outsourced\n    }\n  }\n";
+export declare const WAREHOUSE_DEMAND_QUERY = "\n  query WarehouseDemand($input: WarehouseDemandInput!) {\n    warehouseDemand(input: $input) {\n      totalItems\n      truncated\n      items {\n        \n  orderId\n  orderCode\n  poNumber\n  orderNotes\n  requestedDeliveryDate\n  deliveryDue\n  orderPlacedAt\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  consolidationKey\n  suggestedHandlerCode\n  paymentBadge\n  hold {\n    reason\n    note\n  }\n  queueExclusions\n  externalPlatform\n  externalOrderId\n  sourceFulfillmentHandedOff\n  sourceFulfilled\n  sourceFulfilledReason\n  chargedParcelCount\n  lines {\n    orderLineId\n    productVariantId\n    sku\n    name\n    featuredAsset {\n      id\n      preview\n    }\n    openQty\n    routing\n    routedLocationId\n    onHandAtLocation\n  }\n\n      }\n    }\n  }\n";
+export declare const WAREHOUSE_FULFILLMENTS_QUERY = "\n  query WarehouseFulfillments($input: WarehouseFulfillmentListInput) {\n    warehouseFulfillments(input: $input) {\n      totalItems\n      items {\n        \n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n\n      }\n    }\n  }\n";
+export declare const WAREHOUSE_FULFILLMENT_QUERY = "\n  query WarehouseFulfillment($id: ID!) {\n    warehouseFulfillment(id: $id) {\n      \n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n\n      lines {\n        orderLineId\n        orderId\n        orderCode\n        productVariantId\n        sku\n        name\n        featuredAsset {\n          id\n          preview\n        }\n        quantity\n      }\n    }\n  }\n";
+export declare const WAREHOUSE_FULFILLMENT_HANDLERS_QUERY = "\n  query WarehouseFulfillmentHandlers {\n    warehouseFulfillmentHandlers {\n      code\n      description\n      mode\n      argsRequiredForCreate\n      args {\n        name\n        type\n        list\n        required\n        defaultValue\n        label\n        description\n        ui\n      }\n    }\n  }\n";
+export declare const WAREHOUSE_PICK_LIST_QUERY = "\n  query WarehousePickList($fulfillmentIds: [ID!]!) {\n    warehousePickList(fulfillmentIds: $fulfillmentIds) {\n      generatedAt\n      timeZone\n      warehouseNames\n      lineCount\n      unitCount\n      printedBy {\n        id\n        name\n      }\n      fulfillments {\n        id\n        reference\n        state\n        orderCodes\n        stockLocationName\n        lineCount\n        unitCount\n      }\n      lines {\n        sku\n        name\n        productVariantId\n        quantity\n        fulfillments {\n          fulfillmentId\n          reference\n          orderCodes\n          quantity\n        }\n      }\n    }\n  }\n";
+export declare const WAREHOUSE_APPEND_CANDIDATES_QUERY = "\n  query WarehouseAppendCandidates($fulfillmentId: ID!) {\n    warehouseAppendCandidates(fulfillmentId: $fulfillmentId) {\n      \n  orderId\n  orderCode\n  poNumber\n  orderNotes\n  requestedDeliveryDate\n  deliveryDue\n  orderPlacedAt\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  consolidationKey\n  suggestedHandlerCode\n  paymentBadge\n  hold {\n    reason\n    note\n  }\n  queueExclusions\n  externalPlatform\n  externalOrderId\n  sourceFulfillmentHandedOff\n  sourceFulfilled\n  sourceFulfilledReason\n  chargedParcelCount\n  lines {\n    orderLineId\n    productVariantId\n    sku\n    name\n    featuredAsset {\n      id\n      preview\n    }\n    openQty\n    routing\n    routedLocationId\n    onHandAtLocation\n  }\n\n    }\n  }\n";
+/** The order API, not the warehouse one: it names money (`ReadOrder`). */
+export declare const FULFILLMENT_DETACH_PREVIEW_QUERY = "\n  query FulfillmentDetachPreview($fulfillmentId: ID!, $orderId: ID!) {\n    fulfillmentDetachPreview(fulfillmentId: $fulfillmentId, orderId: $orderId) {\n      deliveryChargeApplies\n      profileName\n      profileMinimum\n      currencyCode\n      priceIncludesTax\n      currentIncludesTax\n      currentCharge\n      newCharge\n      orders {\n        orderId\n        code\n        currentCharge\n        newCharge\n      }\n      remainingNet\n      belowProfileMinimum\n      refusal {\n        code\n        message\n      }\n    }\n  }\n";
+export declare const CLAIM_FULFILLMENT_MUTATION = "\n  mutation ClaimFulfillment($id: ID!) {\n    claimFulfillment(id: $id) {\n      \n  __typename\n  ... on WarehouseFulfillment {\n    \n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n\n  }\n  \n  ... on WarehouseError {\n    errorCode\n    code\n    message\n    field\n  }\n\n\n    }\n  }\n";
+export declare const UNCLAIM_FULFILLMENT_MUTATION = "\n  mutation UnclaimFulfillment($id: ID!) {\n    unclaimFulfillment(id: $id) {\n      \n  __typename\n  ... on WarehouseFulfillment {\n    \n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n\n  }\n  \n  ... on WarehouseError {\n    errorCode\n    code\n    message\n    field\n  }\n\n\n    }\n  }\n";
+export declare const REOPEN_FULFILLMENT_MUTATION = "\n  mutation ReopenFulfillment($id: ID!) {\n    reopenFulfillment(id: $id) {\n      \n  __typename\n  ... on WarehouseFulfillment {\n    \n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n\n  }\n  \n  ... on WarehouseError {\n    errorCode\n    code\n    message\n    field\n  }\n\n\n    }\n  }\n";
+export declare const PACK_FULFILLMENT_MUTATION = "\n  mutation PackFulfillment($id: ID!, $parcels: [WarehouseParcelInput!]) {\n    packFulfillment(id: $id, parcels: $parcels) {\n      \n  __typename\n  ... on WarehouseFulfillment {\n    \n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n\n  }\n  \n  ... on WarehouseError {\n    errorCode\n    code\n    message\n    field\n  }\n\n\n    }\n  }\n";
+export declare const BOOK_FULFILLMENT_MUTATION = "\n  mutation BookFulfillment($id: ID!) {\n    bookFulfillment(id: $id) {\n      \n  __typename\n  ... on WarehouseFulfillment {\n    \n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n\n  }\n  \n  ... on WarehouseError {\n    errorCode\n    code\n    message\n    field\n  }\n\n\n    }\n  }\n";
+export declare const UNBOOK_FULFILLMENT_MUTATION = "\n  mutation UnbookFulfillment($id: ID!) {\n    unbookFulfillment(id: $id) {\n      \n  __typename\n  ... on WarehouseFulfillment {\n    \n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n\n  }\n  \n  ... on WarehouseError {\n    errorCode\n    code\n    message\n    field\n  }\n\n\n    }\n  }\n";
+export declare const SET_FULFILLMENT_HANDLER_MUTATION = "\n  mutation SetFulfillmentHandler(\n    $id: ID!\n    $handlerCode: String!\n    $handlerArgs: [WarehouseHandlerArgInput!]\n  ) {\n    setFulfillmentHandler(id: $id, handlerCode: $handlerCode, handlerArgs: $handlerArgs) {\n      \n  __typename\n  ... on WarehouseFulfillment {\n    \n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n\n  }\n  \n  ... on WarehouseError {\n    errorCode\n    code\n    message\n    field\n  }\n\n\n    }\n  }\n";
+export declare const SET_FULFILLMENT_WAREHOUSE_MUTATION = "\n  mutation SetFulfillmentWarehouse($id: ID!, $stockLocationId: ID!) {\n    setFulfillmentWarehouse(id: $id, stockLocationId: $stockLocationId) {\n      \n  __typename\n  ... on WarehouseFulfillment {\n    \n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n\n  }\n  \n  ... on WarehouseError {\n    errorCode\n    code\n    message\n    field\n  }\n\n\n    }\n  }\n";
+export declare const CORRECT_FULFILLMENT_QUANTITIES_MUTATION = "\n  mutation CorrectFulfillmentQuantities(\n    $fulfillmentId: ID!\n    $lines: [WarehouseQuantityCorrectionLineInput!]!\n    $disposition: FulfillmentUnitDisposition!\n    $reason: String\n  ) {\n    correctFulfillmentQuantities(\n      fulfillmentId: $fulfillmentId\n      lines: $lines\n      disposition: $disposition\n      reason: $reason\n    ) {\n      \n  __typename\n  ... on WarehouseFulfillment {\n    \n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n\n  }\n  \n  ... on WarehouseError {\n    errorCode\n    code\n    message\n    field\n  }\n\n\n    }\n  }\n";
+export declare const SHIP_FULFILLMENTS_MUTATION = "\n  mutation ShipFulfillments($ids: [ID!]!, $trackingCode: String) {\n    shipFulfillments(ids: $ids, trackingCode: $trackingCode) {\n      \n  __typename\n  ... on WarehouseBulkResult {\n    succeeded\n    failed\n    results {\n      fulfillmentId\n      fulfillment {\n        \n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n\n      }\n      error {\n        code\n        message\n        field\n      }\n    }\n  }\n  \n  ... on WarehouseError {\n    errorCode\n    code\n    message\n    field\n  }\n\n\n    }\n  }\n";
+export declare const DELIVER_FULFILLMENTS_MUTATION = "\n  mutation DeliverFulfillments($ids: [ID!]!) {\n    deliverFulfillments(ids: $ids) {\n      \n  __typename\n  ... on WarehouseBulkResult {\n    succeeded\n    failed\n    results {\n      fulfillmentId\n      fulfillment {\n        \n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n\n      }\n      error {\n        code\n        message\n        field\n      }\n    }\n  }\n  \n  ... on WarehouseError {\n    errorCode\n    code\n    message\n    field\n  }\n\n\n    }\n  }\n";
+export declare const APPEND_TO_FULFILLMENT_MUTATION = "\n  mutation AppendToFulfillment(\n    $id: ID!\n    $lines: [WarehouseFulfillmentLineInput!]!\n    $idempotencyKey: String\n  ) {\n    appendToFulfillment(id: $id, lines: $lines, idempotencyKey: $idempotencyKey) {\n      \n  __typename\n  ... on WarehouseFulfillment {\n    \n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n\n  }\n  \n  ... on WarehouseError {\n    errorCode\n    code\n    message\n    field\n  }\n\n\n    }\n  }\n";
+export declare const DETACH_ORDER_FROM_FULFILLMENT_MUTATION = "\n  mutation DetachOrderFromFulfillment($id: ID!, $orderId: ID!) {\n    detachOrderFromFulfillment(id: $id, orderId: $orderId) {\n      \n  __typename\n  ... on WarehouseFulfillment {\n    \n  id\n  state\n  handlerCode\n  method\n  mode\n  trackingCode\n  stockLocationId\n  stockLocationName\n  createdAt\n  stateChangedAt\n  overdue\n  claimedBy {\n    id\n    name\n  }\n  claimedAt\n  packedAt\n  bookingStatus\n  bookingError\n  parcels {\n    weightGrams\n    lengthMm\n    widthMm\n    heightMm\n  }\n  orders {\n    id\n    code\n    poNumber\n    orderNotes\n    requestedDeliveryDate\n    deliveryDue\n    paymentBadge\n    hold {\n      reason\n      note\n    }\n  }\n  customer {\n    id\n    name\n    phone\n  }\n  shippingAddress {\n    \n  fullName\n  company\n  streetLine1\n  streetLine2\n  city\n  province\n  postalCode\n  countryCode\n\n  }\n  lineCount\n  unitCount\n\n  }\n  \n  ... on WarehouseError {\n    errorCode\n    code\n    message\n    field\n  }\n\n\n    }\n  }\n";
+/** The key a caller retries under, on an error of a call whose key it did not choose. */
+export declare function withAttemptKey(error: unknown, key: string): unknown;
+export interface RawRefusal {
+    __typename?: string;
+    code: string;
+    message: string;
+    field?: string | null;
+}
+export declare function isWarehouseErrorMember(value: unknown): value is RawRefusal;
+/**
+ * A `WarehouseError` as the error the SAME code would be if a warehouse query had thrown it: the
+ * queries refuse with these codes as GraphQL errors, so classifying the union member by the
+ * ErrorResult rules would give one refusal two classes (`INVALID_INPUT` a 400 from a query and a
+ * 422 from a mutation).
+ *
+ * NOTE: every SDK method over a `WarehouseError` union classifies through this function, never
+ * through `errorFromErrorResult` (the create door, `createWarehouseFulfillments`, included).
+ * `fulfillments-warehouse.spec.ts` pins the class of every `WarehouseErrorCode`, so a change to
+ * core's GraphQL-dialect rules cannot move one silently.
+ */
+export declare function warehouseRefusalError(refusal: RawRefusal): PlatformError;
+export declare function invalid(field: string, message: string): ValidationError;
+/** Refused before any request: an absent id would otherwise fail GraphQL validation, uncoded. */
+export declare function assertId(value: unknown, field: string): asserts value is string;
+export type RawFulfillment = WarehouseFulfillment & {
+    __typename?: string;
+};
+export declare function toFulfillment(raw: RawFulfillment): WarehouseFulfillment;
+export declare function toRefusal(raw: RawRefusal | null | undefined): WarehouseRefusal | null;
+export declare function createWarehouseFulfillmentsModule(transport: Transport): WarehouseFulfillmentsModule;