@sixtyninecommerce/admin 0.9.0 → 0.11.0

package/dist/stock/locations.js

@@ -0,0 +1,168 @@
+import { BusinessRuleError, pageFromVendureList, readOffsetCursor, ValidationError, } from '@sixtyninecommerce/core';
+import { fieldOf } from '../catalog/types.js';
+/** The fields a list can be sorted by. */
+export const STOCK_LOCATION_SORT_FIELDS = ['name', 'createdAt', 'updatedAt'];
+const LOCATION_FIELDS = /* GraphQL */ `
+  id
+  name
+  description
+  createdAt
+  updatedAt
+  customFields {
+    isPublic
+    outOfStockThreshold
+  }
+`;
+export const STOCK_LOCATIONS_QUERY = /* GraphQL */ `
+  query StockLocations($options: StockLocationListOptions) {
+    stockLocations(options: $options) {
+      items { ${LOCATION_FIELDS} }
+      totalItems
+    }
+  }
+`;
+export const STOCK_LOCATION_QUERY = /* GraphQL */ `
+  query StockLocation($id: ID!) {
+    stockLocation(id: $id) { ${LOCATION_FIELDS} }
+  }
+`;
+export const CREATE_STOCK_LOCATION_MUTATION = /* GraphQL */ `
+  mutation CreateStockLocation($input: CreateStockLocationInput!) {
+    createStockLocation(input: $input) { ${LOCATION_FIELDS} }
+  }
+`;
+export const UPDATE_STOCK_LOCATION_MUTATION = /* GraphQL */ `
+  mutation UpdateStockLocation($input: UpdateStockLocationInput!) {
+    updateStockLocation(input: $input) { ${LOCATION_FIELDS} }
+  }
+`;
+export const DELETE_STOCK_LOCATION_MUTATION = /* GraphQL */ `
+  mutation DeleteStockLocation($input: DeleteStockLocationInput!) {
+    deleteStockLocation(input: $input) {
+      result
+      message
+    }
+  }
+`;
+const DEFAULT_PAGE_SIZE = 100;
+function toLocation(wire) {
+    return {
+        id: wire.id,
+        name: wire.name,
+        description: wire.description ?? '',
+        createdAt: wire.createdAt,
+        updatedAt: wire.updatedAt,
+        // The column defaults: a row written before the field existed reads null.
+        isPublic: wire.customFields?.isPublic ?? true,
+        outOfStockThreshold: wire.customFields?.outOfStockThreshold ?? 0,
+    };
+}
+const invalidInput = (message) => new ValidationError({
+    code: 'STOCK_LOCATION_INPUT_INVALID',
+    message,
+    status: 400,
+    service: 'vendure',
+});
+function assertId(id, what = 'id') {
+    if (typeof id !== 'string' || id.trim() === '') {
+        throw invalidInput(`${what} must be a stock location id.`);
+    }
+}
+function assertName(name) {
+    if (typeof name !== 'string' || name.trim() === '') {
+        throw invalidInput('A stock location needs a name.');
+    }
+}
+/** The location's own custom fields, only the keys the caller set: never the sender fields. */
+function customFieldsOf(input) {
+    const fields = {};
+    if (input.isPublic !== undefined)
+        fields.isPublic = input.isPublic;
+    if (input.outOfStockThreshold !== undefined)
+        fields.outOfStockThreshold = input.outOfStockThreshold;
+    return Object.keys(fields).length > 0 ? fields : undefined;
+}
+function listOptionsOf(skip, take, options) {
+    const term = options?.term?.trim() ?? '';
+    return {
+        skip,
+        take,
+        ...(term === ''
+            ? {}
+            : {
+                filter: { name: { contains: term }, description: { contains: term } },
+                filterOperator: 'OR',
+            }),
+        ...(options?.sort ? { sort: { [options.sort.field]: options.sort.direction } } : {}),
+    };
+}
+export function createStockLocationsModule(transport) {
+    const listPage = async (skip, take, options) => {
+        const list = await fieldOf(transport, STOCK_LOCATIONS_QUERY, 'stockLocations', { options: listOptionsOf(skip, take, options) }, options);
+        return pageFromVendureList({ items: list.items.map(toLocation), totalItems: list.totalItems }, skip, take, (cursor) => listPage(readOffsetCursor(cursor), take, options));
+    };
+    return {
+        list(options) {
+            if (options?.sort && !STOCK_LOCATION_SORT_FIELDS.includes(options.sort.field)) {
+                return Promise.reject(invalidInput(`sort.field must be one of ${STOCK_LOCATION_SORT_FIELDS.join(', ')}.`));
+            }
+            const take = options?.limit ?? DEFAULT_PAGE_SIZE;
+            const skip = options?.after === undefined ? 0 : readOffsetCursor(options.after);
+            return listPage(skip, take, options);
+        },
+        async get(id, options) {
+            assertId(id);
+            const wire = await fieldOf(transport, STOCK_LOCATION_QUERY, 'stockLocation', { id }, options);
+            return wire === null ? null : toLocation(wire);
+        },
+        async create(input, options) {
+            assertName(input?.name);
+            const customFields = customFieldsOf(input);
+            return toLocation(await fieldOf(transport, CREATE_STOCK_LOCATION_MUTATION, 'createStockLocation', {
+                input: {
+                    name: input.name,
+                    description: input.description ?? '',
+                    ...(customFields ? { customFields } : {}),
+                },
+            }, options));
+        },
+        async update(id, input, options) {
+            assertId(id);
+            if (input?.name !== undefined)
+                assertName(input.name);
+            const customFields = customFieldsOf(input ?? {});
+            return toLocation(await fieldOf(transport, UPDATE_STOCK_LOCATION_MUTATION, 'updateStockLocation', {
+                input: {
+                    id,
+                    ...(input?.name !== undefined ? { name: input.name } : {}),
+                    ...(input?.description !== undefined ? { description: input.description } : {}),
+                    // Core applies customFields key by key: the sender fields are never named here.
+                    ...(customFields ? { customFields } : {}),
+                },
+            }, options));
+        },
+        async delete(id, options) {
+            assertId(id);
+            if (options?.transferToLocationId !== undefined) {
+                assertId(options.transferToLocationId, 'transferToLocationId');
+            }
+            const response = await fieldOf(transport, DELETE_STOCK_LOCATION_MUTATION, 'deleteStockLocation', {
+                input: {
+                    id,
+                    ...(options?.transferToLocationId
+                        ? { transferToLocationId: options.transferToLocationId }
+                        : {}),
+                },
+            }, options);
+            if (response?.result === 'DELETED')
+                return;
+            // Answered at HTTP 200, so the transport never throws for it.
+            throw new BusinessRuleError({
+                code: 'STOCK_LOCATION_NOT_DELETED',
+                message: response?.message?.trim() || 'The stock location was not deleted.',
+                status: 422,
+                service: 'vendure',
+            });
+        },
+    };
+}

