@sixtyninecommerce/admin 0.10.0 → 0.12.0

package/dist/stock/transfers.d.ts

@@ -1,9 +1,41 @@
 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';
+/**
+ * Why the engine would refuse a cancel or a return of a transfer now.
+ *
+ * - `STATE`: the state has no way to it (a cancel of a received transfer or a posted consumption).
+ * - `CANCELLED`: the transfer is cancelled.
+ * - `PARTIALLY_RECEIVED`: a cancel once any unit was received; `close` it instead.
+ * - `DRAFT_NOT_SHIPPED`: a return of a draft: nothing has moved yet.
+ * - `NOT_YET_RECEIVED`: a return of a transfer in transit that has received nothing yet.
+ * - `NOTHING_RECEIVED`: a return of a received transfer that received nothing.
+ * - `ALL_ON_RETURNS`: every received unit is already on a return; cancelling one frees its units.
+ * - `CONSUMPTION`, `IS_RETURN`, `NO_DESTINATION`: a return of a consumption, of a return, or
+ *   of a transfer with no destination.
+ *
+ * Codes may be added; treat an unknown one as a refusal.
+ */
+export type StockTransferActionRefusalCode = 'STATE' | 'CANCELLED' | 'PARTIALLY_RECEIVED' | 'DRAFT_NOT_SHIPPED' | 'NOT_YET_RECEIVED' | 'NOTHING_RECEIVED' | 'ALL_ON_RETURNS' | 'CONSUMPTION' | 'IS_RETURN' | 'NO_DESTINATION';
+/**
+ * Whether an action on a transfer is available now, as the engine judges it, and why not.
+ * Advice only: the write judges again (with the caller's permission and locations), so a
+ * transfer that changed meanwhile is still refused.
+ */
+export interface StockTransferActionAvailability {
+    available: boolean;
+    /** Null exactly when `available`. */
+    reasonCode: StockTransferActionRefusalCode | null;
+}
+/**
+ * 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 +63,7 @@ export interface StockTransferLine {
     id: string;
     variantId: string;
     sku: string;
+    variantName: string;
     quantity: number;
     receivedQuantity: number;
     lostQuantity: number;
@@ -59,6 +92,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 +104,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 +201,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 +290,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;
     /**
@@ -234,8 +356,18 @@ export interface StockTransferReturns {
      * return, or a transfer with nothing received.
      */
     returnableLines: StockTransferReturnableLine[];
+    /**
+     * Whether `createReturn` can make a return of it now, and why not (the engine's own rule).
+     * Null from an engine before the field: it says nothing either way, and `createReturn` still
+     * judges.
+     */
+    returnAvailability: StockTransferActionAvailability | null;
 }
