@sixtyninecommerce/admin 0.8.0 → 0.10.0

package/dist/stock/transfers.d.ts

@@ -0,0 +1,520 @@
+import { type Page, type Transport } from '@sixtyninecommerce/core';
+import { type MyparcelUnretractedShipment } from '../fulfillments/index.js';
+import type { Call, ListOptions } from '../types.js';
+export type StockTransferState = 'draft' | 'in_transit' | 'received' | 'cancelled';
+/** A `transfer` moves stock between two locations; a `consumption` uses it up at one. */
+export type StockTransferKind = 'transfer' | 'consumption';
+export interface StockTransferAddress {
+    contactName: string | null;
+    company: string | null;
+    streetLine1: string;
+    streetLine2: string | null;
+    city: string;
+    province: string | null;
+    postalCode: string;
+    /** ISO 3166-1 alpha-2, upper case. */
+    countryCode: string;
+    phoneNumber: string | null;
+}
+export interface StockTransferAddressInput {
+    contactName?: string | null;
+    company?: string | null;
+    streetLine1: string;
+    streetLine2?: string | null;
+    city: string;
+    province?: string | null;
+    postalCode: string;
+    countryCode: string;
+    phoneNumber?: string | null;
+}
+export interface StockTransferLine {
+    id: string;
+    variantId: string;
+    sku: string;
+    quantity: number;
+    receivedQuantity: number;
+    lostQuantity: number;
+    /**
+     * `quantity − received − lost − returned to the source`. The units a close
+     * sent back to the source are read by `shortfall(id)`.
+     */
+    outstandingQuantity: number;
+}
+export interface StockTransfer {
+    id: string;
+    code: string;
+    kind: StockTransferKind;
+    state: StockTransferState;
+    sourceLocation: {
+        id: string;
+        name: string;
+    };
+    /** Null for a consumption. */
+    destinationLocation: {
+        id: string;
+        name: string;
+    } | null;
+    label: string | null;
+    /** Free text for the people moving the stock. Not a movement reason. */
+    note: string | null;
+    carrier: string | null;
+    trackingCode: string | null;
+    estimatedArrivalAt: string | null;
+    shippedAt: string | null;
+    receivedAt: string | null;
+    cancelledAt: string | null;
+    cancelReason: string | null;
+    deliveryAddress: StockTransferAddress | null;
+    createdAt: string;
+    updatedAt: string;
+    items: StockTransferLine[];
+    totalQuantity: number;
+    totalReceivedQuantity: number;
+    totalLostQuantity: number;
+}
+export interface StockTransferLineInput {
+    variantId: string;
+    quantity: number;
+}
+export interface CreateStockTransferInput {
+    /** Defaults to `transfer`. A `consumption` has no destination. */
+    kind?: StockTransferKind;
+    sourceLocationId: string;
+    /** Required for a transfer; omit for a consumption. */
+    destinationLocationId?: string;
+    label?: string;
+    note?: string;
+    lines: StockTransferLineInput[];
+}
+/** A draft's fields; an omitted field is left as it is. */
+export interface UpdateStockTransferInput {
+    sourceLocationId?: string;
+    destinationLocationId?: string;
+    label?: string;
+    note?: string;
+    /** Replaces every line. */
+    lines?: StockTransferLineInput[];
+    carrier?: string;
+    trackingCode?: string;
+    /** ISO 8601 with an explicit offset. */
+    estimatedArrivalAt?: string;
+}
+export interface ShipStockTransferInput {
+    carrier?: string;
+    trackingCode?: string;
+    /** ISO 8601 with an explicit offset. */
+    estimatedArrivalAt?: string;
+    /** The engine's fulfilment handler code; defaults to manual shipping. */
+    fulfillmentHandlerCode?: string;
+    handlerArgs?: Record<string, unknown>;
+    /** Ship somewhere other than the destination's own address; null re-addresses it there. */
+    deliveryAddress?: StockTransferAddressInput | null;
+}
+export interface ReceiveStockTransferLineInput {
+    lineId: string;
+    receivedQuantity: number;
+    lostQuantity: number;
+}
+/**
+ * What closing a transfer does with a line's unaccounted units: `LOST` writes
+ * them off (what a close does without a disposition), `RETURN_TO_SOURCE`
+ * credits them back to the transfer's source location.
+ */
+export type StockTransferShortfallDisposition = 'LOST' | 'RETURN_TO_SOURCE';
+/** One line's disposition when closing a transfer. */
+export interface StockTransferShortfallLineInput {
+    /** A line (`StockTransferLine.id`) with `outstandingQuantity` above 0. */
+    lineId: string;
+    disposition: StockTransferShortfallDisposition;
+}
+/** `close` options. */
+export interface CloseStockTransferOptions extends Call {
+    /** Write off as lost every line still short that `shortfall` does not name. */
+    acceptShortfallAsLost?: boolean;
+    /**
+     * Per line, what happens to its unaccounted units. Needs an engine with
+     * per-line dispositions; an older one refuses the call
+     * (`GRAPHQL_VALIDATION_FAILED`), and a close without it works on both.
+     */
+    shortfall?: StockTransferShortfallLineInput[];
+}
+/** One line of a transfer, with where each of its units ended up. */
+export interface StockTransferShortfallLine {
+    lineId: string;
+    variantId: string;
+    sku: string;
+    quantity: number;
+    receivedQuantity: number;
+    lostQuantity: number;
+    /** Units the transfer's close credited back to the source (`RETURN_TO_SOURCE`). */
+    returnedToSourceQuantity: number;
+    /** `quantity − received − lost − returnedToSource`. */
+    outstandingQuantity: number;
+}
+/** Where the units of a transfer's lines ended up: arrived, lost, or back at the source. */
+export interface StockTransferShortfall {
+    transferId: string;
+    state: StockTransferState;
+    lines: StockTransferShortfallLine[];
+    totalLostQuantity: number;
+    totalReturnedToSourceQuantity: number;
+}
+export interface StockTransferFilter extends ListOptions {
+    /** Either end of the transfer. */
+    locationId?: string;
+    sourceLocationId?: string;
+    destinationLocationId?: string;
+    state?: StockTransferState[];
+    /** ISO 8601 with an explicit offset. */
+    dateFrom?: string;
+    /** ISO 8601 with an explicit offset. */
+    dateTo?: string;
+    search?: string;
+    /** Only the returns of this transfer. Needs an engine with returns. */
+    returnOfTransferId?: string;
+    /**
+     * `true`: only returns; `false`: only transfers that are not returns;
+     * omitted: both. Needs an engine with returns.
+     */
+    isReturn?: boolean;
+}
+/** A draft return of a transfer. Its source is always the transfer's destination. */
+export interface CreateStockTransferReturnInput {
+    /**
+     * Where the returned stock goes: any location of this store except the
+     * return's source (the transfer's destination).
+     */
+    destinationLocationId: string;
+    label?: string;
+    note?: string;
+    /**
+     * Per variant, at most its `returnableQuantity` (`returns(id)`). A variant
+     * on several lines counts once, summed.
+     */
+    lines: StockTransferLineInput[];
+}
+/** A transfer at the other end of a return link: enough to list it and link to it. */
+export interface StockTransferReturnRef {
+    id: string;
+    code: string;
+    state: StockTransferState;
+    label: string | null;
+    sourceLocation: {
+        id: string;
+        name: string;
+    };
+    destinationLocation: {
+        id: string;
+        name: string;
+    } | null;
+    createdAt: string;
+    totalQuantity: number;
+}
+/** One variant of a transfer, as a return of that transfer sees it. */
+export interface StockTransferReturnableLine {
+    variantId: string;
+    sku: string;
+    variantName: string;
+    /** Summed over the transfer's lines for this variant. */
+    receivedQuantity: number;
+    /** Summed over the transfer's returns that are not cancelled, plus units lost on a cancelled one. */
+    returnedQuantity: number;
+    /** `max(0, received − returned)`: what a new return may still take. */
+    returnableQuantity: number;
+}
+/** How a transfer is linked to returns: the one it returns from, and its own. */
+export interface StockTransferReturns {
+    /** The transfer this one returns stock from; null when it is not a return. */
+    returnOfTransferId: string | null;
+    returnOf: StockTransferReturnRef | null;
+    /** Returns created from this transfer, newest first, every state (cancelled included). */
+    returns: StockTransferReturnRef[];
+    /**
+     * Per variant, what a new return may still take. Empty for a consumption, a
+     * return, or a transfer with nothing received.
+     */
+    returnableLines: StockTransferReturnableLine[];
+}
+/** A member of staff who acted on a transfer. */
+export interface StockTransferStaffRef {
+    /** The administrator's id. */
+    id: string;
+    firstName: string;
+    lastName: string;
+}
+/**
+ * How a transfer's cancellation stands: who cancelled it and why, and what the
+ * operator must still have done outside the platform.
+ */
+export interface StockTransferCancellation {
+    transferId: string;
+    state: StockTransferState;
+    /** Null until it is cancelled. */
+    cancelledAt: string | null;
+    cancelReason: string | null;
+    /**
+     * Who cancelled it. Null when it is not cancelled, or was cancelled before
+     * the engine recorded who did.
+     */
+    cancelledBy: StockTransferStaffRef | null;
+    /**
+     * The Hendriks (3PL) export its shipment is on record under, or null when
+     * it has none: not shipped with Hendriks, or the export never completed. A
+     * cancel withdraws nothing at Hendriks, so a cancelled transfer that still
+     * has one needs Hendriks asked to retract `bluJayOrderNumber`, or the goods
+     * still ship. `bluJayOrderNumber` is null only for an export recorded before
+     * BluJay numbers were.
+     */
+    hendriksExport: {
+        bluJayOrderNumber: string | null;
+    } | null;
+}
+/** One MyParcel parcel of a stock transfer: its own shipment, label and barcode. */
+export interface StockTransferParcel {
+    /** 1-based, parcel order. */
+    ordinal: number;
+    /** Its MyParcel shipment id. */
+    shipmentId: number;
+    /** Null until MyParcel has issued one (it does once the parcel's label is bought). */
+    barcode: string | null;
+    /** Its label was bought; it is never requested again. */
+    labelReady: boolean;
+    /** Why its label could not be bought (e.g. the prepaid balance), else null. */
+    lastError: string | null;
+}
+/**
+ * A stock transfer's MyParcel parcels. A transfer shipped with MyParcel as N
+ * parcels is booked as N MyParcel shipments, one label and one barcode each;
+ * the booking and the labels finish AFTER the ship returns, so read this again
+ * until every parcel has its barcode.
+ */
+export interface StockTransferParcels {
+    transferId: string;
+    state: StockTransferState;
+    /**
+     * The engine's handler it shipped with (`myparcel`, `hendriks-3pl`,
+     * `manual-fulfillment`); null while it is a draft.
+     */
+    fulfillmentHandlerCode: string | null;
+    /**
+     * How many parcels the MyParcel shipment was asked to go in, never fewer
+     * than are booked. Null when the transfer has no MyParcel shipment.
+     */
+    parcelCount: number | null;
+    /**
+     * Every BOOKED parcel, parcel order. Fewer than `parcelCount` while the
+     * booking is still running, or when it stopped part-way (`lastError`).
+     */
+    parcels: StockTransferParcel[];
+    /** Every barcode issued so far, parcel order, without gaps. */
+    trackingCodes: string[];
+    /**
+     * Why the MyParcel booking stopped part-way (`retryMyparcelShipments`
+     * finishes it), or which parcels a removed shipment or a cancel could not
+     * retract at MyParcel (cancel those in the MyParcel backoffice). Null when
+     * there is nothing to act on.
+     */
+    lastError: string | null;
+    /**
+     * The MyParcel shipments a removed shipment or a cancel of this transfer let
+     * go of that MyParcel kept or could not be reached to delete, resolved
+     * entries included. Kept across a re-ship, whatever the handler then is.
+     */
+    unretractedShipments: MyparcelUnretractedShipment[];
+}
+export type StockTransferLabelFormat = 'A4' | 'A6';
+/** One PDF holding every parcel's label of a transfer, in parcel order. */
+export interface StockTransferLabel {
+    format: StockTransferLabelFormat;
+    contentType: string;
+    filename: string;
+    bytes: Uint8Array;
+}
+/**
+ * Stock transfers (the engine's stock-transfer module, wrapped): a draft is
+ * created, shipped (debiting the source), received line by line (crediting the
+ * destination) and closed, or cancelled. A consumption is posted instead of
+ * shipped and debits its one location.
+ *
+ * `note` and `cancelReason` are the transfer's OWN words and stay on the
+ * transfer; they are not movement reasons and do not appear on
+ * `stock.movements()`. Reads need `ReadStockLocation`; every write needs `AdjustStock`
+ * (or, for credentials minted before it existed, `UpdateStockLocation` — a transition a
+ * later release ends).
+ * None of these writes takes an idempotency key yet.
+ *
+ * Every location and variant a transfer names must be the store's own:
+ * another store's location (or an id that does not exist) is refused
+ * `LOCATION_NOT_IN_CHANNEL` (→ `ValidationError`), another store's variant
+ * `STOCK_VARIANT_NOT_FOUND` (→ `NotFoundError`), and another store's transfer
+ * reads as `null` from `get`.
+ *
+ * A credential restricted with `locationIds` is refused `LOCATION_NOT_ALLOWED`
+ * (→ `PermissionDeniedError`) unless it holds the end of the transfer the call
+ * acts for: the SOURCE — the location whose stock is debited — to `create`,
+ * `createReturn` (the RETURN's source, which is the original transfer's
+ * destination), `update`, `ship`, `postConsumption` or `cancel`; the
+ * DESTINATION to `receive`; either end to `close`, and the SOURCE to a `close`
+ * that sends a line back to it. An `update` that moves the
+ * source needs the new source as well. Such a credential lists, and can `get`,
+ * only transfers with at least one end it holds.
+ *
+ * **Returns.** Stock sent somewhere temporary (an event, a pop-up) comes back
+ * as a RETURN: an ordinary transfer, with its own code, linked to the transfer
+ * it reverses. `createReturn` pins its source to that transfer's destination
+ * (where the goods are); its destination is any other location of the store.
+ * Each variant is capped at what the transfer RECEIVED minus its returns that
+ * are not cancelled (`returns(id).returnableLines`), so nothing received means
+ * nothing returnable; what is not returned stays where it is. The return then
+ * ships, receives, closes and cancels like any transfer, and a cancelled
+ * return frees its quantity again. Refusals, each → `BusinessRuleError`:
+ * `STOCK_TRANSFER_NOT_RETURNABLE` (a consumption, a return, or a transfer
+ * neither in transit nor received), `RETURN_QUANTITY_EXCEEDS_RECEIVED` (above
+ * the cap, or a variant not on the transfer, also on an `update` of a return
+ * draft's lines) and `RETURN_SOURCE_LOCKED` (an `update` moving a return's
+ * source). `createReturn` needs what every write needs. The return fields are
+ * read by `returns(id)` and filtered by `list({ returnOfTransferId, isReturn })`,
+ * never by `get`: a caller ahead of the engine sees only those calls refused.
+ */
+export interface StockTransfersModule {
+    list(filter?: StockTransferFilter): Promise<Page<StockTransfer>>;
+    get(id: string, options?: Call): Promise<StockTransfer | null>;
+    create(input: CreateStockTransferInput, options?: Call): Promise<StockTransfer>;
+    /** Only a draft can be edited. */
+    update(id: string, input: UpdateStockTransferInput, options?: Call): Promise<StockTransfer>;
+    /**
+     * Draft → in transit: the source is debited. A MyParcel ship books every
+     * parcel at MyParcel before it answers, so it is allowed up to 120s; a
+     * `REQUEST_TIMEOUT` does not mean it failed — `get` it before shipping again.
+     */
+    ship(id: string, input?: ShipStockTransferInput, options?: Call): Promise<StockTransfer>;
+    /** Post a consumption: debit its location and complete the draft. */
+    postConsumption(id: string, options?: Call): Promise<StockTransfer>;
+    /** Credit the destination with what arrived, and write off what was lost, per line. */
+    receive(id: string, lines: ReceiveStockTransferLineInput[], options?: Call): Promise<StockTransfer>;
+    /**
+     * Close an in-transit transfer as received. Each line still short is settled
+     * as `shortfall` names it — `LOST`, or `RETURN_TO_SOURCE` (credited back to
+     * the source) — and a line it does not name is written off as lost only with
+     * `acceptShortfallAsLost`; otherwise the close is refused. Refused too: a
+     * line named twice, a line of another transfer, a line with nothing
+     * outstanding. Each refusal is a `ValidationError` and changes nothing.
+     */
+    close(id: string, options?: CloseStockTransferOptions): Promise<StockTransfer>;
+    /**
+     * Cancel a draft, or an in-transit transfer (unreceived stock returns to the
+     * source). An in-transit MyParcel shipment's parcels are voided at MyParcel
+     * inside the call, so it is allowed up to 120s.
+     */
+    cancel(id: string, options?: Call & {
+        reason?: string;
+    }): Promise<StockTransfer>;
+    /**
+     * Create a draft RETURN of transfer `id` (the original): its source is the
+     * original's destination, its lines capped per variant at what the original
+     * received minus its other returns that are not cancelled. Answers the
+     * return; ship and receive it like any transfer. A restricted credential
+     * must hold the return's source (the original's destination).
+     */
+    createReturn(id: string, input: CreateStockTransferReturnInput, options?: Call): Promise<StockTransfer>;
+    /**
+     * How transfer `id` is linked to returns — the transfer it returns from, its
+     * own returns, and what a new return may still take per variant — or null
+     * when this store has no such transfer. Its own request, never part of
+     * `get`. Needs `ReadStockLocation`.
+     */
+    returns(id: string, options?: Call): Promise<StockTransferReturns | null>;
+    /**
+     * Where the units of transfer `id`'s lines ended up — received, lost, or
+     * sent back to the source by its close — or null when this store has no such
+     * transfer. Its own request, never part of `get`, so `get` keeps working
+     * against an engine without it. Needs `ReadStockLocation`.
+     */
+    shortfall(id: string, options?: Call): Promise<StockTransferShortfall | null>;
+    /**
+     * Who cancelled transfer `id`, why, and the Hendriks export a cancel leaves
+     * to be retracted by hand — or null when this store has no such transfer.
+     * Read it before `cancel` to warn about the export, and after to show who
+     * did it. Its own request, never part of `get`: a caller deployed ahead of
+     * an engine that does not record the canceller sees only this call refused.
+     * Needs `ReadStockLocation`.
+     */
+    cancellation(id: string, options?: Call): Promise<StockTransferCancellation | null>;
+    /**
+     * The transfer's MyParcel parcels, or null when this store has no such
+     * transfer. Its own request, never part of `get`: a caller deployed ahead of
+     * an engine without the parcel fields sees only this call refused. Needs
+     * `ReadStockLocation`; reads the engine only, never MyParcel.
+     */
+    parcels(id: string, options?: Call): Promise<StockTransferParcels | null>;
+    /**
+     * Finish an in-transit MyParcel transfer's booking: book exactly the parcels
+     * still missing (a parcel MyParcel already holds is adopted, never booked
+     * twice) and ask again for the label of every parcel without a barcode.
+     * Answers the parcels as the retry left them: a booking that fails again is
+     * NOT thrown, it is on `lastError`. Refused `MYPARCEL_RETRY_NOT_APPLICABLE`
+     * (→ `BusinessRuleError`) when the transfer did not ship with MyParcel or is
+     * no longer in transit, and with the ship's own refusals (MyParcel disabled
+     * meanwhile: `MYPARCEL_NOT_AVAILABLE`). Needs what `ship` needs, and a
+     * restricted credential must hold the source.
+     *
+     * The engine books each missing parcel at MyParcel inside this call, so it
+     * is allowed up to 120s. A `REQUEST_TIMEOUT` does NOT mean the booking
+     * failed — the engine carries on — so read `parcels()` again before retrying.
+     */
+    retryMyparcelShipments(id: string, options?: Call): Promise<StockTransferParcels>;
+    /**
+     * Label every MyParcel parcel of an in-transit transfer that still needs its
+     * label or its barcode: queues ONE label job, which asks nothing again for a
+     * parcel already labelled. Answers the parcels as they stand when the job is
+     * queued; the labels land when it has run, so read `parcels()` again. Labels
+     * only: a parcel not booked yet is booked by `retryMyparcelShipments`.
+     *
+     * Refused `MYPARCEL_LABEL_NOT_AVAILABLE` (→ `BusinessRuleError`) when the
+     * transfer did not ship with MyParcel, is not in transit or has no parcel
+     * booked, and `MYPARCEL_NOT_AVAILABLE` while MyParcel is not installed, set
+     * up or enabled. Needs what `ship` needs, and a restricted credential must
+     * hold the source. It only queues, so the default timeout applies.
+     */
+    labelMyparcelParcels(id: string, options?: Call): Promise<StockTransferParcels>;
+    /**
+     * Every MyParcel parcel's label of an in-transit transfer, merged by
+     * MyParcel into one PDF in parcel order, fetched live and never stored.
+     * Refused `MYPARCEL_LABEL_NOT_AVAILABLE` (→ `BusinessRuleError`) when the
+     * transfer has no booked MyParcel parcel in transit. Needs
+     * `ReadStockLocation`, and a restricted credential must hold either end.
+     * Allowed up to 55s: the engine retries a slow MyParcel within a budget the
+     * default timeout does not cover.
+     */
+    myparcelLabel(id: string, format: StockTransferLabelFormat, options?: Call): Promise<StockTransferLabel>;
+}
+export declare const STOCK_TRANSFERS_QUERY = "\n  query StockTransfers($options: StockTransferListOptions) {\n    stockTransfers(options: $options) { items { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  items {\n    id\n    productVariant { id sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n  }\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n } totalItems }\n  }\n";
+export declare const STOCK_TRANSFER_QUERY = "\n  query StockTransfer($id: ID!) { stockTransfer(id: $id) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  items {\n    id\n    productVariant { id sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n  }\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n } }\n";
+export declare const CREATE_STOCK_TRANSFER_MUTATION = "\n  mutation CreateStockTransfer($input: CreateStockTransferInput!) {\n    createStockTransfer(input: $input) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  items {\n    id\n    productVariant { id sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n  }\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n }\n  }\n";
+export declare const UPDATE_STOCK_TRANSFER_MUTATION = "\n  mutation UpdateStockTransfer($id: ID!, $input: UpdateStockTransferInput!) {\n    updateStockTransfer(id: $id, input: $input) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  items {\n    id\n    productVariant { id sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n  }\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n }\n  }\n";
+export declare const SHIP_STOCK_TRANSFER_MUTATION = "\n  mutation ShipStockTransfer($id: ID!, $input: ShipStockTransferInput) {\n    shipStockTransfer(id: $id, input: $input) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  items {\n    id\n    productVariant { id sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n  }\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n }\n  }\n";
+export declare const POST_STOCK_TRANSFER_CONSUMPTION_MUTATION = "\n  mutation PostStockTransferConsumption($id: ID!) {\n    postStockTransferConsumption(id: $id) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  items {\n    id\n    productVariant { id sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n  }\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n }\n  }\n";
+export declare const RECEIVE_STOCK_TRANSFER_LINES_MUTATION = "\n  mutation ReceiveStockTransferLines($id: ID!, $lines: [ReceiveStockTransferLineInput!]!) {\n    receiveStockTransferLines(id: $id, lines: $lines) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  items {\n    id\n    productVariant { id sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n  }\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n }\n  }\n";
+export declare const CLOSE_STOCK_TRANSFER_MUTATION = "\n  mutation CloseStockTransfer($id: ID!, $acceptShortfallAsLost: Boolean) {\n    closeStockTransfer(id: $id, acceptShortfallAsLost: $acceptShortfallAsLost) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  items {\n    id\n    productVariant { id sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n  }\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n }\n  }\n";
+/**
+ * Its own document: it declares `$shortfall`, which an engine without per-line
+ * dispositions refuses as a whole. A close without dispositions keeps sending
+ * the document above.
+ */
+export declare const CLOSE_STOCK_TRANSFER_WITH_SHORTFALL_MUTATION = "\n  mutation CloseStockTransferWithShortfall(\n    $id: ID!\n    $acceptShortfallAsLost: Boolean\n    $shortfall: [StockTransferShortfallLineInput!]!\n  ) {\n    closeStockTransfer(\n      id: $id\n      acceptShortfallAsLost: $acceptShortfallAsLost\n      shortfall: $shortfall\n    ) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  items {\n    id\n    productVariant { id sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n  }\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n }\n  }\n";
+export declare const CANCEL_STOCK_TRANSFER_MUTATION = "\n  mutation CancelStockTransfer($id: ID!, $reason: String) {\n    cancelStockTransfer(id: $id, reason: $reason) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  items {\n    id\n    productVariant { id sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n  }\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n }\n  }\n";
+export declare const CREATE_STOCK_TRANSFER_RETURN_MUTATION = "\n  mutation CreateStockTransferReturn($id: ID!, $input: CreateStockTransferReturnInput!) {\n    createStockTransferReturn(id: $id, input: $input) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  items {\n    id\n    productVariant { id sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n  }\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n }\n  }\n";
+export declare const STOCK_TRANSFER_RETURNS_QUERY = "\n  query StockTransferReturns($id: ID!) {\n    stockTransfer(id: $id) {\n      returnOfTransferId\n      returnOf { \n  id\n  code\n  state\n  label\n  sourceLocation { id name }\n  destinationLocation { id name }\n  createdAt\n  totalQuantity\n }\n      returns { \n  id\n  code\n  state\n  label\n  sourceLocation { id name }\n  destinationLocation { id name }\n  createdAt\n  totalQuantity\n }\n      returnableLines {\n        productVariantId\n        productVariant { name sku }\n        receivedQuantity\n        returnedQuantity\n        returnableQuantity\n      }\n    }\n  }\n";
+/** The per-line settlement fields, in a document of their own like the return fields. */
+export declare const STOCK_TRANSFER_SHORTFALL_QUERY = "\n  query StockTransferShortfall($id: ID!) {\n    stockTransfer(id: $id) {\n      id\n      state\n      items {\n        id\n        productVariant { id sku }\n        quantity\n        receivedQuantity\n        lostQuantity\n        returnedToSourceQuantity\n        outstandingQuantity\n      }\n      totalLostQuantity\n      totalReturnedToSourceQuantity\n    }\n  }\n";
+/**
+ * The cancellation fields, in a document of their own like the return and
+ * parcel fields: `cancelledBy` is newer than the transfer module, and
+ * `get`/`list`/`cancel` keep working against an engine without it.
+ */
+export declare const STOCK_TRANSFER_CANCELLATION_QUERY = "\n  query StockTransferCancellation($id: ID!) {\n    stockTransfer(id: $id) {\n      id\n      state\n      cancelledAt\n      cancelReason\n      cancelledBy { id firstName lastName }\n      fulfillmentHandlerCode\n      hendriksRemotePath\n      hendriksBluJayOrderNumber\n    }\n  }\n";
+export declare const STOCK_TRANSFER_PARCELS_QUERY = "\n  query StockTransferParcels($id: ID!) { stockTransfer(id: $id) { \n  id\n  state\n  fulfillmentHandlerCode\n  parcelCount\n  myparcelParcels { ordinal shipmentId barcode labelReady lastError }\n  trackingCodes\n  myparcelBarcode\n  myparcelLastError\n  myparcelUnretractedShipments { \n  shipmentId\n  reference\n  verdict\n  status\n  statusName\n  billable\n  hidden\n  reason\n  cause\n  firstRecordedAt\n  lastCheckedAt\n  resolvedAt\n }\n } }\n";
+export declare const RETRY_STOCK_TRANSFER_MYPARCEL_SHIPMENTS_MUTATION = "\n  mutation RetryStockTransferMyparcelShipments($id: ID!) {\n    retryStockTransferMyparcelShipments(id: $id) { \n  id\n  state\n  fulfillmentHandlerCode\n  parcelCount\n  myparcelParcels { ordinal shipmentId barcode labelReady lastError }\n  trackingCodes\n  myparcelBarcode\n  myparcelLastError\n  myparcelUnretractedShipments { \n  shipmentId\n  reference\n  verdict\n  status\n  statusName\n  billable\n  hidden\n  reason\n  cause\n  firstRecordedAt\n  lastCheckedAt\n  resolvedAt\n }\n }\n  }\n";
+export declare const LABEL_STOCK_TRANSFER_MYPARCEL_PARCELS_MUTATION = "\n  mutation LabelStockTransferMyparcelParcels($id: ID!) {\n    labelStockTransferMyparcelParcels(id: $id) { \n  id\n  state\n  fulfillmentHandlerCode\n  parcelCount\n  myparcelParcels { ordinal shipmentId barcode labelReady lastError }\n  trackingCodes\n  myparcelBarcode\n  myparcelLastError\n  myparcelUnretractedShipments { \n  shipmentId\n  reference\n  verdict\n  status\n  statusName\n  billable\n  hidden\n  reason\n  cause\n  firstRecordedAt\n  lastCheckedAt\n  resolvedAt\n }\n }\n  }\n";
+export declare const MYPARCEL_STOCK_TRANSFER_LABEL_MUTATION = "\n  mutation MyparcelStockTransferLabel($transferId: ID!, $format: StockTransferLabelFormat!) {\n    getMyparcelStockTransferLabel(transferId: $transferId, format: $format) {\n      format\n      base64\n      contentType\n      filename\n    }\n  }\n";
+export declare function createStockTransfersModule(transport: Transport): StockTransfersModule;