package/dist/stock/transfers.d.ts

@@ -1,9 +1,15 @@
 import { type Page, type Transport } from '@sixtyninecommerce/core';
 import { type MyparcelUnretractedShipment } from '../fulfillments/index.js';
+import type { StockLocationAddress } from '../locations/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';
+/**
+ * What `search` matches in `list`: the transfer code only (`code`, the engine's default), or the
+ * code or the label (`all`).
+ */
+export type StockTransferSearchMode = 'code' | 'all';
 export interface StockTransferAddress {
     contactName: string | null;
     company: string | null;
@@ -31,6 +37,7 @@ export interface StockTransferLine {
     id: string;
     variantId: string;
     sku: string;
+    variantName: string;
     quantity: number;
     receivedQuantity: number;
     lostQuantity: number;
@@ -59,6 +66,10 @@ export interface StockTransfer {
     note: string | null;
     carrier: string | null;
     trackingCode: string | null;
+    /**
+     * A calendar DAY, though it is stored as an instant: the dashboard records the day picked as
+     * that day's 00:00 UTC, so read it as the UTC day (`slice(0, 10)`), never in a local zone.
+     */
     estimatedArrivalAt: string | null;
     shippedAt: string | null;
     receivedAt: string | null;
@@ -67,11 +78,89 @@ export interface StockTransfer {
     deliveryAddress: StockTransferAddress | null;
     createdAt: string;
     updatedAt: string;
+    /**
+     * Who created it. Null when the engine recorded nobody, or that administrator has since been
+     * deleted. An app or API key is not null here: it acts as its own administrator (see
+     * `StockTransferStaffRef`).
+     */
+    initiatedBy: StockTransferStaffRef | null;
     items: StockTransferLine[];
+    /** How many lines it has (`items.length`). */
+    totalLines: number;
     totalQuantity: number;
     totalReceivedQuantity: number;
     totalLostQuantity: number;
 }
+/** A line as `get` and every write answer it: with its cost snapshot. */
+export interface StockTransferDetailLine extends StockTransferLine {
+    /**
+     * The variant's standard cost per unit, in minor units of the store's currency, as posting a
+     * consumption snapshotted it. Null on a transfer's lines, and on a consumption line whose
+     * variant had no cost on file.
+     */
+    unitCost: number | null;
+}
+/**
+ * One transfer as `get` and every write answer it: the list's fields, plus who shipped and
+ * received it, its consumption value, its transfer note and how it was shipped.
+ */
+export interface StockTransferDetail extends Omit<StockTransfer, 'destinationLocation' | 'items'> {
+    /**
+     * Null for a consumption. `address` is the location's own postal address as stored (every
+     * field optional, as `locations` reads it), null when it has none: a shipment goes there
+     * unless `deliveryAddress` names another place.
+     */
+    destinationLocation: {
+        id: string;
+        name: string;
+        address: StockLocationAddress | null;
+    } | null;
+    items: StockTransferDetailLine[];
+    /**
+     * Who shipped it, or posted the consumption. Null as `initiatedBy` is, and while it is not
+     * shipped (removing the shipment clears it).
+     */
+    shippedBy: StockTransferStaffRef | null;
+    /**
+     * Who completed it: the receipt that took it to `received`, a close, or the consumption's
+     * post. Null as `initiatedBy` is, and until then: a partial receipt records nobody.
+     */
+    receivedBy: StockTransferStaffRef | null;
+    /**
+     * A consumption's total standard-cost value, in minor units of the store's currency: the sum
+     * of its lines' `unitCost × quantity`, over the lines that have one. Null for a transfer. A
+     * draft consumption has no cost snapshot yet, so it reads 0 with `consumptionHasUnpricedLines`.
+     */
+    consumptionTotalValue: number | null;
+    /**
+     * True when a line has no cost (a draft, or a variant with no cost on file when it was
+     * posted), so `consumptionTotalValue` understates it. Null for a transfer.
+     */
+    consumptionHasUnpricedLines: boolean | null;
+    /** Where the transfer note PDF is stored; null until one was generated. */
+    pdfStorageKey: string | null;
+    /**
+     * The engine's fulfilment handler it shipped with (`manual-fulfillment`, `myparcel`,
+     * `hendriks-3pl`). Null while it is a draft. A cancelled transfer keeps it.
+     */
+    fulfillmentHandlerCode: string | null;
+    /**
+     * The handler arguments the ship was given, as the handler stores them: a key/value object, or
+     * the `{ name, value }` list the fulfilment forms send. The handler owns their meaning.
+     */
+    handlerArgs: Record<string, unknown> | StockTransferHandlerArg[] | null;
+    /** The first MyParcel parcel's shipment id; every parcel is on `parcels(id)`. */
+    myparcelShipmentId: number | null;
+    /** The first MyParcel parcel's barcode once it has one; every barcode is on `parcels(id)`. */
+    myparcelBarcode: string | null;
+    /** Where the Hendriks (3PL) export was uploaded; null until the export completed. */
+    hendriksRemotePath: string | null;
+}
+/** One handler argument in the list form the fulfilment forms send. */
+export interface StockTransferHandlerArg {
+    name: string;
+    value: string;
+}
 export interface StockTransferLineInput {
     variantId: string;
     quantity: number;
@@ -86,27 +175,32 @@ export interface CreateStockTransferInput {
     note?: string;
     lines: StockTransferLineInput[];
 }
-/** A draft's fields; an omitted field is left as it is. */
+/** A draft's fields; an omitted field is left as it is, and `null` clears one. */
 export interface UpdateStockTransferInput {
     sourceLocationId?: string;
     destinationLocationId?: string;
-    label?: string;
-    note?: string;
+    label?: string | null;
+    note?: string | null;
     /** Replaces every line. */
     lines?: StockTransferLineInput[];
-    carrier?: string;
-    trackingCode?: string;
-    /** ISO 8601 with an explicit offset. */
-    estimatedArrivalAt?: string;
+    carrier?: string | null;
+    trackingCode?: string | null;
+    /** ISO 8601 with an explicit offset. A day is sent as its 00:00 UTC (see `estimatedArrivalAt`). */
+    estimatedArrivalAt?: string | null;
 }
+/**
+ * `carrier`, `trackingCode` and `estimatedArrivalAt`: an omitted field keeps what the draft
+ * holds, and `null` clears it.
+ */
 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>;
+    carrier?: string | null;
+    trackingCode?: string | null;
+    /** ISO 8601 with an explicit offset. A day is sent as its 00:00 UTC (see `estimatedArrivalAt`). */
+    estimatedArrivalAt?: string | null;
+    /** The engine's fulfilment handler code; omitted or null ships it by hand (manual). */
+    fulfillmentHandlerCode?: string | null;
+    /** The handler's arguments: a key/value object or the `{ name, value }` list; none when omitted. */
+    handlerArgs?: Record<string, unknown> | StockTransferHandlerArg[] | null;
     /** Ship somewhere other than the destination's own address; null re-addresses it there. */
     deliveryAddress?: StockTransferAddressInput | null;
 }
@@ -170,6 +264,8 @@ export interface StockTransferFilter extends ListOptions {
     /** ISO 8601 with an explicit offset. */
     dateTo?: string;
     search?: string;
+    /** What `search` matches; the engine's default (`code`) when omitted. */
+    searchMode?: StockTransferSearchMode;
     /** Only the returns of this transfer. Needs an engine with returns. */
     returnOfTransferId?: string;
     /**
@@ -235,7 +331,11 @@ export interface StockTransferReturns {
      */
     returnableLines: StockTransferReturnableLine[];
 }
-/** A member of staff who acted on a transfer. */
+/**
+ * The administrator who acted on a transfer. Usually a member of staff; an app installation or
+ * an API key acts as its own administrator, so it appears here too, with `firstName` "App" or
+ * "API Token" and its own name as `lastName`.
+ */
 export interface StockTransferStaffRef {
     /** The administrator's id. */
     id: string;
@@ -341,7 +441,9 @@ export interface StockTransferLabel {
  * `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.
+ * None of these writes takes an idempotency key yet, and the client never repeats one: a write
+ * whose answer was lost is read back with `get` before it is sent again (each method says what
+ * a repeat does).
  *
  * 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
@@ -377,46 +479,117 @@ export interface StockTransferLabel {
  * never by `get`: a caller ahead of the engine sees only those calls refused.
  */
 export interface StockTransfersModule {
+    /**
+     * The store's transfers and consumptions, newest first, a page at a time (`limit`, default
+     * 25; `after` from a previous page). `search` matches the code, or the code or the label with
+     * `searchMode: 'all'`. A list row carries no detail fields: `get` one for those.
+     *
+     * @effect read
+     * @permission ReadStockLocation
+     */
     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>;
+    /**
+     * One transfer with its detail fields, or `null` when this store has no such transfer.
+     *
+     * @effect read
+     * @permission ReadStockLocation
+     */
+    get(id: string, options?: Call): Promise<StockTransferDetail | null>;
+    /**
+     * A draft transfer or consumption. Moves no stock.
+     *
+     * @effect write
+     * @permission AdjustStock
+     */
+    create(input: CreateStockTransferInput, options?: Call): Promise<StockTransferDetail>;
+    /**
+     * Only a draft can be edited. Moves no stock.
+     *
+     * @effect write
+     * @permission AdjustStock
+     */
+    update(id: string, input: UpdateStockTransferInput, options?: Call): Promise<StockTransferDetail>;
     /**
      * 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.
+     * parcel at MyParcel before it answers and buys their labels, so it is
+     * allowed up to 120s; a `REQUEST_TIMEOUT` does not mean it failed — `get` it
+     * before shipping again. Shipping a transfer already in transit answers it
+     * unchanged: nothing is debited or booked twice. A Hendriks (3PL) ship
+     * uploads its export, which a later cancel does not withdraw.
+     *
+     * Refused `FIELD_GROUP_LOCKED` (`BusinessRuleError`) while an app or API key
+     * owns the store's Stock. A member store's Stock owner never locks the hub's
+     * warehouse (ruling U8).
+     *
+     * @effect money
+     * @permission AdjustStock
+     */
+    ship(id: string, input?: ShipStockTransferInput, options?: Call): Promise<StockTransferDetail>;
+    /**
+     * Post a consumption: debit its location, snapshot each line's cost and
+     * complete the draft. Only a draft is posted, so a repeat is refused
+     * (`USER_INPUT_ERROR`, `ValidationError`) and debits nothing.
+     *
+     * Refused `FIELD_GROUP_LOCKED` (`BusinessRuleError`) while an app or API key
+     * owns the store's Stock. A member store's Stock owner never locks the hub's
+     * warehouse (ruling U8).
+     *
+     * @effect write
+     * @permission AdjustStock
+     */
+    postConsumption(id: string, options?: Call): Promise<StockTransferDetail>;
+    /**
+     * Credit the destination with what arrived, and write off what was lost, per line. The
+     * quantities are each line's running TOTALS, never increments: a repeat of the same call
+     * credits nothing again, and a total lower than the line's is refused.
+     *
+     * Refused `FIELD_GROUP_LOCKED` (`BusinessRuleError`) while an app or API key
+     * owns the store's Stock. A member store's Stock owner never locks the hub's
+     * warehouse (ruling U8).
+     *
+     * @effect write
+     * @permission AdjustStock
      */
-    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>;
+    receive(id: string, lines: ReceiveStockTransferLineInput[], options?: Call): Promise<StockTransferDetail>;
     /**
      * 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.
+     * outstanding. Each refusal is a `ValidationError` and changes nothing. A
+     * close that sends a line back to the source is refused `FIELD_GROUP_LOCKED`
+     * (`BusinessRuleError`) while an app or API key owns the store's Stock.
+     *
+     * @effect write
+     * @permission AdjustStock
      */
-    close(id: string, options?: CloseStockTransferOptions): Promise<StockTransfer>;
+    close(id: string, options?: CloseStockTransferOptions): Promise<StockTransferDetail>;
     /**
      * 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.
+     * inside the call, so it is allowed up to 120s. A cancelled transfer is
+     * final: cancelling it again is refused (`ValidationError`) and restores
+     * nothing twice. An in-transit cancel is refused `FIELD_GROUP_LOCKED`
+     * (`BusinessRuleError`) while an app or API key owns the store's Stock.
+     *
+     * @effect destructive
+     * @permission AdjustStock
      */
     cancel(id: string, options?: Call & {
         reason?: string;
-    }): Promise<StockTransfer>;
+    }): Promise<StockTransferDetail>;
     /**
      * 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).
+     *
+     * @effect write
+     * @permission AdjustStock
      */
-    createReturn(id: string, input: CreateStockTransferReturnInput, options?: Call): Promise<StockTransfer>;
+    createReturn(id: string, input: CreateStockTransferReturnInput, options?: Call): Promise<StockTransferDetail>;
     /**
      * 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
@@ -488,22 +661,22 @@ export interface StockTransfersModule {
      */
     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";
+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  initiatedBy { id firstName lastName }\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n  }\n  totalLines\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 customFields { address } }\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  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\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 customFields { address } }\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  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\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 customFields { address } }\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  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\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 customFields { address } }\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  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\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 customFields { address } }\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  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\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 customFields { address } }\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  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\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 customFields { address } }\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  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\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 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 customFields { address } }\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  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\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 customFields { address } }\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  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\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 customFields { address } }\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  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\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";