-/** 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;
@@ -268,6 +400,11 @@ export interface StockTransferCancellation {
     hendriksExport: {
         bluJayOrderNumber: string | null;
     } | null;
+    /**
+     * Whether `cancel` would accept it now, and why not (the engine's own rule). Null from an
+     * engine before the field: it says nothing either way, and `cancel` still judges.
+     */
+    cancelAvailability: StockTransferActionAvailability | null;
 }
 /** One MyParcel parcel of a stock transfer: its own shipment, label and barcode. */
 export interface StockTransferParcel {
@@ -330,6 +467,62 @@ export interface StockTransferLabel {
     filename: string;
     bytes: Uint8Array;
 }
+/**
+ * The format of a store's transfer codes: `{prefix}{year}-{number}{suffix}`, e.g. `ST-2026-0001`
+ * (the defaults, until the store first sets its own).
+ */
+export interface StockTransferNumberingConfig {
+    prefix: string;
+    suffix: string;
+    /** How many digits the number is padded to, 3 to 8. */
+    digits: number;
+    /**
+     * `none`, `short` (`26`) or `full` (`2026`). A row written before the engine checked it may
+     * hold another value, which prints like `none`.
+     */
+    yearFormat: string;
+    /**
+     * Stored for the shared numbering contract only: the counter restarts each UTC year whenever
+     * the code shows the year, and never when it does not, whatever this says.
+     */
+    yearReset: boolean;
+}
+/** A patch: a field left out keeps its value. */
+export interface UpdateStockTransferNumberingConfigInput {
+    prefix?: string;
+    suffix?: string;
+    /** Clamped to 3..8. */
+    digits?: number;
+    /**
+     * `none`, `short` or `full`. Any other CHANGE is refused `NUMBERING_YEAR_FORMAT_INVALID`
+     * (→ `ValidationError`) and saves nothing; sending the stored value back always passes.
+     */
+    yearFormat?: string;
+    yearReset?: boolean;
+}
+/** `admin.stock.transfers.numbering`: the format the store's transfer codes take. */
+export interface StockTransferNumberingModule {
+    /**
+     * The format the store's NEXT transfer code takes. A store in an organization that shares its
+     * numbering formats (`settings.numbering_formats`) reads the organization's format; the counter
+     * is always the store's own. Needs `ReadStockLocation`.
+     *
+     * @effect read
+     * @permission ReadStockLocation
+     */
+    get(options?: Call): Promise<StockTransferNumberingConfig>;
+    /**
+     * Change the format of the store's OWN row; codes already issued keep theirs, and the counter
+     * never changes. Answers that row, which is not what `get` reads while the store inherits the
+     * organization's format: read `get` again for the format in use. A store that inherits it is
+     * refused `ORGANIZATION_SETTINGS_INHERITED` until it overrides the group, and one whose
+     * organization locks the group `MANAGED_BY_ORGANIZATION`. Needs `UpdateStockLocation`.
+     *
+     * @effect write
+     * @permission UpdateStockLocation
+     */
+    set(input: UpdateStockTransferNumberingConfigInput, options?: Call): Promise<StockTransferNumberingConfig>;
+}
 /**
  * Stock transfers (the engine's stock-transfer module, wrapped): a draft is
  * created, shipped (debiting the source), received line by line (crediting the
@@ -341,7 +534,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,51 +572,128 @@ 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. Whether it would be accepted now, and why not, is
+     * `cancellation(id).cancelAvailability`. 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
-     * when this store has no such transfer. Its own request, never part of
-     * `get`. Needs `ReadStockLocation`.
+     * own returns, what a new return may still take per variant, and whether
+     * `createReturn` can make one now (`returnAvailability`, the engine's own
+     * rule: `createReturn` judges again, per line) — or null when this store has
+     * no such transfer. Its own request, never part of `get`. Needs
+     * `ReadStockLocation`.
+     *
+     * @effect read
+     * @permission ReadStockLocation
      */
     returns(id: string, options?: Call): Promise<StockTransferReturns | null>;
     /**
@@ -434,10 +706,14 @@ export interface StockTransfersModule {
     /**
      * 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`.
+     * Read it before `cancel` to warn about the export and to know whether the
+     * cancel is offered (`cancelAvailability`, the engine's own rule: `cancel`
+     * judges again, with the caller's permission and locations), and after to
+     * show who did it. Its own request, never part of `get`: a caller deployed
+     * ahead of the engine sees only this call refused. Needs `ReadStockLocation`.
+     *
+     * @effect read
+     * @permission ReadStockLocation
      */
     cancellation(id: string, options?: Call): Promise<StockTransferCancellation | null>;
     /**
@@ -487,24 +763,82 @@ export interface StockTransfersModule {
      * default timeout does not cover.
      */
     myparcelLabel(id: string, format: StockTransferLabelFormat, options?: Call): Promise<StockTransferLabel>;
+    /**
+     * Void an in-transit shipment back to an editable draft, to correct a wrong handler or carrier
+     * and ship again. It undoes `ship`: the units go back to the source, every MyParcel parcel is
+     * voided at MyParcel inside the call, and the handler, its arguments, the carrier, tracking
+     * code, ETA, parcels and transfer note are cleared (the delivery address stays, for the
+     * re-ship). Answers the draft.
+     *
+     * MyParcel deletes only a concept: a parcel it keeps (a registered label) is named on
+     * `parcels(id).lastError`, recorded in `unretractedShipments` and never adopted by a re-ship.
+     * A Hendriks export, or any other handler's shipment, is NOT withdrawn: it is voided here only,
+     * and must be retracted at the 3PL by hand.
+     *
+     * Refused (`ValidationError`) for a transfer not in transit, so a repeat restores nothing
+     * twice, and once any unit was received or lost (close or cancel it instead). Refused
+     * `FIELD_GROUP_LOCKED` (`BusinessRuleError`) while an app or API key owns the store's Stock. A
+     * restricted credential must hold the source. The MyParcel calls make it allowed up to 120s;
+     * a `REQUEST_TIMEOUT` does not mean it failed, so `get` the transfer before trying again.
+     *
+     * @effect destructive
+     * @permission AdjustStock
+     */
+    removeShipment(id: string, options?: Call): Promise<StockTransferDetail>;
+    /**
+     * Upload the Hendriks (BluJay) export again for an in-transit transfer shipped with Hendriks
+     * whose export did not land at ship time (`hendriksRemotePath` still null). It reuses the
+     * transfer's BluJay order number and moves no stock. Answers the transfer with its
+     * `hendriksRemotePath`; an upload that fails is thrown, in the engine's words.
+     *
+     * Refused (`ValidationError`) for a transfer not shipped with Hendriks, not in transit, or
+     * already exported: a second retry waits for the first under the transfer's lock and is then
+     * refused, so one transfer never sends Hendriks two orders. A store without the Hendriks plugin
+     * is refused (`ValidationError`) too; one whose Hendriks set-up is missing or switched off is
+     * refused with no code yet, so that arrives as a `GRAPHQL_ERROR` (status 500) in the engine's
+     * words, and nothing is uploaded. A restricted credential must hold the source. The
+     * upload makes it allowed up to 120s; a `REQUEST_TIMEOUT` does not mean it failed, so `get` the
+     * transfer and look at `hendriksRemotePath` before trying again.
+     *
+     * @effect irreversible
+     * @permission AdjustStock
+     */
+    retryHendriksExport(id: string, options?: Call): Promise<StockTransferDetail>;
+    /**
+     * Generate the transfer's note (a consumption's: its consumption note) again and store it;
+     * answers the transfer with the new `pdfStorageKey`. Refused (`ValidationError`) for a draft.
+     * A store without document storage set up answers the transfer unchanged. A restricted
+     * credential must hold either end.
+     *
+     * @effect write
+     * @permission AdjustStock
+     */
+    regeneratePdf(id: string, options?: Call): Promise<StockTransferDetail>;
+    /** The format of the store's transfer codes. */
+    numbering: StockTransferNumberingModule;
 }
-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 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";
+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 REMOVE_STOCK_TRANSFER_SHIPMENT_MUTATION = "\n  mutation RemoveStockTransferShipment($id: ID!) {\n    removeStockTransferShipment(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 RETRY_STOCK_TRANSFER_HENDRIKS_EXPORT_MUTATION = "\n  mutation RetryStockTransferHendriksExport($id: ID!) {\n    retryStockTransferHendriksExport(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 REGENERATE_STOCK_TRANSFER_PDF_MUTATION = "\n  mutation RegenerateStockTransferPdf($id: ID!) {\n    regenerateStockTransferPdf(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 STOCK_TRANSFER_NUMBERING_QUERY = "\n  query StockTransferNumberingConfig {\n    stockTransferNumberingConfig { \n  prefix\n  suffix\n  digits\n  yearFormat\n  yearReset\n }\n  }\n";
+export declare const UPDATE_STOCK_TRANSFER_NUMBERING_MUTATION = "\n  mutation UpdateStockTransferNumberingConfig($input: UpdateStockTransferNumberingConfigInput!) {\n    updateStockTransferNumberingConfig(input: $input) { \n  prefix\n  suffix\n  digits\n  yearFormat\n  yearReset\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      returnAvailability { available reasonCode }\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";
 /**
@@ -512,7 +846,7 @@ export declare const STOCK_TRANSFER_SHORTFALL_QUERY = "\n  query StockTransferSh
  * 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_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      cancelAvailability { available reasonCode }\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";